diff --git a/internal/pkg/expanders/swagger-armspecs.generated.go b/internal/pkg/expanders/swagger-armspecs.generated.go index 7d15002a3..970fe1cd5 100644 --- a/internal/pkg/expanders/swagger-armspecs.generated.go +++ b/internal/pkg/expanders/swagger-armspecs.generated.go @@ -397,15 +397,15 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "alertsMetaData", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.AlertsManagement/alertsMetaData", "2023-07-12-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.AlertsManagement/alertsMetaData", "2024-01-01-preview"), }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.AlertsManagement/operations", "2023-07-12-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.AlertsManagement/operations", "2024-01-01-preview"), }, { Display: "actionRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/actionRules", "2023-05-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/actionRules", "2024-03-01-preview"), }, { Display: "alertRuleRecommendations", @@ -431,14 +431,14 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "actionRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules", "2023-05-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules", "2024-03-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{alertProcessingRuleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{alertProcessingRuleName}", "2023-05-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{alertProcessingRuleName}", "2023-05-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{alertProcessingRuleName}", "2023-05-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{alertProcessingRuleName}", "2023-05-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{alertProcessingRuleName}", "2024-03-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{alertProcessingRuleName}", "2024-03-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{alertProcessingRuleName}", "2024-03-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{alertProcessingRuleName}", "2024-03-01-preview"), }}, }, { @@ -459,30 +459,30 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "alerts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.AlertsManagement/alerts", "2023-07-12-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.AlertsManagement/alerts", "2024-01-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{alertId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}", "2023-07-12-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}", "2024-01-01-preview"), Children: []swagger.ResourceType{ { Display: "enrichments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/enrichments", "2023-07-12-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/enrichments", "2024-01-01-preview"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/enrichments/default", "2023-07-12-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/enrichments/default", "2024-01-01-preview"), }}, }, { Display: "history", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history", "2023-07-12-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history", "2024-01-01-preview"), }}, }}, }, { Display: "alertsSummary", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.AlertsManagement/alertsSummary", "2023-07-12-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.AlertsManagement/alertsSummary", "2024-01-01-preview"), }, { Display: "operations", @@ -1265,413 +1265,562 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.App/operations", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.App/operations", "2024-03-01"), }, { Display: "connectedEnvironments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.App/connectedEnvironments", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.App/connectedEnvironments", "2024-03-01"), }, { Display: "containerApps", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.App/containerApps", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.App/containerApps", "2024-03-01"), }, { Display: "jobs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.App/jobs", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.App/jobs", "2024-03-01"), }, { Display: "availableManagedEnvironmentsWorkloadProfileTypes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/availableManagedEnvironmentsWorkloadProfileTypes", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/availableManagedEnvironmentsWorkloadProfileTypes", "2024-03-01"), }, { Display: "billingMeters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/billingMeters", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/billingMeters", "2024-03-01"), + }, + { + Display: "usages", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/usages", "2024-03-01"), }, { Display: "managedEnvironments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.App/managedEnvironments", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.App/managedEnvironments", "2024-03-01"), }, { Display: "connectedEnvironments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{connectedEnvironmentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "certificates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{certificateName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}", "2024-03-01"), }}, }, { Display: "daprComponents", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{componentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}", "2024-03-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "storages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{storageName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages/{storageName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages/{storageName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages/{storageName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages/{storageName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages/{storageName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages/{storageName}", "2024-03-01"), }}, }}, }}, }, { Display: "containerApps", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{containerAppName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "authConfigs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{authConfigName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName}", "2024-03-01"), }}, }, { Display: "revisions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/revisionsApi/revisions", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/revisionsApi/revisions", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{revisionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/revisionsApi/revisions/{revisionName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/revisionsApi/revisions/{revisionName}", "2024-03-01"), }}, }, { Display: "rootApi", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/rootApi", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/rootApi", "2024-03-01"), }, { Display: "detectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectors", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectors", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{detectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectors/{detectorName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectors/{detectorName}", "2024-03-01"), }}, }, { Display: "revisions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{revisionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "replicas", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{replicaName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas/{replicaName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas/{replicaName}", "2024-03-01"), }}, }}, }}, }, { Display: "sourcecontrols", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{sourceControlName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{sourceControlName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{sourceControlName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{sourceControlName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{sourceControlName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{sourceControlName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{sourceControlName}", "2024-03-01"), }}, }}, }}, }, { Display: "jobs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{jobName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}", "2024-03-01"), Children: []swagger.ResourceType{ + { + Display: "detectors", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectors", "2024-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{detectorName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectors/{detectorName}", "2024-03-01"), + }}, + }, { Display: "executions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{jobExecutionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions/{jobExecutionName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions/{jobExecutionName}", "2024-03-01"), Children: []swagger.ResourceType{}, }}, }}, + SubResources: []swagger.ResourceType{ + { + Display: "{apiName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectorProperties/{apiName}", "2024-03-01"), + }}, }}, }, { Display: "managedEnvironments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{environmentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "certificates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{certificateName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates/{certificateName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates/{certificateName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates/{certificateName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates/{certificateName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates/{certificateName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates/{certificateName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates/{certificateName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates/{certificateName}", "2024-03-01"), }}, }, { Display: "daprComponents", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{componentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}", "2024-03-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "rootApi", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectorProperties/rootApi", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectorProperties/rootApi", "2024-03-01"), }, { Display: "detectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectors", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectors", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{detectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectors/{detectorName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectors/{detectorName}", "2024-03-01"), }}, }, { Display: "managedCertificates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{managedCertificateName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}", "2024-03-01"), }}, }, { Display: "storages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{storageName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages/{storageName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages/{storageName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages/{storageName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages/{storageName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages/{storageName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages/{storageName}", "2024-03-01"), }}, }, + { + Display: "usages", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/usages", "2024-03-01"), + }, { Display: "workloadProfileStates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/workloadProfileStates", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/workloadProfileStates", "2024-03-01"), + }}, + }}, + }, + { + Display: "operations", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.AppConfiguration/operations", "2023-03-01"), + }, + { + Display: "configurationStores", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/configurationStores", "2023-03-01"), + }, + { + Display: "deletedConfigurationStores", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/deletedConfigurationStores", "2023-03-01"), + }, + { + Display: "{configStoreName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/locations/{location}/deletedConfigurationStores/{configStoreName}", "2023-03-01"), + Children: []swagger.ResourceType{}, + }, + { + Display: "configurationStores", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores", "2023-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{configStoreName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}", "2023-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}", "2023-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}", "2023-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}", "2023-03-01"), + Children: []swagger.ResourceType{ + { + Display: "privateEndpointConnections", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections", "2023-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{privateEndpointConnectionName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-03-01"), + }}, + }, + { + Display: "privateLinkResources", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateLinkResources", "2023-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{groupName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateLinkResources/{groupName}", "2023-03-01"), + }}, + }, + { + Display: "replicas", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas", "2023-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{replicaName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}", "2023-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}", "2023-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}", "2023-03-01"), + }}, + }}, + SubResources: []swagger.ResourceType{ + { + Display: "{keyValueName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}", "2023-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}", "2023-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}", "2023-03-01"), }}, }}, }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.AppPlatform/operations", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.AppPlatform/operations", "2023-12-01"), }, { Display: "runtimeVersions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.AppPlatform/runtimeVersions", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.AppPlatform/runtimeVersions", "2023-12-01"), }, { Display: "Spring", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/Spring", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/Spring", "2023-12-01"), }, { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/skus", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/skus", "2023-12-01"), }, { Display: "Spring", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{serviceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}", "2022-12-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "apiPortals", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{apiPortalName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "domains", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{domainName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains/{domainName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains/{domainName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains/{domainName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains/{domainName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains/{domainName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains/{domainName}", "2023-12-01"), + }}, + }}, + }}, + }, + { + Display: "apms", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apms", "2023-12-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{apmName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apms/{apmName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apms/{apmName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apms/{apmName}", "2023-12-01"), + Children: []swagger.ResourceType{}, + }}, + }, + { + Display: "applicationAccelerators", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators", "2023-12-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{applicationAcceleratorName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}", "2023-12-01"), + Children: []swagger.ResourceType{ + { + Display: "customizedAccelerators", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/customizedAccelerators", "2023-12-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{customizedAcceleratorName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/customizedAccelerators/{customizedAcceleratorName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/customizedAccelerators/{customizedAcceleratorName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/customizedAccelerators/{customizedAcceleratorName}", "2023-12-01"), + Children: []swagger.ResourceType{}, + }}, + }, + { + Display: "predefinedAccelerators", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/predefinedAccelerators", "2023-12-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{predefinedAcceleratorName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/predefinedAccelerators/{predefinedAcceleratorName}", "2023-12-01"), + Children: []swagger.ResourceType{}, }}, }}, }}, }, + { + Display: "applicationLiveViews", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationLiveViews", "2023-12-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{applicationLiveViewName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationLiveViews/{applicationLiveViewName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationLiveViews/{applicationLiveViewName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationLiveViews/{applicationLiveViewName}", "2023-12-01"), + }}, + }, { Display: "apps", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{appName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}", "2022-12-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "bindings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{bindingName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings/{bindingName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings/{bindingName}", "2022-12-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings/{bindingName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings/{bindingName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings/{bindingName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings/{bindingName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings/{bindingName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings/{bindingName}", "2023-12-01"), }}, }, { Display: "deployments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{deploymentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}", "2022-12-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "domains", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{domainName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains/{domainName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains/{domainName}", "2022-12-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains/{domainName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains/{domainName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains/{domainName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains/{domainName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains/{domainName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains/{domainName}", "2023-12-01"), }}, }}, }}, }, { Display: "buildServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices", "2023-12-01"), SubResources: []swagger.ResourceType{ { - Display: "{buildServiceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}", "2022-12-01"), + Display: "{buildServiceName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "agentPools", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/agentPools", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/agentPools", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{agentPoolName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/agentPools/{agentPoolName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/agentPools/{agentPoolName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/agentPools/{agentPoolName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/agentPools/{agentPoolName}", "2023-12-01"), }}, }, { Display: "builders", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{builderName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "buildpackBindings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{buildpackBindingName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings/{buildpackBindingName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings/{buildpackBindingName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings/{buildpackBindingName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings/{buildpackBindingName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings/{buildpackBindingName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings/{buildpackBindingName}", "2023-12-01"), }}, }}, }}, }, { Display: "builds", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds", "2023-12-01"), SubResources: []swagger.ResourceType{ { - Display: "{buildName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}", "2022-12-01"), + Display: "{buildName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "results", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}/results", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}/results", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{buildResultName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}/results/{buildResultName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}/results/{buildResultName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -1679,118 +1828,153 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "supportedBuildpacks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedBuildpacks", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedBuildpacks", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{buildpackName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedBuildpacks/{buildpackName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedBuildpacks/{buildpackName}", "2023-12-01"), }}, }, { Display: "supportedStacks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedStacks", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedStacks", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{stackName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedStacks/{stackName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedStacks/{stackName}", "2023-12-01"), }}, }}, }}, }, + { + Display: "buildpackBindings", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildpackBindings", "2023-12-01"), + }, { Display: "certificates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{certificateName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}", "2023-12-01"), }}, }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/default", "2022-12-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/default", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/default", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/default", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/default", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/default", "2023-12-01"), }, { Display: "configurationServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{configurationServiceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}", "2023-12-01"), + Children: []swagger.ResourceType{}, + }}, + }, + { + Display: "containerRegistries", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/containerRegistries", "2023-12-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{containerRegistryName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/containerRegistries/{containerRegistryName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/containerRegistries/{containerRegistryName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/containerRegistries/{containerRegistryName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "deployments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/deployments", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/deployments", "2023-12-01"), + }, + { + Display: "devToolPortals", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/devToolPortals", "2023-12-01"), }, { Display: "gateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{gatewayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "domains", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{domainName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains/{domainName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains/{domainName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains/{domainName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains/{domainName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains/{domainName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains/{domainName}", "2023-12-01"), }}, }, { Display: "routeConfigs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{routeConfigName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs/{routeConfigName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs/{routeConfigName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs/{routeConfigName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs/{routeConfigName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs/{routeConfigName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs/{routeConfigName}", "2023-12-01"), }}, }}, }}, }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/monitoringSettings/default", "2022-12-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/monitoringSettings/default", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/monitoringSettings/default", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/monitoringSettings/default", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/monitoringSettings/default", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/monitoringSettings/default", "2023-12-01"), }, { Display: "serviceRegistries", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{serviceRegistryName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}", "2023-12-01"), }}, }, { Display: "storages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{storageName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages/{storageName}", "2022-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages/{storageName}", "2022-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages/{storageName}", "2022-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages/{storageName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages/{storageName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages/{storageName}", "2023-12-01"), }}, + }, + { + Display: "supportedApmTypes", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/supportedApmTypes", "2023-12-01"), + }, + { + Display: "supportedServerVersions", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/supportedServerVersions", "2023-12-01"), + }}, + SubResources: []swagger.ResourceType{ + { + Display: "{devToolPortalName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/DevToolPortals/{devToolPortalName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/DevToolPortals/{devToolPortalName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/DevToolPortals/{devToolPortalName}", "2023-12-01"), }}, }}, }, @@ -2511,6 +2695,30 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }}, }}, }, + { + Display: "operations", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.AzureFleet/operations", "2024-05-01-preview"), + }, + { + Display: "fleets", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.AzureFleet/fleets", "2024-05-01-preview"), + }, + { + Display: "fleets", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets", "2024-05-01-preview"), + SubResources: []swagger.ResourceType{ + { + Display: "{fleetName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}", "2024-05-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}", "2024-05-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}", "2024-05-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}", "2024-05-01-preview"), + }, + { + Display: "virtualMachineScaleSets", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{name}/virtualMachineScaleSets", "2024-05-01-preview"), + }}, + }, { Display: "operations", Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.AzureLargeInstance/operations", "2023-07-20-preview"), @@ -2631,55 +2839,55 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Batch/operations", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Batch/operations", "2024-02-01"), }, { Display: "batchAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts", "2024-02-01"), }, { Display: "cloudServiceSkus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/cloudServiceSkus", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/cloudServiceSkus", "2024-02-01"), }, { Display: "quotas", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas", "2024-02-01"), }, { Display: "virtualMachineSkus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/virtualMachineSkus", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/virtualMachineSkus", "2024-02-01"), }, { Display: "batchAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{accountName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}", "2024-02-01"), Children: []swagger.ResourceType{ { Display: "applications", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{applicationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}", "2024-02-01"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{versionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}", "2024-02-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -2687,61 +2895,61 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "certificates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{certificateName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}", "2024-02-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "detectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/detectors", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/detectors", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{detectorId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/detectors/{detectorId}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/detectors/{detectorId}", "2024-02-01"), }}, }, { Display: "outboundNetworkDependenciesEndpoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/outboundNetworkDependenciesEndpoints", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/outboundNetworkDependenciesEndpoints", "2024-02-01"), }, { Display: "pools", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{poolName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}", "2024-02-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-02-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{privateLinkResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources/{privateLinkResourceName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources/{privateLinkResourceName}", "2024-02-01"), }}, }}, }}, @@ -2779,13 +2987,13 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { Children: []swagger.ResourceType{ { Display: "benefitUtilizationSummaries", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries", "2023-11-01"), }}, }}, }, { Display: "benefitUtilizationSummaries", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries", "2023-11-01"), }}, }}, }, @@ -2793,52 +3001,6 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { Display: "savingsPlans", Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.BillingBenefits/savingsPlans", "2022-11-01"), }, - { - Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Blockchain/operations", "2018-06-01-preview"), - }, - { - Display: "blockchainMembers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Blockchain/blockchainMembers", "2018-06-01-preview"), - }, - { - Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Blockchain/locations/{locationName}/blockchainMemberOperationResults/{operationId}", "2018-06-01-preview"), - }, - { - Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Blockchain/skus", "2018-06-01-preview"), - }, - { - Display: "blockchainMembers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers", "2018-06-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{blockchainMemberName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}", "2018-06-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}", "2018-06-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}", "2018-06-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}", "2018-06-01-preview"), - Children: []swagger.ResourceType{ - { - Display: "consortiumMembers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/consortiumMembers", "2018-06-01-preview"), - }, - { - Display: "transactionNodes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/transactionNodes", "2018-06-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{transactionNodeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/transactionNodes/{transactionNodeName}", "2018-06-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/transactionNodes/{transactionNodeName}", "2018-06-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/transactionNodes/{transactionNodeName}", "2018-06-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/transactionNodes/{transactionNodeName}", "2018-06-01-preview"), - Children: []swagger.ResourceType{}, - }}, - }}, - }}, - }, { Display: "operations", Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Blueprint/operations", "2017-11-11-preview"), @@ -2970,224 +3132,224 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "edgenodes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Cdn/edgenodes", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Cdn/edgenodes", "2024-02-01"), }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Cdn/operations", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Cdn/operations", "2024-02-01"), }, { Display: "cdnWebApplicationFirewallManagedRuleSets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/cdnWebApplicationFirewallManagedRuleSets", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/cdnWebApplicationFirewallManagedRuleSets", "2024-02-01"), }, { Display: "profiles", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/profiles", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/profiles", "2024-02-01"), }, { Display: "cdnWebApplicationFirewallPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{policyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies/{policyName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies/{policyName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies/{policyName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies/{policyName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies/{policyName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies/{policyName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies/{policyName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies/{policyName}", "2024-02-01"), }}, }, { Display: "profiles", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{profileName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}", "2024-02-01"), Children: []swagger.ResourceType{ { Display: "afdEndpoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{endpointName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}", "2024-02-01"), Children: []swagger.ResourceType{ { Display: "routes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{routeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}", "2024-02-01"), }}, }}, }}, }, { Display: "customDomains", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{customDomainName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}", "2024-02-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "endpoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{endpointName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}", "2024-02-01"), Children: []swagger.ResourceType{ { Display: "customDomains", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{customDomainName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}", "2024-02-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "originGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{originGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}", "2024-02-01"), }}, }, { Display: "origins", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{originName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}", "2024-02-01"), }}, }}, }}, }, { Display: "getLogAnalyticsLocations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsLocations", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsLocations", "2024-02-01"), }, { Display: "getLogAnalyticsMetrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsMetrics", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsMetrics", "2024-02-01"), }, { Display: "getLogAnalyticsRankings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsRankings", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsRankings", "2024-02-01"), }, { Display: "getLogAnalyticsResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsResources", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsResources", "2024-02-01"), }, { Display: "getWafLogAnalyticsMetrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsMetrics", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsMetrics", "2024-02-01"), }, { Display: "getWafLogAnalyticsRankings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsRankings", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsRankings", "2024-02-01"), }, { Display: "originGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{originGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}", "2024-02-01"), Children: []swagger.ResourceType{ { Display: "origins", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{originName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}", "2024-02-01"), }}, }}, }}, }, { Display: "ruleSets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{ruleSetName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}", "2024-02-01"), Children: []swagger.ResourceType{ { Display: "rules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{ruleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}", "2024-02-01"), }}, }}, }}, }, { Display: "secrets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{secretName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}", "2024-02-01"), }}, }, { Display: "securityPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{securityPolicyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}", "2024-02-01"), }}, }}, }}, @@ -3206,53 +3368,53 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Chaos/operations", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Chaos/operations", "2024-01-01"), }, { Display: "experiments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/experiments", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/experiments", "2024-01-01"), }, { Display: "targetTypes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes", "2024-01-01"), SubResources: []swagger.ResourceType{ { Display: "{targetTypeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}", "2024-01-01"), Children: []swagger.ResourceType{ { Display: "capabilityTypes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}/capabilityTypes", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}/capabilityTypes", "2024-01-01"), SubResources: []swagger.ResourceType{ { Display: "{capabilityTypeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}/capabilityTypes/{capabilityTypeName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}/capabilityTypes/{capabilityTypeName}", "2024-01-01"), }}, }}, }}, }, { Display: "{asyncOperationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/operationsStatuses/{asyncOperationId}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/operationStatuses/{asyncOperationId}", "2024-01-01"), }, { Display: "experiments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments", "2024-01-01"), SubResources: []swagger.ResourceType{ { Display: "{experimentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}", "2023-11-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}", "2024-01-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}", "2024-01-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}", "2024-01-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}", "2024-01-01"), Children: []swagger.ResourceType{ { Display: "executions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executions", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executions", "2024-01-01"), SubResources: []swagger.ResourceType{ { Display: "{executionId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executions/{executionId}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executions/{executionId}", "2024-01-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -3260,23 +3422,23 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "targets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets", "2024-01-01"), SubResources: []swagger.ResourceType{ { Display: "{targetName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}", "2024-01-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}", "2024-01-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}", "2024-01-01"), Children: []swagger.ResourceType{ { Display: "capabilities", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities", "2024-01-01"), SubResources: []swagger.ResourceType{ { Display: "{capabilityName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities/{capabilityName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities/{capabilityName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities/{capabilityName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities/{capabilityName}", "2024-01-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities/{capabilityName}", "2024-01-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities/{capabilityName}", "2024-01-01"), }}, }}, }}, @@ -3442,15 +3604,15 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Compute/operations", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Compute/operations", "2024-03-01"), }, { Display: "availabilitySets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets", "2024-03-01"), }, { Display: "capacityReservationGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/capacityReservationGroups", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/capacityReservationGroups", "2024-03-01"), }, { Display: "cloudServices", @@ -3458,27 +3620,27 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "diskAccesses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses", "2023-10-02"), }, { Display: "diskEncryptionSets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets", "2023-10-02"), }, { Display: "disks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks", "2023-10-02"), }, { Display: "galleries", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries", "2023-07-03"), }, { Display: "hostGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/hostGroups", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/hostGroups", "2024-03-01"), }, { Display: "images", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/images", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/images", "2024-03-01"), }, { Display: "cloudServiceOsFamilies", @@ -3500,23 +3662,23 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "{publicGalleryName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}", "2023-07-03"), Children: []swagger.ResourceType{ { Display: "images", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images", "2023-07-03"), SubResources: []swagger.ResourceType{ { Display: "{galleryImageName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}", "2023-07-03"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}/versions", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}/versions", "2023-07-03"), SubResources: []swagger.ResourceType{ { Display: "{galleryImageVersionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}", "2023-07-03"), }}, }}, }}, @@ -3524,23 +3686,23 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "publishers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "offers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}", "2024-03-01"), }}, }}, }}, @@ -3548,41 +3710,41 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "vmimages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/vmimages", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/vmimages", "2024-03-01"), }, { Display: "publishers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "types", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}", "2024-03-01"), }}, }}, }, { Display: "offers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}", "2024-03-01"), }}, }}, }}, @@ -3590,36 +3752,36 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "runCommands", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{commandId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}", "2024-03-01"), }}, }, { Display: "sharedGalleries", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries", "2023-07-03"), SubResources: []swagger.ResourceType{ { Display: "{galleryUniqueName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}", "2023-07-03"), Children: []swagger.ResourceType{ { Display: "images", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images", "2023-07-03"), SubResources: []swagger.ResourceType{ { Display: "{galleryImageName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}", "2023-07-03"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions", "2023-07-03"), SubResources: []swagger.ResourceType{ { Display: "{galleryImageVersionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions/{galleryImageVersionName}", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions/{galleryImageVersionName}", "2023-07-03"), }}, }}, }}, @@ -3628,27 +3790,27 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages", "2024-03-01"), }, { Display: "virtualMachineScaleSets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachineScaleSets", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachineScaleSets", "2024-03-01"), }, { Display: "virtualMachines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines", "2024-03-01"), }, { Display: "vmSizes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes", "2024-03-01"), }, { Display: "proximityPlacementGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/proximityPlacementGroups", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/proximityPlacementGroups", "2024-03-01"), }, { Display: "restorePointCollections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/restorePointCollections", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/restorePointCollections", "2024-03-01"), }, { Display: "skus", @@ -3656,58 +3818,58 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "snapshots", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/snapshots", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/snapshots", "2023-10-02"), }, { Display: "sshPublicKeys", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/sshPublicKeys", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/sshPublicKeys", "2024-03-01"), }, { Display: "virtualMachineScaleSets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets", "2024-03-01"), }, { Display: "virtualMachines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines", "2024-03-01"), }, { Display: "availabilitySets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{availabilitySetName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "vmSizes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes", "2024-03-01"), }}, }}, }, { Display: "capacityReservationGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{capacityReservationGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "capacityReservations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{capacityReservationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}", "2024-03-01"), }}, }}, }}, @@ -3746,19 +3908,19 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "networkInterfaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{networkInterfaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "publicipaddresses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{publicIpAddressName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses/{publicIpAddressName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses/{publicIpAddressName}", "2023-11-01"), }}, }}, }}, @@ -3786,129 +3948,129 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "networkInterfaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/networkInterfaces", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/networkInterfaces", "2023-11-01"), }, { Display: "publicipaddresses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/publicipaddresses", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/publicipaddresses", "2023-11-01"), }}, }}, }, { Display: "diskAccesses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses", "2023-10-02"), SubResources: []swagger.ResourceType{ { Display: "{diskAccessName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}", "2023-04-02"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}", "2023-04-02"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}", "2023-04-02"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}", "2023-10-02"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}", "2023-10-02"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}", "2023-10-02"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}", "2023-10-02"), Children: []swagger.ResourceType{ { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections", "2023-10-02"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-04-02"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-04-02"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-10-02"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-10-02"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-10-02"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateLinkResources", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateLinkResources", "2023-10-02"), }}, }}, }, { Display: "diskEncryptionSets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets", "2023-10-02"), SubResources: []swagger.ResourceType{ { Display: "{diskEncryptionSetName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}", "2023-04-02"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}", "2023-04-02"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}", "2023-04-02"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}", "2023-10-02"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}", "2023-10-02"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}", "2023-10-02"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}", "2023-10-02"), Children: []swagger.ResourceType{ { Display: "associatedResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}/associatedResources", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}/associatedResources", "2023-10-02"), }}, }}, }, { Display: "disks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks", "2023-10-02"), SubResources: []swagger.ResourceType{ { Display: "{diskName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}", "2023-04-02"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}", "2023-04-02"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}", "2023-04-02"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}", "2023-10-02"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}", "2023-10-02"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}", "2023-10-02"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}", "2023-10-02"), Children: []swagger.ResourceType{}, }}, }, { Display: "galleries", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries", "2023-07-03"), SubResources: []swagger.ResourceType{ { Display: "{galleryName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}", "2022-08-03"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}", "2022-08-03"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}", "2022-08-03"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}", "2023-07-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}", "2023-07-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}", "2023-07-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}", "2023-07-03"), Children: []swagger.ResourceType{ { Display: "applications", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications", "2023-07-03"), SubResources: []swagger.ResourceType{ { Display: "{galleryApplicationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}", "2022-08-03"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}", "2022-08-03"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}", "2022-08-03"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}", "2023-07-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}", "2023-07-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}", "2023-07-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}", "2023-07-03"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions", "2023-07-03"), SubResources: []swagger.ResourceType{ { Display: "{galleryApplicationVersionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}", "2022-08-03"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}", "2022-08-03"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}", "2022-08-03"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}", "2023-07-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}", "2023-07-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}", "2023-07-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}", "2023-07-03"), }}, }}, }}, }, { Display: "images", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images", "2023-07-03"), SubResources: []swagger.ResourceType{ { Display: "{galleryImageName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}", "2022-08-03"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}", "2022-08-03"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}", "2022-08-03"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}", "2023-07-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}", "2023-07-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}", "2023-07-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}", "2023-07-03"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions", "2023-07-03"), SubResources: []swagger.ResourceType{ { Display: "{galleryImageVersionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}", "2022-08-03"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}", "2022-08-03"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}", "2022-08-03"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}", "2022-08-03"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}", "2023-07-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}", "2023-07-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}", "2023-07-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}", "2023-07-03"), }}, }}, }}, @@ -3917,29 +4079,29 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "hostGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{hostGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "hosts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{hostName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "hostSizes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/hostSizes", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/hostSizes", "2024-03-01"), }}, }}, }}, @@ -3947,52 +4109,52 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "images", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{imageName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}", "2024-03-01"), }}, }, { Display: "proximityPlacementGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{proximityPlacementGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}", "2024-03-01"), }}, }, { Display: "restorePointCollections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{restorePointCollectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{restorePointName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}", "2024-03-01"), }, { Display: "diskRestorePoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints", "2023-10-02"), SubResources: []swagger.ResourceType{ { Display: "{diskRestorePointName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}", "2023-10-02"), Children: []swagger.ResourceType{}, }}, }}, @@ -4000,105 +4162,105 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "snapshots", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots", "2023-10-02"), SubResources: []swagger.ResourceType{ { Display: "{snapshotName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}", "2023-04-02"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}", "2023-04-02"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}", "2023-04-02"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}", "2023-04-02"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}", "2023-10-02"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}", "2023-10-02"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}", "2023-10-02"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}", "2023-10-02"), Children: []swagger.ResourceType{}, }}, }, { Display: "sshPublicKeys", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{sshPublicKeyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}", "2024-03-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "virtualMachineScaleSets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{vmScaleSetName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "extensions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{vmssExtensionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}", "2024-03-01"), }}, }, { Display: "instanceView", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView", "2024-03-01"), }, { Display: "osUpgradeHistory", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory", "2024-03-01"), }, { Display: "latest", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest", "2024-03-01"), }, { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus", "2024-03-01"), }, { Display: "virtualMachines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{instanceId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "extensions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{vmExtensionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}", "2024-03-01"), }}, }, { Display: "instanceView", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/instanceView", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/instanceView", "2024-03-01"), }, { Display: "runCommands", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{runCommandName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}", "2024-03-01"), }}, }}, }, @@ -4141,46 +4303,46 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "virtualMachines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{vmName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "extensions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{vmExtensionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}", "2024-03-01"), }}, }, { Display: "instanceView", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView", "2024-03-01"), }, { Display: "runCommands", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{runCommandName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}", "2024-03-01"), }}, }, { Display: "vmSizes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes", "2024-03-01"), }, { Display: "guestConfigurationAssignments", @@ -4601,75 +4763,75 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DocumentDB/operations", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DocumentDB/operations", "2024-03-01-preview"), }, { Display: "cassandraClusters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/cassandraClusters", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/cassandraClusters", "2024-05-15"), }, { Display: "databaseAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/databaseAccounts", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/databaseAccounts", "2024-05-15"), }, { Display: "locations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{location}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}", "2024-05-15"), Children: []swagger.ResourceType{ { Display: "restorableDatabaseAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{instanceId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}", "2024-05-15"), Children: []swagger.ResourceType{ { Display: "restorableGraphs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGraphs", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGraphs", "2024-05-15"), }, { Display: "restorableGremlinDatabases", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinDatabases", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinDatabases", "2024-05-15"), }, { Display: "restorableGremlinResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinResources", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinResources", "2024-05-15"), }, { Display: "restorableMongodbCollections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbCollections", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbCollections", "2024-05-15"), }, { Display: "restorableMongodbDatabases", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbDatabases", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbDatabases", "2024-05-15"), }, { Display: "restorableMongodbResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbResources", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbResources", "2024-05-15"), }, { Display: "restorableSqlContainers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers", "2024-05-15"), }, { Display: "restorableSqlDatabases", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlDatabases", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlDatabases", "2024-05-15"), }, { Display: "restorableSqlResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlResources", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlResources", "2024-05-15"), }, { Display: "restorableTableResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableTableResources", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableTableResources", "2024-05-15"), }, { Display: "restorableTables", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableTables", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableTables", "2024-05-15"), }}, }}, }}, @@ -4677,567 +4839,567 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "restorableDatabaseAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/restorableDatabaseAccounts", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/restorableDatabaseAccounts", "2024-05-15"), }, { Display: "cassandraClusters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{clusterName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}", "2023-09-15"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}", "2024-05-15"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}", "2024-05-15"), Children: []swagger.ResourceType{ { Display: "dataCenters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{dataCenterName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}", "2023-09-15"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}", "2024-05-15"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}", "2024-05-15"), }}, }, { Display: "status", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/status", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/status", "2024-05-15"), }}, }}, }, { Display: "databaseAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{accountName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}", "2023-09-15"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}", "2024-05-15"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}", "2024-05-15"), Children: []swagger.ResourceType{ { Display: "cassandraKeyspaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{keyspaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}", "2024-05-15"), Children: []swagger.ResourceType{ { Display: "tables", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{tableName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}", "2024-05-15"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default", "2024-05-15"), Children: []swagger.ResourceType{}, }}, }}, }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default", "2024-05-15"), Children: []swagger.ResourceType{}, }}, }}, }, { Display: "gremlinDatabases", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{databaseName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}", "2024-05-15"), Children: []swagger.ResourceType{ { Display: "graphs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{graphName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}", "2024-05-15"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default", "2024-05-15"), Children: []swagger.ResourceType{}, }}, }}, }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default", "2024-05-15"), Children: []swagger.ResourceType{}, }}, }}, }, { Display: "metricDefinitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions", "2024-05-15"), }, { Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics", "2024-05-15"), }, { Display: "mongodbDatabases", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{databaseName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}", "2024-05-15"), Children: []swagger.ResourceType{ { Display: "collections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{collectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}", "2024-05-15"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default", "2024-05-15"), Children: []swagger.ResourceType{}, }}, }}, }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default", "2024-05-15"), Children: []swagger.ResourceType{}, }}, }}, }, { Display: "mongodbRoleDefinitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{mongoRoleDefinitionId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}", "2024-05-15"), }}, }, { Display: "mongodbUserDefinitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{mongoUserDefinitionId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}", "2024-05-15"), }}, }, { Display: "notebookWorkspaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{notebookWorkspaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}", "2024-05-15"), Children: []swagger.ResourceType{}, }}, }, { Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/percentile/metrics", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/percentile/metrics", "2024-05-15"), }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-05-15"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{groupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources/{groupName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources/{groupName}", "2024-05-15"), }}, }, { Display: "readonlykeys", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys", "2024-05-15"), }, { Display: "services", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{serviceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}", "2024-05-15"), }}, }, { Display: "sqlDatabases", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{databaseName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}", "2024-05-15"), Children: []swagger.ResourceType{ { Display: "clientEncryptionKeys", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{clientEncryptionKeyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}", "2024-05-15"), }}, }, { Display: "containers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{containerName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}", "2024-05-15"), Children: []swagger.ResourceType{ { Display: "storedProcedures", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{storedProcedureName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}", "2024-05-15"), }}, }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default", "2024-05-15"), Children: []swagger.ResourceType{}, }, { Display: "triggers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{triggerName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}", "2024-05-15"), }}, }, { Display: "userDefinedFunctions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{userDefinedFunctionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}", "2024-05-15"), }}, }}, }}, }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default", "2024-05-15"), Children: []swagger.ResourceType{}, }}, }}, }, { Display: "sqlRoleAssignments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{roleAssignmentId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}", "2024-05-15"), }}, }, { Display: "sqlRoleDefinitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{roleDefinitionId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}", "2024-05-15"), }}, }, { Display: "tables", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables", "2024-05-15"), SubResources: []swagger.ResourceType{ { Display: "{tableName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}", "2023-09-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}", "2024-05-15"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}", "2024-05-15"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default", "2023-09-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default", "2024-05-15"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default", "2024-05-15"), Children: []swagger.ResourceType{}, }}, }}, }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/usages", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/usages", "2024-05-15"), }}, SubResources: []swagger.ResourceType{ { Display: "metricDefinitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metricDefinitions", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metricDefinitions", "2024-05-15"), }, { Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metrics", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metrics", "2024-05-15"), }, { Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics", "2024-05-15"), }, { Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics", "2024-05-15"), }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages", "2024-05-15"), }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/usages", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/usages", "2024-05-15"), }, { Display: "metricDefinitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metricDefinitions", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metricDefinitions", "2024-05-15"), }, { Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metrics", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metrics", "2024-05-15"), }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages", "2024-05-15"), }, { Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/metrics", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/metrics", "2024-05-15"), }, { Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics", "2024-05-15"), }, { Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics", "2024-05-15"), }, { Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/metrics", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/metrics", "2024-05-15"), }, { Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sourceRegion/{sourceRegion}/targetRegion/{targetRegion}/percentile/metrics", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sourceRegion/{sourceRegion}/targetRegion/{targetRegion}/percentile/metrics", "2024-05-15"), }, { Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/targetRegion/{targetRegion}/percentile/metrics", "2023-09-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/targetRegion/{targetRegion}/percentile/metrics", "2024-05-15"), }}, }}, }, { Display: "benefitUtilizationSummaries", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries", "2023-11-01"), }, { Display: "benefitUtilizationSummaries", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries", "2023-11-01"), }, { Display: "costAllocationRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules", "2023-11-01"), Children: []swagger.ResourceType{}, SubResources: []swagger.ResourceType{ { Display: "{ruleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}", "2023-11-01"), }}, }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/operations", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/operations", "2023-11-01"), }, { Display: "scheduledActions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/scheduledActions", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/scheduledActions", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/scheduledActions/{name}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/scheduledActions/{name}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/scheduledActions/{name}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/scheduledActions/{name}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/scheduledActions/{name}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/scheduledActions/{name}", "2023-11-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "views", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/views", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/views", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{viewName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/views/{viewName}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/views/{viewName}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/views/{viewName}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/views/{viewName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/views/{viewName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/views/{viewName}", "2023-11-01"), }}, }, { Display: "alerts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts", "2023-11-01"), }, { Display: "dimensions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions", "2023-11-01"), }, { Display: "benefitRecommendations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations", "2023-11-01"), }, { Display: "alerts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/alerts", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/alerts", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{alertId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}", "2023-08-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}", "2023-11-01"), }}, }, { Display: "budgets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/budgets", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/budgets", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{budgetName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}", "2023-11-01"), }}, }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}", "2023-11-01"), }, { Display: "dimensions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/dimensions", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/dimensions", "2023-11-01"), }, { Display: "exports", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/exports", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/exports", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{exportName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/exports/{exportName}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/exports/{exportName}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/exports/{exportName}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/exports/{exportName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/exports/{exportName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/exports/{exportName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "runHistory", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory", "2023-11-01"), }}, }}, }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/operationResults/{operationId}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/operationResults/{operationId}", "2023-11-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/operationStatus/{operationId}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/operationStatus/{operationId}", "2023-11-01"), }, { Display: "scheduledActions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/scheduledActions", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/scheduledActions", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}", "2023-11-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "settings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/settings", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/settings", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{type}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/settings/{type}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/settings/{type}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/settings/{type}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/settings/{type}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/settings/{type}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/settings/{type}", "2023-11-01"), }}, }, { Display: "views", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/views", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/views", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{viewName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/views/{viewName}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/views/{viewName}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/views/{viewName}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/views/{viewName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/views/{viewName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.CostManagement/views/{viewName}", "2023-11-01"), }}, }, { @@ -5485,177 +5647,177 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DataBox/operations", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DataBox/operations", "2024-03-01-preview"), }, { Display: "jobs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs", "2024-03-01-preview"), }, { Display: "jobs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs", "2024-03-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{jobName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}", "2023-03-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}", "2024-03-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}", "2024-03-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}", "2024-03-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}", "2024-03-01-preview"), Children: []swagger.ResourceType{}, }}, }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DataBoxEdge/operations", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DataBoxEdge/operations", "2023-12-01"), }, { Display: "availableSkus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/availableSkus", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/availableSkus", "2023-12-01"), }, { Display: "dataBoxEdgeDevices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices", "2023-12-01"), }, { Display: "dataBoxEdgeDevices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{deviceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "alerts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}", "2023-12-01"), }}, }, { Display: "bandwidthSchedules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}", "2023-12-01"), }}, }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityInfo/default", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityInfo/default", "2023-12-01"), }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticProactiveLogCollectionSettings/default", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticProactiveLogCollectionSettings/default", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticProactiveLogCollectionSettings/default", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticProactiveLogCollectionSettings/default", "2023-12-01"), }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticRemoteSupportSettings/default", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticRemoteSupportSettings/default", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticRemoteSupportSettings/default", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticRemoteSupportSettings/default", "2023-12-01"), }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default", "2023-12-01"), }, { Display: "nodes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/nodes", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/nodes", "2023-12-01"), }, { Display: "orders", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "roles", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}", "2023-12-01"), }, { Display: "addons", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{addonName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}", "2023-12-01"), }}, }, { Display: "monitoringConfig", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default", "2023-12-01"), }}, }}, }, { Display: "shares", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "storageAccountCredentials", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}", "2023-12-01"), }}, }, { Display: "storageAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{storageAccountName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "containers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{containerName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -5663,38 +5825,38 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "triggers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}", "2023-12-01"), }}, }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default", "2023-12-01"), }, { Display: "users", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}", "2023-12-01"), }}, }}, SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}", "2023-12-01"), }, { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}", "2023-12-01"), }}, }}, }, @@ -6189,189 +6351,193 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DataProtection/operations", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DataProtection/operations", "2024-04-01"), }, { Display: "backupVaults", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/backupVaults", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/backupVaults", "2024-04-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationResults/{operationId}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationResults/{operationId}", "2024-04-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationStatus/{operationId}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationStatus/{operationId}", "2024-04-01"), }, { Display: "resourceGuards", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/resourceGuards", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/resourceGuards", "2024-04-01"), }, { Display: "backupVaults", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{vaultName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}", "2023-11-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "backupInstances", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{backupInstanceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "recoveryPoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{recoveryPointId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints/{recoveryPointId}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints/{recoveryPointId}", "2024-04-01"), }}, }}, SubResources: []swagger.ResourceType{ { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/operationResults/{operationId}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/operationResults/{operationId}", "2024-04-01"), }}, }}, }, { Display: "backupJobs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/operations/{operationId}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/operations/{operationId}", "2024-04-01"), }, { Display: "{jobId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}", "2024-04-01"), }}, }, { Display: "backupPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{backupPolicyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}", "2024-04-01"), }}, }, { Display: "backupResourceGuardProxies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{resourceGuardProxyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}", "2024-04-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "deletedBackupInstances", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{backupInstanceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances/{backupInstanceName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances/{backupInstanceName}", "2024-04-01"), Children: []swagger.ResourceType{}, }}, }}, SubResources: []swagger.ResourceType{ { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationResults/{operationId}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationResults/{operationId}", "2024-04-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationStatus/{operationId}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationStatus/{operationId}", "2024-04-01"), }}, }}, }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/operationStatus/{operationId}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/operationStatus/{operationId}", "2024-04-01"), }, { Display: "resourceGuards", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{resourceGuardsName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}", "2023-11-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "deleteProtectedItemRequests", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{requestName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests/{requestName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests/{requestName}", "2024-04-01"), }}, }, { Display: "deleteResourceGuardProxyRequests", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{requestName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests/{requestName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests/{requestName}", "2024-04-01"), }}, }, { Display: "disableSoftDeleteRequests", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{requestName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests/{requestName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests/{requestName}", "2024-04-01"), }}, }, { Display: "getBackupSecurityPINRequests", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{requestName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests/{requestName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests/{requestName}", "2024-04-01"), }}, }, { Display: "updateProtectedItemRequests", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{requestName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests/{requestName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests/{requestName}", "2024-04-01"), }}, }, { Display: "updateProtectionPolicyRequests", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{requestName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests/{requestName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests/{requestName}", "2024-04-01"), }}, }}, }}, }, + { + Display: "backupInstances", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceId}/providers/Microsoft.DataProtection/backupInstances", "2024-04-01"), + }, { Display: "listInvitations", Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DataShare/listInvitations", "2020-09-01"), @@ -6496,184 +6662,127 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DeploymentManager/operations", "2019-11-01-preview"), - }, - { - Display: "artifactSources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/artifactSources", "2019-11-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{artifactSourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/artifactSources/{artifactSourceName}", "2019-11-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/artifactSources/{artifactSourceName}", "2019-11-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/artifactSources/{artifactSourceName}", "2019-11-01-preview"), - }}, - }, - { - Display: "rollouts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts", "2019-11-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{rolloutName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts/{rolloutName}", "2019-11-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts/{rolloutName}", "2019-11-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts/{rolloutName}", "2019-11-01-preview"), - Children: []swagger.ResourceType{}, - }}, - }, - { - Display: "serviceTopologies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies", "2019-11-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{serviceTopologyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}", "2019-11-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}", "2019-11-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}", "2019-11-01-preview"), - Children: []swagger.ResourceType{ - { - Display: "services", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services", "2019-11-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{serviceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}", "2019-11-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}", "2019-11-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}", "2019-11-01-preview"), - Children: []swagger.ResourceType{ - { - Display: "serviceUnits", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}/serviceUnits", "2019-11-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{serviceUnitName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}/serviceUnits/{serviceUnitName}", "2019-11-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}/serviceUnits/{serviceUnitName}", "2019-11-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}/serviceUnits/{serviceUnitName}", "2019-11-01-preview"), - }}, - }}, - }}, - }}, - }}, - }, - { - Display: "steps", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/steps", "2019-11-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{stepName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/steps/{stepName}", "2019-11-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/steps/{stepName}", "2019-11-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/steps/{stepName}", "2019-11-01-preview"), - }}, + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DesktopVirtualization/operations", "2024-04-03"), }, { - Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DesktopVirtualization/operations", "2023-09-05"), + Display: "appAttachPackages", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/appAttachPackages", "2024-04-03"), }, { Display: "applicationGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups", "2024-04-03"), }, { Display: "hostPools", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools", "2024-04-03"), }, { Display: "scalingPlans", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/scalingPlans", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/scalingPlans", "2024-04-03"), }, { Display: "workspaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces", "2024-04-03"), + }, + { + Display: "appAttachPackages", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages", "2024-04-03"), + SubResources: []swagger.ResourceType{ + { + Display: "{appAttachPackageName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}", "2024-04-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}", "2024-04-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}", "2024-04-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}", "2024-04-03"), + }}, }, { Display: "applicationGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups", "2024-04-03"), SubResources: []swagger.ResourceType{ { Display: "{applicationGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}", "2023-09-05"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}", "2023-09-05"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}", "2023-09-05"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}", "2024-04-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}", "2024-04-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}", "2024-04-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}", "2024-04-03"), Children: []swagger.ResourceType{ { Display: "applications", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications", "2024-04-03"), SubResources: []swagger.ResourceType{ { Display: "{applicationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}", "2023-09-05"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}", "2023-09-05"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}", "2023-09-05"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}", "2024-04-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}", "2024-04-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}", "2024-04-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}", "2024-04-03"), }}, }, { Display: "desktops", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops", "2024-04-03"), SubResources: []swagger.ResourceType{ { Display: "{desktopName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}", "2023-09-05"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}", "2024-04-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}", "2024-04-03"), }}, }, { Display: "startMenuItems", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems", "2024-04-03"), }}, }}, }, { Display: "hostPools", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools", "2024-04-03"), SubResources: []swagger.ResourceType{ { Display: "{hostPoolName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}", "2023-09-05"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}", "2023-09-05"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}", "2023-09-05"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}", "2024-04-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}", "2024-04-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}", "2024-04-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}", "2024-04-03"), Children: []swagger.ResourceType{ { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections", "2024-04-03"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-09-05"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-09-05"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-04-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-04-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-04-03"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateLinkResources", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateLinkResources", "2024-04-03"), }, { Display: "scalingPlans", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/scalingPlans", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/scalingPlans", "2024-04-03"), }, { Display: "sessionHosts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts", "2024-04-03"), SubResources: []swagger.ResourceType{ { Display: "{sessionHostName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}", "2023-09-05"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}", "2023-09-05"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}", "2024-04-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}", "2024-04-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}", "2024-04-03"), Children: []swagger.ResourceType{ { Display: "userSessions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions", "2024-04-03"), SubResources: []swagger.ResourceType{ { Display: "{userSessionId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}", "2023-09-05"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}", "2024-04-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}", "2024-04-03"), Children: []swagger.ResourceType{}, }}, }}, @@ -6681,85 +6790,85 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "userSessions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions", "2024-04-03"), }}, }}, }, { Display: "scalingPlans", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans", "2024-04-03"), SubResources: []swagger.ResourceType{ { Display: "{scalingPlanName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}", "2023-09-05"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}", "2023-09-05"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}", "2023-09-05"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}", "2024-04-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}", "2024-04-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}", "2024-04-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}", "2024-04-03"), Children: []swagger.ResourceType{ { Display: "personalSchedules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules", "2024-04-03"), SubResources: []swagger.ResourceType{ { Display: "{scalingPlanScheduleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}", "2023-09-05"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}", "2023-09-05"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}", "2023-09-05"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}", "2024-04-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}", "2024-04-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}", "2024-04-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}", "2024-04-03"), }}, }, { Display: "pooledSchedules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules", "2024-04-03"), SubResources: []swagger.ResourceType{ { Display: "{scalingPlanScheduleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}", "2023-09-05"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}", "2023-09-05"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}", "2023-09-05"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}", "2024-04-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}", "2024-04-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}", "2024-04-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}", "2024-04-03"), }}, }}, }}, }, { Display: "workspaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces", "2024-04-03"), SubResources: []swagger.ResourceType{ { Display: "{workspaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}", "2023-09-05"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}", "2023-09-05"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}", "2023-09-05"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}", "2024-04-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}", "2024-04-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}", "2024-04-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}", "2024-04-03"), Children: []swagger.ResourceType{ { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections", "2024-04-03"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-09-05"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-09-05"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-04-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-04-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-04-03"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateLinkResources", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateLinkResources", "2024-04-03"), }}, }}, }, { Display: "msixPackages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages", "2024-04-03"), SubResources: []swagger.ResourceType{ { Display: "{msixPackageFullName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}", "2023-09-05"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}", "2023-09-05"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}", "2023-09-05"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}", "2023-09-05"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}", "2024-04-03"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}", "2024-04-03"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}", "2024-04-03"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}", "2024-04-03"), }}, }, { @@ -7403,52 +7512,52 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EdgeOrder/operations", "2022-05-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EdgeOrder/operations", "2024-02-01"), }, { Display: "addresses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/addresses", "2022-05-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/addresses", "2024-02-01"), }, { Display: "orderItems", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orderItems", "2022-05-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orderItems", "2024-02-01"), }, { Display: "orders", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orders", "2022-05-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orders", "2024-02-01"), }, { Display: "addresses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses", "2022-05-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{addressName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}", "2022-05-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}", "2022-05-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}", "2022-05-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}", "2022-05-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/addresses/{addressName}", "2024-02-01"), }}, }, { Display: "{orderName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/locations/{location}/orders/{orderName}", "2022-05-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/locations/{location}/orders/{orderName}", "2024-02-01"), }, { Display: "orderItems", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems", "2022-05-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{orderItemName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}", "2022-05-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}", "2022-05-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}", "2022-05-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}", "2022-05-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}", "2024-02-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "orders", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orders", "2022-05-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orders", "2024-02-01"), }, { Display: "operations", @@ -7519,75 +7628,75 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ElasticSan/operations", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ElasticSan/operations", "2024-05-01"), }, { Display: "elasticSans", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ElasticSan/elasticSans", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ElasticSan/elasticSans", "2024-05-01"), }, { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ElasticSan/skus", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ElasticSan/skus", "2024-05-01"), }, { Display: "elasticSans", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans", "2024-05-01"), SubResources: []swagger.ResourceType{ { Display: "{elasticSanName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", "2024-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", "2024-05-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", "2024-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", "2024-05-01"), Children: []swagger.ResourceType{ { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections", "2024-05-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-05-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateLinkResources", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateLinkResources", "2024-05-01"), }, { Display: "volumeGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumeGroups", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumeGroups", "2024-05-01"), }}, SubResources: []swagger.ResourceType{ { Display: "{volumeGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", "2024-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", "2024-05-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", "2024-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", "2024-05-01"), Children: []swagger.ResourceType{ { Display: "snapshots", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots", "2024-05-01"), SubResources: []swagger.ResourceType{ { Display: "{snapshotName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", "2024-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", "2024-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}", "2024-05-01"), }}, }, { Display: "volumes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes", "2024-05-01"), SubResources: []swagger.ResourceType{ { Display: "{volumeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", "2024-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", "2024-05-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", "2024-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", "2024-05-01"), }}, }}, }}, @@ -7631,236 +7740,236 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventGrid/operations", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventGrid/operations", "2024-06-01-preview"), }, { Display: "topicTypes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventGrid/topicTypes", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventGrid/topicTypes", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{topicTypeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}", "2024-06-01-preview"), Children: []swagger.ResourceType{ { Display: "eventTypes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventTypes", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventTypes", "2024-06-01-preview"), }}, }}, }, { Display: "verifiedPartners", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventGrid/verifiedPartners", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventGrid/verifiedPartners", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{verifiedPartnerName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventGrid/verifiedPartners/{verifiedPartnerName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventGrid/verifiedPartners/{verifiedPartnerName}", "2024-06-01-preview"), }}, }, { Display: "domains", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/domains", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/domains", "2024-06-01-preview"), }, { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/eventSubscriptions", "2024-06-01-preview"), }, { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions", "2024-06-01-preview"), }, { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions", "2024-06-01-preview"), }, { Display: "namespaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/namespaces", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/namespaces", "2024-06-01-preview"), }, { Display: "partnerConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerConfigurations", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerConfigurations", "2024-06-01-preview"), }, { Display: "partnerDestinations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerDestinations", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerDestinations", "2024-06-01-preview"), }, { Display: "partnerNamespaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerNamespaces", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerNamespaces", "2024-06-01-preview"), }, { Display: "partnerRegistrations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerRegistrations", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerRegistrations", "2024-06-01-preview"), }, { Display: "partnerTopics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerTopics", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerTopics", "2024-06-01-preview"), }, { Display: "systemTopics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/systemTopics", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/systemTopics", "2024-06-01-preview"), }, { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions", "2024-06-01-preview"), }, { Display: "topics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics", "2024-06-01-preview"), }, { Display: "domains", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{domainName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}", "2024-06-01-preview"), Children: []swagger.ResourceType{ { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{eventSubscriptionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), Children: []swagger.ResourceType{}, }}, }, { Display: "topics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{domainTopicName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}", "2024-06-01-preview"), }, { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{eventSubscriptionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), Children: []swagger.ResourceType{}, }}, }, { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/providers/Microsoft.EventGrid/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/providers/Microsoft.EventGrid/eventSubscriptions", "2024-06-01-preview"), }}, }}, }}, }, { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/eventSubscriptions", "2024-06-01-preview"), }, { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions", "2024-06-01-preview"), }, { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions", "2024-06-01-preview"), }, { Display: "namespaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{namespaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}", "2024-06-01-preview"), Children: []swagger.ResourceType{ { Display: "caCertificates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{caCertificateName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates/{caCertificateName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates/{caCertificateName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates/{caCertificateName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates/{caCertificateName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates/{caCertificateName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates/{caCertificateName}", "2024-06-01-preview"), }}, }, { Display: "clientGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{clientGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups/{clientGroupName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups/{clientGroupName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups/{clientGroupName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups/{clientGroupName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups/{clientGroupName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups/{clientGroupName}", "2024-06-01-preview"), }}, }, { Display: "clients", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{clientName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients/{clientName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients/{clientName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients/{clientName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients/{clientName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients/{clientName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients/{clientName}", "2024-06-01-preview"), }}, }, { Display: "permissionBindings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/permissionBindings", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/permissionBindings", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{permissionBindingName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/permissionBindings/{permissionBindingName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/permissionBindings/{permissionBindingName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/permissionBindings/{permissionBindingName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/permissionBindings/{permissionBindingName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/permissionBindings/{permissionBindingName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/permissionBindings/{permissionBindingName}", "2024-06-01-preview"), }}, }, { Display: "topicSpaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topicSpaces", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topicSpaces", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{topicSpaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topicSpaces/{topicSpaceName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topicSpaces/{topicSpaceName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topicSpaces/{topicSpaceName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topicSpaces/{topicSpaceName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topicSpaces/{topicSpaceName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topicSpaces/{topicSpaceName}", "2024-06-01-preview"), }}, }, { Display: "topics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{topicName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}", "2024-06-01-preview"), Children: []swagger.ResourceType{ { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{eventSubscriptionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), Children: []swagger.ResourceType{}, }}, }}, @@ -7870,51 +7979,51 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "partnerConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations", "2024-06-01-preview"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerConfigurations/default", "2024-06-01-preview"), Children: []swagger.ResourceType{}, }}, }, { Display: "partnerDestinations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{partnerDestinationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName}", "2024-06-01-preview"), Children: []swagger.ResourceType{}, }}, }, { Display: "partnerNamespaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{partnerNamespaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}", "2024-06-01-preview"), Children: []swagger.ResourceType{ { Display: "channels", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{channelName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels/{channelName}", "2024-06-01-preview"), Children: []swagger.ResourceType{}, }}, }}, @@ -7922,37 +8031,37 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "partnerRegistrations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{partnerRegistrationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}", "2024-06-01-preview"), }}, }, { Display: "partnerTopics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{partnerTopicName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}", "2024-06-01-preview"), Children: []swagger.ResourceType{ { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{eventSubscriptionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), Children: []swagger.ResourceType{}, }}, }}, @@ -7960,25 +8069,25 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "systemTopics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{systemTopicName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}", "2024-06-01-preview"), Children: []swagger.ResourceType{ { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{eventSubscriptionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), Children: []swagger.ResourceType{}, }}, }}, @@ -7986,29 +8095,29 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions", "2024-06-01-preview"), }, { Display: "topics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{topicName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}", "2024-06-01-preview"), Children: []swagger.ResourceType{ { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{eventSubscriptionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), Children: []swagger.ResourceType{}, }}, }}, @@ -8016,144 +8125,107 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-06-01-preview"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{privateLinkResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources/{privateLinkResourceName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources/{privateLinkResourceName}", "2024-06-01-preview"), }}, }, { Display: "networkSecurityPerimeterConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{resourceType}/{resourceName}/networkSecurityPerimeterConfigurations", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{resourceType}/{resourceName}/networkSecurityPerimeterConfigurations", "2024-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{perimeterGuid}.{associationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{resourceType}/{resourceName}/networkSecurityPerimeterConfigurations/{perimeterGuid}.{associationName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{resourceType}/{resourceName}/networkSecurityPerimeterConfigurations/{perimeterGuid}.{associationName}", "2024-06-01-preview"), Children: []swagger.ResourceType{}, }}, }, { Display: "eventSubscriptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventSubscriptions", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventSubscriptions", "2024-06-01-preview"), }, { Display: "eventTypes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventTypes", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventTypes", "2024-06-01-preview"), }, { Display: "{eventSubscriptionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}", "2024-06-01-preview"), Children: []swagger.ResourceType{}, }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.EventGrid/extensionTopics/default", "2023-12-15-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.EventGrid/extensionTopics/default", "2024-06-01-preview"), }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventHub/operations", "2024-01-01"), - }, - { - Display: "availableClusterRegions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/availableClusterRegions", "2024-01-01"), - }, - { - Display: "clusters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/clusters", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.EventHub/operations", "2017-04-01"), }, { Display: "namespaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/namespaces", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/namespaces", "2017-04-01"), }, { - Display: "clusters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters", "2024-01-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{clusterName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}", "2024-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}", "2024-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}", "2024-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}", "2024-01-01"), - Children: []swagger.ResourceType{ - { - Display: "namespaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/namespaces", "2024-01-01"), - }, - { - Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default", "2024-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default", "2024-01-01"), - }}, - }}, + Display: "regions", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/sku/{sku}/regions", "2017-04-01"), }, { Display: "namespaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces", "2017-04-01"), SubResources: []swagger.ResourceType{ { Display: "{namespaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}", "2024-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}", "2024-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}", "2024-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}", "2017-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}", "2017-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}", "2017-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}", "2017-04-01"), Children: []swagger.ResourceType{ - { - Display: "applicationGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups", "2024-01-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{applicationGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups/{applicationGroupName}", "2024-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups/{applicationGroupName}", "2024-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups/{applicationGroupName}", "2024-01-01"), - }}, - }, { Display: "authorizationRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules", "2017-04-01"), SubResources: []swagger.ResourceType{ { Display: "{authorizationRuleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}", "2024-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}", "2024-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}", "2017-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}", "2017-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}", "2017-04-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "disasterRecoveryConfigs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs", "2017-04-01"), Children: []swagger.ResourceType{}, SubResources: []swagger.ResourceType{ { Display: "{alias}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}", "2024-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}", "2024-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}", "2017-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}", "2017-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}", "2017-04-01"), Children: []swagger.ResourceType{ { Display: "authorizationRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules", "2017-04-01"), SubResources: []swagger.ResourceType{ { Display: "{authorizationRuleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}", "2017-04-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -8161,78 +8233,51 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "eventhubs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs", "2017-04-01"), SubResources: []swagger.ResourceType{ { Display: "{eventHubName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}", "2024-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}", "2024-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}", "2017-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}", "2017-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}", "2017-04-01"), Children: []swagger.ResourceType{ { Display: "authorizationRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules", "2017-04-01"), SubResources: []swagger.ResourceType{ { Display: "{authorizationRuleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}", "2024-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}", "2024-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}", "2017-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}", "2017-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}", "2017-04-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "consumergroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups", "2017-04-01"), SubResources: []swagger.ResourceType{ { Display: "{consumerGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}", "2024-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}", "2024-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}", "2017-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}", "2017-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}", "2017-04-01"), }}, }}, }}, }, + { + Display: "messagingplan", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/messagingplan", "2017-04-01"), + }, { Display: "networkRuleSets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets", "2017-04-01"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets/default", "2024-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets/default", "2024-01-01"), - }}, - }, - { - Display: "networkSecurityPerimeterConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkSecurityPerimeterConfigurations", "2024-01-01"), - SubResources: []swagger.ResourceType{}, - }, - { - Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections", "2024-01-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-01-01"), - }}, - }, - { - Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateLinkResources", "2024-01-01"), - }, - { - Display: "schemagroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups", "2024-01-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{schemaGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups/{schemaGroupName}", "2024-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups/{schemaGroupName}", "2024-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups/{schemaGroupName}", "2024-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets/default", "2017-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets/default", "2017-04-01"), }}, }}, }}, @@ -8264,7 +8309,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "FrontDoorWebApplicationFirewallManagedRuleSets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets", "2022-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets", "2024-02-01"), }, { Display: "NetworkExperimentProfiles", @@ -8272,7 +8317,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "frontDoorWebApplicationFirewallPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies", "2022-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies", "2024-02-01"), }, { Display: "frontDoors", @@ -8280,10 +8325,10 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "{policyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}", "2022-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}", "2022-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}", "2022-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}", "2022-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}", "2024-02-01"), }, { Display: "NetworkExperimentProfiles", @@ -8325,7 +8370,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "frontDoorWebApplicationFirewallPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies", "2022-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies", "2024-02-01"), }, { Display: "frontDoors", @@ -8457,157 +8502,167 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.HealthcareApis/operations", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.HealthcareApis/operations", "2024-03-31"), }, { Display: "{operationResultId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/{locationName}/operationresults/{operationResultId}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/{locationName}/operationresults/{operationResultId}", "2024-03-31"), }, { Display: "services", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/services", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/services", "2024-03-31"), }, { Display: "workspaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/workspaces", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/workspaces", "2024-03-31"), }, { Display: "services", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services", "2024-03-31"), SubResources: []swagger.ResourceType{ { Display: "{resourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}", "2023-11-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}", "2024-03-31"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}", "2024-03-31"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}", "2024-03-31"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}", "2024-03-31"), Children: []swagger.ResourceType{ { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections", "2024-03-31"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-31"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-31"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-31"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources", "2024-03-31"), SubResources: []swagger.ResourceType{ { Display: "{groupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources/{groupName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources/{groupName}", "2024-03-31"), }}, }}, }}, }, { Display: "workspaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces", "2024-03-31"), SubResources: []swagger.ResourceType{ { Display: "{workspaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}", "2023-11-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}", "2024-03-31"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}", "2024-03-31"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}", "2024-03-31"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}", "2024-03-31"), Children: []swagger.ResourceType{ { Display: "dicomservices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices", "2024-03-31"), SubResources: []swagger.ResourceType{ { Display: "{dicomServiceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}", "2023-11-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}", "2024-03-31"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}", "2024-03-31"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}", "2024-03-31"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}", "2024-03-31"), }}, }, { Display: "fhirservices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices", "2024-03-31"), SubResources: []swagger.ResourceType{ { Display: "{fhirServiceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}", "2023-11-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}", "2024-03-31"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}", "2024-03-31"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}", "2024-03-31"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}", "2024-03-31"), }}, }, { Display: "iotconnectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors", "2024-03-31"), SubResources: []swagger.ResourceType{ { Display: "{iotConnectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}", "2023-11-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}", "2024-03-31"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}", "2024-03-31"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}", "2024-03-31"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}", "2024-03-31"), Children: []swagger.ResourceType{ { Display: "fhirdestinations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations", "2024-03-31"), SubResources: []swagger.ResourceType{ { Display: "{fhirDestinationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations/{fhirDestinationName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations/{fhirDestinationName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations/{fhirDestinationName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations/{fhirDestinationName}", "2024-03-31"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations/{fhirDestinationName}", "2024-03-31"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations/{fhirDestinationName}", "2024-03-31"), }}, }}, }}, }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections", "2024-03-31"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-31"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-31"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-31"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateLinkResources", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateLinkResources", "2024-03-31"), SubResources: []swagger.ResourceType{ { Display: "{groupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateLinkResources/{groupName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateLinkResources/{groupName}", "2024-03-31"), }}, }}, }}, }, + { + Display: "discoverySolutions", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Help/discoverySolutions", "2024-03-01-preview"), + }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Help/operations", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Help/operations", "2024-03-01-preview"), + }, + { + Display: "{solutionId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Help/selfHelp/{solutionId}", "2024-03-01-preview"), }, { Display: "{diagnosticsResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}", "2023-09-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}", "2024-03-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}", "2024-03-01-preview"), }, { - Display: "discoverySolutions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/discoverySolutions", "2023-09-01-preview"), + Display: "{simplifiedSolutionsResourceName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/simplifiedSolutions/{simplifiedSolutionsResourceName}", "2024-03-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/simplifiedSolutions/{simplifiedSolutionsResourceName}", "2024-03-01-preview"), }, { Display: "{solutionResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}", "2023-09-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}", "2023-09-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}", "2024-03-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}", "2024-03-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}", "2024-03-01-preview"), + Children: []swagger.ResourceType{}, }, { Display: "{troubleshooterName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}", "2023-09-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}", "2024-03-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}", "2024-03-01-preview"), Children: []swagger.ResourceType{}, }, { @@ -8834,41 +8889,41 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.VirtualMachineImages/operations", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.VirtualMachineImages/operations", "2024-02-01"), }, { Display: "imageTemplates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.VirtualMachineImages/imageTemplates", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.VirtualMachineImages/imageTemplates", "2024-02-01"), }, { Display: "imageTemplates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{imageTemplateName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}", "2023-07-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}", "2024-02-01"), Children: []swagger.ResourceType{ { Display: "runOutputs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{runOutputName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs/{runOutputName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs/{runOutputName}", "2024-02-01"), }}, }, { Display: "triggers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{triggerName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers/{triggerName}", "2023-07-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers/{triggerName}", "2023-07-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers/{triggerName}", "2023-07-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers/{triggerName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers/{triggerName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/triggers/{triggerName}", "2024-02-01"), }}, }}, }}, @@ -9874,172 +9929,105 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.MachineLearningCompute/operations", "2017-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.MachineLearningServices/operations", "2024-04-01"), }, { - Display: "operationalizationClusters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningCompute/operationalizationClusters", "2017-08-01-preview"), + Display: "quotas", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/quotas", "2024-04-01"), }, { - Display: "operationalizationClusters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningCompute/operationalizationClusters", "2017-08-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{clusterName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningCompute/operationalizationClusters/{clusterName}", "2017-08-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningCompute/operationalizationClusters/{clusterName}", "2017-08-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningCompute/operationalizationClusters/{clusterName}", "2017-08-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningCompute/operationalizationClusters/{clusterName}", "2017-08-01-preview"), - Children: []swagger.ResourceType{}, - }}, + Display: "usages", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages", "2024-04-01"), }, { - Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.MachineLearningExperimentation/operations", "2017-05-01-preview"), + Display: "vmSizes", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes", "2024-04-01"), }, { - Display: "accounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningExperimentation/accounts", "2017-05-01-preview"), + Display: "registries", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/registries", "2024-04-01"), }, { - Display: "accounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts", "2017-05-01-preview"), + Display: "workspaces", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces", "2024-04-01"), + }, + { + Display: "registries", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries", "2024-04-01"), SubResources: []swagger.ResourceType{ { - Display: "{accountName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}", "2017-05-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}", "2017-05-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}", "2017-05-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}", "2017-05-01-preview"), + Display: "{registryName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}", "2024-04-01"), Children: []swagger.ResourceType{ { - Display: "workspaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces", "2017-05-01-preview"), + Display: "codes", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes", "2024-04-01"), SubResources: []swagger.ResourceType{ { - Display: "{workspaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}", "2017-05-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}", "2017-05-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}", "2017-05-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}", "2017-05-01-preview"), + Display: "{codeName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}", "2024-04-01"), Children: []swagger.ResourceType{ { - Display: "projects", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}/projects", "2017-05-01-preview"), + Display: "versions", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions", "2024-04-01"), SubResources: []swagger.ResourceType{ { - Display: "{projectName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}/projects/{projectName}", "2017-05-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}/projects/{projectName}", "2017-05-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}/projects/{projectName}", "2017-05-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}/projects/{projectName}", "2017-05-01-preview"), - }}, - }}, - }}, - }}, - }}, - }, - { - Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.MachineLearningServices/operations", "2023-10-01"), - }, - { - Display: "quotas", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/quotas", "2023-10-01"), - }, - { - Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages", "2023-10-01"), - }, - { - Display: "vmSizes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes", "2023-10-01"), - }, - { - Display: "registries", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/registries", "2023-10-01"), - }, - { - Display: "workspaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces", "2023-10-01"), - }, - { - Display: "registries", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries", "2023-10-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{registryName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}", "2023-10-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}", "2023-10-01"), - Children: []swagger.ResourceType{ - { - Display: "codes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes", "2023-10-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{codeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}", "2023-10-01"), - Children: []swagger.ResourceType{ - { - Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions", "2023-10-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}", "2023-10-01"), - Children: []swagger.ResourceType{}, + Display: "{version}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}", "2024-04-01"), + Children: []swagger.ResourceType{}, }}, }}, }}, }, { Display: "components", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{componentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions/{version}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions/{version}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions/{version}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions/{version}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions/{version}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions/{version}", "2024-04-01"), }}, }}, }}, }, { Display: "data", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}", "2024-04-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -10047,46 +10035,46 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "environments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{environmentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}", "2024-04-01"), }}, }}, }}, }, { Display: "models", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{modelName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}", "2024-04-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -10097,59 +10085,59 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "workspaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{workspaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}", "2023-10-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "batchEndpoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{endpointName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}", "2023-10-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "deployments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{deploymentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}", "2023-10-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}", "2024-04-01"), }}, }}, }}, }, { Display: "codes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}", "2024-04-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -10157,23 +10145,23 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "components", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}", "2024-04-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -10181,47 +10169,48 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "computes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{computeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}", "2023-10-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}", "2024-04-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "connections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{connectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}", "2024-04-01"), + Children: []swagger.ResourceType{}, }}, }, { Display: "data", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}", "2024-04-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -10229,35 +10218,35 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "datastores", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}", "2024-04-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "environments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}", "2024-04-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -10265,36 +10254,36 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "features", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/features", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/features", "2024-04-01"), }, { Display: "featuresets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "features", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{featureName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}", "2024-04-01"), }}, }, { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}", "2024-04-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -10302,58 +10291,69 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "featurestoreEntities", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}", "2024-04-01"), }}, }}, }}, }, { Display: "jobs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{id}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}", "2024-04-01"), Children: []swagger.ResourceType{}, }}, }, + { + Display: "marketplaceSubscriptions", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions", "2024-04-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{name}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions/{name}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions/{name}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions/{name}", "2024-04-01"), + }}, + }, { Display: "models", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}", "2024-04-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -10361,29 +10361,29 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "onlineEndpoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{endpointName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}", "2023-10-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "deployments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{deploymentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}", "2023-10-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/skus", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/skus", "2024-04-01"), }}, }}, }}, @@ -10391,43 +10391,56 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "outboundNetworkDependenciesEndpoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints", "2024-04-01"), }, { Display: "outboundRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{ruleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}", "2024-04-01"), }}, }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-04-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateLinkResources", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateLinkResources", "2024-04-01"), }, { Display: "schedules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}", "2023-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}", "2023-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}", "2023-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}", "2024-04-01"), + }}, + }, + { + Display: "serverlessEndpoints", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints", "2024-04-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{name}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}", "2024-04-01"), + Children: []swagger.ResourceType{}, }}, }}, }}, @@ -10436,10 +10449,6 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { Display: "operations", Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Maintenance/operations", "2023-04-01"), }, - { - Display: "applyUpdates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/applyUpdates", "2023-04-01"), - }, { Display: "configurationAssignments", Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/configurationAssignments", "2023-04-01"), @@ -10465,10 +10474,6 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/{resourceName}", "2023-04-01"), }}, }, - { - Display: "applyUpdates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maintenance/applyUpdates", "2023-04-01"), - }, { Display: "maintenanceConfigurations", Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maintenance/maintenanceConfigurations", "2023-04-01"), @@ -10667,33 +10672,101 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }}, }, { - Display: "tenantActionGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups", "2023-05-01-preview"), + Display: "networkManagerConnections", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { - Display: "{tenantActionGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName}", "2023-05-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName}", "2023-05-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName}", "2023-05-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName}", "2023-05-01-preview"), - Children: []swagger.ResourceType{}, + Display: "{networkManagerConnectionName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}", "2023-11-01"), + }}, + }, + { + Display: "groupQuotas", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas", "2023-06-01-preview"), + SubResources: []swagger.ResourceType{ + { + Display: "{groupQuotaName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}", "2023-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}", "2023-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}", "2023-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}", "2023-06-01-preview"), + Children: []swagger.ResourceType{ + { + Display: "subscriptionRequests", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptionRequests", "2023-06-01-preview"), + SubResources: []swagger.ResourceType{ + { + Display: "{requestId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptionRequests/{requestId}", "2023-06-01-preview"), + }}, + }, + { + Display: "subscriptions", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptions", "2023-06-01-preview"), + SubResources: []swagger.ResourceType{ + { + Display: "{subscriptionId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptions/{subscriptionId}", "2023-06-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptions/{subscriptionId}", "2023-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptions/{subscriptionId}", "2023-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptions/{subscriptionId}", "2023-06-01-preview"), + }}, + }}, SubResources: []swagger.ResourceType{ { - Display: "{notificationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName}/notificationStatus/{notificationId}", "2023-05-01-preview"), + Display: "{requestId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/groupQuotaRequests/{requestId}", "2023-06-01-preview"), + }, + { + Display: "groupQuotaLimits", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/groupQuotaLimits", "2023-06-01-preview"), + SubResources: []swagger.ResourceType{ + { + Display: "{resourceName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/groupQuotaLimits/{resourceName}", "2023-06-01-preview"), + }}, + }, + { + Display: "groupQuotaRequests", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/groupQuotaRequests", "2023-06-01-preview"), + SubResources: []swagger.ResourceType{}, + }, + { + Display: "locationSettings", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings", "2023-06-01-preview"), + SubResources: []swagger.ResourceType{ + { + Display: "{location}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}", "2023-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}", "2023-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}", "2023-06-01-preview"), + }}, + }, + { + Display: "{location}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationUsages/{location}", "2023-06-01-preview"), }}, }}, }, { - Display: "networkManagerConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections", "2023-06-01"), + Display: "{allocationId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/quotaAllocationRequests/{allocationId}", "2023-06-01-preview"), + }, + { + Display: "quotaAllocations", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/quotaAllocations", "2023-06-01-preview"), SubResources: []swagger.ResourceType{ { - Display: "{networkManagerConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}", "2023-06-01"), + Display: "{resourceName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/quotaAllocations/{resourceName}", "2023-06-01-preview"), }}, + }, + { + Display: "quotaAllocationRequests", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocationRequests", "2023-06-01-preview"), + SubResources: []swagger.ResourceType{}, }}, }, { @@ -10984,6 +11057,11 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { SubResources: []swagger.ResourceType{}, }}, }, + { + Display: "keys", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/keys", "2023-01-01-preview"), + SubResources: []swagger.ResourceType{}, + }, { Display: "products", Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/locations/{location}/edgeZones/{edgeZone}/products", "2022-07-31"), @@ -11260,256 +11338,503 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Migrate/operations", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.OffAzure/operations", "2023-06-06"), + }, + { + Display: "hypervSites", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/hypervSites", "2023-06-06"), + }, + { + Display: "importSites", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/importSites", "2023-06-06"), + }, + { + Display: "masterSites", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/masterSites", "2023-06-06"), }, { - Display: "assessmentProjects", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Migrate/assessmentProjects", "2023-03-15"), + Display: "serverSites", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/serverSites", "2023-06-06"), }, { - Display: "assessmentProjects", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects", "2023-03-15"), + Display: "vmwareSites", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/vmwareSites", "2023-06-06"), + }, + { + Display: "hypervSites", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{projectName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}", "2023-03-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}", "2023-03-15"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}", "2023-03-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}", "2023-03-15"), + Display: "{siteName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}", "2023-06-06"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}", "2023-06-06"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}", "2023-06-06"), Children: []swagger.ResourceType{ { - Display: "assessmentOptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions", "2023-03-15"), + Display: "clusters", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{assessmentOptionsName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions/{assessmentOptionsName}", "2023-03-15"), + Display: "{clusterName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters/{clusterName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters/{clusterName}", "2023-06-06"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters/{clusterName}", "2023-06-06"), }}, }, { - Display: "avsAssessmentOptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions", "2023-03-15"), + Display: "hosts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{avsAssessmentOptionsName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions/{avsAssessmentOptionsName}", "2023-03-15"), + Display: "{hostName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts/{hostName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts/{hostName}", "2023-06-06"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts/{hostName}", "2023-06-06"), }}, }, { - Display: "groups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups", "2023-03-15"), + Display: "jobs", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/jobs", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{jobName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/jobs/{jobName}", "2023-06-06"), + }}, + }, + { + Display: "machines", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{groupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}", "2023-03-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}", "2023-03-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}", "2023-03-15"), + Display: "{machineName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}", "2023-06-06"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}", "2023-06-06"), Children: []swagger.ResourceType{ { - Display: "assessments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments", "2023-03-15"), + Display: "softwareinventories", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}/softwareinventories", "2023-06-06"), + }}, + SubResources: []swagger.ResourceType{ + { + Display: "{default}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}/softwareInventories/{default}", "2023-06-06"), + }}, + }}, + }, + { + Display: "runAsAccounts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/runAsAccounts", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{accountName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/runAsAccounts/{accountName}", "2023-06-06"), + }}, + }}, + SubResources: []swagger.ResourceType{ + { + Display: "{operationStatusName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/operationsStatus/{operationStatusName}", "2023-06-06"), + }}, + }}, + }, + { + Display: "importSites", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{siteName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}", "2023-06-06"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}", "2023-06-06"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}", "2023-06-06"), + Children: []swagger.ResourceType{ + { + Display: "deleteJobs", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteJobs", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{jobName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteJobs/{jobName}", "2023-06-06"), + }}, + }, + { + Display: "exportJobs", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportJobs", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{jobName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportJobs/{jobName}", "2023-06-06"), + }}, + }, + { + Display: "importJobs", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importJobs", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{jobName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importJobs/{jobName}", "2023-06-06"), + }}, + }, + { + Display: "jobs", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/jobs", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{jobName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/jobs/{jobName}", "2023-06-06"), + }}, + }, + { + Display: "machines", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/machines", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{machineName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/machines/{machineName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/machines/{machineName}", "2023-06-06"), + }}, + }}, + }}, + }, + { + Display: "masterSites", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{siteName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}", "2023-06-06"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}", "2023-06-06"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}", "2023-06-06"), + Children: []swagger.ResourceType{ + { + Display: "privateEndpointConnections", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{peConnectionName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections/{peConnectionName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections/{peConnectionName}", "2023-06-06"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections/{peConnectionName}", "2023-06-06"), + }}, + }, + { + Display: "privateLinkResources", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateLinkResources", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{privateLinkResourceName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateLinkResources/{privateLinkResourceName}", "2023-06-06"), + }}, + }, + { + Display: "sqlSites", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{sqlSiteName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}", "2023-06-06"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}", "2023-06-06"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}", "2023-06-06"), + Children: []swagger.ResourceType{ + { + Display: "discoverySiteDataSources", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{assessmentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}", "2023-03-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}", "2023-03-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}", "2023-03-15"), - Children: []swagger.ResourceType{ - { - Display: "assessedMachines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines", "2023-03-15"), - SubResources: []swagger.ResourceType{ - { - Display: "{assessedMachineName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName}", "2023-03-15"), - }}, - }}, + Display: "{discoverySiteDataSourceName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}", "2023-06-06"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}", "2023-06-06"), }}, }, { - Display: "avsAssessments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments", "2023-03-15"), + Display: "jobs", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/jobs", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{assessmentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}", "2023-03-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}", "2023-03-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}", "2023-03-15"), - Children: []swagger.ResourceType{ - { - Display: "avsAssessedMachines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines", "2023-03-15"), - SubResources: []swagger.ResourceType{ - { - Display: "{avsAssessedMachineName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines/{avsAssessedMachineName}", "2023-03-15"), - }}, - }}, + Display: "{jobName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/jobs/{jobName}", "2023-06-06"), }}, }, { - Display: "sqlAssessments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments", "2023-03-15"), + Display: "runAsAccounts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/runAsAccounts", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{assessmentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}", "2023-03-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}", "2023-03-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}", "2023-03-15"), - Children: []swagger.ResourceType{ - { - Display: "assessedSqlDatabases", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases", "2023-03-15"), - SubResources: []swagger.ResourceType{ - { - Display: "{assessedSqlDatabaseName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases/{assessedSqlDatabaseName}", "2023-03-15"), - }}, - }, - { - Display: "assessedSqlInstances", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances", "2023-03-15"), - SubResources: []swagger.ResourceType{ - { - Display: "{assessedSqlInstanceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances/{assessedSqlInstanceName}", "2023-03-15"), - }}, - }, - { - Display: "assessedSqlMachines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines", "2023-03-15"), - SubResources: []swagger.ResourceType{ - { - Display: "{assessedSqlMachineName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines/{assessedSqlMachineName}", "2023-03-15"), - }}, - }, - { - Display: "recommendedAssessedEntities", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities", "2023-03-15"), - SubResources: []swagger.ResourceType{ - { - Display: "{recommendedAssessedEntityName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities/{recommendedAssessedEntityName}", "2023-03-15"), - }}, - }, - { - Display: "summaries", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries", "2023-03-15"), - SubResources: []swagger.ResourceType{ - { - Display: "{summaryName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries/{summaryName}", "2023-03-15"), - }}, - }}, + Display: "{accountName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/runAsAccounts/{accountName}", "2023-06-06"), + }}, + }, + { + Display: "sqlAvailabilityGroups", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlAvailabilityGroups", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{sqlAvailabilityGroupName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlAvailabilityGroups/{sqlAvailabilityGroupName}", "2023-06-06"), + }}, + }, + { + Display: "sqlDatabases", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlDatabases", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{sqlDatabaseName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlDatabases/{sqlDatabaseName}", "2023-06-06"), + }}, + }, + { + Display: "sqlServers", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{sqlServerName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers/{sqlServerName}", "2023-06-06"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers/{sqlServerName}", "2023-06-06"), }}, }}, + SubResources: []swagger.ResourceType{ + { + Display: "{operationStatusName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/operationsStatus/{operationStatusName}", "2023-06-06"), + }}, }}, }, { - Display: "hypervcollectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors", "2023-03-15"), + Display: "webAppSites", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{hypervCollectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors/{hypervCollectorName}", "2023-03-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors/{hypervCollectorName}", "2023-03-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors/{hypervCollectorName}", "2023-03-15"), + Display: "{webAppSiteName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}", "2023-06-06"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}", "2023-06-06"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}", "2023-06-06"), + Children: []swagger.ResourceType{ + { + Display: "discoverySiteDataSources", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{discoverySiteDataSourceName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}", "2023-06-06"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}", "2023-06-06"), + }}, + }, + { + Display: "extendedMachines", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/extendedMachines", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{extendedMachineName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/extendedMachines/{extendedMachineName}", "2023-06-06"), + }}, + }, + { + Display: "iisWebApplications", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebApplications", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{webApplicationName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebApplications/{webApplicationName}", "2023-06-06"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebApplications/{webApplicationName}", "2023-06-06"), + }}, + }, + { + Display: "iisWebServers", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebServers", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{webServerName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebServers/{webServerName}", "2023-06-06"), + }}, + }, + { + Display: "runasaccounts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/runasaccounts", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{accountName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/runasaccounts/{accountName}", "2023-06-06"), + }}, + }, + { + Display: "tomcatWebApplications", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebApplications", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{webApplicationName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebApplications/{webApplicationName}", "2023-06-06"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebApplications/{webApplicationName}", "2023-06-06"), + }}, + }, + { + Display: "tomcatWebServers", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebServers", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{webServerName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebServers/{webServerName}", "2023-06-06"), + }}, + }, + { + Display: "webApplications", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/webApplications", "2023-06-06"), + }, + { + Display: "webServers", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/webServers", "2023-06-06"), + }}, }}, - }, + }}, + SubResources: []swagger.ResourceType{ + { + Display: "{operationStatusName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/operationsStatus/{operationStatusName}", "2023-06-06"), + }}, + }}, + }, + { + Display: "serverSites", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{siteName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}", "2023-06-06"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}", "2023-06-06"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}", "2023-06-06"), + Children: []swagger.ResourceType{ { - Display: "importcollectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors", "2023-03-15"), + Display: "jobs", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/jobs", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{importCollectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors/{importCollectorName}", "2023-03-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors/{importCollectorName}", "2023-03-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors/{importCollectorName}", "2023-03-15"), + Display: "{jobName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/jobs/{jobName}", "2023-06-06"), }}, }, { Display: "machines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines", "2023-03-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{machineName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines/{machineName}", "2023-03-15"), + Display: "{machineName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}", "2023-06-06"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}", "2023-06-06"), + Children: []swagger.ResourceType{ + { + Display: "softwareinventories", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}/softwareinventories", "2023-06-06"), + }}, + SubResources: []swagger.ResourceType{ + { + Display: "{default}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}/softwareInventories/{default}", "2023-06-06"), + }}, }}, }, { - Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections", "2023-03-15"), + Display: "runAsAccounts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/runAsAccounts", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-03-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-03-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-03-15"), + Display: "{accountName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/runAsAccounts/{accountName}", "2023-06-06"), }}, - }, + }}, + SubResources: []swagger.ResourceType{ { - Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources", "2023-03-15"), - SubResources: []swagger.ResourceType{ - { - Display: "{privateLinkResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources/{privateLinkResourceName}", "2023-03-15"), - }}, - }, + Display: "{operationStatusName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/operationsStatus/{operationStatusName}", "2023-06-06"), + }}, + }}, + }, + { + Display: "vmwareSites", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites", "2023-06-06"), + SubResources: []swagger.ResourceType{ + { + Display: "{siteName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}", "2023-06-06"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}", "2023-06-06"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}", "2023-06-06"), + Children: []swagger.ResourceType{ { - Display: "projectSummary", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary", "2023-03-15"), + Display: "hosts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/hosts", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{projectSummaryName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary/{projectSummaryName}", "2023-03-15"), + Display: "{hostName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/hosts/{hostName}", "2023-06-06"), }}, }, { - Display: "servercollectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors", "2023-03-15"), + Display: "jobs", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/jobs", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{serverCollectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors/{serverCollectorName}", "2023-03-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors/{serverCollectorName}", "2023-03-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors/{serverCollectorName}", "2023-03-15"), + Display: "{jobName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/jobs/{jobName}", "2023-06-06"), }}, }, { - Display: "sqlAssessmentOptions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions", "2023-03-15"), + Display: "machines", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{assessmentOptionsName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions/{assessmentOptionsName}", "2023-03-15"), + Display: "{machineName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}", "2023-06-06"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}", "2023-06-06"), + Children: []swagger.ResourceType{ + { + Display: "softwareinventories", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/softwareinventories", "2023-06-06"), + }}, + SubResources: []swagger.ResourceType{ + { + Display: "{default}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/softwareInventories/{default}", "2023-06-06"), + }}, }}, }, { - Display: "sqlcollectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors", "2023-03-15"), + Display: "runAsAccounts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/runAsAccounts", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{collectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}", "2023-03-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}", "2023-03-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}", "2023-03-15"), + Display: "{accountName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/runAsAccounts/{accountName}", "2023-06-06"), }}, }, { - Display: "vmwarecollectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors", "2023-03-15"), + Display: "vcenters", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters", "2023-06-06"), SubResources: []swagger.ResourceType{ { - Display: "{vmWareCollectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors/{vmWareCollectorName}", "2023-03-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors/{vmWareCollectorName}", "2023-03-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors/{vmWareCollectorName}", "2023-03-15"), + Display: "{vcenterName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters/{vcenterName}", "2023-06-06"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters/{vcenterName}", "2023-06-06"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters/{vcenterName}", "2023-06-06"), }}, }}, + SubResources: []swagger.ResourceType{ + { + Display: "{operationStatusName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/operationsStatus/{operationStatusName}", "2023-06-06"), + }}, }}, }, + { + Display: "operations", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Migrate/operations", "2023-08-01"), + }, { Display: "{migrateProjectName}", Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}", "2018-09-01-preview"), @@ -11552,403 +11877,120 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { Display: "{eventName}", Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/migrateEvents/{eventName}", "2018-09-01-preview"), DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/migrateEvents/{eventName}", "2018-09-01-preview"), - }}, - }, - { - Display: "solutions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions", "2018-09-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{solutionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}", "2018-09-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}", "2018-09-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}", "2018-09-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}", "2018-09-01-preview"), - Children: []swagger.ResourceType{}, - }}, - }}, - }, - { - Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.MixedReality/operations", "2021-03-01-preview"), - }, - { - Display: "objectAnchorsAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MixedReality/objectAnchorsAccounts", "2021-03-01-preview"), - }, - { - Display: "remoteRenderingAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MixedReality/remoteRenderingAccounts", "2021-03-01-preview"), - }, - { - Display: "spatialAnchorsAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MixedReality/spatialAnchorsAccounts", "2021-03-01-preview"), - }, - { - Display: "objectAnchorsAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/objectAnchorsAccounts", "2021-03-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{accountName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/objectAnchorsAccounts/{accountName}", "2021-03-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/objectAnchorsAccounts/{accountName}", "2021-03-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/objectAnchorsAccounts/{accountName}", "2021-03-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/objectAnchorsAccounts/{accountName}", "2021-03-01-preview"), - Children: []swagger.ResourceType{}, - }}, - }, - { - Display: "remoteRenderingAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts", "2021-03-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{accountName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}", "2021-03-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}", "2021-03-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}", "2021-03-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}", "2021-03-01-preview"), - Children: []swagger.ResourceType{}, - }}, - }, - { - Display: "spatialAnchorsAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts", "2021-03-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{accountName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}", "2021-03-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}", "2021-03-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}", "2021-03-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}", "2021-03-01-preview"), - Children: []swagger.ResourceType{}, - }}, - }, - { - Display: "eventcategories", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Insights/eventcategories", "2015-04-01"), - }, - { - Display: "values", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Insights/eventtypes/management/values", "2015-04-01"), - }, - { - Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Insights/operations", "2015-04-01"), - }, - { - Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Monitor/operations", "2023-04-03"), - }, - { - Display: "actionGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/actionGroups", "2023-01-01"), - }, - { - Display: "activityLogAlerts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/activityLogAlerts", "2020-10-01"), - }, - { - Display: "alertrules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/alertrules", "2016-03-01"), - }, - { - Display: "autoscalesettings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/autoscalesettings", "2022-10-01"), - }, - { - Display: "dataCollectionEndpoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/dataCollectionEndpoints", "2022-06-01"), - }, - { - Display: "dataCollectionRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/dataCollectionRules", "2022-06-01"), - }, - { - Display: "values", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/eventtypes/management/values", "2015-04-01"), - }, - { - Display: "logprofiles", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/logprofiles", "2016-03-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{logProfileName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/logprofiles/{logProfileName}", "2016-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/logprofiles/{logProfileName}", "2016-03-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/logprofiles/{logProfileName}", "2016-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/logprofiles/{logProfileName}", "2016-03-01"), - }}, - }, - { - Display: "metricAlerts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metricAlerts", "2018-03-01"), - }, - { - Display: "metricDefinitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metricDefinitions", "2021-05-01"), - }, - { - Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metrics", "2021-05-01"), - }, - { - Display: "scheduledQueryRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Insights/scheduledQueryRules", "2022-08-01-preview"), - }, - { - Display: "accounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Monitor/accounts", "2023-04-03"), - }, - { - Display: "privateLinkScopes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/microsoft.insights/privateLinkScopes", "2021-07-01-preview"), - }, - { - Display: "actionGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups", "2023-01-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{actionGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}", "2023-01-01"), - Children: []swagger.ResourceType{}, - SubResources: []swagger.ResourceType{ - { - Display: "{notificationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/notificationStatus/{notificationId}", "2023-01-01"), - }}, - }}, - }, - { - Display: "activityLogAlerts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts", "2020-10-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{activityLogAlertName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName}", "2020-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName}", "2020-10-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName}", "2020-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName}", "2020-10-01"), - }}, - }, - { - Display: "dataCollectionEndpoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints", "2022-06-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{dataCollectionEndpointName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}", "2022-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}", "2022-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}", "2022-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}", "2022-06-01"), - Children: []swagger.ResourceType{ - { - Display: "associations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}/associations", "2022-06-01"), - }}, - }}, - }, - { - Display: "dataCollectionRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules", "2022-06-01"), - SubResources: []swagger.ResourceType{ + }}, + }, { - Display: "{dataCollectionRuleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dataCollectionRuleName}", "2022-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dataCollectionRuleName}", "2022-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dataCollectionRuleName}", "2022-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dataCollectionRuleName}", "2022-06-01"), - Children: []swagger.ResourceType{ + Display: "solutions", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions", "2018-09-01-preview"), + SubResources: []swagger.ResourceType{ { - Display: "associations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dataCollectionRuleName}/associations", "2022-06-01"), + Display: "{solutionName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}", "2018-09-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}", "2018-09-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}", "2018-09-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}", "2018-09-01-preview"), + Children: []swagger.ResourceType{}, }}, }}, }, { - Display: "metricAlerts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts", "2018-03-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{ruleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}", "2018-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}", "2018-03-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}", "2018-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}", "2018-03-01"), - Children: []swagger.ResourceType{ - { - Display: "status", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}/status", "2018-03-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{statusName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}/status/{statusName}", "2018-03-01"), - }}, - }}, - }}, + Display: "operations", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.MixedReality/operations", "2021-03-01-preview"), }, { - Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections", "2021-07-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}", "2021-07-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}", "2021-07-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}", "2021-07-01-preview"), - }}, + Display: "objectAnchorsAccounts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MixedReality/objectAnchorsAccounts", "2021-03-01-preview"), }, { - Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateLinkResources", "2021-07-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{groupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}", "2021-07-01-preview"), - }}, + Display: "remoteRenderingAccounts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MixedReality/remoteRenderingAccounts", "2021-03-01-preview"), }, { - Display: "scopedResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/scopedResources", "2021-07-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/scopedResources/{name}", "2021-07-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/scopedResources/{name}", "2021-07-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/scopedResources/{name}", "2021-07-01-preview"), - }}, + Display: "spatialAnchorsAccounts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.MixedReality/spatialAnchorsAccounts", "2021-03-01-preview"), }, { - Display: "scheduledQueryRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules", "2022-08-01-preview"), + Display: "objectAnchorsAccounts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/objectAnchorsAccounts", "2021-03-01-preview"), SubResources: []swagger.ResourceType{ { - Display: "{ruleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}", "2022-08-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}", "2022-08-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}", "2022-08-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}", "2022-08-01-preview"), + Display: "{accountName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/objectAnchorsAccounts/{accountName}", "2021-03-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/objectAnchorsAccounts/{accountName}", "2021-03-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/objectAnchorsAccounts/{accountName}", "2021-03-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/objectAnchorsAccounts/{accountName}", "2021-03-01-preview"), + Children: []swagger.ResourceType{}, }}, }, { - Display: "accounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts", "2023-04-03"), + Display: "remoteRenderingAccounts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts", "2021-03-01-preview"), SubResources: []swagger.ResourceType{ { - Display: "{azureMonitorWorkspaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}", "2023-04-03"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}", "2023-04-03"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}", "2023-04-03"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}", "2023-04-03"), + Display: "{accountName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}", "2021-03-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}", "2021-03-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}", "2021-03-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}", "2021-03-01-preview"), + Children: []swagger.ResourceType{}, }}, }, { - Display: "{asyncOperationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopeOperationStatuses/{asyncOperationId}", "2021-07-01-preview"), - }, - { - Display: "privateLinkScopes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopes", "2021-07-01-preview"), + Display: "spatialAnchorsAccounts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts", "2021-03-01-preview"), SubResources: []swagger.ResourceType{ { - Display: "{scopeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopes/{scopeName}", "2021-07-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopes/{scopeName}", "2021-07-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopes/{scopeName}", "2021-07-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopes/{scopeName}", "2021-07-01-preview"), + Display: "{accountName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}", "2021-03-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}", "2021-03-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}", "2021-03-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}", "2021-03-01-preview"), + Children: []swagger.ResourceType{}, }}, }, { - Display: "alertrules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules", "2016-03-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{ruleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}", "2016-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}", "2016-03-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}", "2016-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}", "2016-03-01"), - }}, + Display: "mongoClusters", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/mongoClusters", "2024-03-01-preview"), }, { - Display: "autoscalesettings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings", "2022-10-01"), + Display: "mongoClusters", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters", "2024-03-01-preview"), SubResources: []swagger.ResourceType{ { - Display: "{autoscaleSettingName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}", "2022-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}", "2022-10-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}", "2022-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}", "2022-10-01"), + Display: "{mongoClusterName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}", "2024-03-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}", "2024-03-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}", "2024-03-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}", "2024-03-01-preview"), Children: []swagger.ResourceType{ { - Display: "predictiveMetrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}/predictiveMetrics", "2022-10-01"), + Display: "firewallRules", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules", "2024-03-01-preview"), + SubResources: []swagger.ResourceType{ + { + Display: "{firewallRuleName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName}", "2024-03-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName}", "2024-03-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName}", "2024-03-01-preview"), + }}, + }, + { + Display: "privateEndpointConnections", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/privateEndpointConnections", "2024-03-01-preview"), + SubResources: []swagger.ResourceType{ + { + Display: "{privateEndpointConnectionName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-01-preview"), + }}, + }, + { + Display: "privateLinkResources", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/privateLinkResources", "2024-03-01-preview"), }}, }}, }, - { - Display: "incidents", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/alertrules/{ruleName}/incidents", "2016-03-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{incidentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/alertrules/{ruleName}/incidents/{incidentName}", "2016-03-01"), - }}, - }, - { - Display: "dataCollectionRuleAssociations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/dataCollectionRuleAssociations", "2022-06-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{associationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/dataCollectionRuleAssociations/{associationName}", "2022-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/dataCollectionRuleAssociations/{associationName}", "2022-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/dataCollectionRuleAssociations/{associationName}", "2022-06-01"), - }}, - }, - { - Display: "diagnosticSettings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings", "2021-05-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}", "2021-05-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}", "2021-05-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}", "2021-05-01-preview"), - }}, - }, - { - Display: "diagnosticSettingsCategories", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/diagnosticSettingsCategories", "2021-05-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/diagnosticSettingsCategories/{name}", "2021-05-01-preview"), - }}, - }, - { - Display: "metricBaselines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/metricBaselines", "2019-03-01"), - }, - { - Display: "metricDefinitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/metricDefinitions", "2021-05-01"), - }, - { - Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/metrics", "2021-05-01"), - }, - { - Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.Insights/vmInsightsOnboardingStatuses/default", "2018-11-27-preview"), - }, - { - Display: "metricNamespaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/microsoft.insights/metricNamespaces", "2017-12-01-preview"), - }, { Display: "operations", Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ManagedIdentity/operations", "2023-01-31"), @@ -12092,627 +12134,753 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.NetApp/operations", "2017-08-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.NetApp/operations", "2023-11-01"), + }, + { + Display: "quotaLimits", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits", "2023-11-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{quotaLimitName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits/{quotaLimitName}", "2023-11-01"), + }}, + }, + { + Display: "regionInfo", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfo", "2023-11-01"), + }, + { + Display: "regionInfos", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos", "2023-11-01"), + Children: []swagger.ResourceType{ + { + Display: "default", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos/default", "2023-11-01"), + }}, + }, + { + Display: "netAppAccounts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/netAppAccounts", "2023-11-01"), }, { Display: "netAppAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts", "2017-08-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{accountName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}", "2017-08-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}", "2017-08-15"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}", "2017-08-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}", "2017-08-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}", "2023-11-01"), Children: []swagger.ResourceType{ + { + Display: "backupPolicies", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies", "2023-11-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{backupPolicyName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}", "2023-11-01"), + }}, + }, + { + Display: "backupVaults", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults", "2023-11-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{backupVaultName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}", "2023-11-01"), + Children: []swagger.ResourceType{ + { + Display: "backups", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups", "2023-11-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{backupName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}", "2023-11-01"), + Children: []swagger.ResourceType{}, + }}, + }}, + }}, + }, { Display: "capacityPools", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools", "2017-08-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{poolName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}", "2017-08-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}", "2017-08-15"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}", "2017-08-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}", "2017-08-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "volumes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes", "2017-08-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{volumeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}", "2017-08-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}", "2017-08-15"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}", "2017-08-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}", "2017-08-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}", "2023-11-01"), Children: []swagger.ResourceType{ { - Display: "mountTargets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/mountTargets", "2017-08-15"), + Display: "current", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestBackupStatus/current", "2023-11-01"), + }, + { + Display: "current", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestRestoreStatus/current", "2023-11-01"), + }, + { + Display: "replicationStatus", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/replicationStatus", "2023-11-01"), }, { Display: "snapshots", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots", "2017-08-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{snapshotName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}", "2017-08-15"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}", "2017-08-15"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}", "2017-08-15"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}", "2017-08-15"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}", "2023-11-01"), + Children: []swagger.ResourceType{}, + }}, + }, + { + Display: "subvolumes", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes", "2023-11-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{subvolumeName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}", "2023-11-01"), + Children: []swagger.ResourceType{}, + }}, + }, + { + Display: "volumeQuotaRules", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules", "2023-11-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{volumeQuotaRuleName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}", "2023-11-01"), }}, }}, }}, }}, }}, + }, + { + Display: "snapshotPolicies", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies", "2023-11-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{snapshotPolicyName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}", "2023-11-01"), + Children: []swagger.ResourceType{ + { + Display: "volumes", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes", "2023-11-01"), + }}, + }}, + }, + { + Display: "volumeGroups", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups", "2023-11-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{volumeGroupName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}", "2023-11-01"), + }}, }}, }}, }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Network/operations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Network/operations", "2023-11-01"), }, { Display: "ApplicationGatewayWebApplicationFirewallPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies", "2023-11-01"), }, { Display: "ExpressRoutePorts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePorts", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePorts", "2023-11-01"), }, { Display: "ExpressRoutePortsLocations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{locationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations/{locationName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations/{locationName}", "2023-11-01"), }}, }, { Display: "IpAllocations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/IpAllocations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/IpAllocations", "2023-11-01"), }, { Display: "ServiceEndpointPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ServiceEndpointPolicies", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ServiceEndpointPolicies", "2023-11-01"), }, { Display: "applicationGatewayAvailableRequestHeaders", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableRequestHeaders", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableRequestHeaders", "2023-11-01"), }, { Display: "applicationGatewayAvailableResponseHeaders", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableResponseHeaders", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableResponseHeaders", "2023-11-01"), }, { Display: "applicationGatewayAvailableServerVariables", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableServerVariables", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableServerVariables", "2023-11-01"), }, { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "predefinedPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{predefinedPolicyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies/{predefinedPolicyName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies/{predefinedPolicyName}", "2023-11-01"), }}, }}, }, { Display: "applicationGatewayAvailableWafRuleSets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets", "2023-11-01"), }, { Display: "applicationGateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGateways", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGateways", "2023-11-01"), }, { Display: "applicationSecurityGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationSecurityGroups", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationSecurityGroups", "2023-11-01"), }, { Display: "azureFirewallFqdnTags", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewallFqdnTags", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewallFqdnTags", "2023-11-01"), }, { Display: "azureFirewalls", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls", "2023-11-01"), }, { Display: "azureWebCategories", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureWebCategories", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureWebCategories", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureWebCategories/{name}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureWebCategories/{name}", "2023-11-01"), }}, }, { Display: "bastionHosts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/bastionHosts", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/bastionHosts", "2023-11-01"), }, { Display: "bgpServiceCommunities", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/bgpServiceCommunities", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/bgpServiceCommunities", "2023-11-01"), }, { Display: "customIpPrefixes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/customIpPrefixes", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/customIpPrefixes", "2023-11-01"), }, { Display: "ddosProtectionPlans", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ddosProtectionPlans", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ddosProtectionPlans", "2023-11-01"), }, { Display: "dscpConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/dscpConfigurations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/dscpConfigurations", "2023-11-01"), }, { Display: "expressRouteCircuits", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCircuits", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCircuits", "2023-11-01"), }, { Display: "expressRouteCrossConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCrossConnections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCrossConnections", "2023-11-01"), }, { Display: "expressRouteGateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteGateways", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteGateways", "2023-11-01"), }, { Display: "expressRouteProviderPorts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{providerport}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts/{providerport}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts/{providerport}", "2023-11-01"), }}, }, { Display: "expressRouteServiceProviders", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteServiceProviders", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteServiceProviders", "2023-11-01"), }, { Display: "firewallPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/firewallPolicies", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/firewallPolicies", "2023-11-01"), }, { Display: "ipGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ipGroups", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/ipGroups", "2023-11-01"), }, { Display: "loadBalancers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/loadBalancers", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/loadBalancers", "2023-11-01"), }, { Display: "CheckDnsNameAvailability", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/CheckDnsNameAvailability", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/CheckDnsNameAvailability", "2023-11-01"), }, { Display: "applicationGatewayWafDynamicManifests", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/applicationGatewayWafDynamicManifests", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/applicationGatewayWafDynamicManifests", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "dafault", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/applicationGatewayWafDynamicManifests/dafault", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/applicationGatewayWafDynamicManifests/dafault", "2023-11-01"), }}, }, { Display: "autoApprovedPrivateLinkServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices", "2023-11-01"), }, { Display: "availableDelegations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availableDelegations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availableDelegations", "2023-11-01"), }, { Display: "availablePrivateEndpointTypes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes", "2023-11-01"), }, { Display: "availableServiceAliases", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availableServiceAliases", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availableServiceAliases", "2023-11-01"), }, { Display: "serviceTagDetails", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/serviceTagDetails", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/serviceTagDetails", "2023-11-01"), }, { Display: "serviceTags", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/serviceTags", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/serviceTags", "2023-11-01"), }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/usages", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/usages", "2023-11-01"), }, { Display: "virtualNetworkAvailableEndpointServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/virtualNetworkAvailableEndpointServices", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/virtualNetworkAvailableEndpointServices", "2023-11-01"), }, { Display: "natGateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/natGateways", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/natGateways", "2023-11-01"), }, { Display: "networkInterfaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkInterfaces", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkInterfaces", "2023-11-01"), }, { Display: "networkManagerConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagerConnections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagerConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{networkManagerConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}", "2023-11-01"), }}, }, { Display: "networkManagers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagers", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagers", "2023-11-01"), }, { Display: "networkProfiles", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkProfiles", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkProfiles", "2023-11-01"), }, { Display: "networkSecurityGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityGroups", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityGroups", "2023-11-01"), }, { Display: "networkVirtualApplianceSkus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualApplianceSkus", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualApplianceSkus", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{skuName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualApplianceSkus/{skuName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualApplianceSkus/{skuName}", "2023-11-01"), }}, }, { Display: "networkVirtualAppliances", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualAppliances", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualAppliances", "2023-11-01"), }, { Display: "networkWatchers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkWatchers", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkWatchers", "2023-11-01"), }, { Display: "p2svpnGateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/p2svpnGateways", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/p2svpnGateways", "2023-11-01"), }, { Display: "privateEndpoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateEndpoints", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateEndpoints", "2023-11-01"), }, { Display: "privateLinkServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateLinkServices", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateLinkServices", "2023-11-01"), }, { Display: "publicIPAddresses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPAddresses", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPAddresses", "2023-11-01"), }, { Display: "publicIPPrefixes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPPrefixes", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPPrefixes", "2023-11-01"), }, { Display: "routeFilters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeFilters", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeFilters", "2023-11-01"), }, { Display: "routeTables", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeTables", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeTables", "2023-11-01"), }, { Display: "securityPartnerProviders", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/securityPartnerProviders", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/securityPartnerProviders", "2023-11-01"), }, { Display: "virtualHubs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs", "2023-11-01"), }, { Display: "virtualNetworkTaps", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworkTaps", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworkTaps", "2023-11-01"), }, { Display: "virtualNetworks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworks", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworks", "2023-11-01"), }, { Display: "virtualRouters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualRouters", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualRouters", "2023-11-01"), }, { Display: "virtualWans", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans", "2023-11-01"), }, { Display: "vpnGateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways", "2023-11-01"), }, { Display: "vpnServerConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnServerConfigurations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnServerConfigurations", "2023-11-01"), }, { Display: "vpnSites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites", "2023-11-01"), }, { Display: "cloudServiceSlots", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{singletonResource}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots/{singletonResource}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots/{singletonResource}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots/{singletonResource}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots/{singletonResource}", "2023-11-01"), }}, }, { Display: "ApplicationGatewayWebApplicationFirewallPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{policyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}", "2023-11-01"), }}, }, { Display: "ExpressRoutePorts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{expressRoutePortName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "links", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{linkName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links/{linkName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links/{linkName}", "2023-11-01"), }}, }}, }}, }, { Display: "IpAllocations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/IpAllocations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/IpAllocations", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{ipAllocationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/IpAllocations/{ipAllocationName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/IpAllocations/{ipAllocationName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/IpAllocations/{ipAllocationName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/IpAllocations/{ipAllocationName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/IpAllocations/{ipAllocationName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/IpAllocations/{ipAllocationName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/IpAllocations/{ipAllocationName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/IpAllocations/{ipAllocationName}", "2023-11-01"), }}, }, { Display: "applicationGateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{applicationGatewayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{connectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections/{connectionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections/{connectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections/{connectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections/{connectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections/{connectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections/{connectionName}", "2023-11-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateLinkResources", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateLinkResources", "2023-11-01"), }}, }}, }, { Display: "applicationSecurityGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{applicationSecurityGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}", "2023-11-01"), }}, }, { Display: "azureFirewalls", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{azureFirewallName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}", "2023-11-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "bastionHosts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{bastionHostName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}", "2023-11-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "connections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{virtualNetworkGatewayConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "sharedkey", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey", "2023-11-01"), Children: []swagger.ResourceType{}, }}, }}, }, { Display: "customIpPrefixes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{customIpPrefixName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes/{customIpPrefixName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes/{customIpPrefixName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes/{customIpPrefixName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes/{customIpPrefixName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes/{customIpPrefixName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes/{customIpPrefixName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes/{customIpPrefixName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes/{customIpPrefixName}", "2023-11-01"), }}, }, { Display: "{ddosCustomPolicyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosCustomPolicies/{ddosCustomPolicyName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosCustomPolicies/{ddosCustomPolicyName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosCustomPolicies/{ddosCustomPolicyName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosCustomPolicies/{ddosCustomPolicyName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosCustomPolicies/{ddosCustomPolicyName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosCustomPolicies/{ddosCustomPolicyName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosCustomPolicies/{ddosCustomPolicyName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosCustomPolicies/{ddosCustomPolicyName}", "2023-11-01"), }, { Display: "ddosProtectionPlans", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{ddosProtectionPlanName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans/{ddosProtectionPlanName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans/{ddosProtectionPlanName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans/{ddosProtectionPlanName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans/{ddosProtectionPlanName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans/{ddosProtectionPlanName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans/{ddosProtectionPlanName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans/{ddosProtectionPlanName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans/{ddosProtectionPlanName}", "2023-11-01"), }}, }, { Display: "dscpConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dscpConfigurations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dscpConfigurations", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{dscpConfigurationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dscpConfigurations/{dscpConfigurationName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dscpConfigurations/{dscpConfigurationName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dscpConfigurations/{dscpConfigurationName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dscpConfigurations/{dscpConfigurationName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dscpConfigurations/{dscpConfigurationName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dscpConfigurations/{dscpConfigurationName}", "2023-11-01"), }}, }, { Display: "expressRouteCircuits", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{circuitName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "authorizations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{authorizationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}", "2023-11-01"), }}, }, { Display: "peerings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{peeringName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "connections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{connectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}", "2023-11-01"), }}, }, { Display: "peerConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{connectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections/{connectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections/{connectionName}", "2023-11-01"), }}, }, { Display: "stats", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/stats", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/stats", "2023-11-01"), }}, SubResources: []swagger.ResourceType{}, }}, }, { Display: "stats", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/stats", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/stats", "2023-11-01"), }}, }}, }, { Display: "expressRouteCrossConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{crossConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "peerings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{peeringName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}", "2023-11-01"), SubResources: []swagger.ResourceType{}, }}, }}, @@ -12720,323 +12888,336 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "expressRouteGateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{expressRouteGatewayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "expressRouteConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{connectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName}", "2023-11-01"), }}, }}, }}, }, { Display: "authorizations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{authorizationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations/{authorizationName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations/{authorizationName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations/{authorizationName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations/{authorizationName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations/{authorizationName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations/{authorizationName}", "2023-11-01"), }}, }, { Display: "firewallPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{firewallPolicyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}", "2023-11-01"), Children: []swagger.ResourceType{ + { + Display: "default", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/firewallPolicyDrafts/default", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/firewallPolicyDrafts/default", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/firewallPolicyDrafts/default", "2023-11-01"), + }, { Display: "ruleCollectionGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{ruleCollectionGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}", "2023-11-01"), + Children: []swagger.ResourceType{ + { + Display: "default", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}/ruleCollectionGroupDrafts/default", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}/ruleCollectionGroupDrafts/default", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}/ruleCollectionGroupDrafts/default", "2023-11-01"), + }}, }}, }, { Display: "signatureOverrides", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides/default", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides/default", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides/default", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides/default", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides/default", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides/default", "2023-11-01"), }}, }}, }}, }, { Display: "ipGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{ipGroupsName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups/{ipGroupsName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups/{ipGroupsName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups/{ipGroupsName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups/{ipGroupsName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups/{ipGroupsName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups/{ipGroupsName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups/{ipGroupsName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups/{ipGroupsName}", "2023-11-01"), }}, }, { Display: "loadBalancers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{loadBalancerName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "backendAddressPools", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{backendAddressPoolName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}", "2023-11-01"), }}, }, { Display: "frontendIPConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/frontendIPConfigurations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/frontendIPConfigurations", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{frontendIPConfigurationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/frontendIPConfigurations/{frontendIPConfigurationName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/frontendIPConfigurations/{frontendIPConfigurationName}", "2023-11-01"), }}, }, { Display: "inboundNatRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{inboundNatRuleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}", "2023-11-01"), }}, }, { Display: "loadBalancingRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/loadBalancingRules", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/loadBalancingRules", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{loadBalancingRuleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/loadBalancingRules/{loadBalancingRuleName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/loadBalancingRules/{loadBalancingRuleName}", "2023-11-01"), }}, }, { Display: "networkInterfaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/networkInterfaces", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/networkInterfaces", "2023-11-01"), }, { Display: "outboundRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/outboundRules", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/outboundRules", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{outboundRuleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/outboundRules/{outboundRuleName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/outboundRules/{outboundRuleName}", "2023-11-01"), }}, }, { Display: "probes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{probeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}", "2023-11-01"), }}, }}, }}, }, { Display: "localNetworkGateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{localNetworkGatewayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}", "2023-11-01"), }}, }, { Display: "autoApprovedPrivateLinkServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices", "2023-11-01"), }, { Display: "availableDelegations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableDelegations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableDelegations", "2023-11-01"), }, { Display: "availablePrivateEndpointTypes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes", "2023-11-01"), }, { Display: "availableServiceAliases", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableServiceAliases", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableServiceAliases", "2023-11-01"), }, { Display: "natGateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{natGatewayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}", "2023-11-01"), }}, }, { Display: "networkInterfaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{networkInterfaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "ipConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{ipConfigurationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}", "2023-11-01"), }}, }, { Display: "loadBalancers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/loadBalancers", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/loadBalancers", "2023-11-01"), }, { Display: "tapConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{tapConfigurationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations/{tapConfigurationName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations/{tapConfigurationName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations/{tapConfigurationName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations/{tapConfigurationName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations/{tapConfigurationName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations/{tapConfigurationName}", "2023-11-01"), }}, }}, }}, }, { Display: "networkManagers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{networkManagerName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "connectivityConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/connectivityConfigurations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/connectivityConfigurations", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{configurationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/connectivityConfigurations/{configurationName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/connectivityConfigurations/{configurationName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/connectivityConfigurations/{configurationName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/connectivityConfigurations/{configurationName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/connectivityConfigurations/{configurationName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/connectivityConfigurations/{configurationName}", "2023-11-01"), }}, }, { Display: "networkGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{networkGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "staticMembers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{staticMemberName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers/{staticMemberName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers/{staticMemberName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers/{staticMemberName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers/{staticMemberName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers/{staticMemberName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers/{staticMemberName}", "2023-11-01"), }}, }}, }}, }, { Display: "scopeConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/scopeConnections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/scopeConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{scopeConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/scopeConnections/{scopeConnectionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/scopeConnections/{scopeConnectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/scopeConnections/{scopeConnectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/scopeConnections/{scopeConnectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/scopeConnections/{scopeConnectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/scopeConnections/{scopeConnectionName}", "2023-11-01"), }}, }, { Display: "securityAdminConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{configurationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "ruleCollections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{ruleCollectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "rules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{ruleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}", "2023-11-01"), }}, }}, }}, @@ -13047,80 +13228,80 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "networkProfiles", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{networkProfileName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles/{networkProfileName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles/{networkProfileName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles/{networkProfileName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles/{networkProfileName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles/{networkProfileName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles/{networkProfileName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles/{networkProfileName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles/{networkProfileName}", "2023-11-01"), }}, }, { Display: "networkSecurityGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{networkSecurityGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "defaultSecurityRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{defaultSecurityRuleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules/{defaultSecurityRuleName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules/{defaultSecurityRuleName}", "2023-11-01"), }}, }, { Display: "securityRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{securityRuleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}", "2023-11-01"), }}, }}, }}, }, { Display: "networkVirtualAppliances", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{networkVirtualApplianceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "networkVirtualApplianceConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{connectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections/{connectionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections/{connectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections/{connectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections/{connectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections/{connectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections/{connectionName}", "2023-11-01"), }}, }, { Display: "virtualApplianceSites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{siteName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites/{siteName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites/{siteName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites/{siteName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites/{siteName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites/{siteName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites/{siteName}", "2023-11-01"), }}, }}, SubResources: []swagger.ResourceType{}, @@ -13128,49 +13309,49 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "networkWatchers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{networkWatcherName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "connectionMonitors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{connectionMonitorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}", "2023-11-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "flowLogs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{flowLogName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}", "2023-11-01"), }}, }, { Display: "packetCaptures", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{packetCaptureName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}", "2023-11-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -13178,432 +13359,432 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "p2svpnGateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{gatewayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}", "2023-11-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "privateEndpoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "privateDnsZoneGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{privateDnsZoneGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}", "2023-11-01"), }}, }}, }}, }, { Display: "privateLinkServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{serviceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{peConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections/{peConnectionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections/{peConnectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections/{peConnectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections/{peConnectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections/{peConnectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections/{peConnectionName}", "2023-11-01"), }}, }}, }}, }, { Display: "publicIPAddresses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{publicIpAddressName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}", "2023-11-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "publicIPPrefixes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{publicIpPrefixName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}", "2023-11-01"), }}, }, { Display: "routeFilters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{routeFilterName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "routeFilterRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{ruleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}", "2023-11-01"), }}, }}, }}, }, { Display: "routeTables", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{routeTableName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "routes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{routeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}", "2023-11-01"), }}, }}, }}, }, { Display: "securityPartnerProviders", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{securityPartnerProviderName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders/{securityPartnerProviderName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders/{securityPartnerProviderName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders/{securityPartnerProviderName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders/{securityPartnerProviderName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders/{securityPartnerProviderName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders/{securityPartnerProviderName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders/{securityPartnerProviderName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders/{securityPartnerProviderName}", "2023-11-01"), }}, }, { Display: "serviceEndpointPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{serviceEndpointPolicyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "serviceEndpointPolicyDefinitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{serviceEndpointPolicyDefinitionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions/{serviceEndpointPolicyDefinitionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions/{serviceEndpointPolicyDefinitionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions/{serviceEndpointPolicyDefinitionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions/{serviceEndpointPolicyDefinitionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions/{serviceEndpointPolicyDefinitionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions/{serviceEndpointPolicyDefinitionName}", "2023-11-01"), }}, }}, }}, }, { Display: "virtualHubs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{virtualHubName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "bgpConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{connectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{connectionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{connectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{connectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{connectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{connectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{connectionName}", "2023-11-01"), }}, }, { Display: "hubRouteTables", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{routeTableName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables/{routeTableName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables/{routeTableName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables/{routeTableName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables/{routeTableName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables/{routeTableName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables/{routeTableName}", "2023-11-01"), }}, }, { Display: "hubVirtualNetworkConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{connectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}", "2023-11-01"), }}, }, { Display: "ipConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{ipConfigName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName}", "2023-11-01"), }}, }, { Display: "routeMaps", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{routeMapName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps/{routeMapName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps/{routeMapName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps/{routeMapName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps/{routeMapName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps/{routeMapName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps/{routeMapName}", "2023-11-01"), }}, }, { Display: "routeTables", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{routeTableName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables/{routeTableName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables/{routeTableName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables/{routeTableName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables/{routeTableName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables/{routeTableName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables/{routeTableName}", "2023-11-01"), }}, }, { Display: "routingIntent", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{routingIntentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent/{routingIntentName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent/{routingIntentName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent/{routingIntentName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent/{routingIntentName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent/{routingIntentName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent/{routingIntentName}", "2023-11-01"), }}, }}, }}, }, { Display: "virtualNetworkGateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{virtualNetworkGatewayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "connections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/connections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/connections", "2023-11-01"), }, { Display: "natRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{natRuleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules/{natRuleName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules/{natRuleName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules/{natRuleName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules/{natRuleName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules/{natRuleName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules/{natRuleName}", "2023-11-01"), }}, }}, }}, }, { Display: "virtualNetworkTaps", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{tapName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps/{tapName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps/{tapName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps/{tapName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps/{tapName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps/{tapName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps/{tapName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps/{tapName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps/{tapName}", "2023-11-01"), }}, }, { Display: "virtualNetworks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{virtualNetworkName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "CheckIPAddressAvailability", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/CheckIPAddressAvailability", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/CheckIPAddressAvailability", "2023-11-01"), }, { Display: "subnets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{subnetName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "ResourceNavigationLinks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/ResourceNavigationLinks", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/ResourceNavigationLinks", "2023-11-01"), }, { Display: "ServiceAssociationLinks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/ServiceAssociationLinks", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/ServiceAssociationLinks", "2023-11-01"), }}, }}, }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/usages", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/usages", "2023-11-01"), }, { Display: "virtualNetworkPeerings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{virtualNetworkPeeringName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}", "2023-11-01"), }}, }}, }}, }, { Display: "virtualRouters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{virtualRouterName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "peerings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{peeringName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings/{peeringName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings/{peeringName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings/{peeringName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings/{peeringName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings/{peeringName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings/{peeringName}", "2023-11-01"), }}, }}, }}, }, { Display: "virtualWans", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{VirtualWANName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}", "2023-11-01"), }, { Display: "supportedSecurityProviders", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/supportedSecurityProviders", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/supportedSecurityProviders", "2023-11-01"), }}, }, { Display: "vpnGateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{gatewayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "natRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{natRuleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules/{natRuleName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules/{natRuleName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules/{natRuleName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules/{natRuleName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules/{natRuleName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules/{natRuleName}", "2023-11-01"), }}, }, { Display: "vpnConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{connectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "vpnLinkConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{linkConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}", "2023-11-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -13613,46 +13794,46 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "vpnServerConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{vpnServerConfigurationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "configurationPolicyGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{configurationPolicyGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups/{configurationPolicyGroupName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups/{configurationPolicyGroupName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups/{configurationPolicyGroupName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups/{configurationPolicyGroupName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups/{configurationPolicyGroupName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups/{configurationPolicyGroupName}", "2023-11-01"), }}, }}, }}, }, { Display: "vpnSites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{vpnSiteName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}", "2023-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}", "2023-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}", "2023-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "vpnSiteLinks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{vpnSiteLinkName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks/{vpnSiteLinkName}", "2023-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks/{vpnSiteLinkName}", "2023-11-01"), }}, }}, }}, @@ -13793,15 +13974,15 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.OperationalInsights/operations", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.OperationalInsights/operations", "2023-09-01"), }, { Display: "clusters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/clusters", "2021-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/clusters", "2022-10-01"), }, { Display: "deletedWorkspaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/deletedWorkspaces", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/deletedWorkspaces", "2023-09-01"), }, { Display: "{asyncOperationId}", @@ -13813,7 +13994,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "workspaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/workspaces", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/workspaces", "2023-09-01"), }, { Display: "queryPacks", @@ -13865,30 +14046,30 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "clusters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters", "2021-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters", "2022-10-01"), SubResources: []swagger.ResourceType{ { Display: "{clusterName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}", "2021-06-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}", "2021-06-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}", "2021-06-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}", "2021-06-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}", "2022-10-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}", "2022-10-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}", "2022-10-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}", "2022-10-01"), }}, }, { Display: "deletedWorkspaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/deletedWorkspaces", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/deletedWorkspaces", "2023-09-01"), }, { Display: "workspaces", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{workspaceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}", "2022-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}", "2022-10-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}", "2022-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}", "2023-09-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}", "2023-09-01"), Children: []swagger.ResourceType{ { Display: "availableServiceTiers", @@ -14710,7 +14891,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "getDefaultAccount", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Purview/getDefaultAccount", "2021-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Purview/getDefaultAccount", "2023-05-01-preview"), }, { Display: "operations", @@ -14718,52 +14899,56 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "accounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts", "2021-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts", "2023-05-01-preview"), }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Purview/locations/{location}/usages", "2021-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Purview/locations/{location}/usages", "2023-05-01-preview"), }, { Display: "accounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts", "2021-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts", "2023-05-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{accountName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}", "2021-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}", "2021-12-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}", "2021-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}", "2021-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}", "2023-05-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}", "2023-05-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}", "2023-05-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}", "2023-05-01-preview"), Children: []swagger.ResourceType{ + { + Display: "ingestionPrivateEndpointConnections", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/ingestionPrivateEndpointConnections", "2023-05-01-preview"), + }, { Display: "kafkaConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations", "2021-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations", "2023-05-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{kafkaConfigurationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}", "2021-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}", "2021-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}", "2021-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}", "2023-05-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}", "2023-05-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}", "2023-05-01-preview"), }}, }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections", "2021-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections", "2023-05-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2021-12-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2021-12-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2021-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-05-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-05-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-05-01-preview"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources", "2021-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources", "2023-05-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{groupId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources/{groupId}", "2021-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources/{groupId}", "2023-05-01-preview"), }}, }}, }}, @@ -14774,35 +14959,35 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Quota/operations", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Quota/operations", "2023-06-01-preview"), }, { Display: "quotaRequests", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/quotaRequests", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/quotaRequests", "2023-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{id}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/quotaRequests/{id}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/quotaRequests/{id}", "2023-06-01-preview"), }}, }, { Display: "quotas", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/quotas", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/quotas", "2023-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{resourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/quotas/{resourceName}", "2023-02-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/quotas/{resourceName}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/quotas/{resourceName}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/quotas/{resourceName}", "2023-06-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/quotas/{resourceName}", "2023-06-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/quotas/{resourceName}", "2023-06-01-preview"), }}, }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/usages", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/usages", "2023-06-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{resourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/usages/{resourceName}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Quota/usages/{resourceName}", "2023-06-01-preview"), }}, }, { @@ -14962,218 +15147,149 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.RedHatOpenShift/operations", "2023-09-04"), - }, - { - Display: "openshiftversions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/locations/{location}/openshiftversions", "2023-09-04"), - }, - { - Display: "openShiftClusters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/openShiftClusters", "2023-09-04"), - }, - { - Display: "machinePools", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftCluster/{resourceName}/machinePools", "2023-09-04"), - }, - { - Display: "secrets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftCluster/{resourceName}/secrets", "2023-09-04"), - }, - { - Display: "syncIdentityProviders", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftCluster/{resourceName}/syncIdentityProviders", "2023-09-04"), - }, - { - Display: "syncSets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftCluster/{resourceName}/syncSets", "2023-09-04"), - }, - { - Display: "openShiftClusters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters", "2023-09-04"), - SubResources: []swagger.ResourceType{ - { - Display: "{resourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}", "2023-09-04"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}", "2023-09-04"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}", "2023-09-04"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}", "2023-09-04"), - Children: []swagger.ResourceType{}, - }}, - }, - { - Display: "{childResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/machinePool/{childResourceName}", "2023-09-04"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/machinePool/{childResourceName}", "2023-09-04"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/machinePool/{childResourceName}", "2023-09-04"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/machinePool/{childResourceName}", "2023-09-04"), - }, - { - Display: "{childResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/secret/{childResourceName}", "2023-09-04"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/secret/{childResourceName}", "2023-09-04"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/secret/{childResourceName}", "2023-09-04"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/secret/{childResourceName}", "2023-09-04"), - }, - { - Display: "{childResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/syncIdentityProvider/{childResourceName}", "2023-09-04"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/syncIdentityProvider/{childResourceName}", "2023-09-04"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/syncIdentityProvider/{childResourceName}", "2023-09-04"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/syncIdentityProvider/{childResourceName}", "2023-09-04"), - }, - { - Display: "{childResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/syncSet/{childResourceName}", "2023-09-04"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/syncSet/{childResourceName}", "2023-09-04"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/syncSet/{childResourceName}", "2023-09-04"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openshiftclusters/{resourceName}/syncSet/{childResourceName}", "2023-09-04"), - }, - { - Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Cache/operations", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Cache/operations", "2024-02-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/asyncOperations/{operationId}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/asyncOperations/{operationId}", "2024-03-01"), }, { Display: "redis", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Cache/redis", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Cache/redis", "2024-03-01"), }, { Display: "redis", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "accessPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{accessPolicyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies/{accessPolicyName}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies/{accessPolicyName}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies/{accessPolicyName}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies/{accessPolicyName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies/{accessPolicyName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies/{accessPolicyName}", "2024-03-01"), }}, }, { Display: "accessPolicyAssignments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{accessPolicyAssignmentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments/{accessPolicyAssignmentName}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments/{accessPolicyAssignmentName}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments/{accessPolicyAssignmentName}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments/{accessPolicyAssignmentName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments/{accessPolicyAssignmentName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments/{accessPolicyAssignmentName}", "2024-03-01"), }}, }, { Display: "firewallRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{ruleName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}", "2024-03-01"), }}, }, { Display: "patchSchedules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/patchSchedules", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/patchSchedules", "2024-03-01"), }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateLinkResources", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateLinkResources", "2024-03-01"), }, { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}", "2023-08-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "linkedServers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{linkedServerName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}", "2024-03-01"), }}, }, { Display: "listUpgradeNotifications", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/listUpgradeNotifications", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/listUpgradeNotifications", "2024-03-01"), }}, SubResources: []swagger.ResourceType{ { Display: "{default}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/{default}", "2023-08-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/{default}", "2023-08-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/{default}", "2023-08-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/{default}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/{default}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/{default}", "2024-03-01"), }}, }}, }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/operationsStatus/{operationId}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/operationsStatus/{operationId}", "2024-02-01"), }, { Display: "redisEnterprise", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Cache/redisEnterprise", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Cache/redisEnterprise", "2024-02-01"), }, { Display: "redisEnterprise", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{clusterName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}", "2023-11-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}", "2024-02-01"), Children: []swagger.ResourceType{ { Display: "databases", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{databaseName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}", "2023-11-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}", "2024-02-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}", "2024-02-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-02-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-02-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-02-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateLinkResources", "2023-11-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateLinkResources", "2024-02-01"), }}, }}, }, @@ -15381,97 +15497,97 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "emergingIssues", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/emergingIssues", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/emergingIssues", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{issueName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/emergingIssues/{issueName}", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/emergingIssues/{issueName}", "2024-02-01"), }}, }, { Display: "events", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/events", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/events", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{eventTrackingId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/events/{eventTrackingId}", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/events/{eventTrackingId}", "2024-02-01"), Children: []swagger.ResourceType{ { Display: "impactedResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{impactedResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources/{impactedResourceName}", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources/{impactedResourceName}", "2024-02-01"), }}, }}, }}, }, { Display: "metadata", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/metadata", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/metadata", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/metadata/{name}", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/metadata/{name}", "2024-02-01"), }}, }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/operations", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ResourceHealth/operations", "2024-02-01"), }, { Display: "availabilityStatuses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/availabilityStatuses", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/availabilityStatuses", "2024-02-01"), }, { Display: "events", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{eventTrackingId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}", "2024-02-01"), Children: []swagger.ResourceType{ { Display: "impactedResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources", "2024-02-01"), SubResources: []swagger.ResourceType{ { Display: "{impactedResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources/{impactedResourceName}", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources/{impactedResourceName}", "2024-02-01"), }}, }}, }}, }, { Display: "availabilityStatuses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceHealth/availabilityStatuses", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceHealth/availabilityStatuses", "2024-02-01"), }, { Display: "availabilityStatuses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses", "2024-02-01"), Children: []swagger.ResourceType{ { Display: "current", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses/current", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses/current", "2024-02-01"), }}, }, { Display: "childAvailabilityStatuses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.ResourceHealth/childAvailabilityStatuses", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.ResourceHealth/childAvailabilityStatuses", "2024-02-01"), Children: []swagger.ResourceType{ { Display: "current", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.ResourceHealth/childAvailabilityStatuses/current", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.ResourceHealth/childAvailabilityStatuses/current", "2024-02-01"), }}, }, { Display: "childResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.ResourceHealth/childResources", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.ResourceHealth/childResources", "2024-02-01"), }, { Display: "events", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.ResourceHealth/events", "2022-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{resourceUri}/providers/Microsoft.ResourceHealth/events", "2024-02-01"), }, { Display: "moveCollections", @@ -15598,7 +15714,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "automations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/automations", "2019-01-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/automations", "2023-12-01-preview"), }, { Display: "connectors", @@ -15706,28 +15822,6 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/mdeOnboardings/default", "2021-10-01-preview"), }}, }, - { - Display: "pricings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings", "2023-01-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{pricingName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}", "2023-01-01"), - Children: []swagger.ResourceType{ - { - Display: "securityOperators", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}/securityOperators", "2023-01-01-preview"), - SubResources: []swagger.ResourceType{ - { - Display: "{securityOperatorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}/securityOperators/{securityOperatorName}", "2023-01-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}/securityOperators/{securityOperatorName}", "2023-01-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}/securityOperators/{securityOperatorName}", "2023-01-01-preview"), - }}, - }}, - }}, - }, { Display: "regulatoryComplianceStandards", Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/regulatoryComplianceStandards", "2019-01-01-preview"), @@ -15781,17 +15875,17 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "securityConnectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityConnectors", "2023-10-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityConnectors", "2024-03-01-preview"), }, { Display: "securityContacts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts", "2020-01-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts", "2023-12-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{securityContactName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName}", "2020-01-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName}", "2020-01-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName}", "2020-01-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName}", "2023-12-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName}", "2023-12-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName}", "2023-12-01-preview"), }}, }, { @@ -15881,7 +15975,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "managedClusters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/managedClusters", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/managedClusters", "2024-04-01"), }, { Display: "applications", @@ -15903,13 +15997,9 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { Display: "volumes", Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/volumes", "2018-09-01-preview"), }, - { - Display: "trafficControllers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceNetworking/trafficControllers", "2023-11-01"), - }, { Display: "signalR", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR", "2024-03-01"), }, { Display: "deletedServers", @@ -15925,7 +16015,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "servers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Sql/servers", "2023-02-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Sql/servers", "2023-05-01-preview"), }, { Display: "virtualClusters", @@ -15933,11 +16023,11 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "sqlVirtualMachineGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups", "2022-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups", "2023-10-01"), }, { Display: "sqlVirtualMachines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines", "2022-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines", "2023-10-01"), }, { Display: "managers", @@ -15945,15 +16035,15 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "deletedAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Storage/deletedAccounts", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Storage/deletedAccounts", "2023-05-01"), }, { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Storage/skus", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Storage/skus", "2023-05-01"), }, { Display: "storageAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts", "2023-05-01"), }, { Display: "storageTasks", @@ -15961,19 +16051,19 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "amlFilesystems", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/amlFilesystems", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/amlFilesystems", "2024-03-01"), }, { Display: "caches", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/caches", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/caches", "2024-03-01"), }, { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/skus", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/skus", "2024-03-01"), }, { Display: "usageModels", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/usageModels", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/usageModels", "2024-03-01"), }, { Display: "jobs", @@ -15997,22 +16087,31 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "supportTickets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets", "2020-04-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{supportTicketName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}", "2020-04-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}", "2020-04-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}", "2020-04-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}", "2024-04-01"), Children: []swagger.ResourceType{ + { + Display: "chatTranscripts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts", "2024-04-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{chatTranscriptName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts/{chatTranscriptName}", "2024-04-01"), + }}, + }, { Display: "communications", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications", "2020-04-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{communicationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}", "2020-04-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}", "2020-04-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}", "2024-04-01"), }}, }}, }}, @@ -16037,7 +16136,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "privateClouds", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.AVS/privateClouds", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.AVS/privateClouds", "2023-09-01"), }, { Display: "dedicatedCloudNodes", @@ -16053,110 +16152,110 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "certificateOrders", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/certificateOrders", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/certificateOrders", "2023-12-01"), }, { Display: "domains", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains", "2023-12-01"), }, { Display: "topLevelDomains", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "aseRegions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/aseRegions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/aseRegions", "2023-12-01"), }, { Display: "availableStacks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/availableStacks", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/availableStacks", "2023-12-01"), }, { Display: "billingMeters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/billingMeters", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/billingMeters", "2023-12-01"), }, { Display: "certificates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates", "2023-12-01"), }, { Display: "containerApps", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/containerApps", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/containerApps", "2023-12-01"), SubResources: []swagger.ResourceType{}, }, { Display: "customhostnameSites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/customhostnameSites", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/customhostnameSites", "2023-12-01"), }, { Display: "deletedSites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{deletedSiteId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "snapshots", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}/snapshots", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}/snapshots", "2023-12-01"), }}, }}, }, { Display: "deploymentLocations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/deploymentLocations", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/deploymentLocations", "2023-12-01"), }, { Display: "geoRegions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions", "2023-12-01"), }, { Display: "hostingEnvironments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments", "2023-12-01"), }, { Display: "kubeEnvironments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/kubeEnvironments", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/kubeEnvironments", "2023-12-01"), }, { Display: "premieraddonoffers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers", "2023-12-01"), }, { Display: "recommendations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations", "2023-12-01"), Children: []swagger.ResourceType{}, SubResources: []swagger.ResourceType{}, }, { Display: "resourceHealthMetadata", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/resourceHealthMetadata", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/resourceHealthMetadata", "2023-12-01"), }, { Display: "serverfarms", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms", "2023-12-01"), }, { Display: "sites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites", "2023-12-01"), }, { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/skus", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/skus", "2023-12-01"), }, { Display: "staticSites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/staticSites", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/staticSites", "2023-12-01"), }, { Display: "webPubSub", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/webPubSub", "2021-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/webPubSub", "2024-03-01"), }, { Display: "deviceServices", @@ -16272,6 +16371,17 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { SubResources: []swagger.ResourceType{}, }}, }, + { + Display: "securityOperators", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}/securityOperators", "2023-01-01-preview"), + SubResources: []swagger.ResourceType{ + { + Display: "{securityOperatorName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}/securityOperators/{securityOperatorName}", "2023-01-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}/securityOperators/{securityOperatorName}", "2023-01-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}/securityOperators/{securityOperatorName}", "2023-01-01-preview"), + }}, + }, { Display: "alerts", Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/alerts", "2022-01-01"), @@ -16282,13 +16392,14 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "automations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations", "2019-01-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations", "2023-12-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{automationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName}", "2019-01-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName}", "2019-01-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName}", "2019-01-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName}", "2023-12-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName}", "2023-12-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName}", "2023-12-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName}", "2023-12-01-preview"), Children: []swagger.ResourceType{}, }}, }, @@ -16392,55 +16503,55 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "securityConnectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors", "2023-10-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors", "2024-03-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{securityConnectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}", "2023-10-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}", "2023-10-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}", "2023-10-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}", "2023-10-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}", "2024-03-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}", "2024-03-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}", "2024-03-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}", "2024-03-01-preview"), Children: []swagger.ResourceType{ { Display: "devops", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops", "2024-05-15-preview"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default", "2023-09-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default", "2023-09-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default", "2023-09-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default", "2024-05-15-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default", "2024-05-15-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default", "2024-05-15-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default", "2024-05-15-preview"), Children: []swagger.ResourceType{ { Display: "azureDevOpsOrgs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs", "2024-05-15-preview"), SubResources: []swagger.ResourceType{ { Display: "{orgName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}", "2023-09-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}", "2023-09-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}", "2024-05-15-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}", "2024-05-15-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}", "2024-05-15-preview"), Children: []swagger.ResourceType{ { Display: "projects", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects", "2024-05-15-preview"), SubResources: []swagger.ResourceType{ { Display: "{projectName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}", "2023-09-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}", "2023-09-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}", "2024-05-15-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}", "2024-05-15-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}", "2024-05-15-preview"), Children: []swagger.ResourceType{ { Display: "repos", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}/repos", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}/repos", "2024-05-15-preview"), SubResources: []swagger.ResourceType{ { Display: "{repoName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}/repos/{repoName}", "2023-09-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}/repos/{repoName}", "2023-09-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}/repos/{repoName}", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}/repos/{repoName}", "2024-05-15-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}/repos/{repoName}", "2024-05-15-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}/repos/{repoName}", "2024-05-15-preview"), }}, }}, }}, @@ -16449,46 +16560,67 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "gitHubOwners", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners", "2024-05-15-preview"), SubResources: []swagger.ResourceType{ { Display: "{ownerName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners/{ownerName}", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners/{ownerName}", "2024-05-15-preview"), Children: []swagger.ResourceType{ { Display: "repos", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners/{ownerName}/repos", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners/{ownerName}/repos", "2024-05-15-preview"), SubResources: []swagger.ResourceType{ { Display: "{repoName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners/{ownerName}/repos/{repoName}", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners/{ownerName}/repos/{repoName}", "2024-05-15-preview"), }}, }}, }}, }, { Display: "gitLabGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups", "2024-05-15-preview"), SubResources: []swagger.ResourceType{ { Display: "{groupFQName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups/{groupFQName}", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups/{groupFQName}", "2024-05-15-preview"), Children: []swagger.ResourceType{ { Display: "projects", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups/{groupFQName}/projects", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups/{groupFQName}/projects", "2024-05-15-preview"), SubResources: []swagger.ResourceType{ { Display: "{projectName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups/{groupFQName}/projects/{projectName}", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups/{groupFQName}/projects/{projectName}", "2024-05-15-preview"), }}, }}, }}, + }, + { + Display: "policies", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/policies", "2024-05-15-preview"), + SubResources: []swagger.ResourceType{ + { + Display: "{policyName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/policies/{policyName}", "2024-05-15-preview"), + }}, + }, + { + Display: "policyAssignments", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/policyAssignments", "2024-05-15-preview"), + SubResources: []swagger.ResourceType{ + { + Display: "{policyAssignmentId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/policyAssignments/{policyAssignmentId}", "2024-05-15-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/policyAssignments/{policyAssignmentId}", "2024-05-15-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/policyAssignments/{policyAssignmentId}", "2024-05-15-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/policyAssignments/{policyAssignmentId}", "2024-05-15-preview"), + }}, }}, SubResources: []swagger.ResourceType{ { Display: "{operationResultId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/operationResults/{operationResultId}", "2023-09-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/operationResults/{operationResultId}", "2024-05-15-preview"), }}, }}, }, @@ -16761,172 +16893,233 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "alertRuleTemplates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{alertRuleTemplateId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates/{alertRuleTemplateId}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates/{alertRuleTemplateId}", "2024-03-01"), }}, }, { Display: "alertRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{ruleId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "actions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{actionId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions/{actionId}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions/{actionId}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions/{actionId}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions/{actionId}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions/{actionId}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions/{actionId}", "2024-03-01"), }}, }}, }}, }, { Display: "automationRules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{automationRuleId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules/{automationRuleId}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules/{automationRuleId}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules/{automationRuleId}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules/{automationRuleId}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules/{automationRuleId}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules/{automationRuleId}", "2024-03-01"), }}, }, { Display: "bookmarks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{bookmarkId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}", "2024-03-01"), + }}, + }, + { + Display: "contentPackages", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentPackages", "2024-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{packageId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentPackages/{packageId}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentPackages/{packageId}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentPackages/{packageId}", "2024-03-01"), + }}, + }, + { + Display: "contentProductPackages", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductPackages", "2024-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{packageId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductPackages/{packageId}", "2024-03-01"), }}, }, + { + Display: "contentProductTemplates", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductTemplates", "2024-03-01"), + }, + { + Display: "contentTemplates", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentTemplates", "2024-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{templateId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentTemplates/{templateId}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentTemplates/{templateId}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentTemplates/{templateId}", "2024-03-01"), + }}, + }, + { + Display: "{templateId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentproducttemplates/{templateId}", "2024-03-01"), + }, { Display: "dataConnectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{dataConnectorId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}", "2024-03-01"), }}, }, { Display: "incidents", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{incidentId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "comments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{incidentCommentId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}", "2024-03-01"), }}, }, { Display: "relations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{relationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations/{relationName}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations/{relationName}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations/{relationName}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations/{relationName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations/{relationName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations/{relationName}", "2024-03-01"), + }}, + }, + { + Display: "tasks", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks", "2024-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{incidentTaskId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks/{incidentTaskId}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks/{incidentTaskId}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks/{incidentTaskId}", "2024-03-01"), }}, }}, }}, }, { Display: "metadata", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{metadataName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata/{metadataName}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata/{metadataName}", "2023-02-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata/{metadataName}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata/{metadataName}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata/{metadataName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata/{metadataName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata/{metadataName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata/{metadataName}", "2024-03-01"), }}, }, { Display: "onboardingStates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{sentinelOnboardingStateName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}", "2024-03-01"), }}, }, { Display: "securityMLAnalyticsSettings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{settingsResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/{settingsResourceName}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/{settingsResourceName}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/{settingsResourceName}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/{settingsResourceName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/{settingsResourceName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/{settingsResourceName}", "2024-03-01"), + }}, + }, + { + Display: "sourcecontrols", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols", "2024-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{sourceControlId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols/{sourceControlId}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols/{sourceControlId}", "2024-03-01"), + Children: []swagger.ResourceType{}, }}, }, { Display: "indicators", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}", "2024-03-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "metrics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/metrics", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/metrics", "2024-03-01"), }, { Display: "watchlists", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{watchlistAlias}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "watchlistItems", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{watchlistItemId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}", "2023-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}", "2023-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}", "2024-03-01"), }}, }}, }}, @@ -17261,64 +17454,64 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "managedClusterVersions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/managedClusterVersions", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/managedClusterVersions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{clusterVersion}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/managedClusterVersions/{clusterVersion}", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/managedClusterVersions/{clusterVersion}", "2024-04-01"), }}, }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterOperationResults/{operationId}", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterOperationResults/{operationId}", "2024-04-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterOperations/{operationId}", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterOperations/{operationId}", "2024-04-01"), }, { Display: "managedClusterVersions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterVersions", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterVersions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{clusterVersion}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterVersions/{clusterVersion}", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterVersions/{clusterVersion}", "2024-04-01"), }}, }, { Display: "managedUnsupportedVMSizes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedUnsupportedVMSizes", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedUnsupportedVMSizes", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{vmSize}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedUnsupportedVMSizes/{vmSize}", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedUnsupportedVMSizes/{vmSize}", "2024-04-01"), }}, }, { Display: "managedClusters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{clusterName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}", "2023-11-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}", "2023-11-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}", "2023-11-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "nodeTypes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{nodeTypeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}", "2023-11-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}", "2023-11-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}", "2023-11-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/skus", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/skus", "2024-04-01"), }}, }}, }}, @@ -17327,50 +17520,50 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "applicationTypes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{applicationTypeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}", "2023-11-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}", "2023-11-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}", "2023-11-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{version}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}", "2023-11-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}", "2023-11-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}", "2023-11-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}", "2024-04-01"), }}, }}, }}, }, { Display: "applications", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{applicationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}", "2023-11-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}", "2023-11-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}", "2023-11-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "services", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{serviceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}", "2023-11-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}", "2023-11-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}", "2023-11-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}", "2024-04-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}", "2024-04-01"), }}, }}, }}, @@ -17468,126 +17661,99 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeResourceName}", "2018-09-01-preview"), }}, }, - { - Display: "trafficControllers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers", "2023-11-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{trafficControllerName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}", "2023-11-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}", "2023-11-01"), - Children: []swagger.ResourceType{ - { - Display: "associations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations", "2023-11-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{associationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations/{associationName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations/{associationName}", "2023-11-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations/{associationName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations/{associationName}", "2023-11-01"), - }}, - }, - { - Display: "frontends", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends", "2023-11-01"), - SubResources: []swagger.ResourceType{ - { - Display: "{frontendName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends/{frontendName}", "2023-11-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends/{frontendName}", "2023-11-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends/{frontendName}", "2023-11-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends/{frontendName}", "2023-11-01"), - }}, - }}, - }}, - }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages", "2021-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages", "2024-03-01"), }, { Display: "signalR", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{resourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}", "2023-08-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}", "2023-08-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}", "2023-08-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "customCertificates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{certificateName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}", "2023-08-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}", "2023-08-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}", "2024-03-01"), }}, }, { Display: "customDomains", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}", "2023-08-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}", "2023-08-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}", "2024-03-01"), }}, }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-08-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-08-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources", "2024-03-01"), }, { Display: "replicas", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{replicaName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}", "2023-08-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}", "2023-08-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}", "2023-08-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}", "2024-03-01"), Children: []swagger.ResourceType{ + { + Display: "sharedPrivateLinkResources", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources", "2024-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{sharedPrivateLinkResourceName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2024-03-01"), + }}, + }, { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/skus", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/skus", "2024-03-01"), }}, }}, }, { Display: "sharedPrivateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{sharedPrivateLinkResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2023-08-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2023-08-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2024-03-01"), }}, }, { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/skus", "2023-08-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/skus", "2024-03-01"), }}, }}, }, @@ -18173,14 +18339,14 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "servers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers", "2023-02-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers", "2023-05-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{serverName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}", "2023-02-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}", "2023-02-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}", "2023-02-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}", "2023-02-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}", "2023-05-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}", "2023-05-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}", "2023-05-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}", "2023-05-01-preview"), Children: []swagger.ResourceType{ { Display: "administrators", @@ -18420,7 +18586,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/operations", "2021-02-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/operations", "2022-11-01-preview"), SubResources: []swagger.ResourceType{}, }, { @@ -18430,12 +18596,14 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "replicationLinks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks", "2022-02-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks", "2023-05-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{linkId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}", "2022-02-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}", "2022-02-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}", "2023-05-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}", "2023-05-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}", "2023-05-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}", "2023-05-01-preview"), Children: []swagger.ResourceType{}, }}, }, @@ -18748,14 +18916,14 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "failoverGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups", "2023-02-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups", "2023-05-01-preview"), SubResources: []swagger.ResourceType{ { Display: "{failoverGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}", "2023-02-01-preview"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}", "2023-02-01-preview"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}", "2023-02-01-preview"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}", "2023-02-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}", "2023-05-01-preview"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}", "2023-05-01-preview"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}", "2023-05-01-preview"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}", "2023-05-01-preview"), Children: []swagger.ResourceType{}, }}, }, @@ -18969,7 +19137,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "replicationLinks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/replicationLinks", "2022-02-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/replicationLinks", "2023-05-01-preview"), }, { Display: "restorableDroppedDatabases", @@ -19110,42 +19278,42 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "sqlVirtualMachineGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups", "2022-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups", "2023-10-01"), SubResources: []swagger.ResourceType{ { Display: "{sqlVirtualMachineGroupName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}", "2022-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}", "2022-02-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}", "2022-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}", "2022-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}", "2023-10-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}", "2023-10-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}", "2023-10-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}", "2023-10-01"), Children: []swagger.ResourceType{ { Display: "availabilityGroupListeners", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners", "2022-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners", "2023-10-01"), SubResources: []swagger.ResourceType{ { Display: "{availabilityGroupListenerName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}", "2022-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}", "2022-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}", "2022-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}", "2023-10-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}", "2023-10-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}", "2023-10-01"), }}, }, { Display: "sqlVirtualMachines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/sqlVirtualMachines", "2022-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/sqlVirtualMachines", "2023-10-01"), }}, }}, }, { Display: "sqlVirtualMachines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines", "2022-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines", "2023-10-01"), SubResources: []swagger.ResourceType{ { Display: "{sqlVirtualMachineName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}", "2022-02-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}", "2022-02-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}", "2022-02-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}", "2022-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}", "2023-10-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}", "2023-10-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}", "2023-10-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}", "2023-10-01"), Children: []swagger.ResourceType{}, }}, }, @@ -19508,194 +19676,225 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "{deletedAccountName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/deletedAccounts/{deletedAccountName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/deletedAccounts/{deletedAccountName}", "2023-05-01"), }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/usages", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/usages", "2023-05-01"), }, { Display: "storageAccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts", "2023-05-01"), SubResources: []swagger.ResourceType{ { Display: "{accountName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}", "2023-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}", "2023-05-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}", "2023-05-01"), Children: []swagger.ResourceType{ { Display: "blobServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices", "2023-05-01"), Children: []swagger.ResourceType{ { Display: "containers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers", "2023-05-01"), SubResources: []swagger.ResourceType{ { Display: "{containerName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}", "2023-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}", "2023-05-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}", "2023-05-01"), Children: []swagger.ResourceType{}, SubResources: []swagger.ResourceType{ { Display: "{immutabilityPolicyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}", "2023-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}", "2023-05-01"), }}, }}, }}, SubResources: []swagger.ResourceType{ { Display: "{BlobServicesName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/{BlobServicesName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/{BlobServicesName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/{BlobServicesName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/{BlobServicesName}", "2023-05-01"), }}, }, { Display: "encryptionScopes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes", "2023-05-01"), SubResources: []swagger.ResourceType{ { Display: "{encryptionScopeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}", "2023-05-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}", "2023-05-01"), }}, }, { Display: "fileServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices", "2023-05-01"), Children: []swagger.ResourceType{ { Display: "shares", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares", "2023-05-01"), SubResources: []swagger.ResourceType{ { Display: "{shareName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}", "2023-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}", "2023-05-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}", "2023-05-01"), Children: []swagger.ResourceType{}, }}, }}, SubResources: []swagger.ResourceType{ { Display: "{FileServicesName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}", "2023-05-01"), }}, }, { Display: "inventoryPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies", "2023-05-01"), SubResources: []swagger.ResourceType{ { Display: "{blobInventoryPolicyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies/{blobInventoryPolicyName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies/{blobInventoryPolicyName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies/{blobInventoryPolicyName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies/{blobInventoryPolicyName}", "2023-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies/{blobInventoryPolicyName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies/{blobInventoryPolicyName}", "2023-05-01"), }}, }, { Display: "localUsers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers", "2023-05-01"), SubResources: []swagger.ResourceType{ { Display: "{username}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}", "2023-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}", "2023-05-01"), Children: []swagger.ResourceType{}, }}, }, + { + Display: "networkSecurityPerimeterConfigurations", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations", "2023-05-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{networkSecurityPerimeterConfigurationName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}", "2023-05-01"), + Children: []swagger.ResourceType{}, + }}, + }, { Display: "objectReplicationPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies", "2023-05-01"), SubResources: []swagger.ResourceType{ { Display: "{objectReplicationPolicyId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}", "2023-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}", "2023-05-01"), }}, }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections", "2023-05-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-05-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateLinkResources", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateLinkResources", "2023-05-01"), }, { Display: "queueServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices", "2023-05-01"), Children: []swagger.ResourceType{ { Display: "queues", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues", "2023-05-01"), SubResources: []swagger.ResourceType{ { Display: "{queueName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}", "2023-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}", "2023-05-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}", "2023-05-01"), }}, }}, SubResources: []swagger.ResourceType{ { Display: "{queueServiceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/{queueServiceName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/{queueServiceName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/{queueServiceName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/{queueServiceName}", "2023-05-01"), + }}, + }, + { + Display: "reports", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/reports", "2023-05-01"), + }, + { + Display: "storageTaskAssignments", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments", "2023-05-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{storageTaskAssignmentName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}", "2023-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}", "2023-05-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}", "2023-05-01"), + Children: []swagger.ResourceType{ + { + Display: "reports", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}/reports", "2023-05-01"), + }}, }}, }, { Display: "tableServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices", "2023-05-01"), Children: []swagger.ResourceType{ { Display: "tables", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables", "2023-05-01"), SubResources: []swagger.ResourceType{ { Display: "{tableName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}", "2023-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}", "2023-05-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}", "2023-05-01"), }}, }}, SubResources: []swagger.ResourceType{ { Display: "{tableServiceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/{tableServiceName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/{tableServiceName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/{tableServiceName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/{tableServiceName}", "2023-05-01"), }}, }}, SubResources: []swagger.ResourceType{ { Display: "{migrationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/accountMigrations/{migrationName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/accountMigrations/{migrationName}", "2023-05-01"), }, { Display: "{managementPolicyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}", "2023-05-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}", "2023-05-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}", "2023-05-01"), }}, }}, }, @@ -19722,45 +19921,57 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/ascOperations/{operationId}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/ascOperations/{operationId}", "2024-03-01"), }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/usages", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/usages", "2024-03-01"), }, { Display: "amlFilesystems", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{amlFilesystemName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}", "2023-05-01"), - Children: []swagger.ResourceType{}, + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}", "2024-03-01"), + Children: []swagger.ResourceType{ + { + Display: "importJobs", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/importJobs", "2024-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{importJobName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/importJobs/{importJobName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/importJobs/{importJobName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/importJobs/{importJobName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/importJobs/{importJobName}", "2024-03-01"), + }}, + }}, }}, }, { Display: "caches", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{cacheName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}", "2023-05-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}", "2024-03-01"), Children: []swagger.ResourceType{ { Display: "storageTargets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{storageTargetName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}", "2023-05-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}", "2023-05-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}", "2024-03-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -20003,6 +20214,23 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }}, }}, }, + { + Display: "{fileWorkspaceName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}", "2024-04-01"), + Children: []swagger.ResourceType{ + { + Display: "files", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files", "2024-04-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{fileName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}", "2024-04-01"), + Children: []swagger.ResourceType{}, + }}, + }}, + }, { Display: "environments", Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments", "2020-05-15"), @@ -20168,89 +20396,89 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "privateClouds", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{privateCloudName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}", "2023-03-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}", "2023-09-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}", "2023-09-01"), Children: []swagger.ResourceType{ { Display: "addons", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{addonName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}", "2023-09-01"), }}, }, { Display: "authorizations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{authorizationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}", "2023-09-01"), }}, }, { Display: "cloudLinks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{cloudLinkName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks/{cloudLinkName}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks/{cloudLinkName}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks/{cloudLinkName}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks/{cloudLinkName}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks/{cloudLinkName}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks/{cloudLinkName}", "2023-09-01"), }}, }, { Display: "clusters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{clusterName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}", "2023-03-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}", "2023-09-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}", "2023-09-01"), Children: []swagger.ResourceType{ { Display: "datastores", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{datastoreName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}", "2023-09-01"), }}, }, { Display: "placementPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{placementPolicyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}", "2023-03-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}", "2023-09-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}", "2023-09-01"), }}, }, { Display: "virtualMachines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{virtualMachineId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines/{virtualMachineId}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines/{virtualMachineId}", "2023-09-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -20258,167 +20486,178 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "globalReachConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{globalReachConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}", "2023-09-01"), }}, }, { Display: "hcxEnterpriseSites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{hcxEnterpriseSiteName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}", "2023-09-01"), + }}, + }, + { + Display: "iscsiPaths", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/iscsiPaths", "2023-09-01"), + Children: []swagger.ResourceType{ + { + Display: "default", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/iscsiPaths/default", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/iscsiPaths/default", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/iscsiPaths/default", "2023-09-01"), }}, }, { Display: "scriptExecutions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{scriptExecutionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}", "2023-09-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "scriptPackages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{scriptPackageName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}", "2023-09-01"), Children: []swagger.ResourceType{ { Display: "scriptCmdlets", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}/scriptCmdlets", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}/scriptCmdlets", "2023-09-01"), SubResources: []swagger.ResourceType{ { Display: "{scriptCmdletName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}/scriptCmdlets/{scriptCmdletName}", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}/scriptCmdlets/{scriptCmdletName}", "2023-09-01"), }}, }}, }}, }, { Display: "workloadNetworks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks", "2023-09-01"), Children: []swagger.ResourceType{ { - Display: "dhcpConfigurations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations", "2023-03-01"), - SubResources: []swagger.ResourceType{ + Display: "default", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default", "2023-09-01"), + Children: []swagger.ResourceType{ { - Display: "{dhcpId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}", "2023-03-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}", "2023-03-01"), - }}, - }, - { - Display: "dnsServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices", "2023-03-01"), - SubResources: []swagger.ResourceType{ + Display: "dhcpConfigurations", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations", "2023-09-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{dhcpId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}", "2023-09-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}", "2023-09-01"), + }}, + }, { - Display: "{dnsServiceId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}", "2023-03-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}", "2023-03-01"), - }}, - }, - { - Display: "dnsZones", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones", "2023-03-01"), - SubResources: []swagger.ResourceType{ + Display: "dnsServices", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices", "2023-09-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{dnsServiceId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}", "2023-09-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}", "2023-09-01"), + }}, + }, { - Display: "{dnsZoneId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}", "2023-03-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}", "2023-03-01"), - }}, - }, - { - Display: "gateways", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways", "2023-03-01"), - SubResources: []swagger.ResourceType{ + Display: "dnsZones", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones", "2023-09-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{dnsZoneId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}", "2023-09-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}", "2023-09-01"), + }}, + }, { - Display: "{gatewayId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways/{gatewayId}", "2023-03-01"), - }}, - }, - { - Display: "portMirroringProfiles", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles", "2023-03-01"), - SubResources: []swagger.ResourceType{ + Display: "gateways", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways", "2023-09-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{gatewayId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways/{gatewayId}", "2023-09-01"), + }}, + }, { - Display: "{portMirroringId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}", "2023-03-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}", "2023-03-01"), - }}, - }, - { - Display: "publicIPs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs", "2023-03-01"), - SubResources: []swagger.ResourceType{ + Display: "portMirroringProfiles", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles", "2023-09-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{portMirroringId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}", "2023-09-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}", "2023-09-01"), + }}, + }, { - Display: "{publicIPId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}", "2023-03-01"), - }}, - }, - { - Display: "segments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments", "2023-03-01"), - SubResources: []swagger.ResourceType{ + Display: "publicIPs", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs", "2023-09-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{publicIPId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}", "2023-09-01"), + }}, + }, { - Display: "{segmentId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}", "2023-03-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}", "2023-03-01"), - }}, - }, - { - Display: "virtualMachines", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines", "2023-03-01"), - SubResources: []swagger.ResourceType{ + Display: "segments", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments", "2023-09-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{segmentId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}", "2023-09-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}", "2023-09-01"), + }}, + }, { - Display: "{virtualMachineId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines/{virtualMachineId}", "2023-03-01"), - }}, - }, - { - Display: "vmGroups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups", "2023-03-01"), - SubResources: []swagger.ResourceType{ + Display: "virtualMachines", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines", "2023-09-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{virtualMachineId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines/{virtualMachineId}", "2023-09-01"), + }}, + }, { - Display: "{vmGroupId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}", "2023-03-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}", "2023-03-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}", "2023-03-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}", "2023-03-01"), + Display: "vmGroups", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups", "2023-09-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{vmGroupId}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}", "2023-09-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}", "2023-09-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}", "2023-09-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}", "2023-09-01"), + }}, }}, }}, - SubResources: []swagger.ResourceType{ - { - Display: "{workloadNetworkName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/{workloadNetworkName}", "2023-03-01"), - }}, }}, }}, }, @@ -20519,270 +20758,270 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "deletedSites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/deletedSites", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/deletedSites", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{deletedSiteId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/deletedSites/{deletedSiteId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/deletedSites/{deletedSiteId}", "2023-12-01"), }}, }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/operations/{operationId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/operations/{operationId}", "2023-12-01"), }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/usages", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/usages", "2023-12-01"), }, { Display: "certificateOrders", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{certificateOrderName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "certificates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}", "2023-12-01"), }}, }, { Display: "detectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/detectors", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/detectors", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{detectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/detectors/{detectorName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/detectors/{detectorName}", "2023-12-01"), }}, }}, }}, }, { Display: "domains", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{domainName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "domainOwnershipIdentifiers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}", "2023-12-01"), }}, }}, }}, }, { Display: "certificates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}", "2023-12-01"), }}, }, { Display: "containerApps", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "revisions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{containerAppName}/revisions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{containerAppName}/revisions", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{containerAppName}/revisions/{name}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{containerAppName}/revisions/{name}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{name}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{name}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{name}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{name}", "2023-12-01"), }}, }, { Display: "hostingEnvironments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "recommendationHistory", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendationHistory", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendationHistory", "2023-12-01"), }, { Display: "recommendations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations", "2023-12-01"), Children: []swagger.ResourceType{}, SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/{name}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/{name}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "compute", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute", "2023-12-01"), }, { Display: "virtualip", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip", "2023-12-01"), }, { Display: "customdnssuffix", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix", "2023-12-01"), }, { Display: "networking", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking", "2023-12-01"), }, { Display: "detectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{detectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}", "2023-12-01"), }}, }, { Display: "diagnostics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{diagnosticsName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}", "2023-12-01"), }}, }, { Display: "inboundNetworkDependenciesEndpoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints", "2023-12-01"), }, { Display: "multiRolePools", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "metricdefinitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions", "2023-12-01"), }, { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus", "2023-12-01"), }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages", "2023-12-01"), }}, SubResources: []swagger.ResourceType{ { Display: "metricdefinitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions", "2023-12-01"), }}, }}, }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations", "2023-12-01"), }, { Display: "outboundNetworkDependenciesEndpoints", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints", "2023-12-01"), }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateLinkResources", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateLinkResources", "2023-12-01"), }, { Display: "serverfarms", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms", "2023-12-01"), }, { Display: "sites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites", "2023-12-01"), }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages", "2023-12-01"), }, { Display: "workerPools", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{workerPoolName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "metricdefinitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions", "2023-12-01"), }, { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus", "2023-12-01"), }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages", "2023-12-01"), }}, SubResources: []swagger.ResourceType{ { Display: "metricdefinitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions", "2023-12-01"), }}, }}, }}, @@ -20790,240 +21029,240 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "kubeEnvironments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}", "2023-12-01"), }}, }, { Display: "resourceHealthMetadata", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/resourceHealthMetadata", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/resourceHealthMetadata", "2023-12-01"), }, { Display: "serverfarms", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "capabilities", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities", "2023-12-01"), }, { Display: "limit", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit", "2023-12-01"), }, { Display: "hybridConnectionRelays", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays", "2023-12-01"), }, { Display: "sites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites", "2023-12-01"), }, { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus", "2023-12-01"), }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages", "2023-12-01"), }, { Display: "virtualNetworkConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{vnetName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "routes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{routeName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}", "2023-12-01"), }}, }}, SubResources: []swagger.ResourceType{ { Display: "{gatewayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-12-01"), }}, }}, }}, SubResources: []swagger.ResourceType{ { Display: "{relayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "sites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites", "2023-12-01"), }}, }}, }}, }, { Display: "sites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "analyzeCustomHostname", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname", "2023-12-01"), }, { Display: "backups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{backupId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "basicPublishingCredentialsPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "ftp", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/ftp", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/ftp", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/ftp", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/ftp", "2023-12-01"), }, { Display: "scm", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm", "2023-12-01"), }}, }, { Display: "config", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "appsettings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list", "2023-12-01"), Verb: "POST", - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings", "2023-01-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings", "2023-12-01"), }, { Display: "authsettings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list", "2023-12-01"), Verb: "POST", - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings", "2023-01-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings", "2023-12-01"), }, { Display: "authsettingsV2", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "authsettingsV2", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/list", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/list", "2023-12-01"), }}, }, { Display: "azurestorageaccounts", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts/list", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts/list", "2023-12-01"), Verb: "POST", - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts", "2023-01-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts", "2023-12-01"), }, { Display: "backup", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list", "2023-12-01"), Verb: "POST", - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup", "2023-01-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup", "2023-12-01"), }, { Display: "appsettings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{appSettingKey}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings/{appSettingKey}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings/{appSettingKey}", "2023-12-01"), }}, }, { Display: "connectionstrings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{connectionStringKey}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings/{connectionStringKey}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings/{connectionStringKey}", "2023-12-01"), }}, }, { Display: "connectionstrings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list", "2023-12-01"), Verb: "POST", - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings", "2023-01-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings", "2023-12-01"), }, { Display: "logs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs", "2023-12-01"), }, { Display: "metadata", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list", "2023-12-01"), Verb: "POST", - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata", "2023-01-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata", "2023-12-01"), }, { Display: "publishingcredentials", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list", "2023-12-01"), Verb: "POST", }, { Display: "pushsettings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list", "2023-12-01"), Verb: "POST", - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings", "2023-01-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings", "2023-12-01"), }, { Display: "slotConfigNames", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames", "2023-12-01"), }, { Display: "web", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "snapshots", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{snapshotId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -21031,155 +21270,155 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "continuouswebjobs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{webJobName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "deploymentStatus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{deploymentStatusId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus/{deploymentStatusId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus/{deploymentStatusId}", "2023-12-01"), }}, }, { Display: "deployments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{id}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "log", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log", "2023-12-01"), }}, }}, }, { Display: "domainOwnershipIdentifiers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{domainOwnershipIdentifierName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-12-01"), }}, }, { Display: "MSDeploy", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "log", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log", "2023-12-01"), }}, }, { Display: "onedeploy", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/onedeploy", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/onedeploy", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/onedeploy", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/onedeploy", "2023-12-01"), }, { Display: "functions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "token", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token", "2023-12-01"), }}, SubResources: []swagger.ResourceType{ { Display: "{functionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}", "2023-12-01"), Children: []swagger.ResourceType{}, SubResources: []swagger.ResourceType{}, }}, }, { Display: "hostNameBindings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{hostName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}", "2023-12-01"), }}, }, { Display: "hybridConnectionRelays", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays", "2023-12-01"), }, { Display: "hybridconnection", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{entityName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}", "2023-12-01"), }}, }, { Display: "instances", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{instanceId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "MSDeploy", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "log", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log", "2023-12-01"), }}, }, { Display: "processes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{processId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "dump", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump", "2023-12-01"), }, { Display: "modules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{baseAddress}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}", "2023-12-01"), }}, }, { Display: "threads", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads", "2023-12-01"), }}, }}, }}, @@ -21187,201 +21426,212 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "virtualNetwork", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork", "2023-12-01"), }, { Display: "perfcounters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters", "2023-12-01"), }, { Display: "phplogging", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging", "2023-12-01"), }, { Display: "premieraddons", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{premierAddOnName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}", "2023-12-01"), }}, }, { Display: "virtualNetworks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks", "2023-12-01"), }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateLinkResources", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateLinkResources", "2023-12-01"), }, { Display: "processes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{processId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "dump", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump", "2023-12-01"), }, { Display: "modules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{baseAddress}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}", "2023-12-01"), }}, }, { Display: "threads", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads", "2023-12-01"), }}, }}, }, { Display: "publicCertificates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{publicCertificateName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}", "2023-12-01"), }}, }, { Display: "resourceHealthMetadata", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata/default", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata/default", "2023-12-01"), + }}, + }, + { + Display: "sitecontainers", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers", "2023-12-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{containerName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers/{containerName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers/{containerName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers/{containerName}", "2023-12-01"), }}, }, { Display: "siteextensions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{siteExtensionId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}", "2023-12-01"), }}, }, { Display: "slots", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{slot}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "analyzeCustomHostname", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname", "2023-12-01"), }, { Display: "backups", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{backupId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "basicPublishingCredentialsPolicies", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "ftp", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/ftp", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/ftp", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/ftp", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/ftp", "2023-12-01"), }, { Display: "scm", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/scm", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/scm", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/scm", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/scm", "2023-12-01"), }}, }, { Display: "config", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "authsettingsV2", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "authsettingsV2", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2/list", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2/list", "2023-12-01"), }}, }, { Display: "appsettings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{appSettingKey}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings/{appSettingKey}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings/{appSettingKey}", "2023-12-01"), }}, }, { Display: "connectionstrings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{connectionStringKey}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings/{connectionStringKey}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings/{connectionStringKey}", "2023-12-01"), }}, }, { Display: "logs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs", "2023-12-01"), }, { Display: "web", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "snapshots", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{snapshotId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -21389,150 +21639,150 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "continuouswebjobs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{webJobName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "deploymentStatus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{deploymentStatusId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus/{deploymentStatusId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus/{deploymentStatusId}", "2023-12-01"), }}, }, { Display: "deployments", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{id}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "log", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log", "2023-12-01"), }}, }}, }, { Display: "domainOwnershipIdentifiers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{domainOwnershipIdentifierName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}", "2023-12-01"), }}, }, { Display: "MSDeploy", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "log", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log", "2023-12-01"), }}, }, { Display: "functions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "token", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token", "2023-12-01"), }}, SubResources: []swagger.ResourceType{ { Display: "{functionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}", "2023-12-01"), Children: []swagger.ResourceType{}, SubResources: []swagger.ResourceType{}, }}, }, { Display: "hostNameBindings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{hostName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}", "2023-12-01"), }}, }, { Display: "hybridConnectionRelays", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays", "2023-12-01"), }, { Display: "hybridconnection", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{entityName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}", "2023-12-01"), }}, }, { Display: "instances", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{instanceId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "MSDeploy", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "log", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log", "2023-12-01"), }}, }, { Display: "processes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{processId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "dump", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump", "2023-12-01"), }, { Display: "modules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{baseAddress}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}", "2023-12-01"), }}, }, { Display: "threads", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads", "2023-12-01"), }}, }}, }}, @@ -21540,339 +21790,350 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "status", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status", "2023-12-01"), }, { Display: "virtualNetwork", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork", "2023-12-01"), }, { Display: "perfcounters", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters", "2023-12-01"), }, { Display: "phplogging", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging", "2023-12-01"), }, { Display: "premieraddons", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{premierAddOnName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}", "2023-12-01"), }}, }, { Display: "virtualNetworks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks", "2023-12-01"), }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateLinkResources", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateLinkResources", "2023-12-01"), }, { Display: "processes", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{processId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "dump", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump", "2023-12-01"), }, { Display: "modules", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{baseAddress}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{baseAddress}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{baseAddress}", "2023-12-01"), }}, }, { Display: "threads", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads", "2023-12-01"), }}, }}, }, { Display: "publicCertificates", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{publicCertificateName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}", "2023-12-01"), }}, }, { Display: "resourceHealthMetadata", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "default", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata/default", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata/default", "2023-12-01"), + }}, + }, + { + Display: "sitecontainers", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers", "2023-12-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{containerName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers/{containerName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers/{containerName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers/{containerName}", "2023-12-01"), }}, }, { Display: "siteextensions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{siteExtensionId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}", "2023-12-01"), }}, }, { Display: "snapshots", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots", "2023-12-01"), }, { Display: "snapshotsdr", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshotsdr", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshotsdr", "2023-12-01"), }, { Display: "web", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web", "2023-12-01"), }, { Display: "triggeredwebjobs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{webJobName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "history", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{id}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history/{id}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history/{id}", "2023-12-01"), }}, }}, }}, }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages", "2023-12-01"), }, { Display: "virtualNetworkConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{vnetName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{gatewayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-12-01"), }}, }}, }, { Display: "webjobs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{webJobName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName}", "2023-12-01"), }}, }, { Display: "workflows", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{workflowName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows/{workflowName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows/{workflowName}", "2023-12-01"), }}, }}, SubResources: []swagger.ResourceType{ { Display: "{relayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-12-01"), }, { Display: "{view}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}", "2023-12-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/operationresults/{operationId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/operationresults/{operationId}", "2023-12-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/{operationId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/{operationId}", "2023-12-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/current/operationresults/{operationId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/current/operationresults/{operationId}", "2023-12-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/{operationId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/{operationId}", "2023-12-01"), }}, }}, }, { Display: "snapshots", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots", "2023-12-01"), }, { Display: "snapshotsdr", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshotsdr", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshotsdr", "2023-12-01"), }, { Display: "web", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web", "2023-12-01"), }, { Display: "triggeredwebjobs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{webJobName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "history", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{id}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id}", "2023-12-01"), }}, }}, }}, }, { Display: "usages", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages", "2023-12-01"), }, { Display: "virtualNetworkConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{vnetName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{gatewayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}", "2023-12-01"), }}, }}, }, { Display: "webjobs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{webJobName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName}", "2023-12-01"), }}, }, { Display: "workflows", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{workflowName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows/{workflowName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows/{workflowName}", "2023-12-01"), }}, }}, SubResources: []swagger.ResourceType{ { Display: "runs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{runName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "actions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{actionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "repetitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{repetitionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "requestHistories", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{requestHistoryName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories/{requestHistoryName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories/{requestHistoryName}", "2023-12-01"), }}, }}, }}, }, { Display: "scopeRepetitions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{repetitionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions/{repetitionName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions/{repetitionName}", "2023-12-01"), }}, }}, }}, @@ -21881,99 +22142,99 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "triggers", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{triggerName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "histories", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{historyName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "json", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/schemas/json", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/schemas/json", "2023-12-01"), }}, }}, }, { Display: "versions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/versions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/versions", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{versionId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/versions/{versionId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/versions/{versionId}", "2023-12-01"), }}, }, { Display: "{relayName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}", "2023-12-01"), }, { Display: "{view}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}", "2023-12-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/operationresults/{operationId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/operationresults/{operationId}", "2023-12-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/{operationId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/{operationId}", "2023-12-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId}", "2023-12-01"), }, { Display: "{operationId}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId}", "2023-12-01"), }}, }, { Display: "detectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{detectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors/{detectorName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors/{detectorName}", "2023-12-01"), }}, }, { Display: "diagnostics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{diagnosticCategory}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "analyses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{analysisName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "detectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{detectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -21981,53 +22242,53 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "recommendationHistory", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory", "2023-12-01"), }, { Display: "recommendations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations", "2023-12-01"), Children: []swagger.ResourceType{}, SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "detectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{detectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors/{detectorName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors/{detectorName}", "2023-12-01"), }}, }, { Display: "diagnostics", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{diagnosticCategory}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "analyses", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{analysisName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "detectors", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{detectorName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }}, @@ -22036,153 +22297,153 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "staticSites", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{name}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "basicAuth", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{basicAuthName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth/{basicAuthName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth/{basicAuthName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth/{basicAuthName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth/{basicAuthName}", "2023-12-01"), }}, }, { Display: "builds", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{environmentName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}", "2023-12-01"), Children: []swagger.ResourceType{ { Display: "databaseConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{databaseConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "functions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/functions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/functions", "2023-12-01"), }, { Display: "linkedBackends", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{linkedBackendName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "userProvidedFunctionApps", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{functionAppName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}", "2023-12-01"), }}, }}, }}, }, { Display: "appsettings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listAppSettings", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listAppSettings", "2023-12-01"), Verb: "POST", - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/appsettings", "2023-01-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/appsettings", "2023-12-01"), }, { Display: "functionappsettings", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listFunctionAppSettings", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listFunctionAppSettings", "2023-12-01"), Verb: "POST", - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/functionappsettings", "2023-01-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/functionappsettings", "2023-12-01"), }, { Display: "customDomains", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{domainName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "databaseConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{databaseConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}", "2023-01-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}", "2023-12-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "functions", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/functions", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/functions", "2023-12-01"), }, { Display: "linkedBackends", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{linkedBackendName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}", "2023-12-01"), Children: []swagger.ResourceType{}, }}, }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-12-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateLinkResources", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateLinkResources", "2023-12-01"), }, { Display: "userProvidedFunctionApps", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{functionAppName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName}", "2023-01-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName}", "2023-12-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName}", "2023-12-01"), }}, }}, SubResources: []swagger.ResourceType{}, @@ -22190,55 +22451,104 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "webPubSub", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub", "2021-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{resourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}", "2021-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}", "2021-10-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}", "2021-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}", "2021-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}", "2024-03-01"), Children: []swagger.ResourceType{ + { + Display: "customCertificates", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates", "2024-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{certificateName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}", "2024-03-01"), + }}, + }, + { + Display: "customDomains", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains", "2024-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{name}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}", "2024-03-01"), + }}, + }, { Display: "hubs", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs", "2021-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{hubName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}", "2021-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}", "2021-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}", "2021-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}", "2024-03-01"), }}, }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections", "2021-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2021-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2021-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2021-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2024-03-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateLinkResources", "2021-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateLinkResources", "2024-03-01"), + }, + { + Display: "replicas", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas", "2024-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{replicaName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}", "2024-03-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}", "2024-03-01"), + Children: []swagger.ResourceType{ + { + Display: "sharedPrivateLinkResources", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources", "2024-03-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{sharedPrivateLinkResourceName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2024-03-01"), + }}, + }, + { + Display: "skus", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/skus", "2024-03-01"), + }}, + }}, }, { Display: "sharedPrivateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources", "2021-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources", "2024-03-01"), SubResources: []swagger.ResourceType{ { Display: "{sharedPrivateLinkResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2021-10-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2021-10-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2021-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2024-03-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2024-03-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2024-03-01"), }}, }, { Display: "skus", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/skus", "2021-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/skus", "2024-03-01"), }}, }}, }, @@ -22415,6 +22725,17 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }}, }}, }, + { + Display: "pricings", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scopeId}/providers/Microsoft.Security/pricings", "2024-01-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{pricingName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scopeId}/providers/Microsoft.Security/pricings/{pricingName}", "2024-01-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scopeId}/providers/Microsoft.Security/pricings/{pricingName}", "2024-01-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/{scopeId}/providers/Microsoft.Security/pricings/{pricingName}", "2024-01-01"), + }}, + }, { Display: "assessments", Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Security/assessments", "2021-06-01"), @@ -22494,7 +22815,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.SecurityInsights/operations", "2023-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.SecurityInsights/operations", "2024-03-01"), }, { Display: "operations", @@ -22502,7 +22823,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ServiceFabric/operations", "2023-11-01-preview"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ServiceFabric/operations", "2024-04-01"), }, { Display: "operations", @@ -22510,11 +22831,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.ServiceNetworking/operations", "2023-11-01"), - }, - { - Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.SignalRService/operations", "2021-10-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.SignalRService/operations", "2024-03-01"), }, { Display: "hybridUseBenefits", @@ -22543,7 +22860,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.SqlVirtualMachine/operations", "2022-02-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.SqlVirtualMachine/operations", "2023-10-01"), }, { Display: "operations", @@ -22551,7 +22868,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Storage/operations", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Storage/operations", "2023-05-01"), }, { Display: "operations", @@ -22559,7 +22876,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.StorageCache/operations", "2023-05-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.StorageCache/operations", "2024-03-01"), }, { Display: "locations", @@ -22623,25 +22940,73 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { Display: "acceptOwnershipStatus", Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Subscription/subscriptions/{subscriptionId}/acceptOwnershipStatus", "2021-10-01"), }, + { + Display: "{fileWorkspaceName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}", "2024-04-01"), + Children: []swagger.ResourceType{ + { + Display: "files", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files", "2024-04-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{fileName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}", "2024-04-01"), + Children: []swagger.ResourceType{}, + }}, + }}, + }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/operations", "2020-04-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/operations", "2024-04-01"), }, { Display: "services", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/services", "2020-04-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/services", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{serviceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/services/{serviceName}", "2020-04-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/services/{serviceName}", "2024-04-01"), Children: []swagger.ResourceType{ { Display: "problemClassifications", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/services/{serviceName}/problemClassifications", "2020-04-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/services/{serviceName}/problemClassifications", "2024-04-01"), SubResources: []swagger.ResourceType{ { Display: "{problemClassificationName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/services/{serviceName}/problemClassifications/{problemClassificationName}", "2020-04-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/services/{serviceName}/problemClassifications/{problemClassificationName}", "2024-04-01"), + }}, + }}, + }}, + }, + { + Display: "supportTickets", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/supportTickets", "2024-04-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{supportTicketName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/supportTickets/{supportTicketName}", "2024-04-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/supportTickets/{supportTicketName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/supportTickets/{supportTicketName}", "2024-04-01"), + Children: []swagger.ResourceType{ + { + Display: "chatTranscripts", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts", "2024-04-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{chatTranscriptName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts/{chatTranscriptName}", "2024-04-01"), + }}, + }, + { + Display: "communications", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications", "2024-04-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{communicationName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}", "2024-04-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}", "2024-04-01"), }}, }}, }}, @@ -22660,7 +23025,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.AVS/operations", "2023-03-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.AVS/operations", "2023-09-01"), }, { Display: "operations", @@ -22668,50 +23033,50 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CertificateRegistration/operations", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.CertificateRegistration/operations", "2023-12-01"), }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DomainRegistration/operations", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.DomainRegistration/operations", "2023-12-01"), }, { Display: "availableStacks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/availableStacks", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/availableStacks", "2023-12-01"), }, { Display: "functionAppStacks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/functionAppStacks", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/functionAppStacks", "2023-12-01"), }, { Display: "functionAppStacks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/locations/{location}/functionAppStacks", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/locations/{location}/functionAppStacks", "2023-12-01"), }, { Display: "webAppStacks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/locations/{location}/webAppStacks", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/locations/{location}/webAppStacks", "2023-12-01"), }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/operations", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/operations", "2023-12-01"), }, { Display: "web", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/publishingUsers/web", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/publishingUsers/web", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/publishingUsers/web", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/publishingUsers/web", "2023-12-01"), }, { Display: "sourcecontrols", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/sourcecontrols", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/sourcecontrols", "2023-12-01"), SubResources: []swagger.ResourceType{ { Display: "{sourceControlType}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/sourcecontrols/{sourceControlType}", "2023-01-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/sourcecontrols/{sourceControlType}", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/sourcecontrols/{sourceControlType}", "2023-12-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/sourcecontrols/{sourceControlType}", "2023-12-01"), }}, }, { Display: "webAppStacks", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/webAppStacks", "2023-01-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Web/webAppStacks", "2023-12-01"), }, { Display: "operations", diff --git a/scripts/swagger_update/app.py b/scripts/swagger_update/app.py index 8fed269b7..82267cec3 100644 --- a/scripts/swagger_update/app.py +++ b/scripts/swagger_update/app.py @@ -29,6 +29,9 @@ # This allows you to augment the included files for each README.MD for a specific tag # this is useful when files which are needed are incorrectly left out of the 'input-file' resource_provider_input_file_additions = { + "compute": { + "package-2024-03-01": ["./Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json"] + } # Example: # "cosmos-db" : { # "package-2020-04" : ["./Microsoft.DocumentDB/stable/2019-08-01/cosmos-db.json"] diff --git a/swagger-specs/ai/data-plane/ImageAnalysis/api-set.json b/swagger-specs/ai/data-plane/ImageAnalysis/api-set.json new file mode 100644 index 000000000..76bef1c3a --- /dev/null +++ b/swagger-specs/ai/data-plane/ImageAnalysis/api-set.json @@ -0,0 +1 @@ +{"addition_input_file_paths": [], "input_files": ["stable/2023-10-01/generated.json"], "name": "package-2023-10-01"} \ No newline at end of file diff --git a/swagger-specs/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json b/swagger-specs/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json new file mode 100644 index 000000000..334ece272 --- /dev/null +++ b/swagger-specs/ai/data-plane/ImageAnalysis/stable/2023-10-01/generated.json @@ -0,0 +1,930 @@ +{ + "swagger": "2.0", + "info": { + "title": "Image Analysis", + "version": "2023-10-01", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/computervision", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "Azure AI Computer Vision endpoint (protocol and hostname, for example:\nhttps://.cognitiveservices.azure.com).", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "AadOauth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "AadOauth2Auth": { + "type": "oauth2", + "description": "The Azure Active Directory OAuth2 Flow", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + }, + "ApiKeyAuth": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "tags": [], + "paths": { + "/imageanalysis:analyze": { + "post": { + "operationId": "AnalyzeFromImageData", + "description": "Performs a single Image Analysis operation", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "features", + "in": "query", + "description": "A list of visual features to analyze.\nSeven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.\nAt least one visual feature must be specified.", + "required": true, + "type": "array", + "items": { + "type": "string", + "enum": [ + "tags", + "caption", + "denseCaptions", + "objects", + "read", + "smartCrops", + "people" + ], + "x-ms-enum": { + "name": "VisualFeatures", + "modelAsString": true, + "values": [ + { + "name": "tags", + "value": "tags", + "description": "Extract content tags for thousands of recognizable objects, living beings, scenery, and actions that appear in the image." + }, + { + "name": "caption", + "value": "caption", + "description": "Generate a human-readable caption sentence that describes the content of the image." + }, + { + "name": "denseCaptions", + "value": "denseCaptions", + "description": "Generate human-readable caption sentences for up to 10 different regions in the image, including one for the whole image." + }, + { + "name": "objects", + "value": "objects", + "description": "Object detection. This is similar to tags, but focused on detecting physical objects in the image and returning their location." + }, + { + "name": "read", + "value": "read", + "description": "Extract printed or handwritten text from the image. Also known as Optical Character Recognition (OCR)." + }, + { + "name": "smartCrops", + "value": "smartCrops", + "description": "Find representative sub-regions of the image for thumbnail generation, at desired aspect ratios, with priority given to detected faces." + }, + { + "name": "people", + "value": "people", + "description": "Detect people in the image and return their location." + } + ] + } + }, + "collectionFormat": "csv", + "minItems": 1, + "x-ms-client-name": "visualFeatures" + }, + { + "name": "language", + "in": "query", + "description": "The desired language for result generation (a two-letter language code).\nIf this option is not specified, the default value 'en' is used (English).\nSee https://aka.ms/cv-languages for a list of supported languages.", + "required": false, + "type": "string", + "default": "en", + "minLength": 2 + }, + { + "name": "gender-neutral-caption", + "in": "query", + "description": "Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features.\nBy default captions may contain gender terms (for example: 'man', 'woman', or 'boy', 'girl'). \nIf you set this to \"true\", those will be replaced with gender-neutral terms (for example: 'person' or 'child').", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "genderNeutralCaption" + }, + { + "name": "smartcrops-aspect-ratios", + "in": "query", + "description": "A list of aspect ratios to use for smart cropping.\nAspect ratios are calculated by dividing the target crop width in pixels by the height in pixels.\nSupported values are between 0.75 and 1.8 (inclusive).\nIf this parameter is not specified, the service will return one crop region with an aspect\nratio it sees fit between 0.5 and 2.0 (inclusive).", + "required": false, + "type": "array", + "items": { + "type": "number", + "format": "float" + }, + "collectionFormat": "csv", + "x-ms-client-name": "smartCropsAspectRatios" + }, + { + "name": "model-version", + "in": "query", + "description": "The version of cloud AI-model used for analysis.\nThe format is the following: 'latest' (default value) or 'YYYY-MM-DD' or 'YYYY-MM-DD-preview', where 'YYYY', 'MM', 'DD' are the year, month and day associated with the model.\nThis is not commonly set, as the default always gives the latest AI model with recent improvements.\nIf however you would like to make sure analysis results do not change over time, set this value to a specific model version.", + "required": false, + "type": "string", + "default": "latest", + "minLength": 6, + "maxLength": 18, + "pattern": "^(latest|\\d{4}-\\d{2}-\\d{2})(-preview)?$", + "x-ms-client-name": "modelVersion" + }, + { + "name": "imageData", + "in": "body", + "description": "The image to be analyzed", + "required": true, + "schema": { + "type": "string", + "format": "binary" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageAnalysisResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "AnalyzeFromImageData": { + "$ref": "./examples/AnalyzeFromImageData_MaximumSet.json" + } + } + } + } + }, + "x-ms-paths": { + "/imageanalysis:analyze?_overload=analyzeFromUrl": { + "post": { + "operationId": "AnalyzeFromUrl", + "description": "Performs a single Image Analysis operation", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "features", + "in": "query", + "description": "A list of visual features to analyze.\nSeven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.\nAt least one visual feature must be specified.", + "required": true, + "type": "array", + "items": { + "type": "string", + "enum": [ + "tags", + "caption", + "denseCaptions", + "objects", + "read", + "smartCrops", + "people" + ], + "x-ms-enum": { + "name": "VisualFeatures", + "modelAsString": true, + "values": [ + { + "name": "tags", + "value": "tags", + "description": "Extract content tags for thousands of recognizable objects, living beings, scenery, and actions that appear in the image." + }, + { + "name": "caption", + "value": "caption", + "description": "Generate a human-readable caption sentence that describes the content of the image." + }, + { + "name": "denseCaptions", + "value": "denseCaptions", + "description": "Generate human-readable caption sentences for up to 10 different regions in the image, including one for the whole image." + }, + { + "name": "objects", + "value": "objects", + "description": "Object detection. This is similar to tags, but focused on detecting physical objects in the image and returning their location." + }, + { + "name": "read", + "value": "read", + "description": "Extract printed or handwritten text from the image. Also known as Optical Character Recognition (OCR)." + }, + { + "name": "smartCrops", + "value": "smartCrops", + "description": "Find representative sub-regions of the image for thumbnail generation, at desired aspect ratios, with priority given to detected faces." + }, + { + "name": "people", + "value": "people", + "description": "Detect people in the image and return their location." + } + ] + } + }, + "collectionFormat": "csv", + "minItems": 1, + "x-ms-client-name": "visualFeatures" + }, + { + "name": "language", + "in": "query", + "description": "The desired language for result generation (a two-letter language code).\nIf this option is not specified, the default value 'en' is used (English).\nSee https://aka.ms/cv-languages for a list of supported languages.", + "required": false, + "type": "string", + "default": "en", + "minLength": 2 + }, + { + "name": "gender-neutral-caption", + "in": "query", + "description": "Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features.\nBy default captions may contain gender terms (for example: 'man', 'woman', or 'boy', 'girl'). \nIf you set this to \"true\", those will be replaced with gender-neutral terms (for example: 'person' or 'child').", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "genderNeutralCaption" + }, + { + "name": "smartcrops-aspect-ratios", + "in": "query", + "description": "A list of aspect ratios to use for smart cropping.\nAspect ratios are calculated by dividing the target crop width in pixels by the height in pixels.\nSupported values are between 0.75 and 1.8 (inclusive).\nIf this parameter is not specified, the service will return one crop region with an aspect\nratio it sees fit between 0.5 and 2.0 (inclusive).", + "required": false, + "type": "array", + "items": { + "type": "number", + "format": "float" + }, + "collectionFormat": "csv", + "x-ms-client-name": "smartCropsAspectRatios" + }, + { + "name": "model-version", + "in": "query", + "description": "The version of cloud AI-model used for analysis.\nThe format is the following: 'latest' (default value) or 'YYYY-MM-DD' or 'YYYY-MM-DD-preview', where 'YYYY', 'MM', 'DD' are the year, month and day associated with the model.\nThis is not commonly set, as the default always gives the latest AI model with recent improvements.\nIf however you would like to make sure analysis results do not change over time, set this value to a specific model version.", + "required": false, + "type": "string", + "default": "latest", + "minLength": 6, + "maxLength": 18, + "pattern": "^(latest|\\d{4}-\\d{2}-\\d{2})(-preview)?$", + "x-ms-client-name": "modelVersion" + }, + { + "name": "imageUrl", + "in": "body", + "description": "The image to be analyzed", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrl" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageAnalysisResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "AnalyzeFromUrl": { + "$ref": "./examples/AnalyzeFromUrl_MaximumSet.json" + } + } + } + } + }, + "definitions": { + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "CaptionResult": { + "type": "object", + "description": "Represents a generated phrase that describes the content of the whole image.", + "properties": { + "confidence": { + "type": "number", + "format": "float", + "description": "A score, in the range of 0 to 1 (inclusive), representing the confidence that this description is accurate.\nHigher values indicating higher confidence.", + "minimum": 0, + "maximum": 1 + }, + "text": { + "type": "string", + "description": "The text of the caption.", + "minLength": 1 + } + }, + "required": [ + "confidence", + "text" + ] + }, + "CropRegion": { + "type": "object", + "description": "A region at the desired aspect ratio that can be used as image thumbnail.\nThe region preserves as much content as possible from the analyzed image, with priority given to detected faces.", + "properties": { + "aspectRatio": { + "type": "number", + "format": "float", + "description": "The aspect ratio of the crop region.\nAspect ratio is calculated by dividing the width of the region in pixels by its height in pixels.\nThe aspect ratio will be in the range 0.75 to 1.8 (inclusive) if provided by the developer during the analyze call.\nOtherwise, it will be in the range 0.5 to 2.0 (inclusive).", + "minimum": 0 + }, + "boundingBox": { + "$ref": "#/definitions/ImageBoundingBox", + "description": "The bounding box of the region." + } + }, + "required": [ + "aspectRatio", + "boundingBox" + ] + }, + "DenseCaption": { + "type": "object", + "description": "Represents a generated phrase that describes the content of the whole image or a region in the image", + "properties": { + "confidence": { + "type": "number", + "format": "float", + "description": "A score, in the range of 0 to 1 (inclusive), representing the confidence that this description is accurate.\nHigher values indicating higher confidence.", + "minimum": 0, + "maximum": 1 + }, + "text": { + "type": "string", + "description": "The text of the caption.", + "minLength": 1 + }, + "boundingBox": { + "$ref": "#/definitions/ImageBoundingBox", + "description": "The image region of which this caption applies." + } + }, + "required": [ + "confidence", + "text", + "boundingBox" + ] + }, + "DenseCaptionsResult": { + "type": "object", + "description": "Represents a list of up to 10 image captions for different regions of the image.\nThe first caption always applies to the whole image.", + "properties": { + "values": { + "type": "array", + "description": "The list of image captions.", + "minItems": 1, + "items": { + "$ref": "#/definitions/DenseCaption" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "values" + ] + }, + "DetectedObject": { + "type": "object", + "description": "Represents a physical object detected in an image.", + "properties": { + "boundingBox": { + "$ref": "#/definitions/ImageBoundingBox", + "description": "A rectangular boundary where the object was detected." + }, + "tags": { + "type": "array", + "description": "A single-item list containing the object information.", + "minItems": 0, + "items": { + "$ref": "#/definitions/DetectedTag" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "boundingBox", + "tags" + ] + }, + "DetectedPerson": { + "type": "object", + "description": "Represents a person detected in an image.", + "properties": { + "boundingBox": { + "$ref": "#/definitions/ImageBoundingBox", + "description": "A rectangular boundary where the person was detected.", + "readOnly": true + }, + "confidence": { + "type": "number", + "format": "float", + "description": "A score, in the range of 0 to 1 (inclusive), representing the confidence that this detection was accurate.\nHigher values indicating higher confidence.", + "minimum": 0, + "maximum": 1, + "readOnly": true + } + }, + "required": [ + "boundingBox", + "confidence" + ] + }, + "DetectedTag": { + "type": "object", + "description": "A content entity observation in the image. A tag can be a physical object, living being, scenery, or action\nthat appear in the image.", + "properties": { + "confidence": { + "type": "number", + "format": "float", + "description": "A score, in the range of 0 to 1 (inclusive), representing the confidence that this entity was observed.\nHigher values indicating higher confidence.", + "minimum": 0, + "maximum": 1 + }, + "name": { + "type": "string", + "description": "Name of the entity.", + "minLength": 1 + } + }, + "required": [ + "confidence", + "name" + ] + }, + "DetectedTextBlock": { + "type": "object", + "description": "Represents a single block of detected text in the image.", + "properties": { + "lines": { + "type": "array", + "description": "A list of text lines in this block.", + "minItems": 1, + "items": { + "$ref": "#/definitions/DetectedTextLine" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "lines" + ] + }, + "DetectedTextLine": { + "type": "object", + "description": "Represents a single line of text in the image.", + "properties": { + "text": { + "type": "string", + "description": "Text content of the detected text line.", + "minLength": 1 + }, + "boundingPolygon": { + "type": "array", + "description": "A bounding polygon around the text line. At the moment only quadrilaterals are supported (represented by 4 image points).", + "minItems": 4, + "maxItems": 4, + "items": { + "$ref": "#/definitions/ImagePoint" + }, + "x-ms-identifiers": [] + }, + "words": { + "type": "array", + "description": "A list of words in this line.", + "minItems": 1, + "items": { + "$ref": "#/definitions/DetectedTextWord" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "text", + "boundingPolygon", + "words" + ] + }, + "DetectedTextWord": { + "type": "object", + "description": "A word object consisting of a contiguous sequence of characters. For non-space delimited languages,\r\nsuch as Chinese, Japanese, and Korean, each character is represented as its own word.", + "properties": { + "text": { + "type": "string", + "description": "Text content of the word.", + "minLength": 1 + }, + "boundingPolygon": { + "type": "array", + "description": "A bounding polygon around the word. At the moment only quadrilaterals are supported (represented by 4 image points).", + "minItems": 4, + "maxItems": 4, + "items": { + "$ref": "#/definitions/ImagePoint" + }, + "x-ms-identifiers": [] + }, + "confidence": { + "type": "number", + "format": "float", + "description": "The level of confidence that the word was detected. Confidence scores span the range of 0.0 to 1.0 (inclusive), with higher values indicating a higher confidence of detection.", + "minimum": 0, + "maximum": 1 + } + }, + "required": [ + "text", + "boundingPolygon", + "confidence" + ] + }, + "ImageAnalysisResult": { + "type": "object", + "description": "Represents the outcome of an Image Analysis operation.", + "properties": { + "captionResult": { + "$ref": "#/definitions/CaptionResult", + "description": "The generated phrase that describes the content of the analyzed image.", + "x-ms-client-name": "caption" + }, + "denseCaptionsResult": { + "$ref": "#/definitions/DenseCaptionsResult", + "description": "The up to 10 generated phrases, the first describing the content of the whole image,\nand the others describing the content of different regions of the image.", + "x-ms-client-name": "denseCaptions" + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata", + "description": "Metadata associated with the analyzed image." + }, + "modelVersion": { + "type": "string", + "description": "The cloud AI model used for the analysis" + }, + "objectsResult": { + "$ref": "#/definitions/ObjectsResult", + "description": "A list of detected physical objects in the analyzed image, and their location.", + "x-ms-client-name": "objects" + }, + "peopleResult": { + "$ref": "#/definitions/PeopleResult", + "description": "A list of detected people in the analyzed image, and their location.", + "x-ms-client-name": "people" + }, + "readResult": { + "$ref": "#/definitions/ReadResult", + "description": "The extracted printed and hand-written text in the analyze image. Also knows as OCR.", + "x-ms-client-name": "read" + }, + "smartCropsResult": { + "$ref": "#/definitions/SmartCropsResult", + "description": "A list of crop regions at the desired as aspect ratios (if provided) that can be used as image thumbnails.\nThese regions preserve as much content as possible from the analyzed image, with priority given to detected faces.", + "x-ms-client-name": "smartCrops" + }, + "tagsResult": { + "$ref": "#/definitions/TagsResult", + "description": "A list of content tags in the analyzed image.", + "x-ms-client-name": "tags" + } + }, + "required": [ + "metadata", + "modelVersion" + ] + }, + "ImageBoundingBox": { + "type": "object", + "description": "A basic rectangle specifying a sub-region of the image.", + "properties": { + "x": { + "type": "integer", + "format": "int32", + "description": "X-coordinate of the top left point of the area, in pixels.", + "minimum": 0 + }, + "y": { + "type": "integer", + "format": "int32", + "description": "Y-coordinate of the top left point of the area, in pixels.", + "minimum": 0 + }, + "w": { + "type": "integer", + "format": "int32", + "description": "Width of the area, in pixels.", + "minimum": 0, + "x-ms-client-name": "width" + }, + "h": { + "type": "integer", + "format": "int32", + "description": "Height of the area, in pixels.", + "minimum": 0, + "x-ms-client-name": "height" + } + }, + "required": [ + "x", + "y", + "w", + "h" + ] + }, + "ImageMetadata": { + "type": "object", + "description": "Metadata associated with the analyzed image.", + "properties": { + "height": { + "type": "integer", + "format": "int32", + "description": "The height of the image in pixels.", + "minimum": 1 + }, + "width": { + "type": "integer", + "format": "int32", + "description": "The width of the image in pixels.", + "minimum": 1 + } + }, + "required": [ + "height", + "width" + ] + }, + "ImagePoint": { + "type": "object", + "description": "Represents the coordinates of a single pixel in the image.", + "properties": { + "x": { + "type": "integer", + "format": "int32", + "description": "The horizontal x-coordinate of this point, in pixels. Zero values corresponds to the left-most pixels in the image.", + "minimum": 0 + }, + "y": { + "type": "integer", + "format": "int32", + "description": "The vertical y-coordinate of this point, in pixels. Zero values corresponds to the top-most pixels in the image.", + "minimum": 0 + } + }, + "required": [ + "x", + "y" + ] + }, + "ImageUrl": { + "type": "object", + "description": "An object holding the publicly reachable URL of an image to analyze.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "Publicly reachable URL of an image to analyze." + } + }, + "required": [ + "url" + ] + }, + "ObjectsResult": { + "type": "object", + "description": "Represents a list of physical object detected in an image and their location.", + "properties": { + "values": { + "type": "array", + "description": "A list of physical object detected in an image and their location.", + "minItems": 0, + "items": { + "$ref": "#/definitions/DetectedObject" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "values" + ] + }, + "PeopleResult": { + "type": "object", + "description": "Represents a list of people detected in an image and their location.", + "properties": { + "values": { + "type": "array", + "description": "A list of people detected in an image and their location.", + "minItems": 0, + "items": { + "$ref": "#/definitions/DetectedPerson" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "values" + ] + }, + "ReadResult": { + "type": "object", + "description": "The results of a Read (OCR) operation.", + "properties": { + "blocks": { + "type": "array", + "description": "A list of text blocks in the image. At the moment only one block is returned, containing all the text detected in the image.", + "minItems": 1, + "maxItems": 1, + "items": { + "$ref": "#/definitions/DetectedTextBlock" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "blocks" + ] + }, + "SmartCropsResult": { + "type": "object", + "description": "Smart cropping result. A list of crop regions at the desired as aspect ratios (if provided) that can be used as image thumbnails.\nThese regions preserve as much content as possible from the analyzed image, with priority given to detected faces.", + "properties": { + "values": { + "type": "array", + "description": "A list of crop regions.", + "minItems": 1, + "items": { + "$ref": "#/definitions/CropRegion" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "values" + ] + }, + "TagsResult": { + "type": "object", + "description": "A list of entities observed in the image. Tags can be physical objects, living being, scenery, or actions\nthat appear in the image.", + "properties": { + "values": { + "type": "array", + "description": "A list of tags.", + "minItems": 0, + "items": { + "$ref": "#/definitions/DetectedTag" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "values" + ] + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/swagger-specs/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2023-07-12-preview/AlertsManagement.json b/swagger-specs/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2024-01-01-preview/AlertsManagement.json similarity index 97% rename from swagger-specs/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2023-07-12-preview/AlertsManagement.json rename to swagger-specs/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2024-01-01-preview/AlertsManagement.json index 6f7db7f33..0b603a394 100644 --- a/swagger-specs/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2023-07-12-preview/AlertsManagement.json +++ b/swagger-specs/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2024-01-01-preview/AlertsManagement.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-07-12-preview", + "version": "2024-01-01-preview", "title": "Azure Alerts Management Service Resource Provider", "description": "Azure Alerts Management Service provides a single pane of glass of alerts across Azure Monitor." }, @@ -1002,6 +1002,28 @@ } } }, + "correlationDetails": { + "type": "object", + "description": "Correlation details", + "properties": { + "parentAlertId": { + "type": "string", + "description": "Unique Id (GUID) of the alert that this alert was correlated to.", + "readOnly": true + }, + "correlationDateTime": { + "description": "The alert's correlation date time in ISO-8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "alertProcessingRule": { + "type": "string", + "description": "The alert processing rule that was used to correlate this alert. This is an optional field, it will be presented only for a parent alert.", + "readOnly": true + } + } + }, "essentials": { "type": "object", "description": "This object contains consistent fields across different monitor services.", @@ -1154,6 +1176,19 @@ "description": { "type": "string", "description": "Alert description." + }, + "hasEnrichments": { + "type": "boolean", + "description": "Will be presented with the value true only if there are enrichments.", + "readOnly": true + }, + "isStatefulAlert": { + "type": "boolean", + "description": "True if the alert is stateful, and false if it isn't.", + "readOnly": true + }, + "correlationDetails": { + "$ref": "#/definitions/correlationDetails" } } }, diff --git a/swagger-specs/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2023-05-01-preview/AlertProcessingRules.json b/swagger-specs/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2024-03-01-preview/AlertProcessingRules.json similarity index 95% rename from swagger-specs/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2023-05-01-preview/AlertProcessingRules.json rename to swagger-specs/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2024-03-01-preview/AlertProcessingRules.json index 061fdf3f1..a24150c84 100644 --- a/swagger-specs/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2023-05-01-preview/AlertProcessingRules.json +++ b/swagger-specs/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2024-03-01-preview/AlertProcessingRules.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01-preview", + "version": "2024-03-01-preview", "title": "Azure Alerts Management Service Resource Provider", "description": "APIs for Azure alert processing rules CRUD operations." }, @@ -245,6 +245,9 @@ }, "Create or update a rule that adds alerts correlation": { "$ref": "./examples/AlertProcessingRules_Create_or_update_add_correlation.json" + }, + "Create or update a rule that adds alerts correlation with correlation updates": { + "$ref": "./examples/AlertProcessingRules_Create_or_update_add_correlation_with_correlation_updates.json" } } }, @@ -811,6 +814,9 @@ "name": "NotificationsForCorrelatedAlerts", "modelAsString": true } + }, + "correlationUpdates": { + "$ref": "#/definitions/CorrelationUpdates" } } }, @@ -824,6 +830,40 @@ } } }, + "CorrelationUpdates": { + "type": "object", + "description": "Defines the updates to be applied for correlation.", + "properties": { + "updateType": { + "type": "string", + "description": "The type of update that needs to be performed.", + "default": "timeBased", + "enum": [ + "timeBased" + ], + "x-ms-enum": { + "name": "UpdateType", + "modelAsString": true + } + }, + "updateInterval": { + "type": "string", + "description": "The update interval for notification updates in ISO8601 format." + }, + "actionGroups": { + "type": "array", + "description": "The action group ids.", + "items": { + "type": "string" + } + } + }, + "required": [ + "updateType", + "updateInterval", + "actionGroups" + ] + }, "AlertProcessingRulesList": { "type": "object", "description": "List of alert processing rules.", diff --git a/swagger-specs/alertsmanagement/resource-manager/api-set.json b/swagger-specs/alertsmanagement/resource-manager/api-set.json index 789e84c57..55cfe5a78 100644 --- a/swagger-specs/alertsmanagement/resource-manager/api-set.json +++ b/swagger-specs/alertsmanagement/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.AlertsManagement/stable/2023-03-01/PrometheusRuleGroups.json", "Microsoft.AlertsManagement/preview/2023-07-12-preview/AlertsManagement.json", "Microsoft.AlertsManagement/preview/2019-05-05-preview/SmartGroups.json", "Microsoft.AlertsManagement/preview/2023-08-01-preview/AlertRuleRecommendations.json", "Microsoft.AlertsManagement/preview/2023-05-01-preview/AlertProcessingRules.json"], "name": "package-2023-03"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.AlertsManagement/stable/2023-03-01/PrometheusRuleGroups.json", "Microsoft.AlertsManagement/preview/2024-01-01-preview/AlertsManagement.json", "Microsoft.AlertsManagement/preview/2019-05-05-preview/SmartGroups.json", "Microsoft.AlertsManagement/preview/2023-08-01-preview/AlertRuleRecommendations.json", "Microsoft.AlertsManagement/preview/2024-03-01-preview/AlertProcessingRules.json"], "name": "package-2023-03"} \ No newline at end of file diff --git a/swagger-specs/apicenter/data-plane/ApiCenter.DataApi/preview/2024-02-01-preview/azure.apicenter.dataapi.json b/swagger-specs/apicenter/data-plane/ApiCenter.DataApi/preview/2024-02-01-preview/azure.apicenter.dataapi.json new file mode 100644 index 000000000..4dde16e92 --- /dev/null +++ b/swagger-specs/apicenter/data-plane/ApiCenter.DataApi/preview/2024-02-01-preview/azure.apicenter.dataapi.json @@ -0,0 +1,1824 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure API Center Data API", + "version": "2024-02-01-preview", + "description": "Data API introduces endpoints to manage your API Center resources.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "https://{serviceName}.data.azure-apicenter.net", + "useSchemePrefix": false, + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "Region-unique API Center service name", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "AadOauth2Auth": [ + "https://azure-apicenter.net/user_impersonation" + ] + } + ], + "securityDefinitions": { + "AadOauth2Auth": { + "type": "oauth2", + "description": "The Azure Active Directory OAuth2 Flow", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://azure-apicenter.net/user_impersonation": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [], + "paths": { + "/apis": { + "get": { + "operationId": "Apis_ListAll", + "description": "List a collection of APIs across workspaces.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedApiAll" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Apis_ListAll": { + "$ref": "./examples/Apis_ListAll.json" + } + } + } + }, + "/environments": { + "get": { + "operationId": "Environments_ListAll", + "description": "List a collection of environments across workspaces.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentAll" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Environments_ListAll": { + "$ref": "./examples/Environments_ListAll.json" + } + } + } + }, + "/workspaces/{workspaceName}/apis": { + "get": { + "operationId": "Apis_List", + "description": "List a collection of APIs.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Workspace identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedApi" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Apis_List": { + "$ref": "./examples/Apis_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/workspaces/{workspaceName}/apis/{apiName}": { + "get": { + "operationId": "Apis_Get", + "description": "Get an API.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Workspace identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "apiName", + "in": "path", + "description": "Api identifier.", + "required": true, + "type": "string", + "maxLength": 50 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Api" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Apis_Get": { + "$ref": "./examples/Apis_Get.json" + } + } + } + }, + "/workspaces/{workspaceName}/apis/{apiName}/deployments": { + "get": { + "operationId": "ApiDeployments_ListDeployments", + "description": "List a collection of API deployments.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Workspace identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "apiName", + "in": "path", + "description": "Api identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedApiDeployment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "ApiDeployments_ListDeployments": { + "$ref": "./examples/ApiDeployments_ListDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}": { + "get": { + "operationId": "ApiDeployments_GetDeployment", + "description": "Get an API deployment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Workspace identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "apiName", + "in": "path", + "description": "Api identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "deploymentName", + "in": "path", + "description": "Deployment identifier.", + "required": true, + "type": "string", + "maxLength": 50 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiDeployment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "ApiDeployments_GetDeployment": { + "$ref": "./examples/ApiDeployments_GetDeployment.json" + } + } + } + }, + "/workspaces/{workspaceName}/apis/{apiName}/versions": { + "get": { + "operationId": "ApiVersions_ListVersions", + "description": "List a collection of API versions.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Workspace identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "apiName", + "in": "path", + "description": "Api identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedApiVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "ApiVersions_ListVersions": { + "$ref": "./examples/ApiVersions_ListVersions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}": { + "get": { + "operationId": "ApiVersions_GetVersion", + "description": "Get an API version.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Workspace identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "apiName", + "in": "path", + "description": "Api identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "versionName", + "in": "path", + "description": "Version identifier.", + "required": true, + "type": "string", + "maxLength": 50 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "ApiVersions_GetVersion": { + "$ref": "./examples/ApiVersions_GetVersion.json" + } + } + } + }, + "/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions": { + "get": { + "operationId": "ApiDefinitions_ListDefinitions", + "description": "List a collection of API definitions.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Workspace identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "apiName", + "in": "path", + "description": "Api identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "versionName", + "in": "path", + "description": "Version identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedApiDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "ApiDefinitions_ListDefinitions": { + "$ref": "./examples/ApiDefinitions_ListDefinitions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}": { + "get": { + "operationId": "ApiDefinitions_GetDefinition", + "description": "Get an API definition.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Workspace identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "apiName", + "in": "path", + "description": "Api identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "versionName", + "in": "path", + "description": "Version identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "definitionName", + "in": "path", + "description": "Definition identifier.", + "required": true, + "type": "string", + "maxLength": 50 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "ApiDefinitions_GetDefinition": { + "$ref": "./examples/ApiDefinitions_GetDefinition.json" + } + } + } + }, + "/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}:exportSpecification": { + "post": { + "operationId": "ApiDefinitions_ExportSpecification", + "description": "Export an API specification asynchronously.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Workspace identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "apiName", + "in": "path", + "description": "Api identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "versionName", + "in": "path", + "description": "Version identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "definitionName", + "in": "path", + "description": "API definition identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "type": "object", + "description": "Provides status details for long running operations.", + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the operation." + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "The status of the operation" + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\"." + }, + "result": { + "$ref": "#/definitions/ApiSpecExportResult", + "description": "The result of the operation." + } + }, + "required": [ + "id", + "status" + ] + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "ApiDefinitions_ExportSpecification": { + "$ref": "./examples/ApiDefinitions_ExportSpecification.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}/operations/{operationId}": { + "get": { + "operationId": "ApiDefinitions_GetExportSpecificationOperationStatus", + "description": "Gets status of a an API specification export operation.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Workspace identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "apiName", + "in": "path", + "description": "Api identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "versionName", + "in": "path", + "description": "Version identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "definitionName", + "in": "path", + "description": "API definition identifier.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "The unique ID of the operation.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "object", + "description": "Provides status details for long running operations.", + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the operation." + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "The status of the operation" + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\"." + }, + "result": { + "$ref": "#/definitions/ApiSpecExportResult", + "description": "The result of the operation." + } + }, + "required": [ + "id", + "status" + ] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "ApiDefinitions_GetExportSpecificationOperationStatus": { + "$ref": "./examples/ApiDefinitions_GetExportSpecificationOperationStatus.json" + } + } + } + }, + "/workspaces/{workspaceName}/environments": { + "get": { + "operationId": "Environments_List", + "description": "List a collection of environments.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Workspace identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Environments_List": { + "$ref": "./examples/Environments_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/workspaces/{workspaceName}/environments/{environmentName}": { + "get": { + "operationId": "Environments_Get", + "description": "Get an environment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Workspace identifier.", + "required": true, + "type": "string", + "maxLength": 50 + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment identifier.", + "required": true, + "type": "string", + "maxLength": 50 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Environment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Environments_Get": { + "$ref": "./examples/Environments_Get.json" + } + } + } + } + }, + "definitions": { + "Api": { + "type": "object", + "description": "API resource model.", + "properties": { + "name": { + "type": "string", + "description": "Api identifier.", + "maxLength": 50 + }, + "title": { + "type": "string", + "description": "The name of the API.", + "maxLength": 50 + }, + "summary": { + "type": "string", + "description": "Short description of the API.", + "maxLength": 200 + }, + "description": { + "type": "string", + "description": "The description of the API", + "maxLength": 1000 + }, + "kind": { + "$ref": "#/definitions/ApiKind", + "description": "Kind of API. For example, REST or GraphQL." + }, + "lifecycleStage": { + "$ref": "#/definitions/LifecycleStage", + "description": "Current lifecycle stage of the API.", + "readOnly": true + }, + "termsOfService": { + "$ref": "#/definitions/TermsOfService", + "description": "Terms of service for the API." + }, + "license": { + "$ref": "#/definitions/License", + "description": "The license information for the API." + }, + "externalDocumentation": { + "type": "array", + "description": "External documentation", + "items": { + "$ref": "#/definitions/ExternalDocumentation" + }, + "x-ms-identifiers": [] + }, + "contacts": { + "type": "array", + "description": "Points of contact for the API.", + "items": { + "$ref": "#/definitions/Contact" + }, + "x-ms-identifiers": [] + }, + "customProperties": { + "type": "object", + "description": "The custom metadata defined for API entities." + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "Last updated date and time.", + "readOnly": true + } + }, + "required": [ + "name", + "title", + "kind" + ] + }, + "ApiDefinition": { + "type": "object", + "description": "API definition resource model.", + "properties": { + "name": { + "type": "string", + "description": "Definition identifier.", + "maxLength": 50 + }, + "title": { + "type": "string", + "description": "The name of the API definition.", + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The description of the API definition.", + "maxLength": 1000 + }, + "specification": { + "$ref": "#/definitions/ApiSpecification", + "description": "The API specification details." + } + }, + "required": [ + "name", + "title" + ] + }, + "ApiDeployment": { + "type": "object", + "description": "API deployment resource model.", + "properties": { + "name": { + "type": "string", + "description": "Deployment identifier.", + "maxLength": 50 + }, + "title": { + "type": "string", + "description": "The name of the deployment.", + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The description of the deployment.", + "maxLength": 1000 + }, + "environment": { + "type": "string", + "description": "The name of the deployment environment." + }, + "server": { + "$ref": "#/definitions/ApiDeploymentServer", + "description": "The server information of the API deployment." + }, + "customProperties": { + "type": "object", + "description": "The custom metadata defined for API deployment entities." + }, + "recommended": { + "type": "boolean", + "description": "Indicates if this is currently recommended deployment." + } + }, + "required": [ + "name", + "title", + "environment", + "server" + ] + }, + "ApiDeploymentServer": { + "type": "object", + "description": "Api Deployment Server", + "properties": { + "runtimeUris": { + "type": "array", + "description": "Base runtime URIs for this deployment.", + "items": { + "type": "string", + "format": "uri" + } + } + }, + "required": [ + "runtimeUris" + ] + }, + "ApiKind": { + "type": "string", + "description": "API kind", + "enum": [ + "rest", + "graphql", + "grpc", + "soap", + "webhook", + "websocket" + ], + "x-ms-enum": { + "name": "ApiKind", + "modelAsString": true, + "values": [ + { + "name": "Rest", + "value": "rest", + "description": "REST API" + }, + { + "name": "Graphql", + "value": "graphql", + "description": "GraphQL API" + }, + { + "name": "Grpc", + "value": "grpc", + "description": "GRPC API" + }, + { + "name": "Soap", + "value": "soap", + "description": "SOAP API" + }, + { + "name": "Webhook", + "value": "webhook", + "description": "Webhook API" + }, + { + "name": "Websocket", + "value": "websocket", + "description": "Websocket API" + } + ] + } + }, + "ApiSpecExportResult": { + "type": "object", + "description": "Export specification result model.", + "properties": { + "value": { + "type": "string", + "description": "The result of the specification export." + }, + "format": { + "$ref": "#/definitions/ApiSpecExportResultFormat", + "description": "The format of the specification export result." + } + }, + "required": [ + "value", + "format" + ] + }, + "ApiSpecExportResultFormat": { + "type": "string", + "description": "Export specification result format", + "enum": [ + "link" + ], + "x-ms-enum": { + "name": "ApiSpecExportResultFormat", + "modelAsString": true, + "values": [ + { + "name": "Link", + "value": "link", + "description": "Link format" + } + ] + } + }, + "ApiSpecification": { + "type": "object", + "description": "API specification", + "properties": { + "name": { + "type": "string", + "description": "API specification name, e.g. 'swagger' or 'openapi'." + }, + "version": { + "type": "string", + "description": "API specification version, e.g. '3.0.1'." + } + }, + "required": [ + "name", + "version" + ] + }, + "ApiVersion": { + "type": "object", + "description": "API version resource model.", + "properties": { + "name": { + "type": "string", + "description": "Version identifier.", + "maxLength": 50 + }, + "title": { + "type": "string", + "description": "Version title." + }, + "lifecycleStage": { + "$ref": "#/definitions/LifecycleStage", + "description": "Current lifecycle stage of the API version." + } + }, + "required": [ + "name", + "title", + "lifecycleStage" + ] + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "Azure.Core.Foundations.OperationState": { + "type": "string", + "description": "Enum describing allowed operation states.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "NotStarted", + "description": "The operation has not started." + }, + { + "name": "Running", + "value": "Running", + "description": "The operation is in progress." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The operation has completed successfully." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The operation has failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The operation has been canceled by the user." + } + ] + } + }, + "Contact": { + "type": "object", + "description": "API contact information", + "properties": { + "name": { + "type": "string", + "description": "Name of the contact.", + "maxLength": 100 + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL for the contact." + }, + "email": { + "type": "string", + "description": "Email address for the contact.", + "maxLength": 100 + } + }, + "required": [ + "name" + ] + }, + "Environment": { + "type": "object", + "description": "Environment resource model.", + "properties": { + "name": { + "type": "string", + "description": "Environment identifier.", + "maxLength": 50 + }, + "title": { + "type": "string", + "description": "The name of the environment.", + "maxLength": 50 + }, + "kind": { + "$ref": "#/definitions/EnvironmentKind", + "description": "Kind of deployment environment." + }, + "description": { + "type": "string", + "description": "Description of the environment.", + "maxLength": 1000 + }, + "server": { + "$ref": "#/definitions/EnvironmentServer", + "description": "Server information of the environment." + }, + "onboarding": { + "$ref": "#/definitions/EnvironmentOnboardingModel", + "description": "Onboarding information for this environment." + }, + "customProperties": { + "type": "object", + "description": "The custom metadata defined for environment entities." + } + }, + "required": [ + "name", + "title", + "kind" + ] + }, + "EnvironmentKind": { + "type": "string", + "description": "Environment kind", + "enum": [ + "development", + "testing", + "staging", + "production" + ], + "x-ms-enum": { + "name": "EnvironmentKind", + "modelAsString": true, + "values": [ + { + "name": "Development", + "value": "development", + "description": "Environment is in the development stage" + }, + { + "name": "Testing", + "value": "testing", + "description": "Environment is in the testing stage" + }, + { + "name": "Staging", + "value": "staging", + "description": "Environment is in the staging stage" + }, + { + "name": "Production", + "value": "production", + "description": "Environment is in the production stage" + } + ] + } + }, + "EnvironmentOnboardingModel": { + "type": "object", + "description": "Environment Onboarding Model", + "properties": { + "instructions": { + "type": "string", + "description": "Instructions how to onboard to the environment.", + "maxLength": 1000 + }, + "developerPortalUris": { + "type": "array", + "description": "Developer portal URIs of the environment.", + "items": { + "type": "string", + "format": "uri" + } + } + }, + "required": [ + "instructions", + "developerPortalUris" + ] + }, + "EnvironmentServer": { + "type": "object", + "description": "Environment Server", + "properties": { + "type": { + "type": "string", + "description": "Type of the server that represents the environment." + }, + "managementPortalUris": { + "type": "array", + "description": "URIs of the server's management portal.", + "items": { + "type": "string", + "format": "uri" + } + } + }, + "required": [ + "type", + "managementPortalUris" + ] + }, + "ExternalDocumentation": { + "type": "object", + "description": "Api External Documentation Model", + "properties": { + "title": { + "type": "string", + "description": "Title of the documentation.", + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "Description of the documentation.", + "maxLength": 1000 + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL pointing to the documentation." + } + }, + "required": [ + "title", + "description", + "url" + ] + }, + "License": { + "type": "object", + "description": "API License Model", + "properties": { + "name": { + "type": "string", + "description": "Name of the license.", + "maxLength": 50 + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL pointing to the license details. The URL field is mutually exclusive of the identifier field." + }, + "identifier": { + "type": "string", + "description": "SPDX license information for the API. The identifier field is mutually exclusive of the URL field.", + "maxLength": 200 + } + }, + "required": [ + "name" + ] + }, + "LifecycleStage": { + "type": "string", + "description": "API Lifecycle Stage", + "enum": [ + "design", + "development", + "testing", + "preview", + "production", + "deprecated", + "retired" + ], + "x-ms-enum": { + "name": "LifecycleStage", + "modelAsString": true, + "values": [ + { + "name": "Design", + "value": "design", + "description": "API is in the design stage" + }, + { + "name": "Development", + "value": "development", + "description": "API is in the development stage" + }, + { + "name": "Testing", + "value": "testing", + "description": "API is in the testing stage" + }, + { + "name": "Preview", + "value": "preview", + "description": "API is in the preview stage" + }, + { + "name": "Production", + "value": "production", + "description": "API is in the production stage" + }, + { + "name": "Deprecated", + "value": "deprecated", + "description": "API is in the deprecated stage" + }, + { + "name": "Retired", + "value": "retired", + "description": "API is in the retired stage" + } + ] + } + }, + "PagedApi": { + "type": "object", + "description": "Paged collection of Api items", + "properties": { + "value": { + "type": "array", + "description": "The Api items on this page", + "items": { + "$ref": "#/definitions/Api" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedApiAll": { + "type": "object", + "description": "Paged collection of API items across workspaces.", + "properties": { + "value": { + "type": "array", + "description": "The Api items on this page", + "items": { + "$ref": "#/definitions/Api" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedApiDefinition": { + "type": "object", + "description": "Paged collection of ApiDefinition items", + "properties": { + "value": { + "type": "array", + "description": "The ApiDefinition items on this page", + "items": { + "$ref": "#/definitions/ApiDefinition" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedApiDeployment": { + "type": "object", + "description": "Paged collection of ApiDeployment items", + "properties": { + "value": { + "type": "array", + "description": "The ApiDeployment items on this page", + "items": { + "$ref": "#/definitions/ApiDeployment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedApiVersion": { + "type": "object", + "description": "Paged collection of ApiVersion items", + "properties": { + "value": { + "type": "array", + "description": "The ApiVersion items on this page", + "items": { + "$ref": "#/definitions/ApiVersion" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironment": { + "type": "object", + "description": "Paged collection of Environment items", + "properties": { + "value": { + "type": "array", + "description": "The Environment items on this page", + "items": { + "$ref": "#/definitions/Environment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironmentAll": { + "type": "object", + "description": "Paged collection of Environment items across workspaces", + "properties": { + "value": { + "type": "array", + "description": "The Environment items on this page", + "items": { + "$ref": "#/definitions/Environment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "TermsOfService": { + "type": "object", + "description": "API Terms of Service", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "URL pointing to the terms of service." + } + }, + "required": [ + "url" + ] + }, + "Workspace": { + "type": "object", + "description": "Workspace resource model.", + "properties": { + "name": { + "type": "string", + "description": "Workspace identifier.", + "maxLength": 50 + }, + "title": { + "type": "string", + "description": "Workspace title, e.g. 'My workspace'.", + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "Workspace description.", + "maxLength": 1000 + } + }, + "required": [ + "name", + "title" + ] + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "Azure.Core.MaxPageSizeQueryParameter": { + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of result items per page.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.SkipQueryParameter": { + "name": "skip", + "in": "query", + "description": "The number of result items to skip.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0, + "x-ms-parameter-location": "method" + }, + "Azure.Core.TopQueryParameter": { + "name": "top", + "in": "query", + "description": "The number of result items to return.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/apicenter/data-plane/api-set.json b/swagger-specs/apicenter/data-plane/api-set.json new file mode 100644 index 000000000..66fb92f49 --- /dev/null +++ b/swagger-specs/apicenter/data-plane/api-set.json @@ -0,0 +1 @@ +{"addition_input_file_paths": [], "input_files": ["ApiCenter.DataApi/preview/2024-02-01-preview/azure.apicenter.dataapi.json"], "name": "package-2024-02-01-preview"} \ No newline at end of file diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/AuthConfigs.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/AuthConfigs.json similarity index 94% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/AuthConfigs.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/AuthConfigs.json index ca7d0b7a2..1f7353f80 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/AuthConfigs.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/AuthConfigs.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", @@ -285,6 +285,10 @@ "httpSettings": { "$ref": "#/definitions/HttpSettings", "description": "The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization." + }, + "encryptionSettings": { + "$ref": "#/definitions/EncryptionSettings", + "description": "The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization." } }, "x-ms-client-flatten": true @@ -354,6 +358,20 @@ } } }, + "EncryptionSettings": { + "description": "The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.", + "type": "object", + "properties": { + "containerAppAuthEncryptionSecretName": { + "description": "The secret name which is referenced for EncryptionKey.", + "type": "string" + }, + "containerAppAuthSigningSecretName": { + "description": "The secret name which is referenced for SigningKey.", + "type": "string" + } + } + }, "HttpSettingsRoutes": { "description": "The configuration settings of the paths HTTP requests.", "type": "object", @@ -399,6 +417,10 @@ "$ref": "#/definitions/LoginRoutes", "description": "The routes that specify the endpoints used for login and logout requests." }, + "tokenStore": { + "$ref": "#/definitions/TokenStore", + "description": "The configuration settings of the token store." + }, "preserveUrlFragmentsForLogins": { "description": "true if the fragments from the request are preserved after the login request is made; otherwise, false.", "type": "boolean" @@ -430,6 +452,38 @@ } } }, + "TokenStore": { + "description": "The configuration settings of the token store.", + "type": "object", + "properties": { + "enabled": { + "description": "true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false.", + "type": "boolean" + }, + "tokenRefreshExtensionHours": { + "format": "double", + "description": "The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours.", + "type": "number" + }, + "azureBlobStorage": { + "$ref": "#/definitions/BlobStorageTokenStore", + "description": "The configuration settings of the storage of the tokens if blob storage is used." + } + } + }, + "BlobStorageTokenStore": { + "description": "The configuration settings of the storage of the tokens if blob storage is used.", + "type": "object", + "required": [ + "sasUrlSettingName" + ], + "properties": { + "sasUrlSettingName": { + "description": "The name of the app secrets containing the SAS URL of the blob storage containing the tokens.", + "type": "string" + } + } + }, "CookieExpiration": { "description": "The configuration settings of the session cookie's expiration.", "type": "object", diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/AvailableWorkloadProfiles.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/AvailableWorkloadProfiles.json similarity index 94% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/AvailableWorkloadProfiles.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/AvailableWorkloadProfiles.json index 7a049115d..95ce7c8ed 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/AvailableWorkloadProfiles.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/AvailableWorkloadProfiles.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", @@ -41,7 +41,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -100,6 +100,11 @@ "format": "int32", "description": "Memory in GiB." }, + "gpus": { + "type": "integer", + "format": "int32", + "description": "Number of GPUs." + }, "displayName": { "type": "string", "description": "The everyday name of the workload profile." diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/BillingMeters.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/BillingMeters.json similarity index 99% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/BillingMeters.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/BillingMeters.json index 0c7321793..49d994e61 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/BillingMeters.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/BillingMeters.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/CommonDefinitions.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/CommonDefinitions.json similarity index 99% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/CommonDefinitions.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/CommonDefinitions.json index 7cda418aa..aece758c8 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/CommonDefinitions.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/CommonDefinitions.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ConnectedEnvironments.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ConnectedEnvironments.json similarity index 99% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ConnectedEnvironments.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ConnectedEnvironments.json index ffa4791be..333ceb68a 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ConnectedEnvironments.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ConnectedEnvironments.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ConnectedEnvironmentsCertificates.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsCertificates.json similarity index 99% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ConnectedEnvironmentsCertificates.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsCertificates.json index 895e962c8..9dcaf46d7 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ConnectedEnvironmentsCertificates.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsCertificates.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ConnectedEnvironmentsDaprComponents.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsDaprComponents.json similarity index 99% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ConnectedEnvironmentsDaprComponents.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsDaprComponents.json index fb6b10e4d..b3e96875e 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ConnectedEnvironmentsDaprComponents.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsDaprComponents.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ConnectedEnvironmentsStorages.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsStorages.json similarity index 99% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ConnectedEnvironmentsStorages.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsStorages.json index e85c2daea..67389bbcd 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ConnectedEnvironmentsStorages.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsStorages.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ContainerApps.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ContainerApps.json similarity index 97% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ContainerApps.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ContainerApps.json index 38b62dee7..700ba1f20 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ContainerApps.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ContainerApps.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", @@ -961,6 +961,16 @@ "corsPolicy": { "description": "CORS policy for container app", "$ref": "#/definitions/CorsPolicy" + }, + "additionalPortMappings": { + "description": "Settings to expose additional ports on container app", + "type": "array", + "items": { + "$ref": "#/definitions/IngressPortMapping" + }, + "x-ms-identifiers": [ + "targetPort" + ] } } }, @@ -1166,6 +1176,30 @@ } } }, + "IngressPortMapping": { + "description": "Port mappings of container app ingress", + "type": "object", + "required": [ + "external", + "targetPort" + ], + "properties": { + "external": { + "description": "Specifies whether the app port is accessible outside of the environment", + "type": "boolean" + }, + "targetPort": { + "format": "int32", + "description": "Specifies the port user's container listens on", + "type": "integer" + }, + "exposedPort": { + "format": "int32", + "description": "Specifies the exposed port for the target port. If not specified, it defaults to target port", + "type": "integer" + } + } + }, "CustomHostnameAnalysisResult": { "description": "Custom domain analysis.", "type": "object", diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ContainerAppsRevisions.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ContainerAppsRevisions.json similarity index 99% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ContainerAppsRevisions.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ContainerAppsRevisions.json index f1ce9858b..51f867093 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ContainerAppsRevisions.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ContainerAppsRevisions.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/Diagnostics.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Diagnostics.json similarity index 81% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/Diagnostics.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Diagnostics.json index a3dbdf7cc..a1b41c653 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/Diagnostics.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Diagnostics.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", @@ -432,6 +432,157 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectors": { + "get": { + "tags": [ + "Jobs", + "Diagnostics" + ], + "summary": "Get the list of diagnostics for a given Container App Job.", + "description": "Get the list of diagnostics for a Container App Job.", + "operationId": "Jobs_ListDetectors", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Jobs.json#/parameters/JobNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the list of available diagnostic data for a Container App Job": { + "$ref": "./examples/Job_ListDetectors.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectors/{detectorName}": { + "get": { + "tags": [ + "Jobs", + "Diagnostics" + ], + "summary": "Get the diagnostics data for a given Container App Job.", + "description": "Get the diagnostics data for a Container App Job.", + "operationId": "Jobs_GetDetector", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Jobs.json#/parameters/JobNameParameter" + }, + { + "name": "detectorName", + "in": "path", + "description": "Name of the Container App Job detector.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Diagnostics" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get diagnostic data for a Container App Job": { + "$ref": "./examples/Job_GetDetector.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectorProperties/{apiName}": { + "get": { + "tags": [ + "Jobs", + "Diagnostics" + ], + "summary": "Get the properties of a Container App Job.", + "description": "Get the properties of a Container App Job.", + "operationId": "Jobs_ProxyGet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Jobs.json#/parameters/JobNameParameter" + }, + { + "name": "apiName", + "in": "path", + "description": "Proxy API Name for Container App Job.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./Jobs.json#/definitions/Job" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App Job by name": { + "$ref": "./examples/Job_ProxyGet.json" + } + } + } } }, "definitions": { diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/Global.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Global.json similarity index 99% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/Global.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Global.json index df7bfdbf6..8c026c31c 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/Global.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Global.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/Jobs.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Jobs.json similarity index 96% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/Jobs.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Jobs.json index c728acac1..c581f1f67 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/Jobs.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Jobs.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", @@ -1028,40 +1028,47 @@ "type": "string" }, "type": { - "description": "Job Type.", + "description": "Job execution type", "type": "string" }, - "status": { - "description": "Current running State of the job", - "enum": [ - "Running", - "Processing", - "Stopped", - "Degraded", - "Failed", - "Unknown", - "Succeeded" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "JobExecutionRunningState", - "modelAsString": true - } - }, - "startTime": { - "description": "Job execution start time.", - "format": "date-time", - "type": "string" - }, - "endTime": { - "description": "Job execution end time.", - "format": "date-time", - "type": "string" - }, - "template": { - "description": "Job's execution container.", - "$ref": "#/definitions/JobExecutionTemplate" + "properties": { + "description": "Container Apps Job execution specific properties.", + "type": "object", + "properties": { + "status": { + "description": "Current running State of the job", + "enum": [ + "Running", + "Processing", + "Stopped", + "Degraded", + "Failed", + "Unknown", + "Succeeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobExecutionRunningState", + "modelAsString": true + } + }, + "startTime": { + "description": "Job execution start time.", + "format": "date-time", + "type": "string" + }, + "endTime": { + "description": "Job execution end time.", + "format": "date-time", + "type": "string" + }, + "template": { + "description": "Job's execution container.", + "$ref": "#/definitions/JobExecutionTemplate" + } + }, + "x-ms-client-flatten": true } } }, diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ManagedEnvironments.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ManagedEnvironments.json similarity index 98% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ManagedEnvironments.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ManagedEnvironments.json index 7500c645c..0dbbbd90c 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ManagedEnvironments.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ManagedEnvironments.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", @@ -1259,6 +1259,22 @@ "$ref": "#/definitions/Mtls" } } + }, + "peerTrafficConfiguration": { + "description": "Peer traffic settings for the Managed Environment", + "type": "object", + "properties": { + "encryption": { + "description": "Peer traffic encryption settings for the Managed Environment", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Boolean indicating whether the peer traffic encryption is enabled" + } + } + } + } } }, "x-ms-client-flatten": true diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ManagedEnvironmentsDaprComponents.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ManagedEnvironmentsDaprComponents.json similarity index 99% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ManagedEnvironmentsDaprComponents.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ManagedEnvironmentsDaprComponents.json index 0840aa667..b32e5ef5c 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ManagedEnvironmentsDaprComponents.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ManagedEnvironmentsDaprComponents.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ManagedEnvironmentsStorages.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ManagedEnvironmentsStorages.json similarity index 99% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ManagedEnvironmentsStorages.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ManagedEnvironmentsStorages.json index 94c262a23..ffe41cb86 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/ManagedEnvironmentsStorages.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/ManagedEnvironmentsStorages.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/SourceControls.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/SourceControls.json similarity index 99% rename from swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/SourceControls.json rename to swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/SourceControls.json index 99542d45a..b19f6fc1a 100644 --- a/swagger-specs/app/resource-manager/Microsoft.App/stable/2023-05-01/SourceControls.json +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/SourceControls.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-03-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Subscriptions.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Subscriptions.json new file mode 100644 index 000000000..54ed5f4c0 --- /dev/null +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Subscriptions.json @@ -0,0 +1,80 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-03-01", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/getCustomDomainVerificationId": { + "post": { + "tags": [ + "Subscriptions" + ], + "description": "Get the verification id of a subscription used for verifying custom domains", + "operationId": "GetCustomDomainVerificationId", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The custom domain verification id has been returned successfully.", + "schema": { + "$ref": "#/definitions/CustomDomainVerificationId" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List all operations": { + "$ref": "./examples/Subscriptions_GetCustomDomainVerificationId.json" + } + } + } + } + }, + "definitions": { + "CustomDomainVerificationId": { + "description": "Custom domain verification Id of a subscription", + "type": "string", + "readOnly": true + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Usages.json b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Usages.json new file mode 100644 index 000000000..e9bd95daa --- /dev/null +++ b/swagger-specs/app/resource-manager/Microsoft.App/stable/2024-03-01/Usages.json @@ -0,0 +1,188 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-03-01", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/usages": { + "get": { + "tags": [ + "Usages" + ], + "operationId": "Usages_List", + "description": "Gets, for the specified location, the current resource usage information as well as the limits under the subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List usages": { + "$ref": "./examples/Usages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/usages": { + "get": { + "tags": [ + "Usages" + ], + "operationId": "ManagedEnvironmentUsages_List", + "description": "Gets the current usage information as well as the limits for environment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List managed environment usages": { + "$ref": "./examples/ManagedEnvironmentUsages_List.json" + } + } + } + } + }, + "definitions": { + "UsageName": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "type": "object", + "properties": { + "unit": { + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "number", + "format": "float", + "description": "The current usage of the resource." + }, + "limit": { + "type": "number", + "format": "float", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes Compute Resource Usage." + }, + "ListUsagesResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of compute resource usages." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information." + } + } + } + } +} diff --git a/swagger-specs/app/resource-manager/api-set.json b/swagger-specs/app/resource-manager/api-set.json index e93473fbb..62880cec2 100644 --- a/swagger-specs/app/resource-manager/api-set.json +++ b/swagger-specs/app/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.App/stable/2023-05-01/AuthConfigs.json", "Microsoft.App/stable/2023-05-01/AvailableWorkloadProfiles.json", "Microsoft.App/stable/2023-05-01/BillingMeters.json", "Microsoft.App/stable/2023-05-01/CommonDefinitions.json", "Microsoft.App/stable/2023-05-01/ConnectedEnvironments.json", "Microsoft.App/stable/2023-05-01/ConnectedEnvironmentsCertificates.json", "Microsoft.App/stable/2023-05-01/ConnectedEnvironmentsDaprComponents.json", "Microsoft.App/stable/2023-05-01/ConnectedEnvironmentsStorages.json", "Microsoft.App/stable/2023-05-01/ContainerApps.json", "Microsoft.App/stable/2023-05-01/ContainerAppsRevisions.json", "Microsoft.App/stable/2023-05-01/Diagnostics.json", "Microsoft.App/stable/2023-05-01/Global.json", "Microsoft.App/stable/2023-05-01/Jobs.json", "Microsoft.App/stable/2023-05-01/ManagedEnvironments.json", "Microsoft.App/stable/2023-05-01/ManagedEnvironmentsDaprComponents.json", "Microsoft.App/stable/2023-05-01/ManagedEnvironmentsStorages.json", "Microsoft.App/stable/2023-05-01/SourceControls.json"], "name": "package-2023-05"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.App/stable/2024-03-01/AuthConfigs.json", "Microsoft.App/stable/2024-03-01/AvailableWorkloadProfiles.json", "Microsoft.App/stable/2024-03-01/BillingMeters.json", "Microsoft.App/stable/2024-03-01/CommonDefinitions.json", "Microsoft.App/stable/2024-03-01/ConnectedEnvironments.json", "Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsCertificates.json", "Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsDaprComponents.json", "Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsStorages.json", "Microsoft.App/stable/2024-03-01/ContainerApps.json", "Microsoft.App/stable/2024-03-01/ContainerAppsRevisions.json", "Microsoft.App/stable/2024-03-01/Diagnostics.json", "Microsoft.App/stable/2024-03-01/Global.json", "Microsoft.App/stable/2024-03-01/Jobs.json", "Microsoft.App/stable/2024-03-01/ManagedEnvironments.json", "Microsoft.App/stable/2024-03-01/ManagedEnvironmentsDaprComponents.json", "Microsoft.App/stable/2024-03-01/ManagedEnvironmentsStorages.json", "Microsoft.App/stable/2024-03-01/SourceControls.json", "Microsoft.App/stable/2024-03-01/Subscriptions.json", "Microsoft.App/stable/2024-03-01/Usages.json"], "name": "package-2024-03"} \ No newline at end of file diff --git a/swagger-specs/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json b/swagger-specs/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json index ff007d39f..8d4cad68f 100644 --- a/swagger-specs/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json +++ b/swagger-specs/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/2023-11-01/appconfiguration.json @@ -1,131 +1,211 @@ { "swagger": "2.0", "info": { + "title": "Azure App Configuration", "version": "2023-11-01", - "title": "Azure App Configuration" + "description": "Azure App Configuration REST API", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] }, "schemes": [ "https" ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://azconfig.io/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Connection String", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://azconfig.io/.default": "" + } + } + }, + "tags": [], "paths": { "/keys": { "get": { - "tags": [ - "Keys" - ], - "summary": "Gets a list of keys.", "operationId": "GetKeys", - "consumes": [], + "summary": "Gets a list of keys.", + "description": "Gets a list of keys.", "produces": [ "application/vnd.microsoft.appconfig.keyset+json", - "application/problem+json" + "application/problem+json", + "application/json" ], "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, { "name": "name", "in": "query", "description": "A filter for the name of the returned keys.", + "required": false, "type": "string" }, - { - "$ref": "#/parameters/SyncTokens" - }, - { - "$ref": "#/parameters/ApiVersion" - }, { "name": "After", "in": "query", - "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", - "type": "string" + "description": "Instructs the server to return elements that appear after the element referred\nto by the specified token.", + "required": false, + "type": "string", + "x-ms-client-name": "after" + }, + { + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { "name": "Accept-Datetime", "in": "header", - "description": "Requests the server to respond with the state of the resource at the specified time.", - "type": "string" + "description": "Requests the server to respond with the state of the resource at the specified\ntime.", + "required": false, + "type": "string", + "x-ms-client-name": "acceptDatetime" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/KeyListResult" }, "headers": { + "Content-Type": { + "type": "string", + "description": "Content-Type header", + "enum": [ + "application/vnd.microsoft.appconfig.keyset+json", + "application/problem+json" + ], + "x-ms-enum": { + "modelAsString": false + } + }, "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "GetKeys": { + "Gets a list of keys.": { "$ref": "./examples/GetKeys.json" } }, "x-ms-pageable": { - "itemName": "items", "nextLinkName": "@nextLink" } }, "head": { - "tags": [ - "Keys" - ], - "summary": "Requests the headers and status of the given resource.", "operationId": "CheckKeys", - "consumes": [], - "produces": [], + "summary": "Requests the headers and status of the given resource.", + "description": "Requests the headers and status of the given resource.", "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, { "name": "name", "in": "query", "description": "A filter for the name of the returned keys.", + "required": false, "type": "string" }, { - "$ref": "#/parameters/SyncTokens" - }, - { - "$ref": "#/parameters/ApiVersion" + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { "name": "After", "in": "query", - "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", - "type": "string" + "description": "Instructs the server to return elements that appear after the element referred\nto by the specified token.", + "required": false, + "type": "string", + "x-ms-client-name": "after" }, { "name": "Accept-Datetime", "in": "header", - "description": "Requests the server to respond with the state of the resource at the specified time.", - "type": "string" + "description": "Requests the server to respond with the state of the resource at the specified\ntime.", + "required": false, + "type": "string", + "x-ms-client-name": "acceptDatetime" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "headers": { "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response." + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + } } }, "x-ms-examples": { - "CheckKeys": { + "Check keys": { "$ref": "./examples/CheckKeys.json" } } @@ -133,240 +213,413 @@ }, "/kv": { "get": { - "tags": [ - "KeyValues" - ], - "summary": "Gets a list of key-values.", "operationId": "GetKeyValues", - "consumes": [], + "summary": "Gets a list of key-values.", + "description": "Gets a list of key-values.", "produces": [ "application/vnd.microsoft.appconfig.kvset+json", - "application/problem+json" + "application/problem+json", + "application/json" ], "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, { "name": "key", "in": "query", - "description": "A filter used to match keys. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering", + "description": "A filter used to match keys. Syntax reference:\nhttps://aka.ms/azconfig/docs/keyvaluefiltering", + "required": false, "type": "string" }, { "name": "label", "in": "query", - "description": "A filter used to match labels. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering", + "description": "A filter used to match labels. Syntax reference:\nhttps://aka.ms/azconfig/docs/keyvaluefiltering", + "required": false, "type": "string" }, { - "$ref": "#/parameters/SyncTokens" - }, - { - "$ref": "#/parameters/ApiVersion" + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { "name": "After", "in": "query", - "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", - "type": "string" + "description": "Instructs the server to return elements that appear after the element referred\nto by the specified token.", + "required": false, + "type": "string", + "x-ms-client-name": "after" }, { "name": "Accept-Datetime", "in": "header", - "description": "Requests the server to respond with the state of the resource at the specified time.", - "type": "string" + "description": "Requests the server to respond with the state of the resource at the specified\ntime.", + "required": false, + "type": "string", + "x-ms-client-name": "acceptDatetime" }, { - "$ref": "#/parameters/KeyValueFields" + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "key", + "label", + "content_type", + "value", + "last_modified", + "tags", + "locked", + "etag" + ], + "x-ms-enum": { + "name": "KeyValueFields", + "modelAsString": true, + "values": [ + { + "name": "key", + "value": "key", + "description": "Key field." + }, + { + "name": "label", + "value": "label", + "description": "Label field." + }, + { + "name": "content_type", + "value": "content_type", + "description": "Content type field." + }, + { + "name": "value", + "value": "value", + "description": "Value field." + }, + { + "name": "last_modified", + "value": "last_modified", + "description": "Last modified field." + }, + { + "name": "tags", + "value": "tags", + "description": "Tags field." + }, + { + "name": "locked", + "value": "locked", + "description": "Locked field." + }, + { + "name": "etag", + "value": "etag", + "description": "Etag field." + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-client-name": "select" }, { "name": "snapshot", "in": "query", - "description": "A filter used get key-values for a snapshot. The value should be the name of the snapshot. Not valid when used with 'key' and 'label' filters.", + "description": "A filter used get key-values for a snapshot. The value should be the name of\nthe snapshot. Not valid when used with 'key' and 'label' filters.", + "required": false, "type": "string" }, { "name": "If-Match", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag matches the\nvalue provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag does not\nmatch the value provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" }, { "name": "tags", "in": "query", - "description": "A filter used to query by tags. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering", + "description": "A filter used to query by tags. Syntax reference:\nhttps://aka.ms/azconfig/docs/keyvaluefiltering", + "required": false, "type": "array", "items": { "type": "string" }, - "collectionFormat": "multi", - "uniqueItems": true + "collectionFormat": "multi" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/KeyValueListResult" }, "headers": { - "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "Content-Type": { + "type": "string", + "description": "Content-Type header", + "enum": [ + "application/vnd.microsoft.appconfig.kvset+json", + "application/problem+json" + ], + "x-ms-enum": { + "modelAsString": false + } }, "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" + "type": "string", + "description": "A value representing the current state of the resource." + }, + "Sync-Token": { + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "GetKeyValues": { - "$ref": "./examples/GetKeyValues.json" - }, - "GetKeyValues_IfMatch": { + "Gets a list of key-values using the If-Match header.": { "$ref": "./examples/GetKeyValues_IfMatch.json" }, - "GetKeyValues_IfNoneMatch": { + "Gets a list of key-values using the If-None-Match header.": { "$ref": "./examples/GetKeyValues_IfNoneMatch.json" + }, + "Gets a list of key-values.": { + "$ref": "./examples/GetKeyValues.json" } }, "x-ms-pageable": { - "itemName": "items", "nextLinkName": "@nextLink" } }, "head": { - "tags": [ - "KeyValues" - ], - "summary": "Requests the headers and status of the given resource.", "operationId": "CheckKeyValues", - "consumes": [], - "produces": [], + "summary": "Requests the headers and status of the given resource.", + "description": "Requests the headers and status of the given resource.", "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, { "name": "key", "in": "query", - "description": "A filter used to match keys. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering", + "description": "A filter used to match keys. Syntax reference:\nhttps://aka.ms/azconfig/docs/keyvaluefiltering", + "required": false, "type": "string" }, { "name": "label", "in": "query", - "description": "A filter used to match labels. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering", + "description": "A filter used to match labels. Syntax reference:\nhttps://aka.ms/azconfig/docs/keyvaluefiltering", + "required": false, "type": "string" }, { - "$ref": "#/parameters/SyncTokens" - }, - { - "$ref": "#/parameters/ApiVersion" + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { "name": "After", "in": "query", - "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", - "type": "string" + "description": "Instructs the server to return elements that appear after the element referred\nto by the specified token.", + "required": false, + "type": "string", + "x-ms-client-name": "after" }, { "name": "Accept-Datetime", "in": "header", - "description": "Requests the server to respond with the state of the resource at the specified time.", - "type": "string" + "description": "Requests the server to respond with the state of the resource at the specified\ntime.", + "required": false, + "type": "string", + "x-ms-client-name": "acceptDatetime" }, { - "$ref": "#/parameters/KeyValueFields" + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "key", + "label", + "content_type", + "value", + "last_modified", + "tags", + "locked", + "etag" + ], + "x-ms-enum": { + "name": "KeyValueFields", + "modelAsString": true, + "values": [ + { + "name": "key", + "value": "key", + "description": "Key field." + }, + { + "name": "label", + "value": "label", + "description": "Label field." + }, + { + "name": "content_type", + "value": "content_type", + "description": "Content type field." + }, + { + "name": "value", + "value": "value", + "description": "Value field." + }, + { + "name": "last_modified", + "value": "last_modified", + "description": "Last modified field." + }, + { + "name": "tags", + "value": "tags", + "description": "Tags field." + }, + { + "name": "locked", + "value": "locked", + "description": "Locked field." + }, + { + "name": "etag", + "value": "etag", + "description": "Etag field." + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-client-name": "select" }, { "name": "snapshot", "in": "query", "description": "A filter used get key-values for a snapshot. Not valid when used with 'key' and 'label' filters.", + "required": false, "type": "string" }, { "name": "If-Match", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag matches the\nvalue provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag does not\nmatch the value provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" }, { "name": "tags", "in": "query", - "description": "A filter used to query by tags. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering", + "description": "A filter used to query by tags. Syntax reference:\nhttps://aka.ms/azconfig/docs/keyvaluefiltering", + "required": false, "type": "array", "items": { "type": "string" }, - "collectionFormat": "multi", - "uniqueItems": true + "collectionFormat": "multi" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "headers": { - "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" - }, "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" + "type": "string", + "description": "A value representing the current state of the resource." + }, + "Sync-Token": { + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response." + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + } } }, "x-ms-examples": { - "CheckKeyValues": { - "$ref": "./examples/CheckKeyValues.json" - }, - "CheckKeyValues_IfMatch": { + "Requests the headers and status of the given resource using the If-Match header.": { "$ref": "./examples/CheckKeyValues_IfMatch.json" }, - "CheckKeyValues_IfNoneMatch": { + "Requests the headers and status of the given resource using the If-None-Match header.": { "$ref": "./examples/CheckKeyValues_IfNoneMatch.json" + }, + "Requests the headers and status of the given resource.": { + "$ref": "./examples/CheckKeyValues.json" } } } }, "/kv/{key}": { "get": { - "tags": [ - "KeyValues" - ], - "summary": "Gets a single key-value.", "operationId": "GetKeyValue", - "consumes": [], + "summary": "Gets a single key-value.", + "description": "Gets a single key-value.", "produces": [ "application/vnd.microsoft.appconfig.kv+json", - "application/problem+json" + "application/problem+json", + "application/json" ], "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, { "name": "key", "in": "path", - "description": "The key of the key-value to retrieve.", + "description": "The key of the key-value.", "required": true, "type": "string" }, @@ -374,78 +627,174 @@ "name": "label", "in": "query", "description": "The label of the key-value to retrieve.", + "required": false, "type": "string" }, { - "$ref": "#/parameters/SyncTokens" + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "key", + "label", + "content_type", + "value", + "last_modified", + "tags", + "locked", + "etag" + ], + "x-ms-enum": { + "name": "KeyValueFields", + "modelAsString": true, + "values": [ + { + "name": "key", + "value": "key", + "description": "Key field." + }, + { + "name": "label", + "value": "label", + "description": "Label field." + }, + { + "name": "content_type", + "value": "content_type", + "description": "Content type field." + }, + { + "name": "value", + "value": "value", + "description": "Value field." + }, + { + "name": "last_modified", + "value": "last_modified", + "description": "Last modified field." + }, + { + "name": "tags", + "value": "tags", + "description": "Tags field." + }, + { + "name": "locked", + "value": "locked", + "description": "Locked field." + }, + { + "name": "etag", + "value": "etag", + "description": "Etag field." + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-client-name": "select" }, { - "$ref": "#/parameters/ApiVersion" + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { "name": "Accept-Datetime", "in": "header", - "description": "Requests the server to respond with the state of the resource at the specified time.", - "type": "string" + "description": "Requests the server to respond with the state of the resource at the specified\ntime.", + "required": false, + "type": "string", + "x-ms-client-name": "acceptDatetime" }, { "name": "If-Match", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag matches the\nvalue provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag does not\nmatch the value provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" }, { - "$ref": "#/parameters/KeyValueFields" + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/KeyValue" }, "headers": { - "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "Content-Type": { + "type": "string", + "description": "Content-Type header", + "enum": [ + "application/vnd.microsoft.appconfig.kv+json", + "application/problem+json" + ], + "x-ms-enum": { + "modelAsString": false + } }, "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" + "type": "string", + "description": "A value representing the current state of the resource." + }, + "Sync-Token": { + "type": "string", + "description": "Used to guarantee real-time consistency between requests." + }, + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." } } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "GetKeyValue": { - "$ref": "./examples/GetKeyValue.json" - }, - "GetKeyValue_IfMatch": { + "Gets a single key-value using the If-Match header.": { "$ref": "./examples/GetKeyValue_IfMatch.json" }, - "GetKeyValue_IfNoneMatch": { + "Gets a single key-value using the If-None-Match header.": { "$ref": "./examples/GetKeyValue_IfNoneMatch.json" + }, + "Gets a single key-value.": { + "$ref": "./examples/GetKeyValue.json" } } }, "put": { - "tags": [ - "KeyValues" - ], - "summary": "Creates a key-value.", "operationId": "PutKeyValue", + "summary": "Creates a key-value.", + "description": "Creates a key-value.", + "produces": [ + "application/vnd.microsoft.appconfig.kv+json", + "application/problem+json", + "application/json" + ], "consumes": [ "application/vnd.microsoft.appconfig.kv+json", "application/vnd.microsoft.appconfig.kvset+json", @@ -454,11 +803,10 @@ "application/*+json", "application/json-patch+json" ], - "produces": [ - "application/vnd.microsoft.appconfig.kv+json", - "application/problem+json" - ], "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, { "name": "key", "in": "path", @@ -470,80 +818,103 @@ "name": "label", "in": "query", "description": "The label of the key-value to create.", + "required": false, "type": "string" }, { - "name": "entity", - "in": "body", - "description": "The key-value to create.", - "schema": { - "$ref": "#/definitions/KeyValue" - } - }, - { - "$ref": "#/parameters/SyncTokens" - }, - { - "$ref": "#/parameters/ApiVersion" + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { "name": "If-Match", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag matches the\nvalue provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag does not\nmatch the value provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "name": "entity", + "in": "body", + "description": "The key-value to create.", + "required": false, + "schema": { + "$ref": "#/definitions/KeyValue" + } } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/KeyValue" }, "headers": { - "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "Content-Type": { + "type": "string", + "description": "Content-Type header", + "enum": [ + "application/vnd.microsoft.appconfig.kv+json", + "application/problem+json" + ], + "x-ms-enum": { + "modelAsString": false + } }, "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" + "type": "string", + "description": "A value representing the current state of the resource." + }, + "Sync-Token": { + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "PutKeyValue": { - "$ref": "./examples/PutKeyValue.json" - }, - "PutKeyValue_IfMatch": { + "Creates a key-value with the If-Match header.": { "$ref": "./examples/PutKeyValue_IfMatch.json" + }, + "Creates a key-value.": { + "$ref": "./examples/PutKeyValue.json" } } }, "delete": { - "tags": [ - "KeyValues" - ], - "summary": "Deletes a key-value.", "operationId": "DeleteKeyValue", - "consumes": [], + "summary": "Deletes a key-value.", + "description": "Deletes a key-value.", "produces": [ "application/vnd.microsoft.appconfig.kv+json", - "application/problem+json" + "application/problem+json", + "application/json" ], "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, { "name": "key", "in": "path", @@ -555,72 +926,90 @@ "name": "label", "in": "query", "description": "The label of the key-value to delete.", + "required": false, "type": "string" }, { - "$ref": "#/parameters/SyncTokens" - }, - { - "$ref": "#/parameters/ApiVersion" + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { "name": "If-Match", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag matches the\nvalue provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/KeyValue" }, "headers": { - "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "Content-Type": { + "type": "string", + "description": "Content-Type header", + "enum": [ + "application/vnd.microsoft.appconfig.kv+json", + "application/problem+json" + ], + "x-ms-enum": { + "modelAsString": false + } }, "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" + "type": "string", + "description": "A value representing the current state of the resource." + }, + "Sync-Token": { + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "204": { - "description": "Success", + "description": "There is no content to send for this request, but the headers may be useful. ", "headers": { "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "DeleteKeyValue": { - "$ref": "./examples/DeleteKeyValue.json" - }, - "DeleteKeyValue_IfMatch": { + "Deletes a key-value using If-Match header": { "$ref": "./examples/DeleteKeyValue_IfMatch.json" + }, + "Deletes a key-value.": { + "$ref": "./examples/DeleteKeyValue.json" } } }, "head": { - "tags": [ - "KeyValues" - ], - "summary": "Requests the headers and status of the given resource.", "operationId": "CheckKeyValue", - "consumes": [], - "produces": [], + "summary": "Requests the headers and status of the given resource.", + "description": "Requests the headers and status of the given resource.", "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, { "name": "key", "in": "path", @@ -632,1268 +1021,2059 @@ "name": "label", "in": "query", "description": "The label of the key-value to retrieve.", + "required": false, "type": "string" }, { - "$ref": "#/parameters/SyncTokens" - }, - { - "$ref": "#/parameters/ApiVersion" + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { "name": "Accept-Datetime", "in": "header", - "description": "Requests the server to respond with the state of the resource at the specified time.", - "type": "string" + "description": "Requests the server to respond with the state of the resource at the specified\ntime.", + "required": false, + "type": "string", + "x-ms-client-name": "acceptDatetime" }, { "name": "If-Match", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag matches the\nvalue provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag does not\nmatch the value provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "key", + "label", + "content_type", + "value", + "last_modified", + "tags", + "locked", + "etag" + ], + "x-ms-enum": { + "name": "KeyValueFields", + "modelAsString": true, + "values": [ + { + "name": "key", + "value": "key", + "description": "Key field." + }, + { + "name": "label", + "value": "label", + "description": "Label field." + }, + { + "name": "content_type", + "value": "content_type", + "description": "Content type field." + }, + { + "name": "value", + "value": "value", + "description": "Value field." + }, + { + "name": "last_modified", + "value": "last_modified", + "description": "Last modified field." + }, + { + "name": "tags", + "value": "tags", + "description": "Tags field." + }, + { + "name": "locked", + "value": "locked", + "description": "Locked field." + }, + { + "name": "etag", + "value": "etag", + "description": "Etag field." + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-client-name": "select" }, { - "$ref": "#/parameters/KeyValueFields" + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "headers": { - "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" - }, "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" + "type": "string", + "description": "A value representing the current state of the resource." + }, + "Sync-Token": { + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response." - } - }, + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, "x-ms-examples": { - "CheckKeyValue": { - "$ref": "./examples/CheckKeyValue.json" - }, - "CheckKeyValue_IfMatch": { + "Requests the headers and status of the given resource using the If-Match header.": { "$ref": "./examples/CheckKeyValue_IfMatch.json" }, - "CheckKeyValue_IfNoneMatch": { + "Requests the headers and status of the given resource using the If-None-Match header.": { "$ref": "./examples/CheckKeyValue_IfNoneMatch.json" + }, + "Requests the headers and status of the given resource.": { + "$ref": "./examples/CheckKeyValue.json" } } } }, - "/snapshots": { + "/labels": { "get": { - "tags": [ - "Snapshots" - ], - "summary": "Gets a list of key-value snapshots.", - "operationId": "GetSnapshots", - "consumes": [], + "operationId": "GetLabels", + "summary": "Gets a list of labels.", + "description": "Gets a list of labels.", "produces": [ - "application/vnd.microsoft.appconfig.snapshotset+json", - "application/problem+json" + "application/vnd.microsoft.appconfig.labelset+json", + "application/problem+json", + "application/json" ], "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, { "name": "name", "in": "query", - "description": "A filter for the name of the returned snapshots.", + "description": "A filter for the name of the returned labels.", + "required": false, "type": "string" }, { - "$ref": "#/parameters/SyncTokens" - }, - { - "$ref": "#/parameters/ApiVersion" + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { "name": "After", "in": "query", - "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", - "type": "string" + "description": "Instructs the server to return elements that appear after the element referred\nto by the specified token.", + "required": false, + "type": "string", + "x-ms-client-name": "after" + }, + { + "name": "Accept-Datetime", + "in": "header", + "description": "Requests the server to respond with the state of the resource at the specified\ntime.", + "required": false, + "type": "string", + "x-ms-client-name": "acceptDatetime" }, { - "$ref": "#/parameters/SnapshotFields" + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "name" + ], + "x-ms-enum": { + "name": "LabelFields", + "modelAsString": true, + "values": [ + { + "name": "name", + "value": "name", + "description": "Name field." + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-client-name": "select" }, { - "$ref": "#/parameters/Status" + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/SnapshotListResult" + "$ref": "#/definitions/LabelListResult" }, "headers": { + "Content-Type": { + "type": "string", + "description": "Content-Type header", + "enum": [ + "application/vnd.microsoft.appconfig.labelset+json", + "application/problem+json" + ], + "x-ms-enum": { + "modelAsString": false + } + }, "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "GetSnapshots": { - "$ref": "./examples/GetSnapshots.json" + "Gets a list of labels.": { + "$ref": "./examples/GetLabels.json" } }, "x-ms-pageable": { - "itemName": "items", "nextLinkName": "@nextLink" } }, "head": { - "tags": [ - "Snapshots" - ], + "operationId": "CheckLabels", "summary": "Requests the headers and status of the given resource.", - "operationId": "CheckSnapshots", - "consumes": [], - "produces": [], + "description": "Requests the headers and status of the given resource.", "parameters": [ { - "$ref": "#/parameters/SyncTokens" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "query", + "description": "A filter for the name of the returned labels.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/ApiVersion" + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { "name": "After", "in": "query", - "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", - "type": "string" + "description": "Instructs the server to return elements that appear after the element referred\nto by the specified token.", + "required": false, + "type": "string", + "x-ms-client-name": "after" + }, + { + "name": "Accept-Datetime", + "in": "header", + "description": "Requests the server to respond with the state of the resource at the specified\ntime.", + "required": false, + "type": "string", + "x-ms-client-name": "acceptDatetime" + }, + { + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "name" + ], + "x-ms-enum": { + "name": "LabelFields", + "modelAsString": true, + "values": [ + { + "name": "name", + "value": "name", + "description": "Name field." + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-client-name": "select" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "headers": { "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response." + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + } } }, "x-ms-examples": { - "CheckSnapshots": { - "$ref": "./examples/CheckSnapshots.json" + "Requests the headers and status of the given resource.": { + "$ref": "./examples/CheckLabels.json" } } } }, - "/snapshots/{name}": { - "get": { - "tags": [ - "Snapshots" - ], - "summary": "Gets a single key-value snapshot.", - "operationId": "GetSnapshot", - "consumes": [], + "/locks/{key}": { + "put": { + "operationId": "PutLock", + "summary": "Locks a key-value.", + "description": "Locks a key-value.", "produces": [ - "application/vnd.microsoft.appconfig.snapshot+json", - "application/problem+json" + "application/vnd.microsoft.appconfig.kv+json", + "application/problem+json", + "application/json" ], "parameters": [ { - "$ref": "#/parameters/SyncTokens" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "name", + "name": "key", "in": "path", - "description": "The name of the key-value snapshot to retrieve.", + "description": "The key of the key-value to lock.", "required": true, "type": "string" }, + { + "name": "label", + "in": "query", + "description": "The label, if any, of the key-value to lock.", + "required": false, + "type": "string" + }, + { + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" + }, { "name": "If-Match", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag matches the\nvalue provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag does not\nmatch the value provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" }, { - "$ref": "#/parameters/SnapshotFields" + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/Snapshot" + "$ref": "#/definitions/KeyValue" }, "headers": { - "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "Content-Type": { + "type": "string", + "description": "Content-Type header", + "enum": [ + "application/vnd.microsoft.appconfig.kv+json", + "application/problem+json" + ], + "x-ms-enum": { + "modelAsString": false + } }, "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" + "type": "string", + "description": "A value representing the current state of the resource." }, - "Link": { - "description": "Includes links to related resources.", - "type": "string" + "Sync-Token": { + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "GetSnapshot": { - "$ref": "./examples/GetSnapshot.json" - }, - "GetSnapshot_IfMatch": { - "$ref": "./examples/GetSnapshot_IfMatch.json" - }, - "GetSnapshot_IfNoneMatch": { - "$ref": "./examples/GetSnapshot_IfNoneMatch.json" + "Locks a key-value using If-Match header.": { + "$ref": "./examples/PutLock_IfMatch.json" }, - "GetSnapshot_Failed": { - "$ref": "./examples/GetSnapshot_Failed.json" + "Locks a key-value.": { + "$ref": "./examples/PutLock.json" } } }, - "put": { - "tags": [ - "Snapshots" - ], - "summary": "Creates a key-value snapshot.", - "operationId": "CreateSnapshot", - "consumes": [ - "application/vnd.microsoft.appconfig.snapshot+json", - "application/json" - ], + "delete": { + "operationId": "DeleteLock", + "summary": "Unlocks a key-value.", + "description": "Unlocks a key-value.", "produces": [ - "application/vnd.microsoft.appconfig.snapshot+json", - "application/problem+json" + "application/vnd.microsoft.appconfig.kv+json", + "application/problem+json", + "application/json" ], "parameters": [ { - "name": "name", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "key", "in": "path", - "description": "The name of the key-value snapshot to create.", + "description": "The key of the key-value to unlock.", "required": true, + "type": "string" + }, + { + "name": "label", + "in": "query", + "description": "The label, if any, of the key-value to unlock.", + "required": false, + "type": "string" + }, + { + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, "type": "string", - "maxLength": 256 + "x-ms-client-name": "syncToken" }, { - "name": "entity", - "in": "body", - "description": "The key-value snapshot to create.", - "required": true, - "schema": { - "$ref": "#/definitions/Snapshot" - } + "name": "If-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag matches the\nvalue provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { - "$ref": "#/parameters/SyncTokens" + "name": "If-None-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag does not\nmatch the value provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" }, { - "$ref": "#/parameters/ApiVersion" + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { - "201": { - "description": "Success", + "200": { + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/Snapshot" + "$ref": "#/definitions/KeyValue" }, "headers": { - "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "Content-Type": { + "type": "string", + "description": "Content-Type header", + "enum": [ + "application/vnd.microsoft.appconfig.kv+json", + "application/problem+json" + ], + "x-ms-enum": { + "modelAsString": false + } }, "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" - }, - "Link": { - "description": "Includes links to related resources.", - "type": "string" + "type": "string", + "description": "A value representing the current state of the resource." }, - "Operation-Location": { - "description": "The URL to track the status of the long running operation.", - "type": "string" + "Sync-Token": { + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "CreateSnapshot": { - "$ref": "./examples/CreateSnapshot.json" + "Unlocks a key-value using If-Match header.": { + "$ref": "./examples/DeleteLock_IfMatch.json" + }, + "Unlocks a key-value.": { + "$ref": "./examples/DeleteLock.json" } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "Snapshots" - ], - "summary": "Updates the state of a key-value snapshot.", - "operationId": "UpdateSnapshot", - "consumes": [ - "application/json", - "application/merge-patch+json" - ], - "produces": [ - "application/vnd.microsoft.appconfig.snapshot+json", - "application/problem+json" - ], + } + } + }, + "/operations": { + "get": { + "operationId": "GetOperationDetails", + "summary": "Gets the state of a long running operation.", + "description": "Gets the state of a long running operation.", "parameters": [ { - "name": "name", - "in": "path", - "description": "The name of the key-value snapshot to update.", - "required": true, - "type": "string" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "entity", - "in": "body", - "description": "The parameters used to update the snapshot.", + "name": "snapshot", + "in": "query", + "description": "Snapshot identifier for the long running operation.", "required": true, - "schema": { - "$ref": "#/definitions/SnapshotUpdateParameters" - } - }, - { - "$ref": "#/parameters/SyncTokens" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "If-Match", - "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", "type": "string" }, { - "name": "If-None-Match", - "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", - "type": "string" + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/Snapshot" - }, - "headers": { - "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" - }, - "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" - }, - "Link": { - "description": "Includes links to related resources.", - "type": "string" - } + "$ref": "#/definitions/OperationDetails" } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "UpdateSnapshot": { - "$ref": "./examples/UpdateSnapshot.json" - }, - "UpdateSnapshot_IfMatch": { - "$ref": "./examples/UpdateSnapshot_IfMatch.json" + "Gets the state of a long running operation.": { + "$ref": "./examples/GetOperationStatus.json" } } - }, - "head": { - "tags": [ - "Snapshots" + } + }, + "/revisions": { + "get": { + "operationId": "GetRevisions", + "summary": "Gets a list of key-value revisions.", + "description": "Gets a list of key-value revisions.", + "produces": [ + "application/vnd.microsoft.appconfig.kvset+json", + "application/problem+json", + "application/json" ], - "summary": "Requests the headers and status of the given resource.", - "operationId": "CheckSnapshot", - "consumes": [], - "produces": [], "parameters": [ { - "name": "name", - "in": "path", - "description": "The name of the key-value snapshot to check.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SyncTokens" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ApiVersion" + "name": "key", + "in": "query", + "description": "A filter used to match keys. Syntax reference:\nhttps://aka.ms/azconfig/docs/restapirevisions", + "required": false, + "type": "string" }, { - "name": "If-Match", - "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", + "name": "label", + "in": "query", + "description": "A filter used to match labels. Syntax reference:\nhttps://aka.ms/azconfig/docs/restapirevisions", + "required": false, "type": "string" }, { - "name": "If-None-Match", + "name": "Sync-Token", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "headers": { - "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" - }, - "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" - }, - "Link": { - "description": "Includes links to related resources.", - "type": "string" - } - } - }, - "default": { - "description": "Error response." - } - }, - "x-ms-examples": { - "CheckSnapshot": { - "$ref": "./examples/CheckSnapshot.json" - }, - "CheckSnapshot_IfMatch": { - "$ref": "./examples/CheckSnapshot_IfMatch.json" + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, - "CheckSnapshot_IfNoneMatch": { - "$ref": "./examples/CheckSnapshot_IfNoneMatch.json" - } - } - } - }, - "/labels": { - "get": { - "tags": [ - "Labels" - ], - "summary": "Gets a list of labels.", - "operationId": "GetLabels", - "consumes": [], - "produces": [ - "application/vnd.microsoft.appconfig.labelset+json", - "application/problem+json" - ], - "parameters": [ { - "name": "name", + "name": "After", "in": "query", - "description": "A filter for the name of the returned labels.", - "type": "string" - }, - { - "$ref": "#/parameters/SyncTokens" + "description": "Instructs the server to return elements that appear after the element referred\nto by the specified token.", + "required": false, + "type": "string", + "x-ms-client-name": "after" }, { - "$ref": "#/parameters/ApiVersion" + "name": "Accept-Datetime", + "in": "header", + "description": "Requests the server to respond with the state of the resource at the specified\ntime.", + "required": false, + "type": "string", + "x-ms-client-name": "acceptDatetime" }, { - "name": "After", + "name": "$Select", "in": "query", - "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", - "type": "string" + "description": "Used to select what fields are present in the returned resource(s).", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "key", + "label", + "content_type", + "value", + "last_modified", + "tags", + "locked", + "etag" + ], + "x-ms-enum": { + "name": "KeyValueFields", + "modelAsString": true, + "values": [ + { + "name": "key", + "value": "key", + "description": "Key field." + }, + { + "name": "label", + "value": "label", + "description": "Label field." + }, + { + "name": "content_type", + "value": "content_type", + "description": "Content type field." + }, + { + "name": "value", + "value": "value", + "description": "Value field." + }, + { + "name": "last_modified", + "value": "last_modified", + "description": "Last modified field." + }, + { + "name": "tags", + "value": "tags", + "description": "Tags field." + }, + { + "name": "locked", + "value": "locked", + "description": "Locked field." + }, + { + "name": "etag", + "value": "etag", + "description": "Etag field." + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-client-name": "select" }, { - "name": "Accept-Datetime", - "in": "header", - "description": "Requests the server to respond with the state of the resource at the specified time.", - "type": "string" + "name": "tags", + "in": "query", + "description": "A filter used to query by tags. Syntax reference:\nhttps://aka.ms/azconfig/docs/restapirevisions", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" }, { - "$ref": "#/parameters/LabelFields" + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/LabelListResult" + "$ref": "#/definitions/KeyValueListResult" }, "headers": { + "Content-Type": { + "type": "string", + "description": "Content-Type header", + "enum": [ + "application/vnd.microsoft.appconfig.kvset+json", + "application/problem+json" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "ETag": { + "type": "string", + "description": "A value representing the current state of the resource." + }, "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "GetLabels": { - "$ref": "./examples/GetLabels.json" + "Gets a list of key-value revisions.": { + "$ref": "./examples/GetRevisions.json" } }, "x-ms-pageable": { - "itemName": "items", "nextLinkName": "@nextLink" } }, "head": { - "tags": [ - "Labels" - ], + "operationId": "CheckRevisions", "summary": "Requests the headers and status of the given resource.", - "operationId": "CheckLabels", - "consumes": [], - "produces": [], + "description": "Requests the headers and status of the given resource.", "parameters": [ { - "name": "name", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "key", "in": "query", - "description": "A filter for the name of the returned labels.", + "description": "A filter used to match keys. Syntax reference:\nhttps://aka.ms/azconfig/docs/restapirevisions", + "required": false, "type": "string" }, { - "$ref": "#/parameters/SyncTokens" + "name": "label", + "in": "query", + "description": "A filter used to match labels. Syntax reference:\nhttps://aka.ms/azconfig/docs/restapirevisions", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/ApiVersion" + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { "name": "After", "in": "query", - "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", - "type": "string" + "description": "Instructs the server to return elements that appear after the element referred\nto by the specified token.", + "required": false, + "type": "string", + "x-ms-client-name": "after" }, { "name": "Accept-Datetime", "in": "header", - "description": "Requests the server to respond with the state of the resource at the specified time.", - "type": "string" + "description": "Requests the server to respond with the state of the resource at the specified\ntime.", + "required": false, + "type": "string", + "x-ms-client-name": "acceptDatetime" + }, + { + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "key", + "label", + "content_type", + "value", + "last_modified", + "tags", + "locked", + "etag" + ], + "x-ms-enum": { + "name": "KeyValueFields", + "modelAsString": true, + "values": [ + { + "name": "key", + "value": "key", + "description": "Key field." + }, + { + "name": "label", + "value": "label", + "description": "Label field." + }, + { + "name": "content_type", + "value": "content_type", + "description": "Content type field." + }, + { + "name": "value", + "value": "value", + "description": "Value field." + }, + { + "name": "last_modified", + "value": "last_modified", + "description": "Last modified field." + }, + { + "name": "tags", + "value": "tags", + "description": "Tags field." + }, + { + "name": "locked", + "value": "locked", + "description": "Locked field." + }, + { + "name": "etag", + "value": "etag", + "description": "Etag field." + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-client-name": "select" + }, + { + "name": "tags", + "in": "query", + "description": "A filter used to query by tags. Syntax reference:\nhttps://aka.ms/azconfig/docs/restapirevisions", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" }, { - "$ref": "#/parameters/LabelFields" + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "headers": { + "ETag": { + "type": "string", + "description": "A value representing the current state of the resource." + }, "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response." + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + } } }, "x-ms-examples": { - "CheckLabels": { - "$ref": "./examples/CheckLabels.json" + "Requests the headers and status of the given resource.": { + "$ref": "./examples/CheckRevisions.json" } } } }, - "/locks/{key}": { - "put": { - "tags": [ - "Locks" - ], - "summary": "Locks a key-value.", - "operationId": "PutLock", - "consumes": [], + "/snapshots": { + "get": { + "operationId": "GetSnapshots", + "summary": "Gets a list of key-value snapshots.", + "description": "Gets a list of key-value snapshots.", "produces": [ - "application/vnd.microsoft.appconfig.kv+json", - "application/problem+json" + "application/vnd.microsoft.appconfig.snapshotset+json", + "application/problem+json", + "application/json" ], "parameters": [ { - "name": "key", - "in": "path", - "description": "The key of the key-value to lock.", - "required": true, - "type": "string" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "label", + "name": "name", "in": "query", - "description": "The label, if any, of the key-value to lock.", + "description": "A filter for the name of the returned snapshots.", + "required": false, "type": "string" }, { - "$ref": "#/parameters/SyncTokens" + "name": "After", + "in": "query", + "description": "Instructs the server to return elements that appear after the element referred\nto by the specified token.", + "required": false, + "type": "string", + "x-ms-client-name": "after" }, { - "$ref": "#/parameters/ApiVersion" + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "status", + "filters", + "composition_type", + "created", + "expires", + "retention_period", + "size", + "items_count", + "tags", + "etag" + ], + "x-ms-enum": { + "name": "SnapshotFields", + "modelAsString": true, + "values": [ + { + "name": "name", + "value": "name", + "description": "Name field." + }, + { + "name": "status", + "value": "status", + "description": "Status field." + }, + { + "name": "filters", + "value": "filters", + "description": "Filters field." + }, + { + "name": "composition_type", + "value": "composition_type", + "description": "Composition type field." + }, + { + "name": "created", + "value": "created", + "description": "Created field." + }, + { + "name": "expires", + "value": "expires", + "description": "Expires field." + }, + { + "name": "retention_period", + "value": "retention_period", + "description": "Retention period field." + }, + { + "name": "size", + "value": "size", + "description": "Size field." + }, + { + "name": "items_count", + "value": "items_count", + "description": "Items count field." + }, + { + "name": "tags", + "value": "tags", + "description": "Tags field." + }, + { + "name": "etag", + "value": "etag", + "description": "Etag field." + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-client-name": "select" }, { - "name": "If-Match", - "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", - "type": "string" + "name": "status", + "in": "query", + "description": "Used to filter returned snapshots by their status property.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "provisioning", + "ready", + "archived", + "failed" + ], + "x-ms-enum": { + "name": "SnapshotStatus", + "modelAsString": true, + "values": [ + { + "name": "provisioning", + "value": "provisioning", + "description": "Provisioning" + }, + { + "name": "ready", + "value": "ready", + "description": "Ready" + }, + { + "name": "archived", + "value": "archived", + "description": "Archived" + }, + { + "name": "failed", + "value": "failed", + "description": "Failed" + } + ] + } + }, + "collectionFormat": "csv" }, { - "name": "If-None-Match", + "name": "Sync-Token", "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", - "type": "string" + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/KeyValue" + "$ref": "#/definitions/SnapshotListResult" }, "headers": { - "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "Content-Type": { + "type": "string", + "description": "Content-Type header", + "enum": [ + "application/vnd.microsoft.appconfig.snapshotset+json", + "application/problem+json" + ], + "x-ms-enum": { + "modelAsString": false + } }, - "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" + "Sync-Token": { + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "PutLock": { - "$ref": "./examples/PutLock.json" - }, - "PutLock_IfMatch": { - "$ref": "./examples/PutLock_IfMatch.json" + "Gets a list of key-value snapshots.": { + "$ref": "./examples/GetSnapshots.json" } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" } }, - "delete": { - "tags": [ - "Locks" - ], - "summary": "Unlocks a key-value.", - "operationId": "DeleteLock", - "consumes": [], - "produces": [ - "application/vnd.microsoft.appconfig.kv+json", - "application/problem+json" - ], + "head": { + "operationId": "CheckSnapshots", + "summary": "Requests the headers and status of the given resource.", + "description": "Requests the headers and status of the given resource.", "parameters": [ { - "name": "key", - "in": "path", - "description": "The key of the key-value to unlock.", - "required": true, - "type": "string" - }, - { - "name": "label", - "in": "query", - "description": "The label, if any, of the key-value to unlock.", - "type": "string" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/SyncTokens" - }, - { - "$ref": "#/parameters/ApiVersion" + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { - "name": "If-Match", - "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", - "type": "string" + "name": "After", + "in": "query", + "description": "Instructs the server to return elements that appear after the element referred\nto by the specified token.", + "required": false, + "type": "string", + "x-ms-client-name": "after" }, { - "name": "If-None-Match", - "in": "header", - "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", - "type": "string" + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/KeyValue" - }, + "description": "The request has succeeded.", "headers": { "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" - }, - "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "DeleteLock": { - "$ref": "./examples/DeleteLock.json" - }, - "DeleteLock_IfMatch": { - "$ref": "./examples/DeleteLock_IfMatch.json" + "Requests the headers and status of the given resource.": { + "$ref": "./examples/CheckSnapshots.json" } } } }, - "/revisions": { + "/snapshots/{name}": { "get": { - "tags": [ - "Revisions" - ], - "summary": "Gets a list of key-value revisions.", - "operationId": "GetRevisions", - "consumes": [], + "operationId": "GetSnapshot", + "summary": "Gets a single key-value snapshot.", + "description": "Gets a single key-value snapshot.", "produces": [ - "application/vnd.microsoft.appconfig.kvset+json", - "application/problem+json" + "application/vnd.microsoft.appconfig.snapshot+json", + "application/problem+json", + "application/json" ], "parameters": [ { - "name": "key", - "in": "query", - "description": "A filter used to match keys. Syntax reference: https://aka.ms/azconfig/docs/restapirevisions", - "type": "string" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "label", - "in": "query", - "description": "A filter used to match labels. Syntax reference: https://aka.ms/azconfig/docs/restapirevisions", + "name": "name", + "in": "path", + "description": "The name of the snapshot.", + "required": true, "type": "string" }, { - "$ref": "#/parameters/SyncTokens" - }, - { - "$ref": "#/parameters/ApiVersion" + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "name", + "status", + "filters", + "composition_type", + "created", + "expires", + "retention_period", + "size", + "items_count", + "tags", + "etag" + ], + "x-ms-enum": { + "name": "SnapshotFields", + "modelAsString": true, + "values": [ + { + "name": "name", + "value": "name", + "description": "Name field." + }, + { + "name": "status", + "value": "status", + "description": "Status field." + }, + { + "name": "filters", + "value": "filters", + "description": "Filters field." + }, + { + "name": "composition_type", + "value": "composition_type", + "description": "Composition type field." + }, + { + "name": "created", + "value": "created", + "description": "Created field." + }, + { + "name": "expires", + "value": "expires", + "description": "Expires field." + }, + { + "name": "retention_period", + "value": "retention_period", + "description": "Retention period field." + }, + { + "name": "size", + "value": "size", + "description": "Size field." + }, + { + "name": "items_count", + "value": "items_count", + "description": "Items count field." + }, + { + "name": "tags", + "value": "tags", + "description": "Tags field." + }, + { + "name": "etag", + "value": "etag", + "description": "Etag field." + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-client-name": "select" }, { - "name": "After", - "in": "query", - "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", - "type": "string" + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { - "name": "Accept-Datetime", + "name": "If-Match", "in": "header", - "description": "Requests the server to respond with the state of the resource at the specified time.", - "type": "string" + "description": "Used to perform an operation only if the targeted resource's etag matches the\nvalue provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { - "$ref": "#/parameters/KeyValueFields" + "name": "If-None-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag does not\nmatch the value provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" }, { - "name": "tags", - "in": "query", - "description": "A filter used to query by tags. Syntax reference: https://aka.ms/azconfig/docs/restapirevisions", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "uniqueItems": true + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/KeyValueListResult" + "$ref": "#/definitions/Snapshot" }, "headers": { - "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "Content-Type": { + "type": "string", + "description": "Content-Type header", + "enum": [ + "application/vnd.microsoft.appconfig.snapshot+json", + "application/problem+json" + ], + "x-ms-enum": { + "modelAsString": false + } }, "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" + "type": "string", + "description": "A value representing the current state of the resource." + }, + "Link": { + "type": "string", + "description": "Includes links to related resources." + }, + "Sync-Token": { + "type": "string", + "description": "Used to guarantee real-time consistency between requests." + }, + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." } } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "GetRevisions": { - "$ref": "./examples/GetRevisions.json" + "Gets a single key-value snapshot failed.": { + "$ref": "./examples/GetSnapshot_Failed.json" + }, + "Gets a single key-value snapshot using If-Match header.": { + "$ref": "./examples/GetSnapshot_IfMatch.json" + }, + "Gets a single key-value snapshot using If-None-Match header.": { + "$ref": "./examples/GetSnapshot_IfNoneMatch.json" + }, + "Gets a single key-value snapshot.": { + "$ref": "./examples/GetSnapshot.json" } - }, - "x-ms-pageable": { - "itemName": "items", - "nextLinkName": "@nextLink" } }, - "head": { - "tags": [ - "Revisions" + "put": { + "operationId": "CreateSnapshot", + "summary": "Creates a key-value snapshot.", + "description": "Creates a key-value snapshot.", + "produces": [ + "application/vnd.microsoft.appconfig.snapshot+json", + "application/problem+json", + "application/json" + ], + "consumes": [ + "application/vnd.microsoft.appconfig.snapshot+json", + "application/json" ], - "summary": "Requests the headers and status of the given resource.", - "operationId": "CheckRevisions", - "consumes": [], - "produces": [], "parameters": [ { - "name": "key", - "in": "query", - "description": "A filter used to match keys. Syntax reference: https://aka.ms/azconfig/docs/restapirevisions", - "type": "string" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "label", - "in": "query", - "description": "A filter used to match labels. Syntax reference: https://aka.ms/azconfig/docs/restapirevisions", - "type": "string" + "name": "name", + "in": "path", + "description": "The name of the key-value snapshot to create.", + "required": true, + "type": "string", + "maxLength": 256 + }, + { + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { - "$ref": "#/parameters/SyncTokens" + "name": "entity", + "in": "body", + "description": "The key-value snapshot to create.", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "Content-Type header", + "enum": [ + "application/vnd.microsoft.appconfig.snapshot+json", + "application/problem+json" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "ETag": { + "type": "string", + "description": "A value representing the current state of the resource." + }, + "Link": { + "type": "string", + "description": "Includes links to related resources." + }, + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "Sync-Token": { + "type": "string", + "description": "Used to guarantee real-time consistency between requests." + } + } }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Creates a key-value snapshot.": { + "$ref": "./examples/CreateSnapshot.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "UpdateSnapshot", + "summary": "Updates the state of a key-value snapshot.", + "description": "Updates the state of a key-value snapshot.", + "produces": [ + "application/vnd.microsoft.appconfig.snapshot+json", + "application/problem+json", + "application/json" + ], + "consumes": [ + "application/merge-patch+json", + "application/json" + ], + "parameters": [ { - "$ref": "#/parameters/ApiVersion" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "After", - "in": "query", - "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", + "name": "name", + "in": "path", + "description": "The name of the key-value snapshot to update.", + "required": true, "type": "string" }, { - "name": "Accept-Datetime", + "name": "Sync-Token", "in": "header", - "description": "Requests the server to respond with the state of the resource at the specified time.", - "type": "string" + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" }, { - "$ref": "#/parameters/KeyValueFields" + "name": "If-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag matches the\nvalue provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { - "name": "tags", - "in": "query", - "description": "A filter used to query by tags. Syntax reference: https://aka.ms/azconfig/docs/restapirevisions", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "uniqueItems": true + "name": "If-None-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag does not\nmatch the value provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "name": "entity", + "in": "body", + "description": "The parameters used to update the snapshot.", + "required": true, + "schema": { + "$ref": "#/definitions/SnapshotUpdateParameters" + } } ], "responses": { "200": { - "description": "Success", + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Snapshot" + }, "headers": { - "Sync-Token": { - "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", - "type": "string" + "Content-Type": { + "type": "string", + "description": "Content-Type header", + "enum": [ + "application/vnd.microsoft.appconfig.snapshot+json", + "application/problem+json" + ], + "x-ms-enum": { + "modelAsString": false + } }, "ETag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" + "type": "string", + "description": "A value representing the current state of the resource." + }, + "Link": { + "type": "string", + "description": "Includes links to related resources." + }, + "Sync-Token": { + "type": "string", + "description": "Used to guarantee real-time consistency between requests." } } }, "default": { - "description": "Error response." + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Error" + } } }, "x-ms-examples": { - "CheckRevisions": { - "$ref": "./examples/CheckRevisions.json" + "Updates the state of a key-value snapshot using the If-Match header.": { + "$ref": "./examples/UpdateSnapshot_IfMatch.json" + }, + "Updates the state of a key-value snapshot.": { + "$ref": "./examples/UpdateSnapshot.json" } } - } - }, - "/operations": { - "get": { - "tags": [ - "Operations" - ], - "summary": "Gets the state of a long running operation.", - "operationId": "GetOperationDetails", - "consumes": [], - "produces": [ - "application/json" - ], + }, + "head": { + "operationId": "CheckSnapshot", + "summary": "Requests the headers and status of the given resource.", + "description": "Requests the headers and status of the given resource.", "parameters": [ { - "$ref": "#/parameters/ApiVersion" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "snapshot", - "in": "query", - "description": "Snapshot identifier for the long running operation.", + "name": "name", + "in": "path", + "description": "The name of the key-value snapshot to check.", "required": true, "type": "string" + }, + { + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "required": false, + "type": "string", + "x-ms-client-name": "syncToken" + }, + { + "name": "If-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag matches the\nvalue provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag does not\nmatch the value provided.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OperationDetails" + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "A value representing the current state of the resource." + }, + "Link": { + "type": "string", + "description": "Includes links to related resources." + }, + "Sync-Token": { + "type": "string", + "description": "Used to guarantee real-time consistency between requests." + } } }, "default": { - "description": "Error response describing why the operation failed", + "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Error" } } }, "x-ms-examples": { - "GetOperationStatus": { - "$ref": "./examples/GetOperationStatus.json" + "Requests the headers and status of the given resource using If-Match header.": { + "$ref": "./examples/CheckSnapshot_IfMatch.json" + }, + "Requests the headers and status of the given resource using If-None-Match header": { + "$ref": "./examples/CheckSnapshot_IfNoneMatch.json" + }, + "Requests the headers and status of the given resource.": { + "$ref": "./examples/CheckSnapshot.json" } } } } }, "definitions": { - "Key": { + "Azure.Core.Foundations.Error": { "type": "object", + "description": "The error object.", "properties": { - "name": { - "type": "string", - "readOnly": true, - "description": "The name of the key." - } - } - }, - "KeyValue": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the key-value." - }, - "label": { - "type": "string", - "description": "The label the key-value belongs to." - }, - "content_type": { + "code": { "type": "string", - "description": "The content type of the value stored within the key-value." + "description": "One of a server-defined set of error codes." }, - "value": { + "message": { "type": "string", - "description": "The value of the key-value." + "description": "A human-readable representation of the error." }, - "last_modified": { - "format": "date-time", + "target": { "type": "string", - "description": "A date representing the last time the key-value was modified." + "description": "The target of the error." }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" }, - "description": "The tags of the key-value" - }, - "locked": { - "type": "boolean", - "description": "Indicates whether the key-value is locked." + "x-ms-identifiers": [] }, - "etag": { - "type": "string", - "description": "A value representing the current state of the resource." + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." } - } + }, + "required": [ + "code", + "message" + ] }, - "Snapshot": { + "Azure.Core.Foundations.InnerError": { "type": "object", - "required": [ - "filters" - ], + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", "properties": { - "name": { - "description": "The name of the snapshot.", + "code": { "type": "string", - "readOnly": true + "description": "One of a server-defined set of error codes." }, - "status": { - "description": "The current status of the snapshot.", - "type": "string", - "enum": [ - "provisioning", - "ready", - "archived", - "failed" - ], - "x-ms-enum": { - "name": "SnapshotStatus", - "modelAsString": true + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "Azure.Core.Foundations.OperationState": { + "type": "string", + "description": "Enum describing allowed operation states.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "NotStarted", + "description": "The operation has not started." }, - "readOnly": true - }, - "filters": { - "description": "A list of filters used to filter the key-values included in the snapshot.", - "type": "array", - "minItems": 1, - "maxItems": 3, - "items": { - "$ref": "#/definitions/KeyValueFilter" + { + "name": "Running", + "value": "Running", + "description": "The operation is in progress." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The operation has completed successfully." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The operation has failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The operation has been canceled by the user." } - }, - "composition_type": { - "description": "The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label.", - "type": "string", - "enum": [ - "key", - "key_label" - ], - "x-ms-enum": { - "name": "CompositionType", - "modelAsString": true + ] + } + }, + "CompositionType": { + "type": "string", + "description": "Composition types.", + "enum": [ + "key", + "key_label" + ], + "x-ms-enum": { + "name": "CompositionType", + "modelAsString": true, + "values": [ + { + "name": "key", + "value": "key", + "description": "The 'key' composition type." + }, + { + "name": "key_label", + "value": "key_label", + "description": "The 'key_label' composition type." } + ] + } + }, + "Error": { + "type": "object", + "description": "Azure App Configuration error object.", + "properties": { + "type": { + "type": "string", + "description": "The type of the error." }, - "created": { - "description": "The time that the snapshot was created.", - "format": "date-time", + "title": { "type": "string", - "readOnly": true + "description": "A brief summary of the error." }, - "expires": { - "description": "The time that the snapshot will expire.", - "format": "date-time", + "name": { "type": "string", - "readOnly": true + "description": "The name of the parameter that resulted in the error." }, - "retention_period": { - "description": "The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used.", - "type": "integer", - "minimum": 3600, - "maximum": 7776000, - "format": "int64" + "detail": { + "type": "string", + "description": "A detailed description of the error." }, - "size": { - "description": "The size in bytes of the snapshot.", + "status": { "type": "integer", - "format": "int64", + "format": "int32", + "description": "The HTTP status code that the error maps to." + } + } + }, + "Key": { + "type": "object", + "description": "Keys serve as identifiers for key-values and are used to store and retrieve corresponding values.", + "properties": { + "name": { + "type": "string", + "description": "The name of the key.", "readOnly": true + } + }, + "required": [ + "name" + ] + }, + "KeyListResult": { + "type": "object", + "description": "The result of a list request.", + "properties": { + "items": { + "type": "array", + "description": "The collection value.", + "items": { + "$ref": "#/definitions/Key" + }, + "x-ms-identifiers": [] }, - "items_count": { - "description": "The amount of key-values in the snapshot.", - "type": "integer", - "format": "int64", + "@nextLink": { + "type": "string", + "description": "The URI that can be used to request the next set of paged results." + } + } + }, + "KeyValue": { + "type": "object", + "description": "A key-value pair representing application settings.", + "properties": { + "key": { + "type": "string", + "description": "The key of the key-value.", "readOnly": true }, + "label": { + "type": "string", + "description": "The label the key-value belongs to." + }, + "content_type": { + "type": "string", + "description": "The content type of the value stored within the key-value.", + "x-ms-client-name": "contentType" + }, + "value": { + "type": "string", + "description": "The value of the key-value." + }, + "last_modified": { + "type": "string", + "format": "date-time", + "description": "A date representing the last time the key-value was modified.", + "x-ms-client-name": "lastModified" + }, "tags": { - "description": "The tags of the snapshot.", "type": "object", + "description": "The tags of the key-value", "additionalProperties": { "type": "string" } }, + "locked": { + "type": "boolean", + "description": "Indicates whether the key-value is locked." + }, "etag": { - "description": "A value representing the current state of the snapshot.", "type": "string", - "readOnly": true + "description": "A value representing the current state of the resource." } + }, + "required": [ + "key" + ] + }, + "KeyValueFields": { + "type": "string", + "description": "Key-value fields.", + "enum": [ + "key", + "label", + "content_type", + "value", + "last_modified", + "tags", + "locked", + "etag" + ], + "x-ms-enum": { + "name": "KeyValueFields", + "modelAsString": true, + "values": [ + { + "name": "key", + "value": "key", + "description": "Key field." + }, + { + "name": "label", + "value": "label", + "description": "Label field." + }, + { + "name": "content_type", + "value": "content_type", + "description": "Content type field." + }, + { + "name": "value", + "value": "value", + "description": "Value field." + }, + { + "name": "last_modified", + "value": "last_modified", + "description": "Last modified field." + }, + { + "name": "tags", + "value": "tags", + "description": "Tags field." + }, + { + "name": "locked", + "value": "locked", + "description": "Locked field." + }, + { + "name": "etag", + "value": "etag", + "description": "Etag field." + } + ] } }, "KeyValueFilter": { - "description": "Enables filtering of key-values. Syntax reference: https://aka.ms/azconfig/docs/restapisnapshots", "type": "object", - "required": [ - "key" - ], + "description": "Enables filtering of key-values. Syntax reference:\nhttps://aka.ms/azconfig/docs/restapisnapshots", "properties": { "key": { - "description": "Filters key-values by their key field.", - "type": "string" + "type": "string", + "description": "Filters key-values by their key field." }, "label": { - "description": "Filters key-values by their label field.", - "type": "string" + "type": "string", + "description": "Filters key-values by their label field." }, "tags": { - "description": "Filters key-values by their tags field.", "type": "array", + "description": "Filters key-values by their tags field.", "items": { "type": "string" - }, - "uniqueItems": true - } - } - }, - "SnapshotUpdateParameters": { - "description": "Parameters used to update a snapshot.", - "type": "object", - "properties": { - "status": { - "description": "The desired status of the snapshot.", - "type": "string", - "enum": [ - "provisioning", - "ready", - "archived", - "failed" - ], - "x-ms-enum": { - "name": "SnapshotStatus", - "modelAsString": true } } - } + }, + "required": [ + "key" + ] }, - "SnapshotListResult": { - "description": "The result of a snapshot list request.", + "KeyValueListResult": { "type": "object", + "description": "The result of a list request.", "properties": { "items": { - "description": "The collection value.", "type": "array", + "description": "The collection value.", "items": { - "$ref": "#/definitions/Snapshot" - } + "$ref": "#/definitions/KeyValue" + }, + "x-ms-identifiers": [] + }, + "etag": { + "type": "string", + "description": "An identifier representing the returned state of the resource." }, "@nextLink": { - "description": "The URI that can be used to request the next set of paged results.", - "type": "string" + "type": "string", + "description": "The URI that can be used to request the next set of paged results." } } }, "Label": { "type": "object", + "description": "Labels are used to group key-values.", "properties": { "name": { "type": "string", - "readOnly": true, "description": "The name of the label." } } }, - "Error": { - "description": "Azure App Configuration error object.", + "LabelFields": { + "type": "string", + "description": "Label fields.", + "enum": [ + "name" + ], + "x-ms-enum": { + "name": "LabelFields", + "modelAsString": true, + "values": [ + { + "name": "name", + "value": "name", + "description": "Name field." + } + ] + } + }, + "LabelListResult": { "type": "object", + "description": "The result of a list request.", "properties": { - "type": { - "description": "The type of the error.", - "type": "string" - }, - "title": { - "description": "A brief summary of the error.", - "type": "string" - }, - "name": { - "description": "The name of the parameter that resulted in the error.", - "type": "string" - }, - "detail": { - "description": "A detailed description of the error.", - "type": "string" + "items": { + "type": "array", + "description": "The collection value.", + "items": { + "$ref": "#/definitions/Label" + }, + "x-ms-identifiers": [] }, - "status": { - "description": "The HTTP status code that the error maps to.", - "type": "integer" + "@nextLink": { + "type": "string", + "description": "The URI that can be used to request the next set of paged results." } - }, - "readOnly": true + } }, "OperationDetails": { - "description": "Details of a long running operation.", "type": "object", + "description": "Details of a long running operation.", "properties": { "id": { - "description": "The unique id of the operation.", - "type": "string" + "type": "string", + "description": "The unique id of the operation." }, "status": { - "description": "The current status of the operation", - "enum": [ - "NotStarted", - "Running", - "Succeeded", - "Failed", - "Canceled" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": false, - "name": "State" - } + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "The current status of the operation" }, "error": { - "description": "An error, available when the status is `Failed`, describing why the operation failed.", - "$ref": "#/definitions/ErrorDetail" + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "An error, available when the status is `Failed`, describing why the operation\nfailed." } }, "required": [ @@ -1901,255 +3081,249 @@ "status" ] }, - "ErrorDetail": { - "description": "The details of an error.", + "Snapshot": { "type": "object", + "description": "A snapshot is a named, immutable subset of an App Configuration store's key-values.", "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "type": "string" + "name": { + "type": "string", + "description": "The name of the snapshot.", + "readOnly": true }, - "message": { - "description": "A human-readable representation of the error.", - "type": "string" + "status": { + "$ref": "#/definitions/SnapshotStatus", + "description": "The current status of the snapshot.", + "readOnly": true }, - "details": { - "description": "An array of details about specific errors that led to this reported error.", + "filters": { "type": "array", + "description": "A list of filters used to filter the key-values included in the snapshot.", + "minItems": 1, + "maxItems": 3, "items": { - "$ref": "#/definitions/ErrorDetail" + "$ref": "#/definitions/KeyValueFilter" + }, + "x-ms-identifiers": [] + }, + "composition_type": { + "$ref": "#/definitions/CompositionType", + "description": "The composition type describes how the key-values within the snapshot are\ncomposed. The 'key' composition type ensures there are no two key-values\ncontaining the same key. The 'key_label' composition type ensures there are no\ntwo key-values containing the same key and label.", + "x-ms-client-name": "compositionType" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The time that the snapshot was created.", + "readOnly": true + }, + "expires": { + "type": "string", + "format": "date-time", + "description": "The time that the snapshot will expire.", + "readOnly": true + }, + "retention_period": { + "type": "integer", + "format": "int64", + "description": "The amount of time, in seconds, that a snapshot will remain in the archived\nstate before expiring. This property is only writable during the creation of a\nsnapshot. If not specified, the default lifetime of key-value revisions will be\nused.", + "minimum": 3600, + "maximum": 7776000, + "x-ms-client-name": "retentionPeriod" + }, + "size": { + "type": "integer", + "format": "int64", + "description": "The size in bytes of the snapshot.", + "readOnly": true + }, + "items_count": { + "type": "integer", + "format": "int64", + "description": "The amount of key-values in the snapshot.", + "readOnly": true, + "x-ms-client-name": "itemsCount" + }, + "tags": { + "type": "object", + "description": "The tags of the snapshot.", + "additionalProperties": { + "type": "string" } }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerError" + "etag": { + "type": "string", + "description": "A value representing the current state of the snapshot.", + "readOnly": true } }, "required": [ - "code", - "message" + "name", + "filters" ] }, - "InnerError": { - "description": "An object containing specific information about an error.", - "type": "object", - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "type": "string" - }, - "innererror": { - "description": "An object containing more specific information than the current object about the error.", - "$ref": "#/definitions/InnerError" - } + "SnapshotFields": { + "type": "string", + "description": "Snapshot fields.", + "enum": [ + "name", + "status", + "filters", + "composition_type", + "created", + "expires", + "retention_period", + "size", + "items_count", + "tags", + "etag" + ], + "x-ms-enum": { + "name": "SnapshotFields", + "modelAsString": true, + "values": [ + { + "name": "name", + "value": "name", + "description": "Name field." + }, + { + "name": "status", + "value": "status", + "description": "Status field." + }, + { + "name": "filters", + "value": "filters", + "description": "Filters field." + }, + { + "name": "composition_type", + "value": "composition_type", + "description": "Composition type field." + }, + { + "name": "created", + "value": "created", + "description": "Created field." + }, + { + "name": "expires", + "value": "expires", + "description": "Expires field." + }, + { + "name": "retention_period", + "value": "retention_period", + "description": "Retention period field." + }, + { + "name": "size", + "value": "size", + "description": "Size field." + }, + { + "name": "items_count", + "value": "items_count", + "description": "Items count field." + }, + { + "name": "tags", + "value": "tags", + "description": "Tags field." + }, + { + "name": "etag", + "value": "etag", + "description": "Etag field." + } + ] } }, - "KeyListResult": { - "description": "The result of a list request.", + "SnapshotListResult": { "type": "object", + "description": "The result of a snapshot list request.", "properties": { "items": { - "description": "The collection value.", "type": "array", + "description": "The collection value.", "items": { - "$ref": "#/definitions/Key" - } + "$ref": "#/definitions/Snapshot" + }, + "x-ms-identifiers": [] }, "@nextLink": { - "description": "The URI that can be used to request the next set of paged results.", - "type": "string" + "type": "string", + "description": "The URI that can be used to request the next set of paged results." } } }, - "KeyValueListResult": { - "description": "The result of a list request.", - "type": "object", - "properties": { - "items": { - "description": "The collection value.", - "type": "array", - "items": { - "$ref": "#/definitions/KeyValue" + "SnapshotStatus": { + "type": "string", + "description": "Snapshot status.", + "enum": [ + "provisioning", + "ready", + "archived", + "failed" + ], + "x-ms-enum": { + "name": "SnapshotStatus", + "modelAsString": true, + "values": [ + { + "name": "provisioning", + "value": "provisioning", + "description": "Provisioning" + }, + { + "name": "ready", + "value": "ready", + "description": "Ready" + }, + { + "name": "archived", + "value": "archived", + "description": "Archived" + }, + { + "name": "failed", + "value": "failed", + "description": "Failed" } - }, - "etag": { - "description": "An identifier representing the returned state of the resource.", - "type": "string" - }, - "@nextLink": { - "description": "The URI that can be used to request the next set of paged results.", - "type": "string" - } + ] } }, - "LabelListResult": { - "description": "The result of a list request.", + "SnapshotUpdateParameters": { "type": "object", + "description": "Parameters used to update a snapshot.", "properties": { - "items": { - "description": "The collection value.", - "type": "array", - "items": { - "$ref": "#/definitions/Label" - } - }, - "@nextLink": { - "description": "The URI that can be used to request the next set of paged results.", - "type": "string" + "status": { + "$ref": "#/definitions/SnapshotStatus", + "description": "The desired status of the snapshot." } } } }, "parameters": { - "SyncTokens": { - "name": "Sync-Token", + "Azure.Core.ClientRequestIdHeader": { + "name": "x-ms-client-request-id", "in": "header", - "description": "Used to guarantee real-time consistency between requests.", - "type": "string" + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method", + "x-ms-client-name": "clientRequestId" }, - "ApiVersion": { + "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", - "description": "The API version to be used with the HTTP request.", - "required": true, - "type": "string" - }, - "Endpoint": { - "name": "endpoint", - "in": "path", - "description": "The endpoint of the App Configuration instance to send requests to.", + "description": "The API version to use for this operation.", "required": true, "type": "string", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "client" - }, - "KeyValueFields": { - "name": "$Select", - "in": "query", - "description": "Used to select what fields are present in the returned resource(s).", - "type": "array", - "items": { - "type": "string", - "enum": [ - "key", - "label", - "content_type", - "value", - "last_modified", - "tags", - "locked", - "etag" - ], - "x-ms-enum": { - "name": "KeyValueFields", - "modelAsString": true - } - }, - "x-ms-parameter-location": "method", - "collectionFormat": "csv" - }, - "LabelFields": { - "name": "$Select", - "in": "query", - "description": "Used to select what fields are present in the returned resource(s).", - "type": "array", - "items": { - "type": "string", - "enum": [ - "name" - ], - "x-ms-enum": { - "name": "LabelFields", - "modelAsString": true - } - }, - "x-ms-parameter-location": "method", - "collectionFormat": "csv" - }, - "SnapshotFields": { - "name": "$Select", - "in": "query", - "description": "Used to select what fields are present in the returned resource(s).", - "type": "array", - "items": { - "type": "string", - "enum": [ - "name", - "status", - "filters", - "composition_type", - "created", - "expires", - "retention_period", - "size", - "items_count", - "tags", - "etag" - ], - "x-ms-enum": { - "name": "SnapshotFields", - "modelAsString": true - } - }, + "minLength": 1, "x-ms-parameter-location": "method", - "collectionFormat": "csv" - }, - "Status": { - "name": "status", - "in": "query", - "description": "Used to filter returned snapshots by their status property.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "provisioning", - "ready", - "archived", - "failed" - ], - "x-ms-enum": { - "name": "SnapshotStatus", - "modelAsString": true - } - }, - "x-ms-parameter-location": "method", - "collectionFormat": "csv" - } - }, - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "#/parameters/Endpoint" - } - ] - }, - "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" - } - }, - "connection_string": { - "type": "apiKey", - "description": "Connection string secret used to connect to an App Config resource.", - "name": "Connection String", - "in": "header" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - }, - { - "connection_string": [] + "x-ms-client-name": "apiVersion" } - ] + } } diff --git a/swagger-specs/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json b/swagger-specs/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json new file mode 100644 index 000000000..ae5c9edcd --- /dev/null +++ b/swagger-specs/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json @@ -0,0 +1,2559 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-03-01", + "title": "AppConfigurationManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/configurationStores": { + "get": { + "tags": [ + "ConfigurationStores" + ], + "description": "Lists the configuration stores for a given subscription.", + "operationId": "ConfigurationStores_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStoreListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_List": { + "$ref": "./examples/ConfigurationStoresList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores": { + "get": { + "tags": [ + "ConfigurationStores" + ], + "description": "Lists the configuration stores for a given resource group.", + "operationId": "ConfigurationStores_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStoreListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_ListByResourceGroup": { + "$ref": "./examples/ConfigurationStoresListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}": { + "get": { + "tags": [ + "ConfigurationStores" + ], + "description": "Gets the properties of the specified configuration store.", + "operationId": "ConfigurationStores_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_Get": { + "$ref": "./examples/ConfigurationStoresGet.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationStores" + ], + "description": "Creates a configuration store with the specified parameters.", + "operationId": "ConfigurationStores_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "configStoreCreationParameters", + "in": "body", + "description": "The parameters for creating a configuration store.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_Create": { + "$ref": "./examples/ConfigurationStoresCreate.json" + }, + "ConfigurationStores_Create_With_Identity": { + "$ref": "./examples/ConfigurationStoresCreateWithIdentity.json" + }, + "ConfigurationStores_Create_With_Local_Auth_Disabled": { + "$ref": "./examples/ConfigurationStoresCreateWithLocalAuthDisabled.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ConfigurationStores" + ], + "description": "Deletes a configuration store.", + "operationId": "ConfigurationStores_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "No Content - the specified resource was not found." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_Delete": { + "$ref": "./examples/ConfigurationStoresDelete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ConfigurationStores" + ], + "description": "Updates a configuration store with the specified parameters.", + "operationId": "ConfigurationStores_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "configStoreUpdateParameters", + "in": "body", + "description": "The parameters for updating a configuration store.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationStoreUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_Update": { + "$ref": "./examples/ConfigurationStoresUpdate.json" + }, + "ConfigurationStores_Update_With_Identity": { + "$ref": "./examples/ConfigurationStoresUpdateWithIdentity.json" + }, + "ConfigurationStores_Update_Disable_Local_Auth": { + "$ref": "./examples/ConfigurationStoresUpdateDisableLocalAuth.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/checkNameAvailability": { + "post": { + "tags": [ + "Operations" + ], + "description": "Checks whether the configuration store name is available for use.", + "operationId": "Operations_CheckNameAvailability", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "checkNameAvailabilityParameters", + "in": "body", + "description": "The object containing information for the availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NameAvailabilityStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_CheckNameAvailable": { + "$ref": "./examples/CheckNameAvailable.json" + }, + "ConfigurationStores_CheckNameNotAvailable": { + "$ref": "./examples/CheckNameNotAvailable.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys": { + "post": { + "tags": [ + "ConfigurationStores" + ], + "description": "Lists the access key for the specified configuration store.", + "operationId": "ConfigurationStores_ListKeys", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ApiKeyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_ListKeys": { + "$ref": "./examples/ConfigurationStoresListKeys.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/regenerateKey": { + "post": { + "tags": [ + "ConfigurationStores" + ], + "description": "Regenerates an access key for the specified configuration store.", + "operationId": "ConfigurationStores_RegenerateKey", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "regenerateKeyParameters", + "in": "body", + "description": "The parameters for regenerating an access key.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ApiKey" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_RegenerateKey": { + "$ref": "./examples/ConfigurationStoresRegenerateKey.json" + } + } + } + }, + "/providers/Microsoft.AppConfiguration/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists the operations available from this provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OperationDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/OperationsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_ListByConfigurationStore", + "description": "Lists all private endpoint connections for a configuration store.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnection_List": { + "$ref": "./examples/ConfigurationStoresListPrivateEndpointConnections.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the configuration store.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnection_GetConnection": { + "$ref": "./examples/ConfigurationStoresGetPrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "description": "Update the state of the specified private endpoint connection associated with the configuration store. This operation cannot be used to create a private endpoint connection. Private endpoint connections must be created with the Network resource provider.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection name", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The private endpoint connection properties.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnection_Update": { + "$ref": "./examples/ConfigurationStoresUpdatePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "No Content - the specified resource was not found." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Delete": { + "$ref": "./examples/ConfigurationStoresDeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByConfigurationStore", + "description": "Gets the private link resources that need to be created for a configuration store.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_ListGroupIds": { + "$ref": "./examples/PrivateLinkResourcesListByConfigurationStore.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_Get", + "description": "Gets a private link resource that need to be created for a configuration store.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_Get": { + "$ref": "./examples/PrivateLinkResourceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}": { + "get": { + "tags": [ + "KeyValues" + ], + "description": "Gets the properties of the specified key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.", + "operationId": "KeyValues_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "keyValueName", + "in": "path", + "description": "Identifier of key and label combination. Key and label are joined by $ character. Label is optional.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/KeyValue" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "KeyValues_Get": { + "$ref": "./examples/ConfigurationStoresGetKeyValue.json" + } + } + }, + "put": { + "tags": [ + "KeyValues" + ], + "description": "Creates a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.", + "operationId": "KeyValues_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "keyValueName", + "in": "path", + "description": "Identifier of key and label combination. Key and label are joined by $ character. Label is optional.", + "required": true, + "type": "string" + }, + { + "name": "keyValueParameters", + "in": "body", + "description": "The parameters for creating a key-value.", + "required": false, + "schema": { + "$ref": "#/definitions/KeyValue" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/KeyValue" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "KeyValues_CreateOrUpdate": { + "$ref": "./examples/ConfigurationStoresCreateKeyValue.json" + } + } + }, + "delete": { + "tags": [ + "KeyValues" + ], + "description": "Deletes a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.", + "operationId": "KeyValues_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "keyValueName", + "in": "path", + "description": "Identifier of key and label combination. Key and label are joined by $ character. Label is optional.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "No Content - the specified resource was not found." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "KeyValues_Delete": { + "$ref": "./examples/ConfigurationStoresDeleteKeyValue.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/deletedConfigurationStores": { + "get": { + "tags": [ + "DeletedConfigurationStores" + ], + "operationId": "ConfigurationStores_ListDeleted", + "description": "Gets information about the deleted configuration stores in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved information about all deleted configuration stores in a subscription.", + "schema": { + "$ref": "#/definitions/DeletedConfigurationStoreListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeletedConfigurationStores_List": { + "$ref": "./examples/DeletedConfigurationStoresList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/locations/{location}/deletedConfigurationStores/{configStoreName}": { + "get": { + "tags": [ + "DeletedConfigurationStores" + ], + "operationId": "ConfigurationStores_GetDeleted", + "description": "Gets a deleted Azure app configuration store.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved information about the deleted configuration store.", + "schema": { + "$ref": "#/definitions/DeletedConfigurationStore" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeletedConfigurationStores_Get": { + "$ref": "./examples/DeletedConfigurationStoresGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/locations/{location}/deletedConfigurationStores/{configStoreName}/purge": { + "post": { + "tags": [ + "DeletedConfigurationStores" + ], + "operationId": "ConfigurationStores_PurgeDeleted", + "x-ms-long-running-operation": true, + "description": "Permanently deletes the specified configuration store.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "No Content - the specified resource was not found." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Purge a deleted configuration store": { + "$ref": "./examples/DeletedConfigurationStoresPurge.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "Operations" + ], + "description": "Checks whether the configuration store name is available for use.", + "operationId": "Operations_RegionalCheckNameAvailability", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "checkNameAvailabilityParameters", + "in": "body", + "description": "The object containing information for the availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NameAvailabilityStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_CheckNameAvailable": { + "$ref": "./examples/RegionalCheckNameAvailable.json" + }, + "ConfigurationStores_CheckNameNotAvailable": { + "$ref": "./examples/RegionalCheckNameNotAvailable.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas": { + "get": { + "tags": [ + "Replicas" + ], + "description": "Lists the replicas for a given configuration store.", + "operationId": "Replicas_ListByConfigurationStore", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ReplicaListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Replicas_ListByConfigurationStore": { + "$ref": "./examples/ConfigurationStoresListReplicas.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}": { + "get": { + "tags": [ + "Replicas" + ], + "description": "Gets the properties of the specified replica.", + "operationId": "Replicas_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "replicaName", + "in": "path", + "description": "The name of the replica.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]*$" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Replicas_Get": { + "$ref": "./examples/ConfigurationStoresGetReplica.json" + } + } + }, + "put": { + "tags": [ + "Replicas" + ], + "description": "Creates a replica with the specified parameters.", + "operationId": "Replicas_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "replicaName", + "in": "path", + "description": "The name of the replica.", + "required": true, + "type": "string" + }, + { + "name": "replicaCreationParameters", + "in": "body", + "description": "The parameters for creating a replica.", + "required": true, + "schema": { + "$ref": "#/definitions/Replica" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Replicas_Create": { + "$ref": "./examples/ConfigurationStoresCreateReplica.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Replicas" + ], + "description": "Deletes a replica.", + "operationId": "Replicas_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "replicaName", + "in": "path", + "description": "The name of the replica.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content - the specified resource was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Replicas_Delete": { + "$ref": "./examples/ConfigurationStoresDeleteReplica.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "ConfigurationStoreListResult": { + "description": "The result of a request to list configuration stores.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "ConfigurationStore": { + "description": "The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it.", + "required": [ + "location", + "sku" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "The managed identity information, if configured." + }, + "properties": { + "$ref": "#/definitions/ConfigurationStoreProperties", + "description": "The properties of a configuration store.", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the configuration store." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Resource system metadata." + } + } + }, + "ConfigurationStoreProperties": { + "description": "The properties of a configuration store.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the configuration store.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of configuration store.", + "type": "string", + "readOnly": true + }, + "endpoint": { + "description": "The DNS endpoint where the configuration store API will be available.", + "type": "string", + "readOnly": true + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperties", + "description": "The encryption settings of the configuration store." + }, + "privateEndpointConnections": { + "description": "The list of private endpoint connections that are set up for this resource.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionReference" + } + }, + "publicNetworkAccess": { + "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "disableLocalAuth": { + "type": "boolean", + "default": false, + "description": "Disables all authentication methods other than AAD authentication." + }, + "softDeleteRetentionInDays": { + "type": "integer", + "format": "int32", + "default": 7, + "description": "The amount of time in days that the configuration store will be retained when it is soft deleted." + }, + "enablePurgeProtection": { + "type": "boolean", + "default": false, + "description": "Property specifying whether protection against purge is enabled for this configuration store." + }, + "createMode": { + "type": "string", + "description": "Indicates whether the configuration store need to be recovered.", + "enum": [ + "Recover", + "Default" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": false + }, + "x-ms-mutability": [ + "create" + ] + } + } + }, + "EncryptionProperties": { + "type": "object", + "description": "The encryption settings for a configuration store.", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Key vault properties." + } + } + }, + "PrivateEndpointConnectionReference": { + "type": "object", + "description": "A reference to a related private endpoint connection.", + "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 + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + } + }, + "KeyVaultProperties": { + "type": "object", + "description": "Settings concerning key vault encryption for a configuration store.", + "properties": { + "keyIdentifier": { + "description": "The URI of the key vault key used to encrypt data.", + "type": "string" + }, + "identityClientId": { + "description": "The client id of the identity which will be used to access key vault.", + "type": "string" + } + } + }, + "ConfigurationStoreUpdateParameters": { + "description": "The parameters for updating a configuration store.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationStorePropertiesUpdateParameters", + "description": "The properties for updating a configuration store.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "The managed identity information for the configuration store." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the configuration store." + }, + "tags": { + "description": "The ARM resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ConfigurationStorePropertiesUpdateParameters": { + "description": "The properties for updating a configuration store.", + "type": "object", + "properties": { + "encryption": { + "$ref": "#/definitions/EncryptionProperties", + "description": "The encryption settings of the configuration store." + }, + "disableLocalAuth": { + "type": "boolean", + "description": "Disables all authentication methods other than AAD authentication." + }, + "publicNetworkAccess": { + "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "enablePurgeProtection": { + "type": "boolean", + "description": "Property specifying whether protection against purge is enabled for this configuration store." + } + } + }, + "CheckNameAvailabilityParameters": { + "description": "Parameters used for checking whether a resource name is available.", + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "description": "The name to check for availability.", + "type": "string" + }, + "type": { + "description": "The resource type to check for name availability.", + "enum": [ + "Microsoft.AppConfiguration/configurationStores" + ], + "type": "string", + "x-ms-enum": { + "name": "ConfigurationResourceType", + "modelAsString": true + } + } + } + }, + "NameAvailabilityStatus": { + "description": "The result of a request to check the availability of a resource name.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value indicating whether the resource name is available.", + "type": "boolean", + "readOnly": true + }, + "message": { + "description": "If any, the error message that provides more detail for the reason that the name is not available.", + "type": "string", + "readOnly": true + }, + "reason": { + "description": "If any, the reason that the name is not available.", + "type": "string", + "readOnly": true + } + } + }, + "ApiKeyListResult": { + "description": "The result of a request to list API keys.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/ApiKey" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "ApiKey": { + "description": "An API key used for authenticating with a configuration store endpoint.", + "type": "object", + "properties": { + "id": { + "description": "The key ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "A name for the key describing its usage.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The value of the key that is used for authentication purposes.", + "type": "string", + "readOnly": true + }, + "connectionString": { + "description": "A connection string that can be used by supporting clients for authentication.", + "type": "string", + "readOnly": true + }, + "lastModified": { + "format": "date-time", + "description": "The last time any of the key's properties were modified.", + "type": "string", + "readOnly": true + }, + "readOnly": { + "description": "Whether this key can only be used for read operations.", + "type": "boolean", + "readOnly": true + } + } + }, + "RegenerateKeyParameters": { + "description": "The parameters used to regenerate an API key.", + "type": "object", + "properties": { + "id": { + "description": "The id of the key to regenerate.", + "type": "string" + } + } + }, + "KeyValueListResult": { + "description": "The result of a request to list key-values.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/KeyValue" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "KeyValue": { + "description": "The key-value resource along with all resource properties.", + "type": "object", + "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 + }, + "properties": { + "$ref": "#/definitions/KeyValueProperties", + "description": "All key-value properties.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "KeyValueProperties": { + "description": "All key-value properties.", + "type": "object", + "properties": { + "key": { + "description": "The primary identifier of a key-value.\r\nThe key is used in unison with the label to uniquely identify a key-value.", + "type": "string", + "readOnly": true + }, + "label": { + "description": "A value used to group key-values.\r\nThe label is used in unison with the key to uniquely identify a key-value.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The value of the key-value.", + "type": "string" + }, + "contentType": { + "description": "The content type of the key-value's value.\r\nProviding a proper content-type can enable transformations of values when they are retrieved by applications.", + "type": "string" + }, + "eTag": { + "description": "An ETag indicating the state of a key-value within a configuration store.", + "type": "string", + "readOnly": true + }, + "lastModified": { + "format": "date-time", + "description": "The last time a modifying operation was performed on the given key-value.", + "type": "string", + "readOnly": true + }, + "locked": { + "description": "A value indicating whether the key-value is locked.\r\nA locked key-value may not be modified until it is unlocked.", + "type": "boolean", + "readOnly": true + }, + "tags": { + "description": "A dictionary of tags that can help identify what a key-value may be applicable for.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "OperationDefinitionListResult": { + "description": "The result of a request to list configuration store operations.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationDefinition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "OperationDefinition": { + "description": "The definition of a configuration store operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDefinitionDisplay", + "description": "The display information for the configuration store operation." + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of the operation" + } + } + }, + "OperationDefinitionDisplay": { + "description": "The display information for a configuration store operation.", + "type": "object", + "properties": { + "provider": { + "description": "The resource provider name: Microsoft App Configuration.\"", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The operation that users can perform.", + "type": "string" + }, + "description": { + "description": "The description for the operation.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "Service specifications of the operation" + } + } + }, + "ServiceSpecification": { + "description": "Service specification payload", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Specifications of the Log for Azure Monitoring", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "LogSpecification": { + "description": "Specifications of the Log for Azure Monitoring", + "type": "object", + "properties": { + "name": { + "description": "Name of the log", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the log", + "type": "string" + }, + "blobDuration": { + "description": "Blob duration of the log", + "type": "string" + } + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric", + "type": "string" + }, + "unit": { + "description": "Unit that makes sense for the metric", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "internalMetricName": { + "description": "Internal metric name.", + "type": "string" + }, + "dimensions": { + "description": "Dimensions of the metric", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.", + "type": "boolean" + } + } + }, + "MetricDimension": { + "description": "Specifications of the Dimension of metrics", + "type": "object", + "properties": { + "name": { + "description": "Name of the dimension", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension", + "type": "string" + }, + "internalName": { + "description": "Internal name of the dimension.", + "type": "string" + } + } + }, + "ResourceIdentity": { + "type": "object", + "description": "An identity that can be associated with a resource.", + "properties": { + "type": { + "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "userAssignedIdentities": { + "description": "The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentity" + } + }, + "principalId": { + "description": "The principal id of the identity. This property will only be provided for a system-assigned identity.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.", + "type": "string", + "readOnly": true + } + } + }, + "UserIdentity": { + "type": "object", + "description": "A resource identity that is managed by the user of the service.", + "properties": { + "principalId": { + "description": "The principal ID of the user-assigned identity.", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "The client ID of the user-assigned identity.", + "type": "string", + "readOnly": true + } + } + }, + "Sku": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The SKU name of the configuration store.", + "type": "string" + } + }, + "description": "Describes a configuration store SKU." + }, + "ErrorDetails": { + "type": "object", + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "x-ms-identifiers": [], + "description": "The error additional info." + } + } + }, + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "ErrorAdditionalInfo": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The additional info type." + }, + "info": { + "readOnly": true, + "type": "object", + "description": "The additional info." + } + }, + "description": "The resource management error additional info." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "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 + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "description": "The provisioning status of the private endpoint connection.", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource Id for private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + }, + "actionsRequired": { + "enum": [ + "None", + "Recreate" + ], + "type": "string", + "readOnly": true, + "description": "Any action that is required beyond basic workflow (approve/ reject/ disconnect)", + "x-ms-enum": { + "name": "ActionsRequired", + "modelAsString": true + } + } + } + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "A list of private link resources.", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "type": "object", + "description": "A resource that supports private link capabilities.", + "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 + }, + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Private link resource properties.", + "x-ms-client-flatten": true + } + } + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "The list of required DNS zone names of the private link resource." + } + }, + "description": "Properties of a private link resource." + }, + "DeletedConfigurationStore": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource ID for the deleted configuration store." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the configuration store." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type of the configuration store." + }, + "properties": { + "$ref": "#/definitions/DeletedConfigurationStoreProperties", + "description": "Properties of the deleted configuration store", + "x-ms-client-flatten": true + } + }, + "description": "Deleted configuration store information with extended details." + }, + "DeletedConfigurationStoreProperties": { + "type": "object", + "properties": { + "configurationStoreId": { + "readOnly": true, + "type": "string", + "description": "The resource id of the original configuration store." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "The location of the original configuration store." + }, + "deletionDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The deleted date." + }, + "scheduledPurgeDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The scheduled purged date." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags of the original configuration store." + }, + "purgeProtectionEnabled": { + "readOnly": true, + "type": "boolean", + "description": "Purge protection status of the original configuration store." + } + }, + "description": "Properties of the deleted configuration store." + }, + "DeletedConfigurationStoreListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedConfigurationStore" + }, + "description": "The list of deleted configuration store." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of deleted configuration stores." + } + }, + "description": "List of deleted configuration stores" + }, + "ReplicaListResult": { + "description": "The result of a request to list replicas.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/Replica" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "Replica": { + "description": "The replica resource.", + "type": "object", + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the replica.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the replica.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Resource system metadata.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ReplicaProperties", + "description": "All replica properties.", + "x-ms-client-flatten": true, + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ReplicaProperties": { + "description": "All replica properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The URI of the replica where the replica API will be available.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the replica.", + "enum": [ + "Creating", + "Succeeded", + "Deleting", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ReplicaProvisioningState", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Microsoft Azure subscription ID.", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group to which the container registry belongs.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ConfigStoreNameParameter": { + "name": "configStoreName", + "in": "path", + "description": "The name of the configuration store.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9_-]*$", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The client API version.", + "required": true, + "type": "string" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "description": "The location in which uniqueness will be verified.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/swagger-specs/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/scenarios/basic.yaml b/swagger-specs/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/scenarios/basic.yaml new file mode 100644 index 000000000..ac6f41b22 --- /dev/null +++ b/swagger-specs/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/scenarios/basic.yaml @@ -0,0 +1,117 @@ +# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/documentation/api-scenario/references/v1.2/schema.json +scope: ResourceGroup +variables: + configStoreName: + type: string + prefix: configstor + privateEndpointConnectionName: + type: string + prefix: privateend + keyValueName: + type: string + prefix: keyvaluena + groupName: configurationStores + +prepareSteps: + - step: createVirtualNetwork + operationId: VirtualNetworks_CreateOrUpdate + readmeTag: ../../../../../../network/resource-manager/readme.md + parameters: + virtualNetworkName: $(configStoreName)-vnet + parameters: + location: $(location) + properties: + addressSpace: + addressPrefixes: + - 10.0.0.0/16 + subnets: + - name: subnet-1 + properties: + addressPrefix: 10.0.0.0/24 + outputVariables: + subnetId: + type: string + fromResponse: /properties/subnets/0/id + + - step: createPublicIPAddress + operationId: PublicIPAddresses_CreateOrUpdate + readmeTag: ../../../../../../network/resource-manager/readme.md + parameters: + publicIpAddressName: $(configStoreName)-ip + parameters: + location: $(location) + +scenarios: + - steps: + - step: Operations_List + operationId: Operations_List + - step: Operations_CheckNameAvailability + exampleFile: ../examples/CheckNameAvailable.json + - step: Operations_RegionalCheckNameAvailability + exampleFile: ../examples/RegionalCheckNameAvailable.json + - step: ConfigurationStores_Create + exampleFile: ../examples/ConfigurationStoresCreate.json + outputVariables: + configurationStoreId: + type: string + fromResponse: /id + - step: ConfigurationStores_List + exampleFile: ../examples/ConfigurationStoresList.json + - step: ConfigurationStores_ListByResourceGroup + exampleFile: ../examples/ConfigurationStoresListByResourceGroup.json + - step: ConfigurationStores_ListDeleted + exampleFile: ../examples/DeletedConfigurationStoresList.json + - step: ConfigurationStores_Get + exampleFile: ../examples/ConfigurationStoresGet.json + - step: ConfigurationStores_Update + exampleFile: ../examples/ConfigurationStoresUpdate.json + - step: ConfigurationStores_ListKeys + exampleFile: ../examples/ConfigurationStoresListKeys.json + outputVariables: + keyId: + fromResponse: /value/0/id + - step: ConfigurationStores_RegenerateKey + exampleFile: ../examples/ConfigurationStoresRegenerateKey.json + requestUpdate: + - replace: /regenerateKeyParameters/id + value: $(keyId) + - step: KeyValues_CreateOrUpdate + exampleFile: ../examples/ConfigurationStoresCreateKeyValue.json + - step: KeyValues_Get + exampleFile: ../examples/ConfigurationStoresGetKeyValue.json + - step: createPrivateEndpoints + operationId: PrivateEndpoints_CreateOrUpdate + readmeTag: ../../../../../../network/resource-manager/readme.md + parameters: + privateEndpointName: $(privateEndpointConnectionName)-endpoint + parameters: + location: $(location) + properties: + subnet: + id: $(subnetId) + privateLinkServiceConnections: + - name: $(privateEndpointConnectionName) + properties: + privateLinkServiceId: $(configurationStoreId) + groupIds: + - $(groupName) + - step: PrivateEndpointConnections_CreateOrUpdate + exampleFile: ../examples/ConfigurationStoresUpdatePrivateEndpointConnection.json + - step: PrivateEndpointConnections_ListByConfigurationStore + exampleFile: ../examples/ConfigurationStoresListPrivateEndpointConnections.json + - step: PrivateEndpointConnections_Get + exampleFile: ../examples/ConfigurationStoresGetPrivateEndpointConnection.json + - step: PrivateLinkResources_ListByConfigurationStore + exampleFile: ../examples/PrivateLinkResourcesListByConfigurationStore.json + - step: PrivateLinkResources_Get + exampleFile: ../examples/PrivateLinkResourceGet.json + - step: PrivateEndpointConnections_Delete + exampleFile: ../examples/ConfigurationStoresDeletePrivateEndpointConnection.json + - step: KeyValues_Delete + exampleFile: ../examples/ConfigurationStoresDeleteKeyValue.json + - step: ConfigurationStores_Delete + exampleFile: ../examples/ConfigurationStoresDelete.json + - step: ConfigurationStores_GetDeleted + exampleFile: ../examples/DeletedConfigurationStoresGet.json + - step: ConfigurationStores_PurgeDeleted + exampleFile: ../examples/DeletedConfigurationStoresPurge.json diff --git a/swagger-specs/appconfiguration/resource-manager/api-set.json b/swagger-specs/appconfiguration/resource-manager/api-set.json new file mode 100644 index 000000000..3e0067a2a --- /dev/null +++ b/swagger-specs/appconfiguration/resource-manager/api-set.json @@ -0,0 +1 @@ +{"addition_input_file_paths": [], "input_files": ["Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json"], "name": "package-2023-03-01"} \ No newline at end of file diff --git a/swagger-specs/appplatform/resource-manager/Microsoft.AppPlatform/stable/2022-12-01/appplatform.json b/swagger-specs/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/appplatform.json similarity index 73% rename from swagger-specs/appplatform/resource-manager/Microsoft.AppPlatform/stable/2022-12-01/appplatform.json rename to swagger-specs/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/appplatform.json index 37292e460..e17a6215b 100644 --- a/swagger-specs/appplatform/resource-manager/Microsoft.AppPlatform/stable/2022-12-01/appplatform.json +++ b/swagger-specs/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/appplatform.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2022-12-01", + "version": "2023-12-01", "title": "AppPlatformManagementClient", "description": "REST API for Azure Spring Apps" }, @@ -496,13 +496,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/default": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/flushVirtualNetworkDnsSettings": { + "post": { "tags": [ "AppPlatform" ], - "description": "Get the config server and its properties.", - "operationId": "ConfigServers_Get", + "description": "Flush Virtual Network DNS settings for a VNET injected Service.", + "operationId": "Services_FlushVnetDnsSetting", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -518,10 +518,12 @@ } ], "responses": { - "200": { - "description": "Success. The response describes the corresponding Config Server.", - "schema": { - "$ref": "#/definitions/ConfigServerResource" + "202": { + "description": "Accepted. The response indicates the Flush VNET DNS setting operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } } }, "default": { @@ -531,18 +533,24 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { - "ConfigServers_Get": { - "$ref": "./examples/ConfigServers_Get.json" + "Services_FlushVnetDnsSetting": { + "$ref": "./examples/Services_FlushVnetDnsSetting.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/supportedApmTypes": { + "get": { "tags": [ "AppPlatform" ], - "description": "Update the config server.", - "operationId": "ConfigServers_UpdatePut", + "description": "List supported APM types for a Service.", + "operationId": "Services_ListSupportedApmTypes", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -555,28 +563,13 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "name": "configServerResource", - "in": "body", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/ConfigServerResource" - } } ], "responses": { "200": { - "description": "Success. The response describes the updated Config Server.", - "schema": { - "$ref": "#/definitions/ConfigServerResource" - } - }, - "202": { - "description": "Accepted. The response indicates the exiting Config Server is now updating and contains a Location\r\nheader to query the operation result.", + "description": "Success. The response describes the supported APM types.", "schema": { - "$ref": "#/definitions/ConfigServerResource" + "$ref": "#/definitions/SupportedApmTypes" } }, "default": { @@ -586,19 +579,23 @@ } } }, - "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "ConfigServers_UpdatePut": { - "$ref": "./examples/ConfigServers_UpdatePut.json" + "Services_ListSupportedApmTypes": { + "$ref": "./examples/Services_ListSupportedApmTypes.json" } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/listGloballyEnabledApms": { + "post": { "tags": [ "AppPlatform" ], - "description": "Update the config server.", - "operationId": "ConfigServers_UpdatePatch", + "description": "List globally enabled APMs for a Service.", + "operationId": "Services_ListGloballyEnabledApms", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -611,28 +608,13 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "name": "configServerResource", - "in": "body", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/ConfigServerResource" - } } ], "responses": { "200": { - "description": "Success. The response describes the updated Config Server.", - "schema": { - "$ref": "#/definitions/ConfigServerResource" - } - }, - "202": { - "description": "Accepted. The response indicates the exiting Config Server is now updating and contains a Location\r\nheader to query the operation result.", + "description": "Success. The response describes the globally enabled APMs.", "schema": { - "$ref": "#/definitions/ConfigServerResource" + "$ref": "#/definitions/GloballyEnabledApms" } }, "default": { @@ -642,21 +624,20 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "ConfigServers_UpdatePatch": { - "$ref": "./examples/ConfigServers_UpdatePatch.json" + "Services_ListGloballyEnabledApms": { + "$ref": "./examples/Services_ListGloballyEnabledApms.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/validate": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/enableApmGlobally": { "post": { "tags": [ "AppPlatform" ], - "description": "Check if the config server settings are valid.", - "operationId": "ConfigServers_Validate", + "description": "Enable an APM globally.", + "operationId": "Services_EnableApmGlobally", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -671,26 +652,25 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "name": "configServerSettings", + "name": "apm", "in": "body", - "description": "Config server settings to be validated", + "description": "The target APM for the enable operation", "required": true, "schema": { - "$ref": "#/definitions/ConfigServerSettings" + "$ref": "#/definitions/ApmReference" } } ], "responses": { "200": { - "description": "Success. The response describes the validation result of Config Server.", - "schema": { - "$ref": "#/definitions/ConfigServerSettingsValidateResult" - } + "description": "Success." }, "202": { - "description": "Accepted. The response indicates the ConfigServerSetting is validating.", - "schema": { - "$ref": "#/definitions/ConfigServerSettingsValidateResult" + "description": "Accepted. The response indicates the APM is now enabling globally and contains a Location header to query the operation result.", + "headers": { + "Location": { + "type": "string" + } } }, "default": { @@ -702,22 +682,22 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" }, "x-ms-examples": { - "ConfigServers_Validate": { - "$ref": "./examples/ConfigServers_Validate.json" + "Services_EnableApmGlobally": { + "$ref": "./examples/Services_EnableApmGlobally.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/disableApmGlobally": { + "post": { "tags": [ "AppPlatform" ], - "description": "Get the Application Configuration Service and its properties.", - "operationId": "ConfigurationServices_Get", + "description": "Disable an APM globally.", + "operationId": "Services_DisableApmGlobally", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -732,14 +712,25 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ConfigurationServiceNameParameter" + "name": "apm", + "in": "body", + "description": "The target APM for the disable operation", + "required": true, + "schema": { + "$ref": "#/definitions/ApmReference" + } } ], "responses": { "200": { - "description": "Success. The response describes the corresponding Application Configuration Service.", - "schema": { - "$ref": "#/definitions/ConfigurationServiceResource" + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates the APM is now disabling globally and contains a Location header to query the operation result.", + "headers": { + "Location": { + "type": "string" + } } }, "default": { @@ -749,18 +740,24 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, "x-ms-examples": { - "ConfigurationServices_Get": { - "$ref": "./examples/ConfigurationServices_Get.json" + "Services_DisableApmGlobally": { + "$ref": "./examples/Services_DisableApmGlobally.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apms": { + "get": { "tags": [ "AppPlatform" ], - "description": "Create the default Application Configuration Service or update the existing Application Configuration Service.", - "operationId": "ConfigurationServices_CreateOrUpdate", + "description": "Get collection of APMs.", + "operationId": "Apms_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -773,31 +770,13 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ConfigurationServiceNameParameter" - }, - { - "name": "configurationServiceResource", - "in": "body", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/ConfigurationServiceResource" - } } ], "responses": { "200": { - "description": "Success. The response describes the updated Application Configuration Service.", - "schema": { - "$ref": "#/definitions/ConfigurationServiceResource" - } - }, - "201": { - "description": "Created. The response describes the new Service and contains an Azure-AsyncOperation header to query the operation result.", + "description": "Success. The response describes the list of APMs.", "schema": { - "$ref": "#/definitions/ConfigurationServiceResource" + "$ref": "#/definitions/ApmResourceCollection" } }, "default": { @@ -807,19 +786,23 @@ } } }, - "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "ConfigurationServices_CreateOrUpdate": { - "$ref": "./examples/ConfigurationServices_CreateOrUpdate.json" + "Apms_List": { + "$ref": "./examples/Apms_List.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apms/{apmName}": { + "get": { "tags": [ "AppPlatform" ], - "description": "Disable the default Application Configuration Service.", - "operationId": "ConfigurationServices_Delete", + "description": "Get the APM by name.", + "operationId": "Apms_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -834,18 +817,15 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ConfigurationServiceNameParameter" + "$ref": "#/parameters/ApmNameParameter" } ], "responses": { "200": { - "description": "Success. The response indicates the default Application Configuration Service has deleted." - }, - "202": { - "description": "Accepted. The response indicates the default Application Configuration Service is now deleting." - }, - "204": { - "description": "Success. The response indicates the default Application Configuration Service doesn't exist or has deleted." + "description": "Success. The response describes the APM.", + "schema": { + "$ref": "#/definitions/ApmResource" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -854,21 +834,18 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "ConfigurationServices_Delete": { - "$ref": "./examples/ConfigurationServices_Delete.json" + "Apms_Get": { + "$ref": "./examples/Apms_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices": { - "get": { + }, + "put": { "tags": [ "AppPlatform" ], - "description": "Handles requests to list all resources in a Service.", - "operationId": "ConfigurationServices_List", + "description": "Create or update an APM.", + "operationId": "Apms_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -881,13 +858,31 @@ }, { "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApmNameParameter" + }, + { + "name": "apmResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ApmResource" + } } ], "responses": { "200": { - "description": "Success. The response describes the list of configuration service in the Service.", + "description": "Success. The response describes the APM updated.", "schema": { - "$ref": "#/definitions/ConfigurationServiceResourceCollection" + "$ref": "#/definitions/ApmResource" + } + }, + "201": { + "description": "Created. The response describes the new APM created and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ApmResource" } }, "default": { @@ -897,23 +892,19 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "ConfigurationServices_List": { - "$ref": "./examples/ConfigurationServices_List.json" + "Apms_CreateOrUpdate": { + "$ref": "./examples/Apms_CreateOrUpdate.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}/validate": { - "post": { + }, + "delete": { "tags": [ "AppPlatform" ], - "description": "Check if the Application Configuration Service settings are valid.", - "operationId": "ConfigurationServices_Validate", + "description": "Operation to delete an APM", + "operationId": "Apms_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -928,31 +919,21 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ConfigurationServiceNameParameter" - }, - { - "name": "settings", - "in": "body", - "description": "Application Configuration Service settings to be validated", - "required": true, - "schema": { - "$ref": "#/definitions/ConfigurationServiceSettings" - } + "$ref": "#/parameters/ApmNameParameter" } ], "responses": { - "200": { - "description": "Success. The response describes the validation result of Application Configuration Service.", - "schema": { - "$ref": "#/definitions/ConfigurationServiceSettingsValidateResult" - } - }, "202": { - "description": "Accepted. The response indicates the ConfigurationServiceSettings is validating.", - "schema": { - "$ref": "#/definitions/ConfigurationServiceSettingsValidateResult" + "description": "Accepted. The response indicates the delete operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } } }, + "204": { + "description": "Success. The response indicates the resource doesn't exist." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -965,19 +946,19 @@ "final-state-via": "location" }, "x-ms-examples": { - "ConfigurationServices_Validate": { - "$ref": "./examples/ConfigurationServices_Validate.json" + "Apms_Delete": { + "$ref": "./examples/Apms_Delete.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apms/{apmName}/listSecretKeys": { + "post": { "tags": [ "AppPlatform" ], - "description": "Get the Service Registry and its properties.", - "operationId": "ServiceRegistries_Get", + "description": "List keys of APM sensitive properties.", + "operationId": "Apms_ListSecretKeys", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -992,14 +973,14 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ServiceRegistryNameParameter" + "$ref": "#/parameters/ApmNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the corresponding Service Registry.", + "description": "Success. The response describes the keys of APM sensitive properties.", "schema": { - "$ref": "#/definitions/ServiceRegistryResource" + "$ref": "#/definitions/ApmSecretKeys" } }, "default": { @@ -1010,17 +991,19 @@ } }, "x-ms-examples": { - "ServiceRegistries_Get": { - "$ref": "./examples/ServiceRegistries_Get.json" + "Apms_ListSecretKeys": { + "$ref": "./examples/Apms_ListSecretKeys.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/default": { + "get": { "tags": [ "AppPlatform" ], - "description": "Create the default Service Registry or update the existing Service Registry.", - "operationId": "ServiceRegistries_CreateOrUpdate", + "description": "Get the config server and its properties.", + "operationId": "ConfigServers_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1033,22 +1016,13 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ServiceRegistryNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the updated Service Registry.", - "schema": { - "$ref": "#/definitions/ServiceRegistryResource" - } - }, - "201": { - "description": "Created. The response describes the new created Service Registry and contains an Azure-AsyncOperation header to query the operation result.", + "description": "Success. The response describes the corresponding Config Server.", "schema": { - "$ref": "#/definitions/ServiceRegistryResource" + "$ref": "#/definitions/ConfigServerResource" } }, "default": { @@ -1058,19 +1032,18 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "ServiceRegistries_CreateOrUpdate": { - "$ref": "./examples/ServiceRegistries_CreateOrUpdate.json" + "ConfigServers_Get": { + "$ref": "./examples/ConfigServers_Get.json" } } }, - "delete": { + "put": { "tags": [ "AppPlatform" ], - "description": "Disable the default Service Registry.", - "operationId": "ServiceRegistries_Delete", + "description": "Update the config server.", + "operationId": "ConfigServers_UpdatePut", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1085,18 +1058,27 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ServiceRegistryNameParameter" + "name": "configServerResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigServerResource" + } } ], "responses": { "200": { - "description": "Success. The response indicates the default Service Registries has deleted." + "description": "Success. The response describes the updated Config Server.", + "schema": { + "$ref": "#/definitions/ConfigServerResource" + } }, "202": { - "description": "Accepted. The response indicates the default Service Registries is now deleting." - }, - "204": { - "description": "Success. The response indicates the default Service Registries doesn't exist or has deleted." + "description": "Accepted. The response indicates the exiting Config Server is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/ConfigServerResource" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -1107,19 +1089,17 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "ServiceRegistries_Delete": { - "$ref": "./examples/ServiceRegistries_Delete.json" + "ConfigServers_UpdatePut": { + "$ref": "./examples/ConfigServers_UpdatePut.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries": { - "get": { + }, + "patch": { "tags": [ "AppPlatform" ], - "description": "Handles requests to list all resources in a Service.", - "operationId": "ServiceRegistries_List", + "description": "Update the config server.", + "operationId": "ConfigServers_UpdatePatch", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1132,13 +1112,28 @@ }, { "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "configServerResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigServerResource" + } } ], "responses": { "200": { - "description": "Success. The response describes the list of Service Registry resources in the Service.", + "description": "Success. The response describes the updated Config Server.", "schema": { - "$ref": "#/definitions/ServiceRegistryResourceCollection" + "$ref": "#/definitions/ConfigServerResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Config Server is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/ConfigServerResource" } }, "default": { @@ -1148,23 +1143,21 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "ServiceRegistries_List": { - "$ref": "./examples/ServiceRegistries_List.json" + "ConfigServers_UpdatePatch": { + "$ref": "./examples/ConfigServers_UpdatePatch.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/validate": { + "post": { "tags": [ "AppPlatform" ], - "description": "List build services resource.", - "operationId": "BuildService_ListBuildServices", + "description": "Check if the config server settings are valid.", + "operationId": "ConfigServers_Validate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1177,13 +1170,28 @@ }, { "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "configServerSettings", + "in": "body", + "description": "Config server settings to be validated", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigServerSettings" + } } ], "responses": { "200": { - "description": "Success. The response describes the Build Services.", + "description": "Success. The response describes the validation result of Config Server.", "schema": { - "$ref": "#/definitions/BuildServiceCollection" + "$ref": "#/definitions/ConfigServerSettingsValidateResult" + } + }, + "202": { + "description": "Accepted. The response indicates the ConfigServerSetting is validating.", + "schema": { + "$ref": "#/definitions/ConfigServerSettingsValidateResult" } }, "default": { @@ -1193,23 +1201,24 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" }, "x-ms-examples": { - "BuildService_ListBuildServices": { - "$ref": "./examples/BuildService_ListBuildServices.json" + "ConfigServers_Validate": { + "$ref": "./examples/ConfigServers_Validate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}": { "get": { "tags": [ "AppPlatform" ], - "description": "Get a build service resource.", - "operationId": "BuildService_GetBuildService", + "description": "Get the Application Configuration Service and its properties.", + "operationId": "ConfigurationServices_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1224,14 +1233,14 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" + "$ref": "#/parameters/ConfigurationServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the Build Service.", + "description": "Success. The response describes the corresponding Application Configuration Service.", "schema": { - "$ref": "#/definitions/BuildService" + "$ref": "#/definitions/ConfigurationServiceResource" } }, "default": { @@ -1242,19 +1251,17 @@ } }, "x-ms-examples": { - "BuildService_GetBuildService": { - "$ref": "./examples/BuildService_GetBuildService.json" + "ConfigurationServices_Get": { + "$ref": "./examples/ConfigurationServices_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds": { - "get": { + }, + "put": { "tags": [ "AppPlatform" ], - "description": "List KPack builds.", - "operationId": "BuildService_ListBuilds", + "description": "Create the default Application Configuration Service or update the existing Application Configuration Service.", + "operationId": "ConfigurationServices_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1269,14 +1276,29 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" + "$ref": "#/parameters/ConfigurationServiceNameParameter" + }, + { + "name": "configurationServiceResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationServiceResource" + } } ], "responses": { "200": { - "description": "Success. The response describes the builds.", + "description": "Success. The response describes the updated Application Configuration Service.", "schema": { - "$ref": "#/definitions/BuildCollection" + "$ref": "#/definitions/ConfigurationServiceResource" + } + }, + "201": { + "description": "Created. The response describes the new Service and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ConfigurationServiceResource" } }, "default": { @@ -1286,23 +1308,19 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "BuildService_ListBuilds": { - "$ref": "./examples/BuildService_ListBuilds.json" + "ConfigurationServices_CreateOrUpdate": { + "$ref": "./examples/ConfigurationServices_CreateOrUpdate.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}": { - "get": { + }, + "delete": { "tags": [ "AppPlatform" ], - "description": "Get a KPack build.", - "operationId": "BuildService_GetBuild", + "description": "Disable the default Application Configuration Service.", + "operationId": "ConfigurationServices_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1317,18 +1335,18 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildNameParameter" + "$ref": "#/parameters/ConfigurationServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the Build.", - "schema": { - "$ref": "#/definitions/Build" - } + "description": "Success. The response indicates the default Application Configuration Service has deleted." + }, + "202": { + "description": "Accepted. The response indicates the default Application Configuration Service is now deleting." + }, + "204": { + "description": "Success. The response indicates the default Application Configuration Service doesn't exist or has deleted." }, "default": { "description": "Error response describing why the operation failed.", @@ -1337,18 +1355,21 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "BuildService_GetBuild": { - "$ref": "./examples/BuildService_GetBuild.json" + "ConfigurationServices_Delete": { + "$ref": "./examples/ConfigurationServices_Delete.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices": { + "get": { "tags": [ "AppPlatform" ], - "description": "Create or update a KPack build.", - "operationId": "BuildService_CreateOrUpdateBuild", + "description": "Handles requests to list all resources in a Service.", + "operationId": "ConfigurationServices_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1361,34 +1382,13 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildNameParameter" - }, - { - "name": "build", - "in": "body", - "description": "Parameters for the create or update operation", - "required": true, - "schema": { - "$ref": "#/definitions/Build" - } } ], "responses": { "200": { - "description": "Success. The response describes the updated Build.", - "schema": { - "$ref": "#/definitions/Build" - } - }, - "201": { - "description": "Created. The response describes the new Build and contains an Azure-AsyncOperation header to query the operation result.", + "description": "Success. The response describes the list of configuration service in the Service.", "schema": { - "$ref": "#/definitions/Build" + "$ref": "#/definitions/ConfigurationServiceResourceCollection" } }, "default": { @@ -1398,20 +1398,23 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "BuildService_CreateOrUpdateBuild": { - "$ref": "./examples/BuildService_CreateOrUpdateBuild.json" + "ConfigurationServices_List": { + "$ref": "./examples/ConfigurationServices_List.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings/{buildpackBindingName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}/validate": { + "post": { "tags": [ "AppPlatform" ], - "description": "Get a buildpack binding by name.", - "operationId": "BuildpackBinding_Get", + "description": "Check if the Application Configuration Service settings are valid.", + "operationId": "ConfigurationServices_Validate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1426,20 +1429,29 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuilderNameParameter" + "$ref": "#/parameters/ConfigurationServiceNameParameter" }, { - "$ref": "#/parameters/BuildpackBindingNameParameter" + "name": "settings", + "in": "body", + "description": "Application Configuration Service settings to be validated", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationServiceSettings" + } } ], "responses": { "200": { - "description": "Success. The response describes a Buildpack Binding.", + "description": "Success. The response describes the validation result of Application Configuration Service.", "schema": { - "$ref": "#/definitions/BuildpackBindingResource" + "$ref": "#/definitions/ConfigurationServiceSettingsValidateResult" + } + }, + "202": { + "description": "Accepted. The response indicates the ConfigurationServiceSettings is validating.", + "schema": { + "$ref": "#/definitions/ConfigurationServiceSettingsValidateResult" } }, "default": { @@ -1449,18 +1461,24 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { - "BuildpackBinding_Get": { - "$ref": "./examples/BuildpackBinding_Get.json" + "ConfigurationServices_Validate": { + "$ref": "./examples/ConfigurationServices_Validate.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}/validateResource": { + "post": { "tags": [ "AppPlatform" ], - "description": "Create or update a buildpack binding.", - "operationId": "BuildpackBinding_CreateOrUpdate", + "description": "Check if the Application Configuration Service resource is valid.", + "operationId": "ConfigurationServices_ValidateResource", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1475,35 +1493,31 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuilderNameParameter" - }, - { - "$ref": "#/parameters/BuildpackBindingNameParameter" + "$ref": "#/parameters/ConfigurationServiceNameParameter" }, { - "name": "buildpackBinding", + "name": "configurationServiceResource", "in": "body", - "description": "The target buildpack binding for the create or update operation", + "description": "Application Configuration Service resource to be validated", "required": true, "schema": { - "$ref": "#/definitions/BuildpackBindingResource" + "$ref": "#/definitions/ConfigurationServiceResource" } } ], "responses": { "200": { - "description": "Success. The response describes a Buildpack Binding for the create or update operation.", + "description": "Success. The response describes the validation result of Application Configuration Service.", "schema": { - "$ref": "#/definitions/BuildpackBindingResource" + "$ref": "#/definitions/ConfigurationServiceSettingsValidateResult" } }, - "201": { - "description": "Created. The response describes the new Buildpack Binding and contains an Azure-AsyncOperation header to query the operation result.", - "schema": { - "$ref": "#/definitions/BuildpackBindingResource" + "202": { + "description": "Accepted. The response indicates the ConfigurationServiceSettings is validating.", + "headers": { + "Location": { + "type": "string" + } } }, "default": { @@ -1514,18 +1528,23 @@ } }, "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { - "BuildpackBinding_CreateOrUpdate": { - "$ref": "./examples/BuildpackBinding_CreateOrUpdate.json" + "ConfigurationServices_ValidateResource": { + "$ref": "./examples/ConfigurationServices_ValidateResource.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}": { + "get": { "tags": [ "AppPlatform" ], - "description": "Operation to delete a Buildpack Binding", - "operationId": "BuildpackBinding_Delete", + "description": "Get the Service Registry and its properties.", + "operationId": "ServiceRegistries_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1540,24 +1559,15 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuilderNameParameter" - }, - { - "$ref": "#/parameters/BuildpackBindingNameParameter" + "$ref": "#/parameters/ServiceRegistryNameParameter" } ], "responses": { "200": { - "description": "Success. The response indicates the resource is deleted." - }, - "202": { - "description": "Accepted. The response indicates the delete operation is performed in the background." - }, - "204": { - "description": "Success. The response indicates the resource doesn't exist." + "description": "Success. The response describes the corresponding Service Registry.", + "schema": { + "$ref": "#/definitions/ServiceRegistryResource" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -1566,21 +1576,18 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "BuildpackBinding_Delete": { - "$ref": "./examples/BuildpackBinding_Delete.json" + "ServiceRegistries_Get": { + "$ref": "./examples/ServiceRegistries_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings": { - "get": { + }, + "put": { "tags": [ "AppPlatform" ], - "description": "Handles requests to list all buildpack bindings in a builder.", - "operationId": "BuildpackBinding_List", + "description": "Create the default Service Registry or update the existing Service Registry.", + "operationId": "ServiceRegistries_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1595,17 +1602,20 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuilderNameParameter" + "$ref": "#/parameters/ServiceRegistryNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the list of Buildpack Binding in the builder.", + "description": "Success. The response describes the updated Service Registry.", "schema": { - "$ref": "#/definitions/BuildpackBindingResourceCollection" + "$ref": "#/definitions/ServiceRegistryResource" + } + }, + "201": { + "description": "Created. The response describes the new created Service Registry and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ServiceRegistryResource" } }, "default": { @@ -1615,23 +1625,19 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "BuildpackBinding_Get": { - "$ref": "./examples/BuildpackBinding_List.json" + "ServiceRegistries_CreateOrUpdate": { + "$ref": "./examples/ServiceRegistries_CreateOrUpdate.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}/results": { - "get": { + }, + "delete": { "tags": [ "AppPlatform" ], - "description": "List KPack build results.", - "operationId": "BuildService_ListBuildResults", + "description": "Disable the default Service Registry.", + "operationId": "ServiceRegistries_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1646,18 +1652,18 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildNameParameter" + "$ref": "#/parameters/ServiceRegistryNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the build results.", - "schema": { - "$ref": "#/definitions/BuildResultCollection" - } + "description": "Success. The response indicates the default Service Registries has deleted." + }, + "202": { + "description": "Accepted. The response indicates the default Service Registries is now deleting." + }, + "204": { + "description": "Success. The response indicates the default Service Registries doesn't exist or has deleted." }, "default": { "description": "Error response describing why the operation failed.", @@ -1666,23 +1672,21 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "BuildService_ListBuildResults": { - "$ref": "./examples/BuildService_ListBuildResults.json" + "ServiceRegistries_Delete": { + "$ref": "./examples/ServiceRegistries_Delete.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}/results/{buildResultName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries": { "get": { "tags": [ "AppPlatform" ], - "description": "Get a KPack build result.", - "operationId": "BuildService_GetBuildResult", + "description": "Handles requests to list all resources in a Service.", + "operationId": "ServiceRegistries_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1695,22 +1699,13 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildNameParameter" - }, - { - "$ref": "#/parameters/BuildResultNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the build result.", + "description": "Success. The response describes the list of Service Registry resources in the Service.", "schema": { - "$ref": "#/definitions/BuildResult" + "$ref": "#/definitions/ServiceRegistryResourceCollection" } }, "default": { @@ -1720,20 +1715,23 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "BuildService_GetBuildResult": { - "$ref": "./examples/BuildService_GetBuildResult.json" + "ServiceRegistries_List": { + "$ref": "./examples/ServiceRegistries_List.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}/results/{buildResultName}/getLogFileUrl": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationLiveViews": { + "get": { "tags": [ "AppPlatform" ], - "description": "Get a KPack build result log download URL.", - "operationId": "BuildService_GetBuildResultLog", + "description": "Handles requests to list all resources in a Service.", + "operationId": "ApplicationLiveViews_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1746,22 +1744,13 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildNameParameter" - }, - { - "$ref": "#/parameters/BuildResultNameParameter" } ], "responses": { "200": { - "description": "Success. Build result log exists and can be downloaded.", + "description": "Success. The response describes the list of Application Live View resources in the Service.", "schema": { - "$ref": "#/definitions/BuildResultLog" + "$ref": "#/definitions/ApplicationLiveViewResourceCollection" } }, "default": { @@ -1771,20 +1760,23 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "BuildService_GetBuildResultLog": { - "$ref": "./examples/BuildService_GetBuildResultLog.json" + "ApplicationLiveViews_List": { + "$ref": "./examples/ApplicationLiveViews_List.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationLiveViews/{applicationLiveViewName}": { "get": { "tags": [ "AppPlatform" ], - "description": "Get a KPack builder.", - "operationId": "BuildServiceBuilder_Get", + "description": "Get the Application Live and its properties.", + "operationId": "ApplicationLiveViews_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1799,17 +1791,14 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuilderNameParameter" + "$ref": "#/parameters/ApplicationLiveViewNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the Builder", + "description": "Success. The response describes the corresponding Application Live View.", "schema": { - "$ref": "#/definitions/BuilderResource" + "$ref": "#/definitions/ApplicationLiveViewResource" } }, "default": { @@ -1820,8 +1809,8 @@ } }, "x-ms-examples": { - "BuildServiceBuilder_Get": { - "$ref": "./examples/BuildServiceBuilder_Get.json" + "ApplicationLiveViews_Get": { + "$ref": "./examples/ApplicationLiveViews_Get.json" } } }, @@ -1829,8 +1818,8 @@ "tags": [ "AppPlatform" ], - "description": "Create or update a KPack builder.", - "operationId": "BuildServiceBuilder_CreateOrUpdate", + "description": "Create the default Application Live View or update the existing Application Live View.", + "operationId": "ApplicationLiveViews_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1845,32 +1834,29 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuilderNameParameter" + "$ref": "#/parameters/ApplicationLiveViewNameParameter" }, { - "name": "builderResource", + "name": "applicationLiveViewResource", "in": "body", - "description": "The target builder for the create or update operation", + "description": "Parameters for the update operation", "required": true, "schema": { - "$ref": "#/definitions/BuilderResource" + "$ref": "#/definitions/ApplicationLiveViewResource" } } ], "responses": { "200": { - "description": "Success. The response describes the Builder", + "description": "Success. The response describes the updated Application Live View.", "schema": { - "$ref": "#/definitions/BuilderResource" + "$ref": "#/definitions/ApplicationLiveViewResource" } }, "201": { - "description": "Created. The response describes the new Builder and contains an Azure-AsyncOperation header to query the operation result.", + "description": "Created. The response describes the new created Application Live View and contains an Azure-AsyncOperation header to query the operation result.", "schema": { - "$ref": "#/definitions/BuilderResource" + "$ref": "#/definitions/ApplicationLiveViewResource" } }, "default": { @@ -1882,8 +1868,8 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "BuildServiceBuilder_CreateOrUpdate": { - "$ref": "./examples/BuildServiceBuilder_CreateOrUpdate.json" + "ApplicationLiveViews_CreateOrUpdate": { + "$ref": "./examples/ApplicationLiveViews_CreateOrUpdate.json" } } }, @@ -1891,8 +1877,8 @@ "tags": [ "AppPlatform" ], - "description": "Delete a KPack builder.", - "operationId": "BuildServiceBuilder_Delete", + "description": "Disable the default Application Live View.", + "operationId": "ApplicationLiveViews_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1907,21 +1893,20 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuilderNameParameter" + "$ref": "#/parameters/ApplicationLiveViewNameParameter" } ], "responses": { - "200": { - "description": "Success. The response indicates the builder resource has deleted." - }, "202": { - "description": "Accepted. The response indicates the builder resource is deleting." + "description": "Accepted. The response indicates the default Application Live View is now deleting.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { - "description": "Success. The response indicates the builder resource doesn't exist or has deleted." + "description": "Success. The response indicates the defaultApplication Live View doesn't exist or has deleted." }, "default": { "description": "Error response describing why the operation failed.", @@ -1932,19 +1917,19 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "BuildServiceBuilder_Delete": { - "$ref": "./examples/BuildServiceBuilder_Delete.json" + "ApplicationLiveViews_Delete": { + "$ref": "./examples/ApplicationLiveView_Delete.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/devToolPortals": { "get": { "tags": [ "AppPlatform" ], - "description": "List KPack builders result.", - "operationId": "BuildServiceBuilder_List", + "description": "Handles requests to list all resources in a Service.", + "operationId": "DevToolPortals_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1957,16 +1942,13 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the Builder List", + "description": "Success. The response describes the list of Dev Tool Portal resources in the Service.", "schema": { - "$ref": "#/definitions/BuilderResourceCollection" + "$ref": "#/definitions/DevToolPortalResourceCollection" } }, "default": { @@ -1980,19 +1962,19 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "BuildServiceBuilder_List": { - "$ref": "./examples/BuildServiceBuilder_List.json" + "DevToolPortals_List": { + "$ref": "./examples/DevToolPortals_List.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/getResourceUploadUrl": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/DevToolPortals/{devToolPortalName}": { + "get": { "tags": [ "AppPlatform" ], - "description": "Get an resource upload URL for build service, which may be artifacts or source archive.", - "operationId": "BuildService_GetResourceUploadUrl", + "description": "Get the Application Live and its properties.", + "operationId": "DevToolPortals_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2007,14 +1989,14 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" + "$ref": "#/parameters/DevToolPortalNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the resource upload URL.", + "description": "Success. The response describes the corresponding Dev Tool Portal.", "schema": { - "$ref": "#/definitions/ResourceUploadDefinition" + "$ref": "#/definitions/DevToolPortalResource" } }, "default": { @@ -2025,19 +2007,17 @@ } }, "x-ms-examples": { - "BuildService_GetResourceUploadUrl": { - "$ref": "./examples/BuildService_GetResourceUploadUrl.json" + "DevToolPortals_Get": { + "$ref": "./examples/DevToolPortals_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedBuildpacks": { - "get": { + }, + "put": { "tags": [ "AppPlatform" ], - "description": "Get all supported buildpacks.", - "operationId": "BuildService_ListSupportedBuildpacks", + "description": "Create the default Dev Tool Portal or update the existing Dev Tool Portal.", + "operationId": "DevToolPortals_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2052,14 +2032,29 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" + "$ref": "#/parameters/DevToolPortalNameParameter" + }, + { + "name": "DevToolPortalResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/DevToolPortalResource" + } } ], "responses": { "200": { - "description": "Success. The response describes all supported buildpacks.", + "description": "Success. The response describes the updated Dev Tool Portal.", "schema": { - "$ref": "#/definitions/SupportedBuildpacksCollection" + "$ref": "#/definitions/DevToolPortalResource" + } + }, + "201": { + "description": "Created. The response describes the new created Dev Tool Portal and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/DevToolPortalResource" } }, "default": { @@ -2069,20 +2064,19 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "BuildService_ListSupportedBuildpacks": { - "$ref": "./examples/BuildService_ListSupportedBuildpacks.json" + "DevToolPortals_CreateOrUpdate": { + "$ref": "./examples/DevToolPortals_CreateOrUpdate.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedBuildpacks/{buildpackName}": { - "get": { + }, + "delete": { "tags": [ "AppPlatform" ], - "description": "Get the supported buildpack resource.", - "operationId": "BuildService_GetSupportedBuildpack", + "description": "Disable the default Dev Tool Portal.", + "operationId": "DevToolPortals_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2097,19 +2091,21 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildServiceBuildpackNameParameter" + "$ref": "#/parameters/DevToolPortalNameParameter" } ], "responses": { - "200": { - "description": "Success. The response describes the supported buildpack.", - "schema": { - "$ref": "#/definitions/SupportedBuildpackResource" + "202": { + "description": "Accepted. The response indicates the default Dev Tool Portal is now deleting.", + "headers": { + "Location": { + "type": "string" + } } }, + "204": { + "description": "Success. The response indicates the defaultDev Tool Portal doesn't exist or has deleted." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -2117,20 +2113,21 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "BuildService_GetSupportedBuildpack": { - "$ref": "./examples/BuildService_GetSupportedBuildpack.json" + "DevToolPortals_Delete": { + "$ref": "./examples/DevToolPortal_Delete.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedStacks": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/containerRegistries": { "get": { "tags": [ "AppPlatform" ], - "description": "Get all supported stacks.", - "operationId": "BuildService_ListSupportedStacks", + "description": "List container registries resource.", + "operationId": "ContainerRegistries_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2143,16 +2140,13 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes all supported stacks.", + "description": "Success. The response describes the Container Registries to one Azure Spring Apps resource.", "schema": { - "$ref": "#/definitions/SupportedStacksCollection" + "$ref": "#/definitions/ContainerRegistryResourceCollection" } }, "default": { @@ -2162,20 +2156,23 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "BuildService_ListSupportedStacks": { - "$ref": "./examples/BuildService_ListSupportedStacks.json" + "ContainerRegistries_List": { + "$ref": "./examples/ContainerRegistries_List.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedStacks/{stackName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/containerRegistries/{containerRegistryName}": { "get": { "tags": [ "AppPlatform" ], - "description": "Get the supported stack resource.", - "operationId": "BuildService_GetSupportedStack", + "description": "Get the container registries resource.", + "operationId": "ContainerRegistries_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2190,17 +2187,14 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildServiceStackNameParameter" + "$ref": "#/parameters/ContainerRegistryNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the supported stack.", + "description": "Success. The response describe the container registry.", "schema": { - "$ref": "#/definitions/SupportedStackResource" + "$ref": "#/definitions/ContainerRegistryResource" } }, "default": { @@ -2211,19 +2205,17 @@ } }, "x-ms-examples": { - "BuildService_GetSupportedStack": { - "$ref": "./examples/BuildService_GetSupportedStack.json" + "ContainerRegistries_Get": { + "$ref": "./examples/ContainerRegistries_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/agentPools": { - "get": { + }, + "put": { "tags": [ "AppPlatform" ], - "description": "List build service agent pool.", - "operationId": "BuildServiceAgentPool_List", + "description": "Create or update container registry resource.", + "operationId": "ContainerRegistries_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2238,14 +2230,29 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" + "$ref": "#/parameters/ContainerRegistryNameParameter" + }, + { + "name": "containerRegistryResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerRegistryResource" + } } ], "responses": { "200": { - "description": "Success. The response describes build service agent pool.", + "description": "Success. The response describe the existed container registry updated.", "schema": { - "$ref": "#/definitions/BuildServiceAgentPoolResourceCollection" + "$ref": "#/definitions/ContainerRegistryResource" + } + }, + "201": { + "description": "Created. The response describes the new container registry resource created and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ContainerRegistryResource" } }, "default": { @@ -2255,23 +2262,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" }, "x-ms-examples": { - "BuildServiceAgentPool_List": { - "$ref": "./examples/BuildServiceAgentPool_List.json" + "ContainerRegistries_CreateOrUpdate": { + "$ref": "./examples/ContainerRegistries_CreateOrUpdate.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/agentPools/{agentPoolName}": { - "get": { + }, + "delete": { "tags": [ "AppPlatform" ], - "description": "Get build service agent pool.", - "operationId": "BuildServiceAgentPool_Get", + "description": "Delete a container registry resource.", + "operationId": "ContainerRegistries_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2286,19 +2292,21 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildServiceAgentPoolNameParameter" + "$ref": "#/parameters/ContainerRegistryNameParameter" } ], "responses": { - "200": { - "description": "Success. The response describes build service agent pool.", - "schema": { - "$ref": "#/definitions/BuildServiceAgentPoolResource" + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } } }, + "204": { + "description": "Success. The response indicates the resource doesn't exist." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -2306,18 +2314,24 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { - "BuildServiceAgentPool_Get": { - "$ref": "./examples/BuildServiceAgentPool_Get.json" + "ContainerRegistries_Delete": { + "$ref": "./examples/ContainerRegistries_Delete.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/containerRegistries/{containerRegistryName}/validate": { + "post": { "tags": [ "AppPlatform" ], - "description": "Create or update build service agent pool.", - "operationId": "BuildServiceAgentPool_UpdatePut", + "description": "Check if the container registry properties are valid.", + "operationId": "ContainerRegistries_Validate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2332,32 +2346,31 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" - }, - { - "$ref": "#/parameters/BuildServiceAgentPoolNameParameter" + "$ref": "#/parameters/ContainerRegistryNameParameter" }, { - "name": "agentPoolResource", + "name": "ContainerRegistryProperties", "in": "body", - "description": "Parameters for the update operation", + "description": "Parameters for the validate operation", "required": true, "schema": { - "$ref": "#/definitions/BuildServiceAgentPoolResource" + "$ref": "#/definitions/ContainerRegistryProperties" } } ], "responses": { "200": { - "description": "Success. The response describes build service agent pool.", + "description": "Success. The response describe the validation result of container registry.", "schema": { - "$ref": "#/definitions/BuildServiceAgentPoolResource" + "$ref": "#/definitions/ContainerRegistryValidateResult" } }, - "201": { - "description": "Created. The response describes the new build service agent pool and contains an Azure-AsyncOperation header to query the operation result.", - "schema": { - "$ref": "#/definitions/BuildServiceAgentPoolResource" + "202": { + "description": "Accepted. The response indicates the container registry properties is validating.", + "headers": { + "Location": { + "type": "string" + } } }, "default": { @@ -2368,20 +2381,23 @@ } }, "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { - "BuildServiceAgentPool_UpdatePut": { - "$ref": "./examples/BuildServiceAgentPool_UpdatePut.json" + "ContainerRegistries_Validate": { + "$ref": "./examples/ContainerRegistries_Validate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/monitoringSettings/default": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices": { "get": { "tags": [ "AppPlatform" ], - "description": "Get the Monitoring Setting and its properties.", - "operationId": "MonitoringSettings_Get", + "description": "List build services resource.", + "operationId": "BuildService_ListBuildServices", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2398,9 +2414,9 @@ ], "responses": { "200": { - "description": "Success. The response describes the corresponding Monitoring Setting.", + "description": "Success. The response describes the Build Services.", "schema": { - "$ref": "#/definitions/MonitoringSettingResource" + "$ref": "#/definitions/BuildServiceCollection" } }, "default": { @@ -2410,18 +2426,23 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "MonitoringSettings_Get": { - "$ref": "./examples/MonitoringSettings_Get.json" + "BuildService_ListBuildServices": { + "$ref": "./examples/BuildService_ListBuildServices.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}": { + "get": { "tags": [ "AppPlatform" ], - "description": "Update the Monitoring Setting.", - "operationId": "MonitoringSettings_UpdatePut", + "description": "Get a build service resource.", + "operationId": "BuildService_GetBuildService", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2436,26 +2457,14 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "name": "monitoringSettingResource", - "in": "body", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/MonitoringSettingResource" - } + "$ref": "#/parameters/BuildServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the updated Monitoring Setting.", - "schema": { - "$ref": "#/definitions/MonitoringSettingResource" - } - }, - "202": { - "description": "Accepted. The response indicates the exiting Monitoring Setting is now updating and contains a Location\r\nheader to query the operation result.", + "description": "Success. The response describes the Build Service.", "schema": { - "$ref": "#/definitions/MonitoringSettingResource" + "$ref": "#/definitions/BuildService" } }, "default": { @@ -2465,19 +2474,18 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "MonitoringSettings_UpdatePut": { - "$ref": "./examples/MonitoringSettings_UpdatePut.json" + "BuildService_GetBuildService": { + "$ref": "./examples/BuildService_GetBuildService.json" } } }, - "patch": { + "put": { "tags": [ "AppPlatform" ], - "description": "Update the Monitoring Setting.", - "operationId": "MonitoringSettings_UpdatePatch", + "description": "Create a build service resource.", + "operationId": "BuildService_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2492,26 +2500,29 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "name": "monitoringSettingResource", + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "name": "buildService", "in": "body", - "description": "Parameters for the update operation", + "description": "Parameters for the create operation", "required": true, "schema": { - "$ref": "#/definitions/MonitoringSettingResource" + "$ref": "#/definitions/BuildService" } } ], "responses": { "200": { - "description": "Success. The response describes the updated Monitoring Setting.", + "description": "Success. The response describes the Build Service.", "schema": { - "$ref": "#/definitions/MonitoringSettingResource" + "$ref": "#/definitions/BuildService" } }, - "202": { - "description": "Accepted. The response indicates the exiting Monitoring Setting is now updating and contains a Location\r\nheader to query the operation result.", + "201": { + "description": "Created. The response describes the Build Service and contains an Azure-AsyncOperation header to query the operation result.", "schema": { - "$ref": "#/definitions/MonitoringSettingResource" + "$ref": "#/definitions/BuildService" } }, "default": { @@ -2522,20 +2533,23 @@ } }, "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { - "MonitoringSettings_UpdatePatch": { - "$ref": "./examples/MonitoringSettings_UpdatePatch.json" + "BuildService_CreateOrUpdate": { + "$ref": "./examples/BuildService_CreateOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds": { "get": { "tags": [ "AppPlatform" ], - "description": "Get an App and its properties.", - "operationId": "Apps_Get", + "description": "List KPack builds.", + "operationId": "BuildService_ListBuilds", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2550,21 +2564,14 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" - }, - { - "name": "syncStatus", - "in": "query", - "description": "Indicates whether sync status", - "required": false, - "type": "string" + "$ref": "#/parameters/BuildServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the corresponding App.", + "description": "Success. The response describes the builds.", "schema": { - "$ref": "#/definitions/AppResource" + "$ref": "#/definitions/BuildCollection" } }, "default": { @@ -2574,21 +2581,23 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "Apps_Get": { - "$ref": "./examples/Apps_Get.json" - }, - "Apps_Get_VNetInjection": { - "$ref": "./examples/Apps_Get_VNetInjection.json" + "BuildService_ListBuilds": { + "$ref": "./examples/BuildService_ListBuilds.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}": { + "get": { "tags": [ "AppPlatform" ], - "description": "Create a new App or update an exiting App.", - "operationId": "Apps_CreateOrUpdate", + "description": "Get a KPack build.", + "operationId": "BuildService_GetBuild", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2603,35 +2612,17 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" }, { - "name": "appResource", - "in": "body", - "description": "Parameters for the create or update operation", - "required": true, - "schema": { - "$ref": "#/definitions/AppResource" - } + "$ref": "#/parameters/BuildNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the updated App.", - "schema": { - "$ref": "#/definitions/AppResource" - } - }, - "201": { - "description": "Created. The response describes the new App and contains an Azure-AsyncOperation header to query the operation result.", - "schema": { - "$ref": "#/definitions/AppResource" - } - }, - "202": { - "description": "Accepted. The response indicates the exiting App is now updating and contains a Location\r\nheader to query the operation result.", + "description": "Success. The response describes the Build.", "schema": { - "$ref": "#/definitions/AppResource" + "$ref": "#/definitions/Build" } }, "default": { @@ -2641,22 +2632,18 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Apps_CreateOrUpdate": { - "$ref": "./examples/Apps_CreateOrUpdate.json" - }, - "Apps_CreateOrUpdate_VNetInjection": { - "$ref": "./examples/Apps_CreateOrUpdate_VNetInjection.json" + "BuildService_GetBuild": { + "$ref": "./examples/BuildService_GetBuild.json" } } }, - "delete": { + "put": { "tags": [ "AppPlatform" ], - "description": "Operation to delete an App.", - "operationId": "Apps_Delete", + "description": "Create or update a KPack build.", + "operationId": "BuildService_CreateOrUpdateBuild", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2671,18 +2658,33 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + }, + { + "name": "build", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/Build" + } } ], "responses": { "200": { - "description": "Success. The response indicates the resource is deleted." - }, - "202": { - "description": "Accepted. The response indicates the delete operation is performed in the background." + "description": "Success. The response describes the updated Build.", + "schema": { + "$ref": "#/definitions/Build" + } }, - "204": { - "description": "Success. The response indicates the resource doesn't exist." + "201": { + "description": "Created. The response describes the new Build and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/Build" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -2691,19 +2693,18 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Apps_Delete": { - "$ref": "./examples/Apps_Delete.json" + "BuildService_CreateOrUpdateBuild": { + "$ref": "./examples/BuildService_CreateOrUpdateBuild.json" } } }, - "patch": { + "delete": { "tags": [ "AppPlatform" ], - "description": "Operation to update an exiting App.", - "operationId": "Apps_Update", + "description": "delete a KPack build.", + "operationId": "BuildService_DeleteBuild", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2718,31 +2719,24 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" }, { - "name": "appResource", - "in": "body", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/AppResource" - } + "$ref": "#/parameters/BuildNameParameter" } ], "responses": { - "200": { - "description": "Success. The response describes the updated App.", - "schema": { - "$ref": "#/definitions/AppResource" - } - }, "202": { - "description": "Accepted. The response indicates the exiting App is now updating and contains a Location header to query the operation result.", - "schema": { - "$ref": "#/definitions/AppResource" + "description": "Accepted. The response indicates the delete operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } } }, + "204": { + "description": "Success. The response indicates the build resource doesn't exist or has deleted." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -2751,23 +2745,23 @@ } }, "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { - "Apps_Update": { - "$ref": "./examples/Apps_Update.json" - }, - "Apps_Update_VNetInjection": { - "$ref": "./examples/Apps_Update_VNetInjection.json" + "BuildService_DeleteBuild": { + "$ref": "./examples/BuildService_DeleteBuild.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildpackBindings": { "get": { "tags": [ "AppPlatform" ], - "description": "Handles requests to list all resources in a Service.", - "operationId": "Apps_List", + "description": "Get collection of buildpack bindings under all builders.", + "operationId": "BuildpackBinding_ListForCluster", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2784,9 +2778,9 @@ ], "responses": { "200": { - "description": "Success. The response describes the list of Apps in the Service.", + "description": "Success. The response describes the list of buildpack bindings under all builders in the cluster.", "schema": { - "$ref": "#/definitions/AppResourceCollection" + "$ref": "#/definitions/BuildpackBindingResourceCollection" } }, "default": { @@ -2800,22 +2794,19 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "Apps_List": { - "$ref": "./examples/Apps_List.json" - }, - "Apps_List_VNetInjection": { - "$ref": "./examples/Apps_List_VNetInjection.json" + "BuildpackBinding_ListForCluster": { + "$ref": "./examples/BuildpackBinding_ListForCluster.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/getResourceUploadUrl": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings/{buildpackBindingName}": { + "get": { "tags": [ "AppPlatform" ], - "description": "Get an resource upload URL for an App, which may be artifacts or source archive.", - "operationId": "Apps_GetResourceUploadUrl", + "description": "Get a buildpack binding by name.", + "operationId": "BuildpackBinding_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2830,14 +2821,20 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildpackBindingNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the resource upload URL.", + "description": "Success. The response describes a Buildpack Binding.", "schema": { - "$ref": "#/definitions/ResourceUploadDefinition" + "$ref": "#/definitions/BuildpackBindingResource" } }, "default": { @@ -2848,19 +2845,17 @@ } }, "x-ms-examples": { - "Apps_GetResourceUploadUrl": { - "$ref": "./examples/Apps_GetResourceUploadUrl.json" + "BuildpackBinding_Get": { + "$ref": "./examples/BuildpackBinding_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/setActiveDeployments": { - "post": { + }, + "put": { "tags": [ "AppPlatform" ], - "description": "Set existing Deployment under the app as active", - "operationId": "Apps_SetActiveDeployments", + "description": "Create or update a buildpack binding.", + "operationId": "BuildpackBinding_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2875,29 +2870,35 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" }, { - "name": "activeDeploymentCollection", + "$ref": "#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildpackBindingNameParameter" + }, + { + "name": "buildpackBinding", "in": "body", - "description": "A list of Deployment name to be active.", + "description": "The target buildpack binding for the create or update operation", "required": true, "schema": { - "$ref": "#/definitions/ActiveDeploymentCollection" + "$ref": "#/definitions/BuildpackBindingResource" } } ], "responses": { "200": { - "description": "Success. The response describes the active deployment.", + "description": "Success. The response describes a Buildpack Binding for the create or update operation.", "schema": { - "$ref": "#/definitions/AppResource" + "$ref": "#/definitions/BuildpackBindingResource" } }, - "202": { - "description": "Accepted. The response indicates the exiting Binding is now updating and contains a Location header to query the operation result.", + "201": { + "description": "Created. The response describes the new Buildpack Binding and contains an Azure-AsyncOperation header to query the operation result.", "schema": { - "$ref": "#/definitions/AppResource" + "$ref": "#/definitions/BuildpackBindingResource" } }, "default": { @@ -2909,19 +2910,17 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Apps_SetActiveDeployments": { - "$ref": "./examples/Apps_SetActiveDeployments.json" + "BuildpackBinding_CreateOrUpdate": { + "$ref": "./examples/BuildpackBinding_CreateOrUpdate.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings/{bindingName}": { - "get": { + }, + "delete": { "tags": [ "AppPlatform" ], - "description": "Get a Binding and its properties.", - "operationId": "Bindings_Get", + "description": "Operation to delete a Buildpack Binding", + "operationId": "BuildpackBinding_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2936,18 +2935,24 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" }, { - "$ref": "#/parameters/BindingNameParameter" + "$ref": "#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildpackBindingNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the corresponding Binding.", - "schema": { - "$ref": "#/definitions/BindingResource" - } + "description": "Success. The response indicates the resource is deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource doesn't exist." }, "default": { "description": "Error response describing why the operation failed.", @@ -2956,18 +2961,21 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "Bindings_Get": { - "$ref": "./examples/Bindings_Get.json" + "BuildpackBinding_Delete": { + "$ref": "./examples/BuildpackBinding_Delete.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/buildpackBindings": { + "get": { "tags": [ "AppPlatform" ], - "description": "Create a new Binding or update an exiting Binding.", - "operationId": "Bindings_CreateOrUpdate", + "description": "Handles requests to list all buildpack bindings in a builder.", + "operationId": "BuildpackBinding_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2982,38 +2990,17 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" - }, - { - "$ref": "#/parameters/BindingNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" }, { - "name": "bindingResource", - "in": "body", - "description": "Parameters for the create or update operation", - "required": true, - "schema": { - "$ref": "#/definitions/BindingResource" - } + "$ref": "#/parameters/BuilderNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the created or updated Binding.", - "schema": { - "$ref": "#/definitions/BindingResource" - } - }, - "201": { - "description": "Created. The response describes the new Binding and contains an Azure-AsyncOperation header to query the operation result.", - "schema": { - "$ref": "#/definitions/BindingResource" - } - }, - "202": { - "description": "Accepted. The response indicates the exiting Binding is now updating and contains a Location\r\nheader to query the operation result.", + "description": "Success. The response describes the list of Buildpack Binding in the builder.", "schema": { - "$ref": "#/definitions/BindingResource" + "$ref": "#/definitions/BuildpackBindingResourceCollection" } }, "default": { @@ -3023,19 +3010,23 @@ } } }, - "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "Bindings_CreateOrUpdate": { - "$ref": "./examples/Bindings_CreateOrUpdate.json" + "BuildpackBinding_Get": { + "$ref": "./examples/BuildpackBinding_List.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}/results": { + "get": { "tags": [ "AppPlatform" ], - "description": "Operation to delete a Binding.", - "operationId": "Bindings_Delete", + "description": "List KPack build results.", + "operationId": "BuildService_ListBuildResults", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3050,21 +3041,18 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" }, { - "$ref": "#/parameters/BindingNameParameter" + "$ref": "#/parameters/BuildNameParameter" } ], "responses": { "200": { - "description": "Success. The response indicates the resource is deleted." - }, - "202": { - "description": "Accepted. The response indicates the delete operation is performed in the background." - }, - "204": { - "description": "Success. The response indicates the resource doesn't exist." + "description": "Success. The response describes the build results.", + "schema": { + "$ref": "#/definitions/BuildResultCollection" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -3073,19 +3061,23 @@ } } }, - "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "Bindings_Delete": { - "$ref": "./examples/Bindings_Delete.json" + "BuildService_ListBuildResults": { + "$ref": "./examples/BuildService_ListBuildResults.json" } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}/results/{buildResultName}": { + "get": { "tags": [ "AppPlatform" ], - "description": "Operation to update an exiting Binding.", - "operationId": "Bindings_Update", + "description": "Get a KPack build result.", + "operationId": "BuildService_GetBuildResult", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3100,32 +3092,20 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" }, { - "$ref": "#/parameters/BindingNameParameter" + "$ref": "#/parameters/BuildNameParameter" }, { - "name": "bindingResource", - "in": "body", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/BindingResource" - } + "$ref": "#/parameters/BuildResultNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the updated Binding.", - "schema": { - "$ref": "#/definitions/BindingResource" - } - }, - "202": { - "description": "Accepted. The response indicates the exiting Binding is now updating and contains a Location\r\nheader to query the operation result.", + "description": "Success. The response describes the build result.", "schema": { - "$ref": "#/definitions/BindingResource" + "$ref": "#/definitions/BuildResult" } }, "default": { @@ -3135,21 +3115,20 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Bindings_Update": { - "$ref": "./examples/Bindings_Update.json" + "BuildService_GetBuildResult": { + "$ref": "./examples/BuildService_GetBuildResult.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builds/{buildName}/results/{buildResultName}/getLogFileUrl": { + "post": { "tags": [ "AppPlatform" ], - "description": "Handles requests to list all resources in an App.", - "operationId": "Bindings_List", + "description": "Get a KPack build result log download URL.", + "operationId": "BuildService_GetBuildResultLog", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3164,14 +3143,20 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + }, + { + "$ref": "#/parameters/BuildResultNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the list of Bindings in the App.", + "description": "Success. Build result log exists and can be downloaded.", "schema": { - "$ref": "#/definitions/BindingResourceCollection" + "$ref": "#/definitions/BuildResultLog" } }, "default": { @@ -3181,23 +3166,20 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Bindings_List": { - "$ref": "./examples/Bindings_List.json" + "BuildService_GetBuildResultLog": { + "$ref": "./examples/BuildService_GetBuildResultLog.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages/{storageName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}": { "get": { "tags": [ "AppPlatform" ], - "description": "Get the storage resource.", - "operationId": "Storages_Get", + "description": "Get a KPack builder.", + "operationId": "BuildServiceBuilder_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3212,14 +3194,17 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/StorageNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" } ], "responses": { "200": { - "description": "Success. The response describe the storage.", + "description": "Success. The response describes the Builder", "schema": { - "$ref": "#/definitions/StorageResource" + "$ref": "#/definitions/BuilderResource" } }, "default": { @@ -3230,8 +3215,8 @@ } }, "x-ms-examples": { - "Storages_Get": { - "$ref": "./examples/Storages_Get.json" + "BuildServiceBuilder_Get": { + "$ref": "./examples/BuildServiceBuilder_Get.json" } } }, @@ -3239,8 +3224,8 @@ "tags": [ "AppPlatform" ], - "description": "Create or update storage resource.", - "operationId": "Storages_CreateOrUpdate", + "description": "Create or update a KPack builder.", + "operationId": "BuildServiceBuilder_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3255,35 +3240,32 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/StorageNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" }, { - "name": "storageResource", + "$ref": "#/parameters/BuilderNameParameter" + }, + { + "name": "builderResource", "in": "body", - "description": "Parameters for the create or update operation", + "description": "The target builder for the create or update operation", "required": true, "schema": { - "$ref": "#/definitions/StorageResource" + "$ref": "#/definitions/BuilderResource" } } ], "responses": { "200": { - "description": "Success. The response describe the existed storage updated.", + "description": "Success. The response describes the Builder", "schema": { - "$ref": "#/definitions/StorageResource" + "$ref": "#/definitions/BuilderResource" } }, "201": { - "description": "Created. The response describes the new storage resource created and contains an Azure-AsyncOperation header to query the operation result.", - "schema": { - "$ref": "#/definitions/StorageResource" - } - }, - "202": { - "description": "Accepted. The response indicates the exiting storage is now updating and contains a Location\r\nheader to query the operation result.", + "description": "Created. The response describes the new Builder and contains an Azure-AsyncOperation header to query the operation result.", "schema": { - "$ref": "#/definitions/StorageResource" + "$ref": "#/definitions/BuilderResource" } }, "default": { @@ -3295,8 +3277,8 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Storages_CreateOrUpdate": { - "$ref": "./examples/Storages_CreateOrUpdate.json" + "BuildServiceBuilder_CreateOrUpdate": { + "$ref": "./examples/BuildServiceBuilder_CreateOrUpdate.json" } } }, @@ -3304,8 +3286,8 @@ "tags": [ "AppPlatform" ], - "description": "Delete the storage resource.", - "operationId": "Storages_Delete", + "description": "Delete a KPack builder.", + "operationId": "BuildServiceBuilder_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3320,18 +3302,21 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/StorageNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuilderNameParameter" } ], "responses": { "200": { - "description": "Success. The response indicates the storage deleted." + "description": "Success. The response indicates the builder resource has deleted." }, "202": { - "description": "Accepted. The response indicates the delete operation is performed in the background." + "description": "Accepted. The response indicates the builder resource is deleting." }, "204": { - "description": "No content. The response indicates the storage doesn't exist." + "description": "Success. The response indicates the builder resource doesn't exist or has deleted." }, "default": { "description": "Error response describing why the operation failed.", @@ -3342,19 +3327,19 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Storages_Delete": { - "$ref": "./examples/Storages_Delete.json" + "BuildServiceBuilder_Delete": { + "$ref": "./examples/BuildServiceBuilder_Delete.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders": { "get": { "tags": [ "AppPlatform" ], - "description": "List all the storages of one Azure Spring Apps resource.", - "operationId": "Storages_List", + "description": "List KPack builders result.", + "operationId": "BuildServiceBuilder_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3367,13 +3352,16 @@ }, { "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response describe all the storages attached to one Azure Spring Apps resource.", + "description": "Success. The response describes the Builder List", "schema": { - "$ref": "#/definitions/StorageResourceCollection" + "$ref": "#/definitions/BuilderResourceCollection" } }, "default": { @@ -3387,19 +3375,19 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "Storages_List": { - "$ref": "./examples/Storages_List.json" + "BuildServiceBuilder_List": { + "$ref": "./examples/BuildServiceBuilder_List.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/getResourceUploadUrl": { + "post": { "tags": [ "AppPlatform" ], - "description": "Get the certificate resource.", - "operationId": "Certificates_Get", + "description": "Get an resource upload URL for build service, which may be artifacts or source archive.", + "operationId": "BuildService_GetResourceUploadUrl", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3414,14 +3402,14 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/CertificateNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response describe the certificate.", + "description": "Success. The response describes the resource upload URL.", "schema": { - "$ref": "#/definitions/CertificateResource" + "$ref": "#/definitions/ResourceUploadDefinition" } }, "default": { @@ -3432,17 +3420,19 @@ } }, "x-ms-examples": { - "Certificates_Get": { - "$ref": "./examples/Certificates_Get.json" + "BuildService_GetResourceUploadUrl": { + "$ref": "./examples/BuildService_GetResourceUploadUrl.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedBuildpacks": { + "get": { "tags": [ "AppPlatform" ], - "description": "Create or update certificate resource.", - "operationId": "Certificates_CreateOrUpdate", + "description": "Get all supported buildpacks.", + "operationId": "BuildService_ListSupportedBuildpacks", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3457,35 +3447,62 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/CertificateNameParameter" - }, - { - "name": "certificateResource", - "in": "body", - "description": "Parameters for the create or update operation", - "required": true, - "schema": { - "$ref": "#/definitions/CertificateResource" - } + "$ref": "#/parameters/BuildServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response describe the existed certificate updated.", + "description": "Success. The response describes all supported buildpacks.", "schema": { - "$ref": "#/definitions/CertificateResource" + "$ref": "#/definitions/SupportedBuildpacksCollection" } }, - "201": { - "description": "Created. The response describes the new certificate and contains an Azure-AsyncOperation header to query the operation result.", + "default": { + "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/CertificateResource" + "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "BuildService_ListSupportedBuildpacks": { + "$ref": "./examples/BuildService_ListSupportedBuildpacks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedBuildpacks/{buildpackName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the supported buildpack resource.", + "operationId": "BuildService_GetSupportedBuildpack", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" }, - "202": { - "description": "Accepted. The response indicates the exiting certificate is now updating and contains a Location\r\nheader to query the operation result.", + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceBuildpackNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the supported buildpack.", "schema": { - "$ref": "#/definitions/CertificateResource" + "$ref": "#/definitions/SupportedBuildpackResource" } }, "default": { @@ -3495,19 +3512,20 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Certificates_CreateOrUpdate": { - "$ref": "./examples/Certificates_CreateOrUpdate.json" + "BuildService_GetSupportedBuildpack": { + "$ref": "./examples/BuildService_GetSupportedBuildpack.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedStacks": { + "get": { "tags": [ "AppPlatform" ], - "description": "Delete the certificate resource.", - "operationId": "Certificates_Delete", + "description": "Get all supported stacks.", + "operationId": "BuildService_ListSupportedStacks", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3522,18 +3540,15 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/CertificateNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response indicates the certificate deleted." - }, - "202": { - "description": "Accepted. The response indicates the delete operation is performed in the background." - }, - "204": { - "description": "No content. The response indicates the certificate doesn't exist." + "description": "Success. The response describes all supported stacks.", + "schema": { + "$ref": "#/definitions/SupportedStacksCollection" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -3542,21 +3557,20 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Certificates_Delete": { - "$ref": "./examples/Certificates_Delete.json" + "BuildService_ListSupportedStacks": { + "$ref": "./examples/BuildService_ListSupportedStacks.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/supportedStacks/{stackName}": { "get": { "tags": [ "AppPlatform" ], - "description": "List all the certificates of one user.", - "operationId": "Certificates_List", + "description": "Get the supported stack resource.", + "operationId": "BuildService_GetSupportedStack", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3569,13 +3583,19 @@ }, { "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceStackNameParameter" } ], "responses": { "200": { - "description": "Success. The response describe the list of certificates in the Service.", + "description": "Success. The response describes the supported stack.", "schema": { - "$ref": "#/definitions/CertificateResourceCollection" + "$ref": "#/definitions/SupportedStackResource" } }, "default": { @@ -3585,23 +3605,20 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Certificates_List": { - "$ref": "./examples/Certificates_List.json" + "BuildService_GetSupportedStack": { + "$ref": "./examples/BuildService_GetSupportedStack.json" } } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/locations/{location}/checkNameAvailability": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/agentPools": { + "get": { "tags": [ "AppPlatform" ], - "description": "Checks that the resource name is valid and is not already in use.", - "operationId": "Services_CheckNameAvailability", + "description": "List build service agent pool.", + "operationId": "BuildServiceAgentPool_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3610,27 +3627,20 @@ "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "location", - "in": "path", - "description": "the region", - "required": true, - "type": "string" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "availabilityParameters", - "in": "body", - "description": "Parameters supplied to the operation.", - "required": true, - "schema": { - "$ref": "#/definitions/NameAvailabilityParameters" - } + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BuildServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the name availability.", + "description": "Success. The response describes build service agent pool.", "schema": { - "$ref": "#/definitions/NameAvailability" + "$ref": "#/definitions/BuildServiceAgentPoolResourceCollection" } }, "default": { @@ -3640,20 +3650,23 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "Services_CheckNameAvailability": { - "$ref": "./examples/Services_CheckNameAvailability.json" + "BuildServiceAgentPool_List": { + "$ref": "./examples/BuildServiceAgentPool_List.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains/{domainName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/agentPools/{agentPoolName}": { "get": { "tags": [ "AppPlatform" ], - "description": "Get the custom domain of one lifecycle application.", - "operationId": "CustomDomains_Get", + "description": "Get build service agent pool.", + "operationId": "BuildServiceAgentPool_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3668,17 +3681,17 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" }, { - "$ref": "#/parameters/CustomDomainNameParameter" + "$ref": "#/parameters/BuildServiceAgentPoolNameParameter" } ], "responses": { "200": { - "description": "Success. The response describe the custom domain.", + "description": "Success. The response describes build service agent pool.", "schema": { - "$ref": "#/definitions/CustomDomainResource" + "$ref": "#/definitions/BuildServiceAgentPoolResource" } }, "default": { @@ -3689,8 +3702,8 @@ } }, "x-ms-examples": { - "CustomDomains_Get": { - "$ref": "./examples/CustomDomains_Get.json" + "BuildServiceAgentPool_Get": { + "$ref": "./examples/BuildServiceAgentPool_Get.json" } } }, @@ -3698,8 +3711,8 @@ "tags": [ "AppPlatform" ], - "description": "Create or update custom domain of one lifecycle application.", - "operationId": "CustomDomains_CreateOrUpdate", + "description": "Create or update build service agent pool.", + "operationId": "BuildServiceAgentPool_UpdatePut", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3714,38 +3727,32 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" }, { - "$ref": "#/parameters/CustomDomainNameParameter" + "$ref": "#/parameters/BuildServiceAgentPoolNameParameter" }, { - "name": "domainResource", + "name": "agentPoolResource", "in": "body", - "description": "Parameters for the create or update operation", + "description": "Parameters for the update operation", "required": true, "schema": { - "$ref": "#/definitions/CustomDomainResource" + "$ref": "#/definitions/BuildServiceAgentPoolResource" } } ], "responses": { "200": { - "description": "Success. The response describe the existed custom domain updated.", + "description": "Success. The response describes build service agent pool.", "schema": { - "$ref": "#/definitions/CustomDomainResource" + "$ref": "#/definitions/BuildServiceAgentPoolResource" } }, "201": { - "description": "Created. The response describes the new custom domain and contains an Azure-AsyncOperation header to query the operation result.", - "schema": { - "$ref": "#/definitions/CustomDomainResource" - } - }, - "202": { - "description": "Accepted. The response indicates the exiting custom domain is now updating and contains a Location\r\nheader to query the operation result.", + "description": "Created. The response describes the new build service agent pool and contains an Azure-AsyncOperation header to query the operation result.", "schema": { - "$ref": "#/definitions/CustomDomainResource" + "$ref": "#/definitions/BuildServiceAgentPoolResource" } }, "default": { @@ -3757,17 +3764,19 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "CustomDomains_CreateOrUpdate": { - "$ref": "./examples/CustomDomains_CreateOrUpdate.json" + "BuildServiceAgentPool_UpdatePut": { + "$ref": "./examples/BuildServiceAgentPool_UpdatePut.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/monitoringSettings/default": { + "get": { "tags": [ "AppPlatform" ], - "description": "Delete the custom domain of one lifecycle application.", - "operationId": "CustomDomains_Delete", + "description": "Get the Monitoring Setting and its properties.", + "operationId": "MonitoringSettings_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3780,23 +3789,14 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/AppNameParameter" - }, - { - "$ref": "#/parameters/CustomDomainNameParameter" } ], "responses": { "200": { - "description": "Success. The response indicates the custom domain deleted." - }, - "202": { - "description": "Accepted. The response indicates the delete operation is performed in the background." - }, - "204": { - "description": "No content. The response indicates the custom domain doesn't exist." + "description": "Success. The response describes the corresponding Monitoring Setting.", + "schema": { + "$ref": "#/definitions/MonitoringSettingResource" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -3805,19 +3805,18 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "CustomDomains_Delete": { - "$ref": "./examples/CustomDomains_Delete.json" + "MonitoringSettings_Get": { + "$ref": "./examples/MonitoringSettings_Get.json" } } }, - "patch": { + "put": { "tags": [ "AppPlatform" ], - "description": "Update custom domain of one lifecycle application.", - "operationId": "CustomDomains_Update", + "description": "Update the Monitoring Setting.", + "operationId": "MonitoringSettings_UpdatePut", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3832,32 +3831,26 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" - }, - { - "$ref": "#/parameters/CustomDomainNameParameter" - }, - { - "name": "domainResource", + "name": "monitoringSettingResource", "in": "body", - "description": "Parameters for the create or update operation", + "description": "Parameters for the update operation", "required": true, "schema": { - "$ref": "#/definitions/CustomDomainResource" + "$ref": "#/definitions/MonitoringSettingResource" } } ], "responses": { "200": { - "description": "Success. The response describe the existed custom domain updated.", + "description": "Success. The response describes the updated Monitoring Setting.", "schema": { - "$ref": "#/definitions/CustomDomainResource" + "$ref": "#/definitions/MonitoringSettingResource" } }, "202": { - "description": "Accepted. The response indicates the exiting custom domain is now updating and contains a Location\r\nheader to query the operation result.", + "description": "Accepted. The response indicates the exiting Monitoring Setting is now updating and contains a Location\r\nheader to query the operation result.", "schema": { - "$ref": "#/definitions/CustomDomainResource" + "$ref": "#/definitions/MonitoringSettingResource" } }, "default": { @@ -3869,67 +3862,17 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "CustomDomains_Update": { - "$ref": "./examples/CustomDomains_Update.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains": { - "get": { - "tags": [ - "AppPlatform" - ], - "description": "List the custom domains of one lifecycle application.", - "operationId": "CustomDomains_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/AppNameParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describe the custom domain resource list of one application.", - "schema": { - "$ref": "#/definitions/CustomDomainResourceCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "CustomDomains_List": { - "$ref": "./examples/CustomDomains_List.json" + "MonitoringSettings_UpdatePut": { + "$ref": "./examples/MonitoringSettings_UpdatePut.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/validateDomain": { - "post": { + }, + "patch": { "tags": [ "AppPlatform" ], - "description": "Check the resource name is valid as well as not in use.", - "operationId": "Apps_ValidateDomain", + "description": "Update the Monitoring Setting.", + "operationId": "MonitoringSettings_UpdatePatch", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -3944,23 +3887,26 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" - }, - { - "name": "validatePayload", + "name": "monitoringSettingResource", "in": "body", - "description": "Custom domain payload to be validated", + "description": "Parameters for the update operation", "required": true, "schema": { - "$ref": "#/definitions/CustomDomainValidatePayload" + "$ref": "#/definitions/MonitoringSettingResource" } } ], "responses": { "200": { - "description": "Success. The response describe the name is available.", + "description": "Success. The response describes the updated Monitoring Setting.", "schema": { - "$ref": "#/definitions/CustomDomainValidateResult" + "$ref": "#/definitions/MonitoringSettingResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Monitoring Setting is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/MonitoringSettingResource" } }, "default": { @@ -3970,20 +3916,21 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "Apps_ValidateDomain": { - "$ref": "./examples/Apps_ValidateDomain.json" + "MonitoringSettings_UpdatePatch": { + "$ref": "./examples/MonitoringSettings_UpdatePatch.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}": { "get": { "tags": [ "AppPlatform" ], - "description": "Get a Deployment and its properties.", - "operationId": "Deployments_Get", + "description": "Get an App and its properties.", + "operationId": "Apps_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4001,14 +3948,18 @@ "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/DeploymentNameParameter" + "name": "syncStatus", + "in": "query", + "description": "Indicates whether sync status", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "Success. The response describes the corresponding Deployment.", + "description": "Success. The response describes the corresponding App.", "schema": { - "$ref": "#/definitions/DeploymentResource" + "$ref": "#/definitions/AppResource" } }, "default": { @@ -4019,11 +3970,11 @@ } }, "x-ms-examples": { - "Deployments_Get": { - "$ref": "./examples/Deployments_Get.json" + "Apps_Get": { + "$ref": "./examples/Apps_Get.json" }, - "Deployments_Get_CustomContainer": { - "$ref": "./examples/Deployments_Get_CustomContainer.json" + "Apps_Get_VNetInjection": { + "$ref": "./examples/Apps_Get_VNetInjection.json" } } }, @@ -4031,8 +3982,8 @@ "tags": [ "AppPlatform" ], - "description": "Create a new Deployment or update an exiting Deployment.", - "operationId": "Deployments_CreateOrUpdate", + "description": "Create a new App or update an exiting App.", + "operationId": "Apps_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4050,35 +4001,32 @@ "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/DeploymentNameParameter" - }, - { - "name": "deploymentResource", + "name": "appResource", "in": "body", "description": "Parameters for the create or update operation", "required": true, "schema": { - "$ref": "#/definitions/DeploymentResource" + "$ref": "#/definitions/AppResource" } } ], "responses": { "200": { - "description": "Success. The response describes the updated Deployment.", + "description": "Success. The response describes the updated App.", "schema": { - "$ref": "#/definitions/DeploymentResource" + "$ref": "#/definitions/AppResource" } }, "201": { - "description": "Created. The response describes the new Deployment and contains an Azure-AsyncOperation header to query the operation result.", + "description": "Created. The response describes the new App and contains an Azure-AsyncOperation header to query the operation result.", "schema": { - "$ref": "#/definitions/DeploymentResource" + "$ref": "#/definitions/AppResource" } }, "202": { - "description": "Accepted. The response indicates the exiting Deployment is now updating and contains a Location\r\nheader to query the operation result.", + "description": "Accepted. The response indicates the exiting App is now updating and contains a Location\r\nheader to query the operation result.", "schema": { - "$ref": "#/definitions/DeploymentResource" + "$ref": "#/definitions/AppResource" } }, "default": { @@ -4090,11 +4038,11 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Deployments_CreateOrUpdate": { - "$ref": "./examples/Deployments_CreateOrUpdate.json" + "Apps_CreateOrUpdate": { + "$ref": "./examples/Apps_CreateOrUpdate.json" }, - "Deployments_CreateOrUpdate_CustomContainer": { - "$ref": "./examples/Deployments_CreateOrUpdate_CustomContainer.json" + "Apps_CreateOrUpdate_VNetInjection": { + "$ref": "./examples/Apps_CreateOrUpdate_VNetInjection.json" } } }, @@ -4102,8 +4050,8 @@ "tags": [ "AppPlatform" ], - "description": "Operation to delete a Deployment.", - "operationId": "Deployments_Delete", + "description": "Operation to delete an App.", + "operationId": "Apps_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4119,9 +4067,6 @@ }, { "$ref": "#/parameters/AppNameParameter" - }, - { - "$ref": "#/parameters/DeploymentNameParameter" } ], "responses": { @@ -4143,8 +4088,8 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Deployments_Delete": { - "$ref": "./examples/Deployments_Delete.json" + "Apps_Delete": { + "$ref": "./examples/Apps_Delete.json" } } }, @@ -4152,8 +4097,8 @@ "tags": [ "AppPlatform" ], - "description": "Operation to update an exiting Deployment.", - "operationId": "Deployments_Update", + "description": "Operation to update an exiting App.", + "operationId": "Apps_Update", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4171,29 +4116,26 @@ "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/DeploymentNameParameter" - }, - { - "name": "deploymentResource", + "name": "appResource", "in": "body", "description": "Parameters for the update operation", "required": true, "schema": { - "$ref": "#/definitions/DeploymentResource" + "$ref": "#/definitions/AppResource" } } ], "responses": { "200": { - "description": "Success. The response describes the updated Deployment.", + "description": "Success. The response describes the updated App.", "schema": { - "$ref": "#/definitions/DeploymentResource" + "$ref": "#/definitions/AppResource" } }, "202": { - "description": "Accepted. The response indicates the exiting Deployment is now updating and contains a Location\r\nheader to query the operation result.", + "description": "Accepted. The response indicates the exiting App is now updating and contains a Location header to query the operation result.", "schema": { - "$ref": "#/definitions/DeploymentResource" + "$ref": "#/definitions/AppResource" } }, "default": { @@ -4205,22 +4147,22 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Deployments_Update": { - "$ref": "./examples/Deployments_Update.json" + "Apps_Update": { + "$ref": "./examples/Apps_Update.json" }, - "Deployments_Update_CustomContainer": { - "$ref": "./examples/Deployments_Update_CustomContainer.json" + "Apps_Update_VNetInjection": { + "$ref": "./examples/Apps_Update_VNetInjection.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps": { "get": { "tags": [ "AppPlatform" ], - "description": "Handles requests to list all resources in an App.", - "operationId": "Deployments_List", + "description": "Handles requests to list all resources in a Service.", + "operationId": "Apps_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4233,28 +4175,13 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/AppNameParameter" - }, - { - "name": "version", - "in": "query", - "description": "Version of the deployments to be listed", - "required": false, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "uniqueItems": false } ], "responses": { "200": { - "description": "Success. The response describes the list of Deployments in the App.", + "description": "Success. The response describes the list of Apps in the Service.", "schema": { - "$ref": "#/definitions/DeploymentResourceCollection" + "$ref": "#/definitions/AppResourceCollection" } }, "default": { @@ -4268,19 +4195,22 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "Deployments_List": { - "$ref": "./examples/Deployments_List.json" + "Apps_List": { + "$ref": "./examples/Apps_List.json" + }, + "Apps_List_VNetInjection": { + "$ref": "./examples/Apps_List_VNetInjection.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/deployments": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/getResourceUploadUrl": { + "post": { "tags": [ "AppPlatform" ], - "description": "List deployments for a certain service", - "operationId": "Deployments_ListForCluster", + "description": "Get an resource upload URL for an App, which may be artifacts or source archive.", + "operationId": "Apps_GetResourceUploadUrl", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4295,23 +4225,14 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "name": "version", - "in": "query", - "description": "Version of the deployments to be listed", - "required": false, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "uniqueItems": false + "$ref": "#/parameters/AppNameParameter" } ], "responses": { "200": { - "description": "Success", + "description": "Success. The response describes the resource upload URL.", "schema": { - "$ref": "#/definitions/DeploymentResourceCollection" + "$ref": "#/definitions/ResourceUploadDefinition" } }, "default": { @@ -4321,24 +4242,21 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Deployments_ListForCluster": { - "$ref": "./examples/Deployments_ListForCluster.json" + "Apps_GetResourceUploadUrl": { + "$ref": "./examples/Apps_GetResourceUploadUrl.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/listUsingDeployments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/setActiveDeployments": { "post": { "tags": [ "AppPlatform" ], - "description": "List deployments that are using the builder.", - "operationId": "BuildServiceBuilder_ListDeployments", - "parameters": [ + "description": "Set existing Deployment under the app as active", + "operationId": "Apps_SetActiveDeployments", + "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, @@ -4352,17 +4270,29 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BuildServiceNameParameter" + "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/BuilderNameParameter" + "name": "activeDeploymentCollection", + "in": "body", + "description": "A list of Deployment name to be active.", + "required": true, + "schema": { + "$ref": "#/definitions/ActiveDeploymentCollection" + } } ], "responses": { "200": { - "description": "Success", + "description": "Success. The response describes the active deployment.", "schema": { - "$ref": "#/definitions/DeploymentList" + "$ref": "#/definitions/AppResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Binding is now updating and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/AppResource" } }, "default": { @@ -4372,20 +4302,21 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "BuildServiceBuilder_ListDeployments": { - "$ref": "./examples/BuildServiceBuilder_ListDeployments.json" + "Apps_SetActiveDeployments": { + "$ref": "./examples/Apps_SetActiveDeployments.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/start": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings/{bindingName}": { + "get": { "tags": [ "AppPlatform" ], - "description": "Start the deployment.", - "operationId": "Deployments_Start", + "description": "Get a Binding and its properties.", + "operationId": "Bindings_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4403,15 +4334,15 @@ "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/DeploymentNameParameter" + "$ref": "#/parameters/BindingNameParameter" } ], "responses": { "200": { - "description": "Success." - }, - "202": { - "description": "Accepted. The response indicates the Deployment is now starting and contains a Location header to\r\nquery the operation result." + "description": "Success. The response describes the corresponding Binding.", + "schema": { + "$ref": "#/definitions/BindingResource" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -4420,21 +4351,18 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Deployments_Start": { - "$ref": "./examples/Deployments_Start.json" + "Bindings_Get": { + "$ref": "./examples/Bindings_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/stop": { - "post": { + }, + "put": { "tags": [ "AppPlatform" ], - "description": "Stop the deployment.", - "operationId": "Deployments_Stop", + "description": "Create a new Binding or update an exiting Binding.", + "operationId": "Bindings_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4452,15 +4380,36 @@ "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/DeploymentNameParameter" + "$ref": "#/parameters/BindingNameParameter" + }, + { + "name": "bindingResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/BindingResource" + } } ], "responses": { "200": { - "description": "Success." + "description": "Success. The response describes the created or updated Binding.", + "schema": { + "$ref": "#/definitions/BindingResource" + } + }, + "201": { + "description": "Created. The response describes the new Binding and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/BindingResource" + } }, "202": { - "description": "Accepted. The response indicates the Deployment is now stopping and contains a Location header to\r\nquery the operation result." + "description": "Accepted. The response indicates the exiting Binding is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/BindingResource" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -4471,19 +4420,17 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Deployments_Stop": { - "$ref": "./examples/Deployments_Stop.json" + "Bindings_CreateOrUpdate": { + "$ref": "./examples/Bindings_CreateOrUpdate.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/restart": { - "post": { + }, + "delete": { "tags": [ "AppPlatform" ], - "description": "Restart the deployment.", - "operationId": "Deployments_Restart", + "description": "Operation to delete a Binding.", + "operationId": "Bindings_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4501,15 +4448,18 @@ "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/DeploymentNameParameter" + "$ref": "#/parameters/BindingNameParameter" } ], "responses": { "200": { - "description": "Success." + "description": "Success. The response indicates the resource is deleted." }, "202": { - "description": "Accepted. The response indicates the Deployment is now restarting and contains a Location header\r\nto query the operation result." + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource doesn't exist." }, "default": { "description": "Error response describing why the operation failed.", @@ -4520,19 +4470,17 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Deployments_Restart": { - "$ref": "./examples/Deployments_Restart.json" + "Bindings_Delete": { + "$ref": "./examples/Bindings_Delete.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/enableRemoteDebugging": { - "post": { + }, + "patch": { "tags": [ "AppPlatform" ], - "description": "Enable remote debugging.", - "operationId": "Deployments_EnableRemoteDebugging", + "description": "Operation to update an exiting Binding.", + "operationId": "Bindings_Update", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4550,29 +4498,29 @@ "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/DeploymentNameParameter" + "$ref": "#/parameters/BindingNameParameter" }, { - "name": "remoteDebuggingPayload", + "name": "bindingResource", "in": "body", - "description": "Parameters for enable remote debugging", - "required": false, + "description": "Parameters for the update operation", + "required": true, "schema": { - "$ref": "#/definitions/RemoteDebuggingPayload" + "$ref": "#/definitions/BindingResource" } } ], "responses": { "200": { - "description": "Success.", + "description": "Success. The response describes the updated Binding.", "schema": { - "$ref": "#/definitions/RemoteDebugging" + "$ref": "#/definitions/BindingResource" } }, "202": { - "description": "Accepted. The response indicates the RemoteDebugging is now enabling and contains a Location header to query the operation result.", + "description": "Accepted. The response indicates the exiting Binding is now updating and contains a Location\r\nheader to query the operation result.", "schema": { - "$ref": "#/definitions/RemoteDebugging" + "$ref": "#/definitions/BindingResource" } }, "default": { @@ -4584,19 +4532,19 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Deployments_EnableRemoteDebugging": { - "$ref": "./examples/Deployments_EnableRemoteDebugging.json" + "Bindings_Update": { + "$ref": "./examples/Bindings_Update.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/disableRemoteDebugging": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/bindings": { + "get": { "tags": [ "AppPlatform" ], - "description": "Disable remote debugging.", - "operationId": "Deployments_DisableRemoteDebugging", + "description": "Handles requests to list all resources in an App.", + "operationId": "Bindings_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4612,22 +4560,13 @@ }, { "$ref": "#/parameters/AppNameParameter" - }, - { - "$ref": "#/parameters/DeploymentNameParameter" } ], "responses": { "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/RemoteDebugging" - } - }, - "202": { - "description": "Accepted. The response indicates the RemoteDebugging is now disabling and contains a Location header to query the operation result.", + "description": "Success. The response describes the list of Bindings in the App.", "schema": { - "$ref": "#/definitions/RemoteDebugging" + "$ref": "#/definitions/BindingResourceCollection" } }, "default": { @@ -4637,21 +4576,23 @@ } } }, - "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "Deployments_DisableRemoteDebugging": { - "$ref": "./examples/Deployments_DisableRemoteDebugging.json" + "Bindings_List": { + "$ref": "./examples/Bindings_List.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/getRemoteDebuggingConfig": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages/{storageName}": { + "get": { "tags": [ "AppPlatform" ], - "description": "Get remote debugging config.", - "operationId": "Deployments_GetRemoteDebuggingConfig", + "description": "Get the storage resource.", + "operationId": "Storages_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4666,17 +4607,14 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" - }, - { - "$ref": "#/parameters/DeploymentNameParameter" + "$ref": "#/parameters/StorageNameParameter" } ], "responses": { "200": { - "description": "Success.", + "description": "Success. The response describe the storage.", "schema": { - "$ref": "#/definitions/RemoteDebugging" + "$ref": "#/definitions/StorageResource" } }, "default": { @@ -4687,19 +4625,17 @@ } }, "x-ms-examples": { - "Deployments_GetRemoteDebuggingConfig": { - "$ref": "./examples/Deployments_GetRemoteDebuggingConfig.json" + "Storages_Get": { + "$ref": "./examples/Storages_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/getLogFileUrl": { - "post": { + }, + "put": { "tags": [ "AppPlatform" ], - "description": "Get deployment log file URL", - "operationId": "Deployments_GetLogFileUrl", + "description": "Create or update storage resource.", + "operationId": "Storages_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4714,21 +4650,36 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/StorageNameParameter" }, { - "$ref": "#/parameters/DeploymentNameParameter" + "name": "storageResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/StorageResource" + } } ], "responses": { "200": { - "description": "Success. The response contains the log file URL.", + "description": "Success. The response describe the existed storage updated.", "schema": { - "$ref": "#/definitions/LogFileUrlResponse" + "$ref": "#/definitions/StorageResource" } }, - "204": { - "description": "Success. The deployment does not have log file." + "201": { + "description": "Created. The response describes the new storage resource created and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/StorageResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting storage is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/StorageResource" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -4737,20 +4688,19 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "Deployments_GetLogFileUrl": { - "$ref": "./examples/Deployments_GetLogFileUrl.json" + "Storages_CreateOrUpdate": { + "$ref": "./examples/Storages_CreateOrUpdate.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/generateHeapDump": { - "post": { + }, + "delete": { "tags": [ "AppPlatform" ], - "description": "Generate Heap Dump", - "operationId": "Deployments_GenerateHeapDump", + "description": "Delete the storage resource.", + "operationId": "Storages_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4765,27 +4715,61 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/StorageNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the storage deleted." }, - { - "$ref": "#/parameters/DeploymentNameParameter" + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." }, - { - "name": "diagnosticParameters", - "in": "body", - "description": "Parameters for the diagnostic operation", - "required": true, + "204": { + "description": "No content. The response indicates the storage doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/DiagnosticParameters" + "$ref": "#/definitions/CloudError" } } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Storages_Delete": { + "$ref": "./examples/Storages_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List all the storages of one Azure Spring Apps resource.", + "operationId": "Storages_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } ], "responses": { "200": { - "description": "Success. A heap dump was generated." - }, - "202": { - "description": "Accepted. The response indicates a heap dump is generating." + "description": "Success. The response describe all the storages attached to one Azure Spring Apps resource.", + "schema": { + "$ref": "#/definitions/StorageResourceCollection" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -4794,21 +4778,23 @@ } } }, - "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "Deployments_GenerateHeapDump": { - "$ref": "./examples/Deployments_GenerateHeapDump.json" + "Storages_List": { + "$ref": "./examples/Storages_List.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/generateThreadDump": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}": { + "get": { "tags": [ "AppPlatform" ], - "description": "Generate Thread Dump", - "operationId": "Deployments_GenerateThreadDump", + "description": "Get the certificate resource.", + "operationId": "Certificates_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4823,27 +4809,15 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" - }, - { - "$ref": "#/parameters/DeploymentNameParameter" - }, - { - "name": "diagnosticParameters", - "in": "body", - "description": "Parameters for the diagnostic operation", - "required": true, - "schema": { - "$ref": "#/definitions/DiagnosticParameters" - } + "$ref": "#/parameters/CertificateNameParameter" } ], "responses": { "200": { - "description": "Success. A thread dump was generated." - }, - "202": { - "description": "Accepted. The response indicates a thread dump is generating." + "description": "Success. The response describe the certificate.", + "schema": { + "$ref": "#/definitions/CertificateResource" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -4852,21 +4826,18 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Deployments_GenerateHeapDump": { - "$ref": "./examples/Deployments_GenerateThreadDump.json" + "Certificates_Get": { + "$ref": "./examples/Certificates_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/startJFR": { - "post": { + }, + "put": { "tags": [ "AppPlatform" ], - "description": "Start JFR", - "operationId": "Deployments_StartJFR", + "description": "Create or update certificate resource.", + "operationId": "Certificates_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4881,27 +4852,36 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AppNameParameter" - }, - { - "$ref": "#/parameters/DeploymentNameParameter" + "$ref": "#/parameters/CertificateNameParameter" }, { - "name": "diagnosticParameters", + "name": "certificateResource", "in": "body", - "description": "Parameters for the diagnostic operation", + "description": "Parameters for the create or update operation", "required": true, "schema": { - "$ref": "#/definitions/DiagnosticParameters" + "$ref": "#/definitions/CertificateResource" } } ], "responses": { "200": { - "description": "Success. A JFR generated." + "description": "Success. The response describe the existed certificate updated.", + "schema": { + "$ref": "#/definitions/CertificateResource" + } + }, + "201": { + "description": "Created. The response describes the new certificate and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/CertificateResource" + } }, "202": { - "description": "Accepted. The response indicates a JFR is starting." + "description": "Accepted. The response indicates the exiting certificate is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/CertificateResource" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -4912,33 +4892,43 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Deployments_StartJFR": { - "$ref": "./examples/Deployments_StartJFR.json" + "Certificates_CreateOrUpdate": { + "$ref": "./examples/Certificates_CreateOrUpdate.json" } } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/Spring": { - "get": { + }, + "delete": { "tags": [ "AppPlatform" ], - "description": "Handles requests to list all resources in a subscription.", - "operationId": "Services_ListBySubscription", + "description": "Delete the certificate resource.", + "operationId": "Certificates_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the list of Services in the subscription.", - "schema": { - "$ref": "#/definitions/ServiceResourceList" - } + "description": "Success. The response indicates the certificate deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "No content. The response indicates the certificate doesn't exist." }, "default": { "description": "Error response describing why the operation failed.", @@ -4947,23 +4937,21 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "Services_ListBySubscription": { - "$ref": "./examples/Services_ListBySubscription.json" + "Certificates_Delete": { + "$ref": "./examples/Certificates_Delete.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates": { "get": { "tags": [ "AppPlatform" ], - "description": "Handles requests to list all resources in a resource group.", - "operationId": "Services_List", + "description": "List all the certificates of one user.", + "operationId": "Certificates_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -4973,13 +4961,16 @@ }, { "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the list of Services in the resource group.", + "description": "Success. The response describe the list of certificates in the Service.", "schema": { - "$ref": "#/definitions/ServiceResourceList" + "$ref": "#/definitions/CertificateResourceCollection" } }, "default": { @@ -4993,29 +4984,48 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "Services_List": { - "$ref": "./examples/Services_List.json" + "Certificates_List": { + "$ref": "./examples/Certificates_List.json" } } } }, - "/providers/Microsoft.AppPlatform/operations": { - "get": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/locations/{location}/checkNameAvailability": { + "post": { "tags": [ "AppPlatform" ], - "description": "Lists all of the available REST API operations of the Microsoft.AppPlatform provider.", - "operationId": "Operations_List", + "description": "Checks that the resource name is valid and is not already in use.", + "operationId": "Services_CheckNameAvailability", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "the region", + "required": true, + "type": "string" + }, + { + "name": "availabilityParameters", + "in": "body", + "description": "Parameters supplied to the operation.", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } } ], "responses": { "200": { - "description": "Success. The response describes the list of operations.", + "description": "Success. The response describes the name availability.", "schema": { - "$ref": "#/definitions/AvailableOperations" + "$ref": "#/definitions/NameAvailability" } }, "default": { @@ -5025,33 +5035,45 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" + "Services_CheckNameAvailability": { + "$ref": "./examples/Services_CheckNameAvailability.json" } } } }, - "/providers/Microsoft.AppPlatform/runtimeVersions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains/{domainName}": { "get": { "tags": [ "AppPlatform" ], - "description": "Lists all of the available runtime versions supported by Microsoft.AppPlatform provider.", - "operationId": "RuntimeVersions_ListRuntimeVersions", + "description": "Get the custom domain of one lifecycle application.", + "operationId": "CustomDomains_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/CustomDomainNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the details of all supported deployment runtime versions.", + "description": "Success. The response describe the custom domain.", "schema": { - "$ref": "#/definitions/AvailableRuntimeVersions" + "$ref": "#/definitions/CustomDomainResource" } }, "default": { @@ -5062,32 +5084,63 @@ } }, "x-ms-examples": { - "RuntimeVersions_ListRuntimeVersions": { - "$ref": "./examples/RuntimeVersions_ListRuntimeVersions.json" + "CustomDomains_Get": { + "$ref": "./examples/CustomDomains_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/skus": { - "get": { + }, + "put": { "tags": [ "AppPlatform" ], - "description": "Lists all of the available skus of the Microsoft.AppPlatform provider.", - "operationId": "Skus_List", + "description": "Create or update custom domain of one lifecycle application.", + "operationId": "CustomDomains_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/CustomDomainNameParameter" + }, + { + "name": "domainResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } } ], "responses": { "200": { - "description": "Success", + "description": "Success. The response describe the existed custom domain updated.", "schema": { - "$ref": "#/definitions/ResourceSkuCollection" + "$ref": "#/definitions/CustomDomainResource" + } + }, + "201": { + "description": "Created. The response describes the new custom domain and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting custom domain is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/CustomDomainResource" } }, "default": { @@ -5097,23 +5150,19 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "Skus_List": { - "$ref": "./examples/Skus_List.json" + "CustomDomains_CreateOrUpdate": { + "$ref": "./examples/CustomDomains_CreateOrUpdate.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}": { - "get": { + }, + "delete": { "tags": [ "AppPlatform" ], - "description": "Get the Spring Cloud Gateway and its properties.", - "operationId": "Gateways_Get", + "description": "Delete the custom domain of one lifecycle application.", + "operationId": "CustomDomains_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5128,15 +5177,21 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GatewayNameParameter" + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/CustomDomainNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the corresponding Spring Cloud Gateway.", - "schema": { - "$ref": "#/definitions/GatewayResource" - } + "description": "Success. The response indicates the custom domain deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "No content. The response indicates the custom domain doesn't exist." }, "default": { "description": "Error response describing why the operation failed.", @@ -5145,18 +5200,19 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "Gateways_Get": { - "$ref": "./examples/Gateways_Get.json" + "CustomDomains_Delete": { + "$ref": "./examples/CustomDomains_Delete.json" } } }, - "put": { + "patch": { "tags": [ "AppPlatform" ], - "description": "Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.", - "operationId": "Gateways_CreateOrUpdate", + "description": "Update custom domain of one lifecycle application.", + "operationId": "CustomDomains_Update", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5171,29 +5227,32 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GatewayNameParameter" + "$ref": "#/parameters/AppNameParameter" }, { - "name": "gatewayResource", + "$ref": "#/parameters/CustomDomainNameParameter" + }, + { + "name": "domainResource", "in": "body", - "description": "The gateway for the create or update operation", + "description": "Parameters for the create or update operation", "required": true, "schema": { - "$ref": "#/definitions/GatewayResource" + "$ref": "#/definitions/CustomDomainResource" } } ], "responses": { "200": { - "description": "Success. The response describes the updated Spring Cloud Gateway.", + "description": "Success. The response describe the existed custom domain updated.", "schema": { - "$ref": "#/definitions/GatewayResource" + "$ref": "#/definitions/CustomDomainResource" } }, - "201": { - "description": "Created. The response describes the new created Spring Cloud Gateway and contains an Azure-AsyncOperation header to query the operation result.", + "202": { + "description": "Accepted. The response indicates the exiting custom domain is now updating and contains a Location\r\nheader to query the operation result.", "schema": { - "$ref": "#/definitions/GatewayResource" + "$ref": "#/definitions/CustomDomainResource" } }, "default": { @@ -5205,17 +5264,19 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Gateways_CreateOrUpdate": { - "$ref": "./examples/Gateways_CreateOrUpdate.json" + "CustomDomains_Update": { + "$ref": "./examples/CustomDomains_Update.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains": { + "get": { "tags": [ "AppPlatform" ], - "description": "Disable the default Spring Cloud Gateway.", - "operationId": "Gateways_Delete", + "description": "List the custom domains of one lifecycle application.", + "operationId": "CustomDomains_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5230,18 +5291,15 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GatewayNameParameter" + "$ref": "#/parameters/AppNameParameter" } ], "responses": { "200": { - "description": "Success. The response indicates the default Spring Cloud Gateway has deleted." - }, - "202": { - "description": "Accepted. The response indicates the default Spring Cloud Gateway is now deleting." - }, - "204": { - "description": "Success. The response indicates the default Spring Cloud Gateway doesn't exist or has deleted." + "description": "Success. The response describe the custom domain resource list of one application.", + "schema": { + "$ref": "#/definitions/CustomDomainResourceCollection" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -5250,21 +5308,23 @@ } } }, - "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "Gateways_Delete": { - "$ref": "./examples/Gateways_Delete.json" + "CustomDomains_List": { + "$ref": "./examples/CustomDomains_List.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/validateDomain": { + "post": { "tags": [ "AppPlatform" ], - "description": "Handles requests to list all resources in a Service.", - "operationId": "Gateways_List", + "description": "Check the resource name is valid as well as not in use.", + "operationId": "Apps_ValidateDomain", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5277,13 +5337,25 @@ }, { "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "name": "validatePayload", + "in": "body", + "description": "Custom domain payload to be validated", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainValidatePayload" + } } ], "responses": { "200": { - "description": "Success. The response describes the list of gateways in the Service.", + "description": "Success. The response describe the name is available.", "schema": { - "$ref": "#/definitions/GatewayResourceCollection" + "$ref": "#/definitions/CustomDomainValidateResult" } }, "default": { @@ -5293,23 +5365,20 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Gateways_List": { - "$ref": "./examples/Gateways_List.json" + "Apps_ValidateDomain": { + "$ref": "./examples/Apps_ValidateDomain.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs/{routeConfigName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}": { "get": { "tags": [ "AppPlatform" ], - "description": "Get the Spring Cloud Gateway route configs.", - "operationId": "GatewayRouteConfigs_Get", + "description": "Get a Deployment and its properties.", + "operationId": "Deployments_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5324,17 +5393,17 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GatewayNameParameter" + "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/GatewayRouteConfigNameParameter" + "$ref": "#/parameters/DeploymentNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the corresponding Spring Cloud Gateway route configs.", + "description": "Success. The response describes the corresponding Deployment.", "schema": { - "$ref": "#/definitions/GatewayRouteConfigResource" + "$ref": "#/definitions/DeploymentResource" } }, "default": { @@ -5345,8 +5414,11 @@ } }, "x-ms-examples": { - "GatewayRouteConfigs_Get": { - "$ref": "./examples/GatewayRouteConfigs_Get.json" + "Deployments_Get": { + "$ref": "./examples/Deployments_Get.json" + }, + "Deployments_Get_CustomContainer": { + "$ref": "./examples/Deployments_Get_CustomContainer.json" } } }, @@ -5354,8 +5426,8 @@ "tags": [ "AppPlatform" ], - "description": "Create the default Spring Cloud Gateway route configs or update the existing Spring Cloud Gateway route configs.", - "operationId": "GatewayRouteConfigs_CreateOrUpdate", + "description": "Create a new Deployment or update an exiting Deployment.", + "operationId": "Deployments_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5370,32 +5442,38 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GatewayNameParameter" + "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/GatewayRouteConfigNameParameter" + "$ref": "#/parameters/DeploymentNameParameter" }, { - "name": "gatewayRouteConfigResource", + "name": "deploymentResource", "in": "body", - "description": "The Spring Cloud Gateway route config for the create or update operation", + "description": "Parameters for the create or update operation", "required": true, "schema": { - "$ref": "#/definitions/GatewayRouteConfigResource" + "$ref": "#/definitions/DeploymentResource" } } ], "responses": { "200": { - "description": "Success. The response describes the updated Spring Cloud Gateway route configs.", + "description": "Success. The response describes the updated Deployment.", "schema": { - "$ref": "#/definitions/GatewayRouteConfigResource" + "$ref": "#/definitions/DeploymentResource" } }, "201": { - "description": "Created. The response describes the new created Spring Cloud Gateway route configs and contains an Azure-AsyncOperation header to query the operation result.", + "description": "Created. The response describes the new Deployment and contains an Azure-AsyncOperation header to query the operation result.", "schema": { - "$ref": "#/definitions/GatewayRouteConfigResource" + "$ref": "#/definitions/DeploymentResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Deployment is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/DeploymentResource" } }, "default": { @@ -5407,8 +5485,11 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "GatewayRouteConfigs_CreateOrUpdate": { - "$ref": "./examples/GatewayRouteConfigs_CreateOrUpdate.json" + "Deployments_CreateOrUpdate": { + "$ref": "./examples/Deployments_CreateOrUpdate.json" + }, + "Deployments_CreateOrUpdate_CustomContainer": { + "$ref": "./examples/Deployments_CreateOrUpdate_CustomContainer.json" } } }, @@ -5416,8 +5497,8 @@ "tags": [ "AppPlatform" ], - "description": "Delete the Spring Cloud Gateway route config.", - "operationId": "GatewayRouteConfigs_Delete", + "description": "Operation to delete a Deployment.", + "operationId": "Deployments_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5432,21 +5513,21 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GatewayNameParameter" + "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/GatewayRouteConfigNameParameter" + "$ref": "#/parameters/DeploymentNameParameter" } ], "responses": { "200": { - "description": "Success. The response indicates the Spring Cloud Gateway route config has deleted." + "description": "Success. The response indicates the resource is deleted." }, "202": { - "description": "Accepted. The response indicates the Spring Cloud Gateway route config is now deleting." + "description": "Accepted. The response indicates the delete operation is performed in the background." }, "204": { - "description": "Success. The response indicates the Spring Cloud Gateway route config doesn't exist or has deleted." + "description": "Success. The response indicates the resource doesn't exist." }, "default": { "description": "Error response describing why the operation failed.", @@ -5457,19 +5538,17 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "GatewayRouteConfigs_Delete": { - "$ref": "./examples/GatewayRouteConfigs_Delete.json" + "Deployments_Delete": { + "$ref": "./examples/Deployments_Delete.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs": { - "get": { + }, + "patch": { "tags": [ "AppPlatform" ], - "description": "Handle requests to list all Spring Cloud Gateway route configs.", - "operationId": "GatewayRouteConfigs_List", + "description": "Operation to update an exiting Deployment.", + "operationId": "Deployments_Update", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5484,14 +5563,32 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GatewayNameParameter" + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "deploymentResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentResource" + } } ], "responses": { "200": { - "description": "Success. The response describes the list of Spring Cloud Gateway route configs.", + "description": "Success. The response describes the updated Deployment.", "schema": { - "$ref": "#/definitions/GatewayRouteConfigResourceCollection" + "$ref": "#/definitions/DeploymentResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting Deployment is now updating and contains a Location\r\nheader to query the operation result.", + "schema": { + "$ref": "#/definitions/DeploymentResource" } }, "default": { @@ -5501,23 +5598,24 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "GatewayRouteConfigs_List": { - "$ref": "./examples/GatewayRouteConfigs_List.json" + "Deployments_Update": { + "$ref": "./examples/Deployments_Update.json" + }, + "Deployments_Update_CustomContainer": { + "$ref": "./examples/Deployments_Update_CustomContainer.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains/{domainName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments": { "get": { "tags": [ "AppPlatform" ], - "description": "Get the Spring Cloud Gateway custom domain.", - "operationId": "GatewayCustomDomains_Get", + "description": "Handles requests to list all resources in an App.", + "operationId": "Deployments_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5532,17 +5630,26 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GatewayNameParameter" + "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/GatewayCustomDomainParameter" + "name": "version", + "in": "query", + "description": "Version of the deployments to be listed", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "uniqueItems": false } ], "responses": { "200": { - "description": "Success. The response describes the corresponding Spring Cloud Gateway custom domain.", + "description": "Success. The response describes the list of Deployments in the App.", "schema": { - "$ref": "#/definitions/GatewayCustomDomainResource" + "$ref": "#/definitions/DeploymentResourceCollection" } }, "default": { @@ -5552,18 +5659,23 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "GatewayCustomDomains_Get": { - "$ref": "./examples/GatewayCustomDomains_Get.json" + "Deployments_List": { + "$ref": "./examples/Deployments_List.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/deployments": { + "get": { "tags": [ "AppPlatform" ], - "description": "Create or update the Spring Cloud Gateway custom domain.", - "operationId": "GatewayCustomDomains_CreateOrUpdate", + "description": "List deployments for a certain service", + "operationId": "Deployments_ListForCluster", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5578,32 +5690,30 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GatewayNameParameter" - }, - { - "$ref": "#/parameters/GatewayCustomDomainParameter" + "name": "version", + "in": "query", + "description": "Version of the deployments to be listed", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "uniqueItems": false }, { - "name": "gatewayCustomDomainResource", - "in": "body", - "description": "The gateway custom domain resource for the create or update operation", - "required": true, - "schema": { - "$ref": "#/definitions/GatewayCustomDomainResource" - } + "name": "$expand", + "in": "query", + "description": "The expand expression to apply on the operation.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "Success. The response describes the updated Spring Cloud Gateway custom domain.", - "schema": { - "$ref": "#/definitions/GatewayCustomDomainResource" - } - }, - "201": { - "description": "Created. The response describes the new created Spring Cloud Gateway custom domain and contains an Azure-AsyncOperation header to query the operation result.", + "description": "Success", "schema": { - "$ref": "#/definitions/GatewayCustomDomainResource" + "$ref": "#/definitions/DeploymentResourceCollection" } }, "default": { @@ -5613,19 +5723,23 @@ } } }, - "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "GatewayCustomDomains_CreateOrUpdate": { - "$ref": "./examples/GatewayCustomDomains_CreateOrUpdate.json" + "Deployments_ListForCluster": { + "$ref": "./examples/Deployments_ListForCluster.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}/builders/{builderName}/listUsingDeployments": { + "post": { "tags": [ "AppPlatform" ], - "description": "Delete the Spring Cloud Gateway custom domain.", - "operationId": "GatewayCustomDomains_Delete", + "description": "List deployments that are using the builder.", + "operationId": "BuildServiceBuilder_ListDeployments", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5640,21 +5754,18 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GatewayNameParameter" + "$ref": "#/parameters/BuildServiceNameParameter" }, { - "$ref": "#/parameters/GatewayCustomDomainParameter" + "$ref": "#/parameters/BuilderNameParameter" } ], "responses": { "200": { - "description": "Success. The response indicates the Spring Cloud Gateway custom domain has deleted." - }, - "202": { - "description": "Accepted. The response indicates the Spring Cloud Gateway custom domain is now deleting." - }, - "204": { - "description": "Success. The response indicates the Spring Cloud Gateway custom domain doesn't exist or has deleted." + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentList" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -5663,21 +5774,20 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "GatewayCustomDomains_Delete": { - "$ref": "./examples/GatewayCustomDomains_Delete.json" + "BuildServiceBuilder_ListDeployments": { + "$ref": "./examples/BuildServiceBuilder_ListDeployments.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/start": { + "post": { "tags": [ "AppPlatform" ], - "description": "Handle requests to list all Spring Cloud Gateway custom domains.", - "operationId": "GatewayCustomDomains_List", + "description": "Start the deployment.", + "operationId": "Deployments_Start", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5692,15 +5802,18 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GatewayNameParameter" + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the list of Spring Cloud Gateway custom domains.", - "schema": { - "$ref": "#/definitions/GatewayCustomDomainResourceCollection" - } + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates the Deployment is now starting and contains a Location header to\r\nquery the operation result." }, "default": { "description": "Error response describing why the operation failed.", @@ -5709,23 +5822,21 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "GatewayCustomDomains_List": { - "$ref": "./examples/GatewayCustomDomains_List.json" + "Deployments_Start": { + "$ref": "./examples/Deployments_Start.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/validateDomain": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/stop": { "post": { "tags": [ "AppPlatform" ], - "description": "Check the domains are valid as well as not in use.", - "operationId": "Gateways_ValidateDomain", + "description": "Stop the deployment.", + "operationId": "Deployments_Stop", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5740,24 +5851,18 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GatewayNameParameter" + "$ref": "#/parameters/AppNameParameter" }, { - "name": "validatePayload", - "in": "body", - "description": "Custom domain payload to be validated", - "required": true, - "schema": { - "$ref": "#/definitions/CustomDomainValidatePayload" - } + "$ref": "#/parameters/DeploymentNameParameter" } ], "responses": { "200": { - "description": "Success. The response describe the name is available.", - "schema": { - "$ref": "#/definitions/CustomDomainValidateResult" - } + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates the Deployment is now stopping and contains a Location header to\r\nquery the operation result." }, "default": { "description": "Error response describing why the operation failed.", @@ -5766,20 +5871,21 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "Gateways_ValidateDomain": { - "$ref": "./examples/Gateways_ValidateDomain.json" + "Deployments_Stop": { + "$ref": "./examples/Deployments_Stop.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/restart": { + "post": { "tags": [ "AppPlatform" ], - "description": "Get the API portal and its properties.", - "operationId": "ApiPortals_Get", + "description": "Restart the deployment.", + "operationId": "Deployments_Restart", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5794,15 +5900,18 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiPortalNameParameter" + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the corresponding API portal.", - "schema": { - "$ref": "#/definitions/ApiPortalResource" - } + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates the Deployment is now restarting and contains a Location header\r\nto query the operation result." }, "default": { "description": "Error response describing why the operation failed.", @@ -5811,18 +5920,21 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "ApiPortals_Get": { - "$ref": "./examples/ApiPortals_Get.json" + "Deployments_Restart": { + "$ref": "./examples/Deployments_Restart.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/enableRemoteDebugging": { + "post": { "tags": [ "AppPlatform" ], - "description": "Create the default API portal or update the existing API portal.", - "operationId": "ApiPortals_CreateOrUpdate", + "description": "Enable remote debugging.", + "operationId": "Deployments_EnableRemoteDebugging", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5837,29 +5949,32 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiPortalNameParameter" + "$ref": "#/parameters/AppNameParameter" }, { - "name": "apiPortalResource", - "in": "body", - "description": "The API portal for the create or update operation", - "required": true, + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "remoteDebuggingPayload", + "in": "body", + "description": "Parameters for enable remote debugging", + "required": false, "schema": { - "$ref": "#/definitions/ApiPortalResource" + "$ref": "#/definitions/RemoteDebuggingPayload" } } ], "responses": { "200": { - "description": "Success. The response describes the updated API portal.", + "description": "Success.", "schema": { - "$ref": "#/definitions/ApiPortalResource" + "$ref": "#/definitions/RemoteDebugging" } }, - "201": { - "description": "Created. The response describes the new created API portal and contains an Azure-AsyncOperation header to query the operation result.", + "202": { + "description": "Accepted. The response indicates the RemoteDebugging is now enabling and contains a Location header to query the operation result.", "schema": { - "$ref": "#/definitions/ApiPortalResource" + "$ref": "#/definitions/RemoteDebugging" } }, "default": { @@ -5871,17 +5986,19 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "ApiPortals_CreateOrUpdate": { - "$ref": "./examples/ApiPortals_CreateOrUpdate.json" + "Deployments_EnableRemoteDebugging": { + "$ref": "./examples/Deployments_EnableRemoteDebugging.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/disableRemoteDebugging": { + "post": { "tags": [ "AppPlatform" ], - "description": "Delete the default API portal.", - "operationId": "ApiPortals_Delete", + "description": "Disable remote debugging.", + "operationId": "Deployments_DisableRemoteDebugging", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5896,18 +6013,24 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiPortalNameParameter" + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" } ], "responses": { "200": { - "description": "Success. The response indicates the default API portal has deleted." + "description": "Success.", + "schema": { + "$ref": "#/definitions/RemoteDebugging" + } }, "202": { - "description": "Accepted. The response indicates the default API portal is now deleting." - }, - "204": { - "description": "Success. The response indicates the default API portal doesn't exist or has deleted." + "description": "Accepted. The response indicates the RemoteDebugging is now disabling and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/RemoteDebugging" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -5918,19 +6041,19 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "ApiPortals_Delete": { - "$ref": "./examples/ApiPortals_Delete.json" + "Deployments_DisableRemoteDebugging": { + "$ref": "./examples/Deployments_DisableRemoteDebugging.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/getRemoteDebuggingConfig": { + "post": { "tags": [ "AppPlatform" ], - "description": "Handles requests to list all resources in a Service.", - "operationId": "ApiPortals_List", + "description": "Get remote debugging config.", + "operationId": "Deployments_GetRemoteDebuggingConfig", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5943,13 +6066,19 @@ }, { "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the list of API portals in the Service.", + "description": "Success.", "schema": { - "$ref": "#/definitions/ApiPortalResourceCollection" + "$ref": "#/definitions/RemoteDebugging" } }, "default": { @@ -5959,23 +6088,20 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "ApiPortals_List": { - "$ref": "./examples/ApiPortals_List.json" + "Deployments_GetRemoteDebuggingConfig": { + "$ref": "./examples/Deployments_GetRemoteDebuggingConfig.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains/{domainName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/getLogFileUrl": { + "post": { "tags": [ "AppPlatform" ], - "description": "Get the API portal custom domain.", - "operationId": "ApiPortalCustomDomains_Get", + "description": "Get deployment log file URL", + "operationId": "Deployments_GetLogFileUrl", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -5990,19 +6116,22 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiPortalNameParameter" + "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/ApiPortalCustomDomainParameter" + "$ref": "#/parameters/DeploymentNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the corresponding API portal custom domain.", + "description": "Success. The response contains the log file URL.", "schema": { - "$ref": "#/definitions/ApiPortalCustomDomainResource" + "$ref": "#/definitions/LogFileUrlResponse" } }, + "204": { + "description": "Success. The deployment does not have log file." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -6011,17 +6140,19 @@ } }, "x-ms-examples": { - "ApiPortalCustomDomains_Get": { - "$ref": "./examples/ApiPortalCustomDomains_Get.json" + "Deployments_GetLogFileUrl": { + "$ref": "./examples/Deployments_GetLogFileUrl.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/generateHeapDump": { + "post": { "tags": [ "AppPlatform" ], - "description": "Create or update the API portal custom domain.", - "operationId": "ApiPortalCustomDomains_CreateOrUpdate", + "description": "Generate Heap Dump", + "operationId": "Deployments_GenerateHeapDump", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -6036,33 +6167,27 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiPortalNameParameter" + "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/ApiPortalCustomDomainParameter" + "$ref": "#/parameters/DeploymentNameParameter" }, { - "name": "apiPortalCustomDomainResource", + "name": "diagnosticParameters", "in": "body", - "description": "The API portal custom domain for the create or update operation", + "description": "Parameters for the diagnostic operation", "required": true, "schema": { - "$ref": "#/definitions/ApiPortalCustomDomainResource" + "$ref": "#/definitions/DiagnosticParameters" } } ], "responses": { "200": { - "description": "Success. The response describes the updated Spring Cloud Gateway route configs.", - "schema": { - "$ref": "#/definitions/ApiPortalCustomDomainResource" - } + "description": "Success. A heap dump was generated." }, - "201": { - "description": "Created. The response describes the new created Spring Cloud Gateway custom domain and contains an Azure-AsyncOperation header to query the operation result.", - "schema": { - "$ref": "#/definitions/ApiPortalCustomDomainResource" - } + "202": { + "description": "Accepted. The response indicates a heap dump is generating." }, "default": { "description": "Error response describing why the operation failed.", @@ -6073,17 +6198,19 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "ApiPortalCustomDomains_CreateOrUpdate": { - "$ref": "./examples/ApiPortalCustomDomains_CreateOrUpdate.json" + "Deployments_GenerateHeapDump": { + "$ref": "./examples/Deployments_GenerateHeapDump.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/generateThreadDump": { + "post": { "tags": [ "AppPlatform" ], - "description": "Delete the API portal custom domain.", - "operationId": "ApiPortalCustomDomains_Delete", + "description": "Generate Thread Dump", + "operationId": "Deployments_GenerateThreadDump", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -6098,21 +6225,27 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiPortalNameParameter" + "$ref": "#/parameters/AppNameParameter" }, { - "$ref": "#/parameters/ApiPortalCustomDomainParameter" + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "diagnosticParameters", + "in": "body", + "description": "Parameters for the diagnostic operation", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticParameters" + } } ], "responses": { "200": { - "description": "Success. The response indicates the API portal custom domain has deleted." + "description": "Success. A thread dump was generated." }, "202": { - "description": "Accepted. The response indicates the API portal custom domain is now deleting." - }, - "204": { - "description": "Success. The response indicates the API portal custom domain doesn't exist or has deleted." + "description": "Accepted. The response indicates a thread dump is generating." }, "default": { "description": "Error response describing why the operation failed.", @@ -6123,19 +6256,19 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "ApiPortalCustomDomains_Delete": { - "$ref": "./examples/ApiPortalCustomDomains_Delete.json" + "Deployments_GenerateHeapDump": { + "$ref": "./examples/Deployments_GenerateThreadDump.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}/startJFR": { + "post": { "tags": [ "AppPlatform" ], - "description": "Handle requests to list all API portal custom domains.", - "operationId": "ApiPortalCustomDomains_List", + "description": "Start JFR", + "operationId": "Deployments_StartJFR", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -6150,15 +6283,27 @@ "$ref": "#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiPortalNameParameter" + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "diagnosticParameters", + "in": "body", + "description": "Parameters for the diagnostic operation", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticParameters" + } } ], "responses": { "200": { - "description": "Success. The response describes the list of API portal custom domains.", - "schema": { - "$ref": "#/definitions/ApiPortalCustomDomainResourceCollection" - } + "description": "Success. A JFR generated." + }, + "202": { + "description": "Accepted. The response indicates a JFR is starting." }, "default": { "description": "Error response describing why the operation failed.", @@ -6167,54 +6312,34 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "ApiPortalCustomDomains_List": { - "$ref": "./examples/ApiPortalCustomDomains_List.json" + "Deployments_StartJFR": { + "$ref": "./examples/Deployments_StartJFR.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/validateDomain": { - "post": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/Spring": { + "get": { "tags": [ "AppPlatform" ], - "description": "Check the domains are valid as well as not in use.", - "operationId": "ApiPortals_ValidateDomain", + "description": "Handles requests to list all resources in a subscription.", + "operationId": "Services_ListBySubscription", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiPortalNameParameter" - }, - { - "name": "validatePayload", - "in": "body", - "description": "Custom domain payload to be validated", - "required": true, - "schema": { - "$ref": "#/definitions/CustomDomainValidatePayload" - } } ], "responses": { "200": { - "description": "Success. The response describe the name is available.", + "description": "Success. The response describes the list of Services in the subscription.", "schema": { - "$ref": "#/definitions/CustomDomainValidateResult" + "$ref": "#/definitions/ServiceResourceList" } }, "default": { @@ -6224,283 +6349,3931 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "ApiPortals_ValidateDomain": { - "$ref": "./examples/ApiPortals_ValidateDomain.json" + "Services_ListBySubscription": { + "$ref": "./examples/Services_ListBySubscription.json" } } } - } - }, - "definitions": { - "ServiceResource": { - "description": "Service resource", - "type": "object", - "allOf": [ + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in a resource group.", + "operationId": "Services_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Services in the resource group.", + "schema": { + "$ref": "#/definitions/ServiceResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Services_List": { + "$ref": "./examples/Services_List.json" + } + } + } + }, + "/providers/Microsoft.AppPlatform/operations": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Lists all of the available REST API operations of the Microsoft.AppPlatform provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/AvailableOperations" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/providers/Microsoft.AppPlatform/runtimeVersions": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Lists all of the available runtime versions supported by Microsoft.AppPlatform provider.", + "operationId": "RuntimeVersions_ListRuntimeVersions", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the details of all supported deployment runtime versions.", + "schema": { + "$ref": "#/definitions/AvailableRuntimeVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "RuntimeVersions_ListRuntimeVersions": { + "$ref": "./examples/RuntimeVersions_ListRuntimeVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/skus": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Lists all of the available skus of the Microsoft.AppPlatform provider.", + "operationId": "Skus_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ResourceSkuCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Skus_List": { + "$ref": "./examples/Skus_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/supportedServerVersions": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Lists all of the available server versions supported by Microsoft.AppPlatform provider.", + "operationId": "Services_ListSupportedServerVersions", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the supported server versions.", + "schema": { + "$ref": "#/definitions/SupportedServerVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Services_ListSupportedServerVersions": { + "$ref": "./examples/Services_ListSupportedServerVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the Spring Cloud Gateway and its properties.", + "operationId": "Gateways_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Spring Cloud Gateway.", + "schema": { + "$ref": "#/definitions/GatewayResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gateways_Get": { + "$ref": "./examples/Gateways_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.", + "operationId": "Gateways_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "name": "gatewayResource", + "in": "body", + "description": "The gateway for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Spring Cloud Gateway.", + "schema": { + "$ref": "#/definitions/GatewayResource" + } + }, + "201": { + "description": "Created. The response describes the new created Spring Cloud Gateway and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/GatewayResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Gateways_CreateOrUpdate": { + "$ref": "./examples/Gateways_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Disable the default Spring Cloud Gateway.", + "operationId": "Gateways_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the default Spring Cloud Gateway has deleted." + }, + "202": { + "description": "Accepted. The response indicates the default Spring Cloud Gateway is now deleting." + }, + "204": { + "description": "Success. The response indicates the default Spring Cloud Gateway doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Gateways_Delete": { + "$ref": "./examples/Gateways_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/listEnvSecrets": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "List sensitive environment variables of Spring Cloud Gateway.", + "operationId": "Gateways_ListEnvSecrets", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the sensitive environment variables of Spring Cloud Gateway.", + "schema": { + "$ref": "#/definitions/GatewayEnvSecrets" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gateways_ListEnvSecrets": { + "$ref": "./examples/Gateways_ListEnvSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/restart": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Restart the Spring Cloud Gateway.", + "operationId": "Gateways_Restart", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates gateway is now restarting and contains a Location header\r\nto query the operation result.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Gateways_Restart": { + "$ref": "./examples/Gateways_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in a Service.", + "operationId": "Gateways_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of gateways in the Service.", + "schema": { + "$ref": "#/definitions/GatewayResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gateways_List": { + "$ref": "./examples/Gateways_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs/{routeConfigName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the Spring Cloud Gateway route configs.", + "operationId": "GatewayRouteConfigs_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "$ref": "#/parameters/GatewayRouteConfigNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Spring Cloud Gateway route configs.", + "schema": { + "$ref": "#/definitions/GatewayRouteConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GatewayRouteConfigs_Get": { + "$ref": "./examples/GatewayRouteConfigs_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create the default Spring Cloud Gateway route configs or update the existing Spring Cloud Gateway route configs.", + "operationId": "GatewayRouteConfigs_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "$ref": "#/parameters/GatewayRouteConfigNameParameter" + }, + { + "name": "gatewayRouteConfigResource", + "in": "body", + "description": "The Spring Cloud Gateway route config for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayRouteConfigResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Spring Cloud Gateway route configs.", + "schema": { + "$ref": "#/definitions/GatewayRouteConfigResource" + } + }, + "201": { + "description": "Created. The response describes the new created Spring Cloud Gateway route configs and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/GatewayRouteConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GatewayRouteConfigs_CreateOrUpdate": { + "$ref": "./examples/GatewayRouteConfigs_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the Spring Cloud Gateway route config.", + "operationId": "GatewayRouteConfigs_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "$ref": "#/parameters/GatewayRouteConfigNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the Spring Cloud Gateway route config has deleted." + }, + "202": { + "description": "Accepted. The response indicates the Spring Cloud Gateway route config is now deleting." + }, + "204": { + "description": "Success. The response indicates the Spring Cloud Gateway route config doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GatewayRouteConfigs_Delete": { + "$ref": "./examples/GatewayRouteConfigs_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handle requests to list all Spring Cloud Gateway route configs.", + "operationId": "GatewayRouteConfigs_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Spring Cloud Gateway route configs.", + "schema": { + "$ref": "#/definitions/GatewayRouteConfigResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GatewayRouteConfigs_List": { + "$ref": "./examples/GatewayRouteConfigs_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains/{domainName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the Spring Cloud Gateway custom domain.", + "operationId": "GatewayCustomDomains_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "$ref": "#/parameters/GatewayCustomDomainParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Spring Cloud Gateway custom domain.", + "schema": { + "$ref": "#/definitions/GatewayCustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GatewayCustomDomains_Get": { + "$ref": "./examples/GatewayCustomDomains_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update the Spring Cloud Gateway custom domain.", + "operationId": "GatewayCustomDomains_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "$ref": "#/parameters/GatewayCustomDomainParameter" + }, + { + "name": "gatewayCustomDomainResource", + "in": "body", + "description": "The gateway custom domain resource for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayCustomDomainResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Spring Cloud Gateway custom domain.", + "schema": { + "$ref": "#/definitions/GatewayCustomDomainResource" + } + }, + "201": { + "description": "Created. The response describes the new created Spring Cloud Gateway custom domain and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/GatewayCustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GatewayCustomDomains_CreateOrUpdate": { + "$ref": "./examples/GatewayCustomDomains_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the Spring Cloud Gateway custom domain.", + "operationId": "GatewayCustomDomains_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "$ref": "#/parameters/GatewayCustomDomainParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the Spring Cloud Gateway custom domain has deleted." + }, + "202": { + "description": "Accepted. The response indicates the Spring Cloud Gateway custom domain is now deleting." + }, + "204": { + "description": "Success. The response indicates the Spring Cloud Gateway custom domain doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GatewayCustomDomains_Delete": { + "$ref": "./examples/GatewayCustomDomains_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handle requests to list all Spring Cloud Gateway custom domains.", + "operationId": "GatewayCustomDomains_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of Spring Cloud Gateway custom domains.", + "schema": { + "$ref": "#/definitions/GatewayCustomDomainResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GatewayCustomDomains_List": { + "$ref": "./examples/GatewayCustomDomains_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/validateDomain": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Check the domains are valid as well as not in use.", + "operationId": "Gateways_ValidateDomain", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GatewayNameParameter" + }, + { + "name": "validatePayload", + "in": "body", + "description": "Custom domain payload to be validated", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainValidatePayload" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describe the name is available.", + "schema": { + "$ref": "#/definitions/CustomDomainValidateResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gateways_ValidateDomain": { + "$ref": "./examples/Gateways_ValidateDomain.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the API portal and its properties.", + "operationId": "ApiPortals_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding API portal.", + "schema": { + "$ref": "#/definitions/ApiPortalResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApiPortals_Get": { + "$ref": "./examples/ApiPortals_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create the default API portal or update the existing API portal.", + "operationId": "ApiPortals_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + }, + { + "name": "apiPortalResource", + "in": "body", + "description": "The API portal for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ApiPortalResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated API portal.", + "schema": { + "$ref": "#/definitions/ApiPortalResource" + } + }, + "201": { + "description": "Created. The response describes the new created API portal and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ApiPortalResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApiPortals_CreateOrUpdate": { + "$ref": "./examples/ApiPortals_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the default API portal.", + "operationId": "ApiPortals_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the default API portal has deleted." + }, + "202": { + "description": "Accepted. The response indicates the default API portal is now deleting." + }, + "204": { + "description": "Success. The response indicates the default API portal doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApiPortals_Delete": { + "$ref": "./examples/ApiPortals_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handles requests to list all resources in a Service.", + "operationId": "ApiPortals_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of API portals in the Service.", + "schema": { + "$ref": "#/definitions/ApiPortalResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ApiPortals_List": { + "$ref": "./examples/ApiPortals_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains/{domainName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the API portal custom domain.", + "operationId": "ApiPortalCustomDomains_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalCustomDomainParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding API portal custom domain.", + "schema": { + "$ref": "#/definitions/ApiPortalCustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApiPortalCustomDomains_Get": { + "$ref": "./examples/ApiPortalCustomDomains_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update the API portal custom domain.", + "operationId": "ApiPortalCustomDomains_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalCustomDomainParameter" + }, + { + "name": "apiPortalCustomDomainResource", + "in": "body", + "description": "The API portal custom domain for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ApiPortalCustomDomainResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated Spring Cloud Gateway route configs.", + "schema": { + "$ref": "#/definitions/ApiPortalCustomDomainResource" + } + }, + "201": { + "description": "Created. The response describes the new created Spring Cloud Gateway custom domain and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ApiPortalCustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApiPortalCustomDomains_CreateOrUpdate": { + "$ref": "./examples/ApiPortalCustomDomains_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the API portal custom domain.", + "operationId": "ApiPortalCustomDomains_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalCustomDomainParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the API portal custom domain has deleted." + }, + "202": { + "description": "Accepted. The response indicates the API portal custom domain is now deleting." + }, + "204": { + "description": "Success. The response indicates the API portal custom domain doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApiPortalCustomDomains_Delete": { + "$ref": "./examples/ApiPortalCustomDomains_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/domains": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handle requests to list all API portal custom domains.", + "operationId": "ApiPortalCustomDomains_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of API portal custom domains.", + "schema": { + "$ref": "#/definitions/ApiPortalCustomDomainResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ApiPortalCustomDomains_List": { + "$ref": "./examples/ApiPortalCustomDomains_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}/validateDomain": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Check the domains are valid as well as not in use.", + "operationId": "ApiPortals_ValidateDomain", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiPortalNameParameter" + }, + { + "name": "validatePayload", + "in": "body", + "description": "Custom domain payload to be validated", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainValidatePayload" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describe the name is available.", + "schema": { + "$ref": "#/definitions/CustomDomainValidateResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApiPortals_ValidateDomain": { + "$ref": "./examples/ApiPortals_ValidateDomain.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handle requests to list all application accelerator.", + "operationId": "ApplicationAccelerators_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of application accelerator.", + "schema": { + "$ref": "#/definitions/ApplicationAcceleratorResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ApplicationAccelerators_List": { + "$ref": "./examples/ApplicationAccelerators_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the application accelerator.", + "operationId": "ApplicationAccelerators_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding application accelerator.", + "schema": { + "$ref": "#/definitions/ApplicationAcceleratorResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApplicationAccelerators_Get": { + "$ref": "./examples/ApplicationAccelerators_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update the application accelerator.", + "operationId": "ApplicationAccelerators_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "name": "applicationAcceleratorResource", + "in": "body", + "description": "The application accelerator for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationAcceleratorResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated application accelerator.", + "schema": { + "$ref": "#/definitions/ApplicationAcceleratorResource" + } + }, + "201": { + "description": "Created. The response describes the new created application accelerator and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/ApplicationAcceleratorResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApplicationAccelerators_CreateOrUpdate": { + "$ref": "./examples/ApplicationAccelerators_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the application accelerator.", + "operationId": "ApplicationAccelerators_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the application accelerator is now deleting.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the application accelerator doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ApplicationAccelerators_Delete": { + "$ref": "./examples/ApplicationAccelerators_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/customizedAccelerators": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handle requests to list all customized accelerators.", + "operationId": "CustomizedAccelerators_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of customized accelerators.", + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CustomizedAccelerators_List": { + "$ref": "./examples/CustomizedAccelerators_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/customizedAccelerators/{customizedAcceleratorName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the customized accelerator.", + "operationId": "CustomizedAccelerators_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/CustomizedAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding customized accelerator.", + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CustomizedAccelerators_Get": { + "$ref": "./examples/CustomizedAccelerators_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update the customized accelerator.", + "operationId": "CustomizedAccelerators_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/CustomizedAcceleratorNameParameter" + }, + { + "name": "customizedAcceleratorResource", + "in": "body", + "description": "The customized accelerator for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorResource" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes the updated customized accelerator.", + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorResource" + } + }, + "201": { + "description": "Created. The response describes the new created customized accelerator and contains an Azure-AsyncOperation header to query the operation result.", + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CustomizedAccelerators_CreateOrUpdate": { + "$ref": "./examples/CustomizedAccelerators_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the customized accelerator.", + "operationId": "CustomizedAccelerators_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/CustomizedAcceleratorNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the customized accelerator is now deleting.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the customized accelerator doesn't exist or has deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CustomizedAccelerators_Delete": { + "$ref": "./examples/CustomizedAccelerators_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/customizedAccelerators/{customizedAcceleratorName}/validate": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Check the customized accelerator are valid.", + "operationId": "CustomizedAccelerators_Validate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/CustomizedAcceleratorNameParameter" + }, + { + "name": "properties", + "in": "body", + "description": "Customized accelerator properties to be validated", + "required": true, + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorProperties" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describe the customized accelerator is valid.", + "schema": { + "$ref": "#/definitions/CustomizedAcceleratorValidateResult" + } + }, + "202": { + "description": "Accepted. The response indicates the CustomizedAccelerator is validating.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CustomizedAccelerators_Validate": { + "$ref": "./examples/CustomizedAccelerators_Validate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/predefinedAccelerators": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Handle requests to list all predefined accelerators.", + "operationId": "PredefinedAccelerators_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of predefined accelerators.", + "schema": { + "$ref": "#/definitions/PredefinedAcceleratorResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PredefinedAccelerators_List": { + "$ref": "./examples/PredefinedAccelerators_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/predefinedAccelerators/{predefinedAcceleratorName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the predefined accelerator.", + "operationId": "PredefinedAccelerators_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/PredefinedAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding predefined accelerator.", + "schema": { + "$ref": "#/definitions/PredefinedAcceleratorResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PredefinedAccelerators_Get": { + "$ref": "./examples/PredefinedAccelerators_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/predefinedAccelerators/{predefinedAcceleratorName}/disable": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Disable predefined accelerator.", + "operationId": "PredefinedAccelerators_Disable", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/PredefinedAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates the PredefinedAccelerator is now disabling and contains a Location header to query the operation result.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PredefinedAccelerators_Disable": { + "$ref": "./examples/PredefinedAccelerators_Disable.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/applicationAccelerators/{applicationAcceleratorName}/predefinedAccelerators/{predefinedAcceleratorName}/enable": { + "post": { + "tags": [ + "AppPlatform" + ], + "description": "Enable predefined accelerator.", + "operationId": "PredefinedAccelerators_Enable", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApplicationAcceleratorNameParameter" + }, + { + "$ref": "#/parameters/PredefinedAcceleratorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "202": { + "description": "Accepted. The response indicates the PredefinedAccelerator is now enabling and contains a Location header to query the operation result.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PredefinedAccelerators_Enable": { + "$ref": "./examples/PredefinedAccelerators_Enable.json" + } + } + } + } + }, + "definitions": { + "ServiceResource": { + "description": "Service resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ClusterResourceProperties", + "description": "Properties of the Service resource", + "x-ms-client-flatten": false + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the Service resource" + } + } + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The GEO location of the resource.", + "type": "string" + }, + "tags": { + "description": "Tags of the service which is a list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Resource": { + "description": "The core properties of ARM resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "x-ms-azure-resource": true + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "properties": { + "createdBy": { + "description": "The identity that created the resource.", + "type": "string" + }, + "createdByType": { + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC).", + "type": "string" + }, + "lastModifiedBy": { + "description": "The identity that last modified the resource.", + "type": "string" + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "name": "lastModifiedByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of resource modification (UTC).", + "type": "string" + } + }, + "readOnly": true + }, + "ClusterResourceProperties": { + "description": "Service properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Service", + "enum": [ + "Creating", + "Updating", + "Starting", + "Stopping", + "Deleting", + "Deleted", + "Succeeded", + "Failed", + "Moving", + "Moved", + "MoveFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Network profile of the Service" + }, + "vnetAddons": { + "$ref": "#/definitions/ServiceVNetAddons", + "description": "Additional Service settings in vnet injection instance" + }, + "version": { + "format": "int32", + "description": "Version of the Service", + "type": "integer", + "readOnly": true + }, + "serviceId": { + "description": "ServiceInstanceEntity Id which uniquely identifies a created resource", + "type": "string", + "readOnly": true + }, + "powerState": { + "description": "Power state of the Service", + "enum": [ + "Running", + "Stopped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PowerState", + "modelAsString": true + } + }, + "zoneRedundant": { + "type": "boolean", + "default": false, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "fqdn": { + "description": "Fully qualified dns name of the service instance", + "type": "string", + "readOnly": true + }, + "marketplaceResource": { + "$ref": "#/definitions/MarketplaceResource", + "description": "Purchasing 3rd party product of the Service resource." + } + } + }, + "ManagedIdentityProperties": { + "description": "Managed identity properties retrieved from ARM request headers.", + "type": "object", + "properties": { + "type": { + "description": "Type of the managed identity", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true + } + }, + "principalId": { + "description": "Principal Id of system-assigned managed identity.", + "type": "string" + }, + "tenantId": { + "description": "Tenant Id of system-assigned managed identity.", + "type": "string" + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedManagedIdentities", + "description": "Properties of user-assigned managed identities" + } + } + }, + "UserAssignedManagedIdentities": { + "description": "User-assigned managed identities in key-value map. The key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedManagedIdentity" + } + }, + "UserAssignedManagedIdentity": { + "description": "The details of the user-assigned managed identity assigned to an App.", + "type": "object", + "properties": { + "principalId": { + "description": "Principal Id of user-assigned managed identity.", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "Client Id of user-assigned managed identity.", + "type": "string", + "readOnly": true + } + } + }, + "BuildServiceCollection": { + "description": "Object that includes an array of Build service resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Build service resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BuildService" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ContainerRegistryResourceCollection": { + "description": "Collection compose of container registry resources list and a possible link for next page.", + "type": "object", + "properties": { + "value": { + "description": "The container registry resources list.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ContainerRegistryResource" + } + }, + "nextLink": { + "description": "The link to next page of storage list.", + "type": "string" + } + } + }, + "ContainerRegistryResource": { + "description": "Container registry resource payload.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ContainerRegistryProperties", + "description": "Properties of the container registry resource payload.", + "x-ms-client-flatten": false + } + } + }, + "ContainerRegistryProperties": { + "description": "Container registry resource payload.", + "type": "object", + "required": [ + "credentials" + ], + "properties": { + "credentials": { + "$ref": "#/definitions/ContainerRegistryCredentials", + "description": "The credentials of the container registry resource." + }, + "provisioningState": { + "description": "State of the Container Registry.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ContainerRegistryProvisioningState", + "modelAsString": true + } + } + } + }, + "ContainerRegistryCredentials": { + "description": "The credential for the container registry resource.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "The credential type of the container registry credentials.", + "type": "string" + } + }, + "discriminator": "type" + }, + "ContainerRegistryBasicCredentials": { + "description": "The basic authentication properties for the container registry resource.", + "type": "object", + "required": [ + "type", + "server", + "username", + "password" + ], + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistryCredentials" + } + ], + "properties": { + "server": { + "description": "The login server of the Container Registry.", + "type": "string" + }, + "username": { + "description": "The username of the Container Registry.", + "type": "string" + }, + "password": { + "description": "The password of the Container Registry.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "x-ms-discriminator-value": "BasicAuth" + }, + "ContainerRegistryValidateResult": { + "description": "Validation result for container registry properties", + "type": "object", + "properties": { + "isValid": { + "description": "Indicate if the container registry properties are valid", + "type": "boolean" + }, + "message": { + "description": "Detailed validation messages.", + "type": "string" + } + } + }, + "BuildService": { + "description": "Build service resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BuildServiceProperties", + "description": "Properties of the build resource", + "x-ms-client-flatten": false + } + } + }, + "BuildServiceProperties": { + "description": "Build service resource properties payload", + "type": "object", + "properties": { + "containerRegistry": { + "description": "The resource id of the container registry used in this build service.", + "type": "string" + }, + "kPackVersion": { + "description": "The installed KPack version in this build service.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the KPack build service", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BuildServiceProvisioningState", + "modelAsString": true + } + }, + "resourceRequests": { + "description": "The runtime resource configuration of this build service.", + "type": "object", + "properties": { + "cpu": { + "description": "vCPU allocated to the entire build service node pool.", + "type": "string", + "readOnly": true + }, + "memory": { + "description": "Memory allocated to the entire build service node pool.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "BuildCollection": { + "description": "Object that includes an array of Build resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Build resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Build" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "Build": { + "description": "Build resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BuildProperties", + "description": "Properties of the build resource", + "x-ms-client-flatten": false + } + } + }, + "BuildProperties": { + "description": "Build resource properties payload", + "type": "object", + "properties": { + "relativePath": { + "description": "The relative path of source code", + "type": "string" + }, + "builder": { + "description": "The resource id of builder to build the source code", + "type": "string" + }, + "agentPool": { + "description": "The resource id of agent pool", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state of the KPack build result", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BuildProvisioningState", + "modelAsString": true + } + }, + "env": { + "description": "The environment variables for this build", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "apms": { + "$ref": "#/definitions/ApmReferenceCollection", + "description": "The APMs for this build" + }, + "certificates": { + "$ref": "#/definitions/CertificateReferenceCollection", + "description": "The CA Certificates for this build" + }, + "triggeredBuildResult": { + "$ref": "#/definitions/TriggeredBuildResult", + "description": " The build result triggered by this build" + }, + "resourceRequests": { + "$ref": "#/definitions/BuildResourceRequests", + "description": "The customized build resource for this build" + } + } + }, + "BuildResourceRequests": { + "description": "Resource request payload of Build Resource.", + "type": "object", + "properties": { + "cpu": { + "description": "Optional Cpu allocated to the build resource. 1 core can be represented by 1 or 1000m. \r\nThe default value is 1, this should not exceed build service agent pool cpu size.", + "type": "string", + "default": "1" + }, + "memory": { + "description": "Optional Memory allocated to the build resource. 1 GB can be represented by 1Gi or 1024Mi. \r\nThe default value is 2Gi, this should not exceed build service agent pool memory size.", + "type": "string", + "default": "2Gi" + } + } + }, + "TriggeredBuildResult": { + "description": "The build result triggered by a build", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "description": "The unique build id of this build result", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning state of this build result", + "enum": [ + "Queuing", + "Building", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TriggeredBuildResultProvisioningState", + "modelAsString": true + } + }, + "image": { + "description": "The container image of this build result", + "type": "string" + }, + "lastTransitionTime": { + "format": "date-time", + "description": "The last transition time of this build result", + "type": "string" + }, + "lastTransitionReason": { + "description": "The last transition reason of this build result", + "type": "string" + }, + "lastTransitionStatus": { + "description": "The last transition status of this build result", + "type": "string" + } + } + }, + "BuildResultCollection": { + "description": "Object that includes an array of Build result resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Build result resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BuildResult" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "BuildResult": { + "description": "Build result resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BuildResultProperties", + "description": "Properties of the build result resource", + "x-ms-client-flatten": false + } + } + }, + "BuildResultProperties": { + "description": "Build result resource properties payload", + "type": "object", + "properties": { + "name": { + "description": "The name of this build result", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state of the KPack build result", + "enum": [ + "Queuing", + "Building", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BuildResultProvisioningState", + "modelAsString": true + } + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Error when build is failed." + }, + "buildPodName": { + "description": "The build pod name which can be used to get the build log streaming.", + "type": "string" + }, + "buildStages": { + "description": "All of the build stage (init-container and container) resources in build pod.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BuildStageProperties" + }, + "readOnly": true + }, + "image": { + "description": "The container registry image of this build result.", + "type": "string", + "readOnly": true + } + } + }, + "BuildStageProperties": { + "description": "The build stage (init-container and container) resources in build pod.", + "type": "object", + "properties": { + "name": { + "description": "The name of this build stage resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The provisioning state of this build stage resource.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "KPackBuildStageProvisioningState", + "modelAsString": true + } + }, + "exitCode": { + "description": "The exit code of this build init container.", + "type": "string", + "readOnly": true + }, + "reason": { + "description": "The reason of this build init container.", + "type": "string", + "readOnly": true + } + } + }, + "BuildResultLog": { + "description": "Build result log resource properties payload", + "type": "object", + "properties": { + "blobUrl": { + "description": "The public download URL of this build result log", + "type": "string" + } + } + }, + "BuilderResourceCollection": { + "description": "Object that includes an array of Builder resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Builder resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BuilderResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "BuilderResource": { + "description": "KPack Builder resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BuilderProperties", + "description": "Property of the Builder resource." + } + } + }, + "BuilderProperties": { + "description": "KPack Builder properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "Builder provision status.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BuilderProvisioningState", + "modelAsString": true + } + }, + "stack": { + "description": "Builder cluster stack property.", + "type": "object", + "$ref": "#/definitions/StackProperties" + }, + "buildpackGroups": { + "description": "Builder buildpack groups.", + "type": "array", + "items": { + "$ref": "#/definitions/BuildpacksGroupProperties" + } + } + } + }, + "StackProperties": { + "description": "KPack ClusterStack properties payload", + "type": "object", + "properties": { + "id": { + "description": "Id of the ClusterStack.", + "type": "string" + }, + "version": { + "description": "Version of the ClusterStack", + "type": "string" + } + } + }, + "BuildpacksGroupProperties": { + "description": "Buildpack group properties of the Builder", + "type": "object", + "properties": { + "name": { + "description": "Buildpack group name", + "type": "string" + }, + "buildpacks": { + "description": "Buildpacks in the buildpack group", + "type": "array", + "uniqueItems": false, + "items": { + "$ref": "#/definitions/BuildpackProperties" + } + } + } + }, + "BuildpackProperties": { + "description": "Buildpack properties payload", + "type": "object", + "properties": { + "id": { + "description": "Id of the buildpack", + "type": "string" + } + } + }, + "SupportedBuildpacksCollection": { + "description": "Object that includes an array of supported buildpacks resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of supported buildpacks resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SupportedBuildpackResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SupportedBuildpackResource": { + "description": "Supported buildpack resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SupportedBuildpackResourceProperties" + } + } + }, + "SupportedBuildpackResourceProperties": { + "description": "Supported buildpack resource properties", + "type": "object", + "properties": { + "buildpackId": { + "description": "The id of supported buildpack", + "type": "string" + } + } + }, + "SupportedStacksCollection": { + "description": "Object that includes an array of supported stacks resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of supported stacks resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SupportedStackResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SupportedStackResource": { + "description": "Supported stack resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SupportedStackResourceProperties" + } + } + }, + "SupportedStackResourceProperties": { + "description": "Supported stack resource properties", + "type": "object", + "properties": { + "stackId": { + "description": "The id of supported stack", + "type": "string" + }, + "version": { + "description": "The version of supported stack", + "type": "string" + } + } + }, + "BuildServiceAgentPoolResourceCollection": { + "description": "Object that includes an array of build service agent pool resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of build service agent pool resource", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BuildServiceAgentPoolResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "BuildServiceAgentPoolResource": { + "description": "The build service agent pool resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "build service agent pool properties", + "type": "object", + "$ref": "#/definitions/BuildServiceAgentPoolProperties" + } + } + }, + "BuildServiceAgentPoolProperties": { + "description": "Build service agent pool properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the build service agent pool", + "type": "string", + "readOnly": true + }, + "poolSize": { + "description": "build service agent pool size properties", + "type": "object", + "$ref": "#/definitions/BuildServiceAgentPoolSizeProperties" + } + } + }, + "BuildServiceAgentPoolSizeProperties": { + "description": "Build service agent pool size properties", + "type": "object", + "properties": { + "name": { + "description": "The name of build service agent pool size", + "type": "string" + }, + "cpu": { + "description": "The cpu property of build service agent pool size", + "type": "string", + "readOnly": true + }, + "memory": { + "description": "The memory property of build service agent pool size", + "type": "string", + "readOnly": true + } + } + }, + "ConfigurationServiceResourceCollection": { + "description": "Object that includes an array of configuration service resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of configuration service resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationServiceResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ConfigurationServiceResource": { + "description": "Application Configuration Service resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationServiceProperties" + } + } + }, + "ConfigurationServiceProperties": { + "description": "Application Configuration Service properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the Application Configuration Service.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ConfigurationServiceProvisioningState", + "modelAsString": true + } + }, + "generation": { + "description": "The generation of the Application Configuration Service.", + "enum": [ + "Gen1", + "Gen2" + ], + "type": "string", + "default": "Gen1", + "x-ms-enum": { + "name": "ConfigurationServiceGeneration", + "modelAsString": true + } + }, + "resourceRequests": { + "$ref": "#/definitions/ConfigurationServiceResourceRequests", + "description": "The requested resource quantity for required CPU and Memory." + }, + "instances": { + "description": "Collection of instances belong to Application Configuration Service.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationServiceInstance" + }, + "readOnly": true + }, + "settings": { + "$ref": "#/definitions/ConfigurationServiceSettings" + } + } + }, + "ConfigurationServiceResourceRequests": { + "description": "Resource request payload of Application Configuration Service", + "type": "object", + "readOnly": true, + "properties": { + "cpu": { + "description": "Cpu allocated to each Application Configuration Service instance", + "type": "string", + "readOnly": true + }, + "memory": { + "description": "Memory allocated to each Application Configuration Service instance", + "type": "string", + "readOnly": true + }, + "instanceCount": { + "format": "int32", + "description": "Instance count of the Application Configuration Service", + "type": "integer", + "readOnly": true + } + } + }, + "ConfigurationServiceSettings": { + "description": "The settings of Application Configuration Service.", + "type": "object", + "properties": { + "gitProperty": { + "$ref": "#/definitions/ConfigurationServiceGitProperty" + } + } + }, + "ConfigurationServiceGitProperty": { + "description": "Property of git environment.", + "type": "object", + "properties": { + "repositories": { + "$ref": "#/definitions/ConfigurationServiceGitPropertyRepository" + } + } + }, + "ConfigurationServiceGitPropertyRepository": { + "description": "Repositories of Application Configuration Service git property.", + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationServiceGitRepository" + } + }, + "ConfigurationServiceSettingsValidateResult": { + "description": "Validation result for configuration service settings", + "type": "object", + "properties": { + "gitPropertyValidationResult": { + "$ref": "#/definitions/ConfigurationServiceGitPropertyValidateResult" + } + } + }, + "ConfigurationServiceGitPropertyValidateResult": { + "description": "Validation result for configuration service settings", + "type": "object", + "properties": { + "isValid": { + "description": "Indicate if the configuration service settings are valid", + "type": "boolean" + }, + "gitReposValidationResult": { + "description": "The detail validation results", + "type": "array", + "items": { + "$ref": "#/definitions/ValidationMessages" + } + } + } + }, + "ValidationMessages": { + "description": "Validate messages of the configuration service git repositories", + "type": "object", + "properties": { + "name": { + "description": "The name of the configuration service git repository.", + "type": "string" + }, + "messages": { + "description": "Detailed validation messages.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ConfigurationServiceInstance": { + "description": "Collection of instances belong to the Application Configuration Service", + "type": "object", + "properties": { + "name": { + "description": "Name of the Application Configuration Service instance", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the Application Configuration Service instance", + "type": "string", + "readOnly": true + } + } + }, + "ConfigurationServiceGitRepository": { + "description": "Git repository property payload for Application Configuration Service", + "required": [ + "name", + "patterns", + "uri", + "label" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the repository", + "type": "string" + }, + "patterns": { + "description": "Collection of patterns of the repository", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "uri": { + "description": "URI of the repository", + "type": "string" + }, + "label": { + "description": "Label of the repository", + "type": "string" + }, + "searchPaths": { + "description": "Searching path of the repository", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "username": { + "description": "Username of git repository basic auth.", + "type": "string" + }, + "password": { + "description": "Password of git repository basic auth.", + "type": "string" + }, + "hostKey": { + "description": "Public sshKey of git repository.", + "type": "string" + }, + "hostKeyAlgorithm": { + "description": "SshKey algorithm of git repository.", + "type": "string" + }, + "privateKey": { + "description": "Private sshKey algorithm of git repository.", + "type": "string" + }, + "strictHostKeyChecking": { + "description": "Strict host key checking or not.", + "type": "boolean" + }, + "gitImplementation": { + "description": "Git libraries used to support various repository providers", + "$ref": "#/definitions/GitImplementation" + }, + "caCertResourceId": { + "description": "Resource Id of CA certificate for https URL of Git repository.", + "type": "string" + } + } + }, + "GitImplementation": { + "description": "Git libraries used to support various repository providers", + "enum": [ + "go-git", + "libgit2" + ], + "type": "string", + "x-ms-enum": { + "name": "GitImplementation", + "modelAsString": true + } + }, + "ApplicationLiveViewResourceCollection": { + "description": "Object that includes an array of Application Live View resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Application Live View resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationLiveViewResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ApplicationLiveViewResource": { + "description": "Application Live View resource", + "type": "object", + "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "#/definitions/ProxyResource" } ], "properties": { "properties": { - "$ref": "#/definitions/ClusterResourceProperties", - "description": "Properties of the Service resource", - "x-ms-client-flatten": false + "$ref": "#/definitions/ApplicationLiveViewProperties" + } + } + }, + "ApplicationLiveViewProperties": { + "description": "Application Live View properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the Application Live View.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ApplicationLiveViewProvisioningState", + "modelAsString": true + } }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "Sku of the Service resource" + "components": { + "uniqueItems": false, + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ApplicationLiveViewComponent" + }, + "readOnly": true, + "description": "Component details of Application Live View" } } }, - "TrackedResource": { - "description": "The resource model definition for a ARM tracked top level resource.", + "ApplicationLiveViewComponent": { + "description": "Application Live View properties payload", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], "properties": { - "location": { - "description": "The GEO location of the resource.", - "type": "string" + "name": { + "description": "Name of the component.", + "readOnly": true }, - "tags": { - "description": "Tags of the service which is a list of key value pairs that describe the resource.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "resourceRequests": { + "$ref": "#/definitions/ApplicationLiveViewResourceRequests", + "description": "The requested resource quantity for required CPU and Memory.", + "readOnly": true + }, + "instances": { + "description": "Collection of instances belong to Application Live View.", + "uniqueItems": false, + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ApplicationLiveViewInstance" + }, + "readOnly": true } } }, - "Resource": { - "description": "The core properties of ARM resources.", + "ApplicationLiveViewResourceRequests": { + "description": "The resource quantity for required CPU and Memory of Application Live View component", "type": "object", + "readOnly": true, "properties": { - "id": { - "description": "Fully qualified resource Id for the resource.", + "cpu": { + "description": "Cpu quantity allocated to each Application Live View component instance. 1 core can be represented by 1 or 1000m.", "type": "string", "readOnly": true }, - "name": { - "description": "The name of the resource.", + "memory": { + "description": "Memory quantity allocated to each Application Live View component instance. 1 GB can be represented by 1Gi or 1024Mi.", "type": "string", "readOnly": true }, - "type": { - "description": "The type of the resource.", + "instanceCount": { + "description": "Desired instance count of Application Live View component instance.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "ApplicationLiveViewInstance": { + "description": "Collection of instances belong to the Application Live View", + "type": "object", + "properties": { + "name": { + "description": "Name of the Application Live View instance.", "type": "string", "readOnly": true }, - "systemData": { - "$ref": "#/definitions/SystemData" + "status": { + "description": "Status of the Application Live View instance. It can be Pending, Running, Succeeded, Failed, Unknown.", + "type": "string", + "readOnly": true } - }, - "x-ms-azure-resource": true + } }, - "SystemData": { - "description": "Metadata pertaining to creation and last modification of the resource.", + "DevToolPortalResourceCollection": { + "description": "Object that includes an array of Dev Tool Portal resources and a possible link for next set", "type": "object", "properties": { - "createdBy": { - "description": "The identity that created the resource.", - "type": "string" + "value": { + "description": "Collection of Dev Tool Portal resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/DevToolPortalResource" + } }, - "createdByType": { - "description": "The type of identity that created the resource.", + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "DevToolPortalResource": { + "description": "Dev Tool Portal resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DevToolPortalProperties" + } + } + }, + "DevToolPortalProperties": { + "description": "Dev Tool Portal properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the Dev Tool Portal.", "enum": [ - "User", - "Application", - "ManagedIdentity", - "Key" + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Canceled" ], "type": "string", + "readOnly": true, "x-ms-enum": { - "name": "createdByType", + "name": "DevToolPortalProvisioningState", "modelAsString": true } }, - "createdAt": { - "format": "date-time", - "description": "The timestamp of resource creation (UTC).", + "components": { + "description": "Collection of components belong to Dev Tool Portal.", + "uniqueItems": false, + "type": "array", + "x-ms-identifiers": [ + "name" + ], + "items": { + "$ref": "#/definitions/DevToolPortalComponent" + }, + "readOnly": true + }, + "public": { + "description": "Indicates whether the resource exposes public endpoint", + "type": "boolean", + "default": false + }, + "url": { + "description": "URL of the resource, exposed when 'public' is true.", + "type": "string", + "readOnly": true + }, + "ssoProperties": { + "$ref": "#/definitions/DevToolPortalSsoProperties", + "description": "Single sign-on related configuration" + }, + "features": { + "$ref": "#/definitions/DevToolPortalFeatureSettings", + "description": "Settings for Dev Tool Portal" + } + } + }, + "DevToolPortalComponent": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true + }, + "resourceRequests": { + "$ref": "#/definitions/DevToolPortalResourceRequests", + "description": "The requested resource quantity for required CPU and Memory." + }, + "instances": { + "description": "Collection of instances belong to Dev Tool Portal.", + "uniqueItems": false, + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/DevToolPortalInstance" + }, + "readOnly": true + } + } + }, + "DevToolPortalSsoProperties": { + "description": "Single sign-on related configuration", + "type": "object", + "properties": { + "scopes": { + "description": "It defines the specific actions applications can be allowed to do on a user's behalf", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "clientId": { + "description": "The public identifier for the application", "type": "string" }, - "lastModifiedBy": { - "description": "The identity that last modified the resource.", + "clientSecret": { + "description": "The secret known only to the application and the authorization server", + "x-ms-secret": true, "type": "string" }, - "lastModifiedByType": { - "description": "The type of identity that last modified the resource.", + "metadataUrl": { + "description": "The URI of a JSON file with generic OIDC provider configuration.", + "type": "string" + } + } + }, + "DevToolPortalFeatureSettings": { + "description": "Settings for Dev Tool Portal", + "type": "object", + "properties": { + "applicationAccelerator": { + "$ref": "#/definitions/DevToolPortalFeatureDetail", + "description": "Detail of Accelerator plugin" + }, + "applicationLiveView": { + "$ref": "#/definitions/DevToolPortalFeatureDetail", + "description": "Detail of App Live View plugin" + } + } + }, + "DevToolPortalFeatureDetail": { + "description": "Detail settings for Dev Tool Portal feature", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "State of the plugin", + "default": "Enabled", "enum": [ - "User", - "Application", - "ManagedIdentity", - "Key" + "Enabled", + "Disabled" ], - "type": "string", "x-ms-enum": { - "name": "lastModifiedByType", - "modelAsString": true + "modelAsString": true, + "name": "DevToolPortalFeatureState", + "values": [ + { + "description": "Enable the plugin in Dev Tool Portal.", + "value": "Enabled" + }, + { + "description": "Disable the plugin in Dev Tool Portal.", + "value": "Disabled" + } + ] } }, - "lastModifiedAt": { - "format": "date-time", - "description": "The timestamp of resource modification (UTC).", + "route": { + "type": "string", + "description": "Route path to visit the plugin", + "readOnly": true + } + } + }, + "DevToolPortalResourceRequests": { + "description": "The resource quantity for required CPU and Memory of Dev Tool Portal", + "type": "object", + "readOnly": true, + "properties": { + "cpu": { + "description": "Cpu quantity allocated to each Dev Tool Portal instance. 1 core can be represented by 1 or 1000m", + "type": "string", + "readOnly": true + }, + "memory": { + "description": "Memory quantity allocated to each Dev Tool Portal instance. 1 GB can be represented by 1Gi or 1024Mi.", + "type": "string", + "readOnly": true + }, + "instanceCount": { + "description": "Desired instance count of Dev Tool Portal.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "DevToolPortalInstance": { + "description": "Collection of instances belong to the Dev Tool Portal.", + "type": "object", + "properties": { + "name": { + "description": "Name of the Dev Tool Portal instance.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the Dev Tool Portal instance. It can be Pending, Running, Succeeded, Failed, Unknown.", + "type": "string", + "readOnly": true + } + } + }, + "ServiceRegistryResourceCollection": { + "description": "Object that includes an array of Service Registry resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of Service Registry resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ServiceRegistryResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", "type": "string" } - }, - "readOnly": true + } + }, + "ServiceRegistryResource": { + "description": "Service Registry resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServiceRegistryProperties" + } + } }, - "ClusterResourceProperties": { - "description": "Service properties payload", + "ServiceRegistryProperties": { + "description": "Service Registry properties payload", "type": "object", "properties": { "provisioningState": { - "description": "Provisioning state of the Service", + "description": "State of the Service Registry.", "enum": [ "Creating", "Updating", - "Starting", - "Stopping", - "Deleting", - "Deleted", "Succeeded", "Failed", - "Moving", - "Moved", - "MoveFailed" + "Deleting" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "ProvisioningState", + "name": "ServiceRegistryProvisioningState", "modelAsString": true } }, - "networkProfile": { - "$ref": "#/definitions/NetworkProfile", - "description": "Network profile of the Service" - }, - "vnetAddons": { - "$ref": "#/definitions/ServiceVNetAddons", - "description": "Additional Service settings in vnet injection instance" + "resourceRequests": { + "$ref": "#/definitions/ServiceRegistryResourceRequests", + "description": "The requested resource quantity for required CPU and Memory." }, - "version": { - "format": "int32", - "description": "Version of the Service", - "type": "integer", + "instances": { + "description": "Collection of instances belong to Service Registry.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ServiceRegistryInstance" + }, "readOnly": true - }, - "serviceId": { - "description": "ServiceInstanceEntity Id which uniquely identifies a created resource", + } + } + }, + "ServiceRegistryResourceRequests": { + "description": "Resource request payload of Service Registry", + "type": "object", + "readOnly": true, + "properties": { + "cpu": { + "description": "Cpu allocated to each Service Registry instance", "type": "string", "readOnly": true }, - "powerState": { - "description": "Power state of the Service", - "enum": [ - "Running", - "Stopped" - ], + "memory": { + "description": "Memory allocated to each Service Registry instance", "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "PowerState", - "modelAsString": true - } + "readOnly": true }, - "zoneRedundant": { - "type": "boolean", - "default": false, - "x-ms-mutability": [ - "create", - "read" - ] + "instanceCount": { + "format": "int32", + "description": "Instance count of the Service Registry", + "type": "integer", + "readOnly": true + } + } + }, + "ServiceRegistryInstance": { + "description": "Collection of instances belong to the Service Registry", + "type": "object", + "properties": { + "name": { + "description": "Name of the Service Registry instance", + "type": "string", + "readOnly": true }, - "fqdn": { - "description": "Fully qualified dns name of the service instance", + "status": { + "description": "Status of the Service Registry instance", "type": "string", "readOnly": true } } }, - "ManagedIdentityProperties": { - "description": "Managed identity properties retrieved from ARM request headers.", + "Sku": { + "description": "Sku of Azure Spring Apps", "type": "object", "properties": { - "type": { - "description": "Type of the managed identity", - "enum": [ - "None", - "SystemAssigned", - "UserAssigned", - "SystemAssigned,UserAssigned" - ], + "name": { + "description": "Name of the Sku", "type": "string", - "x-ms-enum": { - "name": "ManagedIdentityType", - "modelAsString": true - } - }, - "principalId": { - "description": "Principal Id of system-assigned managed identity.", - "type": "string" + "default": "S0" }, - "tenantId": { - "description": "Tenant Id of system-assigned managed identity.", - "type": "string" + "tier": { + "description": "Tier of the Sku", + "type": "string", + "default": "Standard" }, - "userAssignedIdentities": { - "$ref": "#/definitions/UserAssignedManagedIdentities", - "description": "Properties of user-assigned managed identities" + "capacity": { + "format": "int32", + "description": "Current capacity of the target resource", + "type": "integer" } } }, - "UserAssignedManagedIdentities": { - "description": "User-assigned managed identities in key-value map. The key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "MarketplaceResource": { + "description": "Purchasing 3rd Party product for one Azure Spring Apps instance", "type": "object", - "additionalProperties": { - "$ref": "#/definitions/UserAssignedManagedIdentity" + "properties": { + "plan": { + "description": "The plan id of the 3rd Party Artifact that is being procured.", + "type": "string" + }, + "publisher": { + "description": "The publisher id of the 3rd Party Artifact that is being bought.", + "type": "string" + }, + "product": { + "description": "The 3rd Party artifact that is being procured.", + "type": "string" + } } }, - "UserAssignedManagedIdentity": { - "description": "The details of the user-assigned managed identity assigned to an App.", + "ConfigServerSettingsValidateResult": { + "description": "Validation result for config server settings", "type": "object", "properties": { - "principalId": { - "description": "Principal Id of user-assigned managed identity.", - "type": "string", - "readOnly": true + "isValid": { + "description": "Indicate if the config server settings are valid", + "type": "boolean" }, - "clientId": { - "description": "Client Id of user-assigned managed identity.", - "type": "string", - "readOnly": true + "details": { + "description": "The detail validation results", + "type": "array", + "items": { + "$ref": "#/definitions/ConfigServerSettingsErrorRecord" + } } } }, - "BuildServiceCollection": { - "description": "Object that includes an array of Build service resources and a possible link for next set", + "ConfigServerSettingsErrorRecord": { + "description": "Error record of the config server settings", "type": "object", "properties": { - "value": { - "description": "Collection of Build service resources", - "uniqueItems": false, + "name": { + "description": "The name of the config server settings error record", + "type": "string" + }, + "uri": { + "description": "The uri of the config server settings error record", + "type": "string" + }, + "messages": { + "description": "The detail error messages of the record", "type": "array", "items": { - "$ref": "#/definitions/BuildService" + "type": "string" } - }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" } } }, - "BuildService": { - "description": "Build service resource payload", + "ConfigServerResource": { + "description": "Config Server resource", "type": "object", "allOf": [ { @@ -6509,74 +10282,44 @@ ], "properties": { "properties": { - "$ref": "#/definitions/BuildServiceProperties", - "description": "Properties of the build resource", + "$ref": "#/definitions/ConfigServerProperties", + "description": "Properties of the Config Server resource", "x-ms-client-flatten": false } } }, - "BuildServiceProperties": { - "description": "Build service resource properties payload", + "ConfigServerProperties": { + "description": "Config server git properties payload", "type": "object", "properties": { - "kPackVersion": { - "description": "The installed KPack version in this build service.", - "type": "string" - }, "provisioningState": { - "description": "Provisioning state of the KPack build result", + "description": "State of the config server.", "enum": [ - "Creating", - "Updating", - "Succeeded", + "NotAvailable", + "Deleted", "Failed", - "Deleting" + "Succeeded", + "Updating" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "BuildServiceProvisioningState", + "name": "ConfigServerState", "modelAsString": true } }, - "resourceRequests": { - "description": "The runtime resource configuration of this build service.", - "type": "object", - "properties": { - "cpu": { - "description": "vCPU allocated to the entire build service node pool.", - "type": "string", - "readOnly": true - }, - "memory": { - "description": "Memory allocated to the entire build service node pool.", - "type": "string", - "readOnly": true - } - } - } - } - }, - "BuildCollection": { - "description": "Object that includes an array of Build resources and a possible link for next set", - "type": "object", - "properties": { - "value": { - "description": "Collection of Build resources", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Build" - } - }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" + "error": { + "$ref": "#/definitions/Error", + "description": "Error when apply config server settings." + }, + "configServer": { + "$ref": "#/definitions/ConfigServerSettings", + "description": "Settings of config server." } } }, - "Build": { - "description": "Build resource payload", + "MonitoringSettingResource": { + "description": "Monitoring Setting resource", "type": "object", "allOf": [ { @@ -6585,414 +10328,413 @@ ], "properties": { "properties": { - "$ref": "#/definitions/BuildProperties", - "description": "Properties of the build resource", + "$ref": "#/definitions/MonitoringSettingProperties", + "description": "Properties of the Monitoring Setting resource", "x-ms-client-flatten": false } } }, - "BuildProperties": { - "description": "Build resource properties payload", + "MonitoringSettingProperties": { + "description": "Monitoring Setting properties payload", "type": "object", "properties": { - "relativePath": { - "description": "The relative path of source code", - "type": "string" - }, - "builder": { - "description": "The resource id of builder to build the source code", - "type": "string" - }, - "agentPool": { - "description": "The resource id of agent pool", - "type": "string" - }, "provisioningState": { - "description": "Provisioning state of the KPack build result", + "description": "State of the Monitoring Setting.", "enum": [ - "Creating", - "Updating", - "Succeeded", + "NotAvailable", "Failed", - "Deleting" + "Succeeded", + "Updating" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "BuildProvisioningState", + "name": "MonitoringSettingState", "modelAsString": true } }, - "env": { - "description": "The environment variables for this build", - "type": "object", - "additionalProperties": { - "type": "string" - } + "error": { + "$ref": "#/definitions/Error", + "description": "Error when apply Monitoring Setting changes." }, - "triggeredBuildResult": { - "$ref": "#/definitions/TriggeredBuildResult", - "description": " The build result triggered by this build" + "traceEnabled": { + "description": "Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not", + "type": "boolean" }, - "resourceRequests": { - "$ref": "#/definitions/BuildResourceRequests", - "description": "The customized build resource for this build" - } - } - }, - "BuildResourceRequests": { - "description": "Resource request payload of Build Resource.", - "type": "object", - "properties": { - "cpu": { - "description": "Optional Cpu allocated to the build resource. 1 core can be represented by 1 or 1000m. \r\nThe default value is 1, this should not exceed build service agent pool cpu size.", - "type": "string", - "default": "1" + "appInsightsInstrumentationKey": { + "description": "Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings", + "type": "string" }, - "memory": { - "description": "Optional Memory allocated to the build resource. 1 GB can be represented by 1Gi or 1024Mi. \r\nThe default value is 2Gi, this should not exceed build service agent pool memory size.", - "type": "string", - "default": "2Gi" + "appInsightsSamplingRate": { + "description": "Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]", + "format": "double", + "maximum": 100.0, + "minimum": 0.0, + "type": "number" + }, + "appInsightsAgentVersions": { + "$ref": "#/definitions/applicationInsightsAgentVersions", + "description": "Indicates the versions of application insight agent" } } }, - "TriggeredBuildResult": { - "description": "The build result triggered by a build", + "applicationInsightsAgentVersions": { + "description": "Application Insights agent versions properties payload", "type": "object", - "readOnly": true, "properties": { - "id": { - "description": "The unique build id of this build result", - "type": "string" + "java": { + "description": "Indicates the version of application insight java agent", + "type": "string", + "readOnly": true } } }, - "BuildResultCollection": { - "description": "Object that includes an array of Build result resources and a possible link for next set", + "NetworkProfile": { + "description": "Service network profile payload", "type": "object", "properties": { - "value": { - "description": "Collection of Build result resources", - "uniqueItems": false, + "serviceRuntimeSubnetId": { + "description": "Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "appSubnetId": { + "description": "Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "serviceCidr": { + "description": "Azure Spring Apps service reserved CIDR", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "serviceRuntimeNetworkResourceGroup": { + "description": "Name of the resource group containing network resources of Azure Spring Apps Service Runtime", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "appNetworkResourceGroup": { + "description": "Name of the resource group containing network resources for customer apps in Azure Spring Apps", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "outboundIPs": { + "description": "Desired outbound IP resources for Azure Spring Apps resource.", + "type": "object", + "readOnly": true, + "properties": { + "publicIPs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "A list of public IP addresses." + } + } + }, + "requiredTraffics": { + "description": "Required inbound or outbound traffics for Azure Spring Apps resource.", "type": "array", + "readOnly": true, "items": { - "$ref": "#/definitions/BuildResult" + "$ref": "#/definitions/RequiredTraffic" } }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" - } - } - }, - "BuildResult": { - "description": "Build result resource payload", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BuildResultProperties", - "description": "Properties of the build result resource", - "x-ms-client-flatten": false + "ingressConfig": { + "description": "Ingress configuration payload for Azure Spring Apps resource.", + "$ref": "#/definitions/IngressConfig" + }, + "outboundType": { + "description": "The egress traffic type of Azure Spring Apps VNet instances.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] } } }, - "BuildResultProperties": { - "description": "Build result resource properties payload", + "RequiredTraffic": { + "description": "Required inbound or outbound traffic for Azure Spring Apps resource.", "type": "object", "properties": { - "name": { - "description": "The name of this build result", - "type": "string" - }, - "provisioningState": { - "description": "Provisioning state of the KPack build result", - "enum": [ - "Queuing", - "Building", - "Succeeded", - "Failed", - "Deleting" - ], + "protocol": { + "description": "The protocol of required traffic", "type": "string", + "readOnly": true + }, + "port": { + "description": "The port of required traffic", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "ips": { + "description": "The ip list of required traffic", + "type": "array", "readOnly": true, - "x-ms-enum": { - "name": "BuildResultProvisioningState", - "modelAsString": true + "items": { + "type": "string" } }, - "buildPodName": { - "description": "The build pod name which can be used to get the build log streaming.", - "type": "string" - }, - "buildStages": { - "description": "All of the build stage (init-container and container) resources in build pod.", - "uniqueItems": false, + "fqdns": { + "description": "The FQDN list of required traffic", "type": "array", + "readOnly": true, "items": { - "$ref": "#/definitions/BuildStageProperties" - }, - "readOnly": true - } - } - }, - "BuildStageProperties": { - "description": "The build stage (init-container and container) resources in build pod.", - "type": "object", - "properties": { - "name": { - "description": "The name of this build stage resource.", + "type": "string" + } + }, + "direction": { + "description": "The direction of required traffic", "type": "string", - "readOnly": true - }, - "status": { - "description": "The provisioning state of this build stage resource.", + "readOnly": true, "enum": [ - "NotStarted", - "Running", - "Succeeded", - "Failed" + "Inbound", + "Outbound" ], - "type": "string", - "readOnly": true, "x-ms-enum": { - "name": "KPackBuildStageProvisioningState", + "name": "trafficDirection", "modelAsString": true } } } }, - "BuildResultLog": { - "description": "Build result log resource properties payload", + "IngressConfig": { + "description": "Ingress configuration payload for Azure Spring Apps resource.", "type": "object", "properties": { - "blobUrl": { - "description": "The public download URL of this build result log", - "type": "string" + "readTimeoutInSeconds": { + "format": "int32", + "description": "Ingress read time out in seconds.", + "type": "integer" } } }, - "BuilderResourceCollection": { - "description": "Object that includes an array of Builder resources and a possible link for next set", + "Error": { + "description": "The error code compose of code and message.", "type": "object", "properties": { - "value": { - "description": "Collection of Builder resources", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/BuilderResource" - } + "code": { + "description": "The code of error.", + "type": "string" }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "message": { + "description": "The message of error.", "type": "string" } } }, - "BuilderResource": { - "description": "KPack Builder resource", + "ServiceVNetAddons": { + "description": "Additional Service settings in vnet injection instance", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], "properties": { - "properties": { - "$ref": "#/definitions/BuilderProperties", - "description": "Property of the Builder resource." + "logStreamPublicEndpoint": { + "description": "Indicates whether the log stream in vnet injection instance could be accessed from internet.", + "type": "boolean", + "default": false + }, + "dataPlanePublicEndpoint": { + "description": "Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.", + "type": "boolean", + "default": false } } }, - "BuilderProperties": { - "description": "KPack Builder properties payload", + "ConfigServerSettings": { + "description": "The settings of config server.", "type": "object", "properties": { - "provisioningState": { - "description": "Builder provision status.", - "enum": [ - "Creating", - "Updating", - "Succeeded", - "Failed", - "Deleting" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BuilderProvisioningState", - "modelAsString": true - } - }, - "stack": { - "description": "Builder cluster stack property.", - "type": "object", - "$ref": "#/definitions/StackProperties" - }, - "buildpackGroups": { - "description": "Builder buildpack groups.", - "type": "array", - "items": { - "$ref": "#/definitions/BuildpacksGroupProperties" - } + "gitProperty": { + "$ref": "#/definitions/ConfigServerGitProperty", + "description": "Property of git environment." } } }, - "StackProperties": { - "description": "KPack ClusterStack properties payload", + "ConfigServerGitProperty": { + "description": "Property of git.", + "required": [ + "uri" + ], "type": "object", "properties": { - "id": { - "description": "Id of the ClusterStack.", - "type": "string" + "repositories": { + "description": "Repositories of git.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GitPatternRepository" + } }, - "version": { - "description": "Version of the ClusterStack", + "uri": { + "description": "URI of the repository", "type": "string" - } - } - }, - "BuildpacksGroupProperties": { - "description": "Buildpack group properties of the Builder", - "type": "object", - "properties": { - "name": { - "description": "Buildpack group name", + }, + "label": { + "description": "Label of the repository", "type": "string" }, - "buildpacks": { - "description": "Buildpacks in the buildpack group", - "type": "array", + "searchPaths": { + "description": "Searching path of the repository", "uniqueItems": false, + "type": "array", "items": { - "$ref": "#/definitions/BuildpackProperties" + "type": "string" } - } - } - }, - "BuildpackProperties": { - "description": "Buildpack properties payload", - "type": "object", - "properties": { - "id": { - "description": "Id of the buildpack", + }, + "username": { + "description": "Username of git repository basic auth.", + "type": "string" + }, + "password": { + "description": "Password of git repository basic auth.", + "type": "string" + }, + "hostKey": { + "description": "Public sshKey of git repository.", + "type": "string" + }, + "hostKeyAlgorithm": { + "description": "SshKey algorithm of git repository.", + "type": "string" + }, + "privateKey": { + "description": "Private sshKey algorithm of git repository.", "type": "string" + }, + "strictHostKeyChecking": { + "description": "Strict host key checking or not.", + "type": "boolean" } } }, - "SupportedBuildpacksCollection": { - "description": "Object that includes an array of supported buildpacks resources and a possible link for next set", + "GitPatternRepository": { + "description": "Git repository property payload for config server", + "required": [ + "name", + "uri" + ], "type": "object", "properties": { - "value": { - "description": "Collection of supported buildpacks resources", + "name": { + "description": "Name of the repository", + "type": "string" + }, + "pattern": { + "description": "Collection of pattern of the repository", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/SupportedBuildpackResource" + "type": "string" } }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "uri": { + "description": "URI of the repository", "type": "string" - } - } - }, - "SupportedBuildpackResource": { - "description": "Supported buildpack resource payload", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SupportedBuildpackResourceProperties" - } - } - }, - "SupportedBuildpackResourceProperties": { - "description": "Supported buildpack resource properties", - "type": "object", - "properties": { - "buildpackId": { - "description": "The id of supported buildpack", + }, + "label": { + "description": "Label of the repository", "type": "string" - } - } - }, - "SupportedStacksCollection": { - "description": "Object that includes an array of supported stacks resources and a possible link for next set", - "type": "object", - "properties": { - "value": { - "description": "Collection of supported stacks resources", + }, + "searchPaths": { + "description": "Searching path of the repository", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/SupportedStackResource" + "type": "string" } }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "username": { + "description": "Username of git repository basic auth.", "type": "string" + }, + "password": { + "description": "Password of git repository basic auth.", + "type": "string" + }, + "hostKey": { + "description": "Public sshKey of git repository.", + "type": "string" + }, + "hostKeyAlgorithm": { + "description": "SshKey algorithm of git repository.", + "type": "string" + }, + "privateKey": { + "description": "Private sshKey algorithm of git repository.", + "type": "string" + }, + "strictHostKeyChecking": { + "description": "Strict host key checking or not.", + "type": "boolean" } } }, - "SupportedStackResource": { - "description": "Supported stack resource payload", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SupportedStackResourceProperties" - } - } - }, - "SupportedStackResourceProperties": { - "description": "Supported stack resource properties", + "TestKeys": { + "description": "Test keys payload", "type": "object", "properties": { - "stackId": { - "description": "The id of supported stack", + "primaryKey": { + "description": "Primary key", "type": "string" }, - "version": { - "description": "The version of supported stack", + "secondaryKey": { + "description": "Secondary key", + "type": "string" + }, + "primaryTestEndpoint": { + "description": "Primary test endpoint", + "type": "string" + }, + "secondaryTestEndpoint": { + "description": "Secondary test endpoint", "type": "string" + }, + "enabled": { + "description": "Indicates whether the test endpoint feature enabled or not", + "type": "boolean" } } }, - "BuildServiceAgentPoolResourceCollection": { - "description": "Object that includes an array of build service agent pool resources and a possible link for next set", + "RegenerateTestKeyRequestPayload": { + "description": "Regenerate test key request payload", + "required": [ + "keyType" + ], "type": "object", "properties": { - "value": { - "description": "Collection of build service agent pool resource", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/BuildServiceAgentPoolResource" + "keyType": { + "description": "Type of the test key", + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "TestKeyType", + "modelAsString": true } - }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" } } }, - "BuildServiceAgentPoolResource": { - "description": "The build service agent pool resource", + "AppResource": { + "description": "App resource payload", "type": "object", "allOf": [ { @@ -7001,202 +10743,275 @@ ], "properties": { "properties": { - "description": "build service agent pool properties", - "type": "object", - "$ref": "#/definitions/BuildServiceAgentPoolProperties" - } - } - }, - "BuildServiceAgentPoolProperties": { - "description": "Build service agent pool properties", - "type": "object", - "properties": { - "provisioningState": { - "description": "Provisioning state of the build service agent pool", - "type": "string", - "readOnly": true - }, - "poolSize": { - "description": "build service agent pool size properties", - "type": "object", - "$ref": "#/definitions/BuildServiceAgentPoolSizeProperties" - } - } - }, - "BuildServiceAgentPoolSizeProperties": { - "description": "Build service agent pool size properties", - "type": "object", - "properties": { - "name": { - "description": "The name of build service agent pool size", - "type": "string" - }, - "cpu": { - "description": "The cpu property of build service agent pool size", - "type": "string", - "readOnly": true + "$ref": "#/definitions/AppResourceProperties", + "description": "Properties of the App resource", + "x-ms-client-flatten": false }, - "memory": { - "description": "The memory property of build service agent pool size", - "type": "string", - "readOnly": true - } - } - }, - "ConfigurationServiceResourceCollection": { - "description": "Object that includes an array of configuration service resources and a possible link for next set", - "type": "object", - "properties": { - "value": { - "description": "Collection of configuration service resources", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ConfigurationServiceResource" - } + "identity": { + "$ref": "#/definitions/ManagedIdentityProperties", + "description": "The Managed Identity type of the app resource" }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "location": { + "description": "The GEO location of the application, always the same with its parent resource", "type": "string" } } }, - "ConfigurationServiceResource": { - "description": "Application Configuration Service resource", + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/ConfigurationServiceProperties" - } - } + "properties": {} }, - "ConfigurationServiceProperties": { - "description": "Application Configuration Service properties payload", + "AppResourceProperties": { + "description": "App resource properties payload", "type": "object", "properties": { + "public": { + "description": "Indicates whether the App exposes public endpoint", + "type": "boolean" + }, + "url": { + "description": "URL of the App", + "type": "string", + "readOnly": true + }, + "addonConfigs": { + "description": "Collection of addons", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, "provisioningState": { - "description": "State of the Application Configuration Service.", + "description": "Provisioning state of the App", "enum": [ - "Creating", - "Updating", "Succeeded", "Failed", + "Creating", + "Updating", "Deleting" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "ConfigurationServiceProvisioningState", + "name": "AppResourceProvisioningState", "modelAsString": true } }, - "resourceRequests": { - "$ref": "#/definitions/ConfigurationServiceResourceRequests", - "description": "The requested resource quantity for required CPU and Memory." - }, - "instances": { - "description": "Collection of instances belong to Application Configuration Service.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ConfigurationServiceInstance" - }, + "fqdn": { + "description": "Fully qualified dns Name.", + "type": "string", "readOnly": true }, - "settings": { - "$ref": "#/definitions/ConfigurationServiceSettings" + "httpsOnly": { + "description": "Indicate if only https is allowed.", + "type": "boolean", + "default": false + }, + "temporaryDisk": { + "$ref": "#/definitions/TemporaryDisk", + "description": "Temporary disk settings" + }, + "persistentDisk": { + "$ref": "#/definitions/PersistentDisk", + "description": "Persistent disk settings" + }, + "customPersistentDisks": { + "$ref": "#/definitions/CustomPersistentDiskCollection", + "description": "List of custom persistent disks" + }, + "enableEndToEndTLS": { + "description": "Indicate if end to end TLS is enabled.", + "type": "boolean", + "default": false + }, + "loadedCertificates": { + "description": "Collection of loaded certificates", + "$ref": "#/definitions/LoadedCertificateCollection" + }, + "vnetAddons": { + "description": "Additional App settings in vnet injection instance", + "$ref": "#/definitions/AppVNetAddons" + }, + "ingressSettings": { + "description": "App ingress settings payload.", + "$ref": "#/definitions/IngressSettings" } } }, - "ConfigurationServiceResourceRequests": { - "description": "Resource request payload of Application Configuration Service", + "TemporaryDisk": { + "description": "Temporary disk payload", "type": "object", - "readOnly": true, "properties": { - "cpu": { - "description": "Cpu allocated to each Application Configuration Service instance", - "type": "string", - "readOnly": true + "sizeInGB": { + "format": "int32", + "description": "Size of the temporary disk in GB", + "maximum": 5.0, + "minimum": 0.0, + "type": "integer" }, - "memory": { - "description": "Memory allocated to each Application Configuration Service instance", + "mountPath": { + "description": "Mount path of the temporary disk", "type": "string", - "readOnly": true + "default": "/tmp" + } + } + }, + "PersistentDisk": { + "description": "Persistent disk payload", + "type": "object", + "properties": { + "sizeInGB": { + "format": "int32", + "description": "Size of the persistent disk in GB", + "maximum": 50.0, + "minimum": 0.0, + "type": "integer" }, - "instanceCount": { + "usedInGB": { "format": "int32", - "description": "Instance count of the Application Configuration Service", + "description": "Size of the used persistent disk in GB", + "maximum": 50.0, + "minimum": 0.0, "type": "integer", "readOnly": true + }, + "mountPath": { + "description": "Mount path of the persistent disk", + "type": "string" } } }, - "ConfigurationServiceSettings": { - "description": "The settings of Application Configuration Service.", - "type": "object", - "properties": { - "gitProperty": { - "$ref": "#/definitions/ConfigurationServiceGitProperty" - } - } - }, - "ConfigurationServiceGitProperty": { - "description": "Property of git environment.", + "LoadedCertificate": { + "description": "Loaded certificate payload", + "required": [ + "resourceId" + ], "type": "object", "properties": { - "repositories": { - "$ref": "#/definitions/ConfigurationServiceGitPropertyRepository" + "resourceId": { + "description": "Resource Id of loaded certificate", + "type": "string" + }, + "loadTrustStore": { + "description": "Indicate whether the certificate will be loaded into default trust store, only work for Java runtime.", + "type": "boolean", + "default": false } } }, - "ConfigurationServiceGitPropertyRepository": { - "description": "Repositories of Application Configuration Service git property.", + "LoadedCertificateCollection": { + "description": "Collection of loaded certificate resources list and a possible link for next page.", "type": "array", "items": { - "$ref": "#/definitions/ConfigurationServiceGitRepository" + "$ref": "#/definitions/LoadedCertificate" } }, - "ConfigurationServiceSettingsValidateResult": { - "description": "Validation result for configuration service settings", + "AppVNetAddons": { + "description": "Additional App settings in vnet injection instance", "type": "object", "properties": { - "gitPropertyValidationResult": { - "$ref": "#/definitions/ConfigurationServiceGitPropertyValidateResult" + "publicEndpoint": { + "description": "Indicates whether the App in vnet injection instance exposes endpoint which could be accessed from internet.", + "type": "boolean", + "default": false + }, + "publicEndpointUrl": { + "description": "URL of the App in vnet injection instance which could be accessed from internet", + "type": "string", + "readOnly": true } } }, - "ConfigurationServiceGitPropertyValidateResult": { - "description": "Validation result for configuration service settings", + "IngressSettings": { + "description": "App ingress settings payload.", "type": "object", "properties": { - "isValid": { - "description": "Indicate if the configuration service settings are valid", - "type": "boolean" + "readTimeoutInSeconds": { + "format": "int32", + "description": "Ingress read time out in seconds.", + "type": "integer" }, - "gitReposValidationResult": { - "description": "The detail validation results", + "sendTimeoutInSeconds": { + "format": "int32", + "description": "Ingress send time out in seconds.", + "type": "integer" + }, + "sessionAffinity": { + "description": "Type of the affinity, set this to Cookie to enable session affinity.", + "enum": [ + "Cookie", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "SessionAffinity", + "modelAsString": true + } + }, + "sessionCookieMaxAge": { + "description": "Time in seconds until the cookie expires.", + "format": "int32", + "type": "integer" + }, + "backendProtocol": { + "description": "How ingress should communicate with this app backend service.", + "enum": [ + "GRPC", + "Default" + ], + "type": "string", + "x-ms-enum": { + "name": "BackendProtocol", + "modelAsString": true + } + }, + "clientAuth": { + "description": "Client-Certification Authentication.", + "type": "object", + "properties": { + "certificates": { + "description": "Collection of certificate resource id.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "AppResourceCollection": { + "description": "Object that includes an array of App resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of App resources", + "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/ValidationMessages" + "$ref": "#/definitions/AppResource" } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" } } }, - "ValidationMessages": { - "description": "Validate messages of the configuration service git repositories", + "ActiveDeploymentCollection": { + "description": "Object that includes an array of Deployment resource name and set them as active.", "type": "object", "properties": { - "name": { - "description": "The name of the configuration service git repository.", - "type": "string" - }, - "messages": { - "description": "Detailed validation messages.", + "activeDeploymentNames": { + "description": "Collection of Deployment name.", + "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -7204,96 +11019,92 @@ } } }, - "ConfigurationServiceInstance": { - "description": "Collection of instances belong to the Application Configuration Service", + "ResourceUploadDefinition": { + "description": "Resource upload definition payload", "type": "object", "properties": { - "name": { - "description": "Name of the Application Configuration Service instance", - "type": "string", - "readOnly": true + "relativePath": { + "description": "Source relative path", + "type": "string" }, - "status": { - "description": "Status of the Application Configuration Service instance", - "type": "string", - "readOnly": true + "uploadUrl": { + "description": "Upload URL", + "type": "string" } } }, - "ConfigurationServiceGitRepository": { - "description": "Git repository property payload for Application Configuration Service", - "required": [ - "name", - "patterns", - "uri", - "label" + "BindingResource": { + "description": "Binding resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } ], + "properties": { + "properties": { + "$ref": "#/definitions/BindingResourceProperties", + "description": "Properties of the Binding resource", + "x-ms-client-flatten": false + } + } + }, + "BindingResourceProperties": { + "description": "Binding resource properties payload", "type": "object", "properties": { - "name": { - "description": "Name of the repository", - "type": "string" + "resourceName": { + "description": "The name of the bound resource", + "type": "string", + "readOnly": true }, - "patterns": { - "description": "Collection of patterns of the repository", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } + "resourceType": { + "description": "The standard Azure resource type of the bound resource", + "type": "string", + "readOnly": true }, - "uri": { - "description": "URI of the repository", + "resourceId": { + "description": "The Azure resource id of the bound resource", "type": "string" }, - "label": { - "description": "Label of the repository", + "key": { + "description": "The key of the bound resource", "type": "string" }, - "searchPaths": { - "description": "Searching path of the repository", - "uniqueItems": false, - "type": "array", - "items": { + "bindingParameters": { + "description": "Binding parameters of the Binding resource", + "type": "object", + "additionalProperties": { "type": "string" } }, - "username": { - "description": "Username of git repository basic auth.", - "type": "string" - }, - "password": { - "description": "Password of git repository basic auth.", - "type": "string" - }, - "hostKey": { - "description": "Public sshKey of git repository.", - "type": "string" - }, - "hostKeyAlgorithm": { - "description": "SshKey algorithm of git repository.", - "type": "string" + "generatedProperties": { + "description": "The generated Spring Boot property file for this binding. The secret will be deducted.", + "type": "string", + "readOnly": true }, - "privateKey": { - "description": "Private sshKey algorithm of git repository.", - "type": "string" + "createdAt": { + "description": "Creation time of the Binding resource", + "type": "string", + "readOnly": true }, - "strictHostKeyChecking": { - "description": "Strict host key checking or not.", - "type": "boolean" + "updatedAt": { + "description": "Update time of the Binding resource", + "type": "string", + "readOnly": true } } }, - "ServiceRegistryResourceCollection": { - "description": "Object that includes an array of Service Registry resources and a possible link for next set", + "BindingResourceCollection": { + "description": "Object that includes an array of Binding resources and a possible link for next set", "type": "object", "properties": { "value": { - "description": "Collection of Service Registry resources", + "description": "Collection of Binding resources", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/ServiceRegistryResource" + "$ref": "#/definitions/BindingResource" } }, "nextLink": { @@ -7302,8 +11113,8 @@ } } }, - "ServiceRegistryResource": { - "description": "Service Registry resource", + "CertificateResource": { + "description": "Certificate resource payload.", "type": "object", "allOf": [ { @@ -7312,16 +11123,68 @@ ], "properties": { "properties": { - "$ref": "#/definitions/ServiceRegistryProperties" + "$ref": "#/definitions/CertificateProperties", + "description": "Properties of the certificate resource payload.", + "x-ms-client-flatten": false } } }, - "ServiceRegistryProperties": { - "description": "Service Registry properties payload", + "CertificateProperties": { + "description": "Certificate resource payload.", + "required": [ + "type" + ], "type": "object", "properties": { + "type": { + "description": "The type of the certificate source.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "thumbprint": { + "description": "The thumbprint of certificate.", + "type": "string", + "readOnly": true + }, + "issuer": { + "description": "The issuer of certificate.", + "type": "string", + "readOnly": true + }, + "issuedDate": { + "description": "The issue date of certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "The expiration date of certificate.", + "type": "string", + "readOnly": true + }, + "activateDate": { + "description": "The activate date of certificate.", + "type": "string", + "readOnly": true + }, + "subjectName": { + "description": "The subject name of certificate.", + "type": "string", + "readOnly": true + }, + "dnsNames": { + "description": "The domain list of certificate.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, "provisioningState": { - "description": "State of the Service Registry.", + "description": "Provisioning state of the Certificate", "enum": [ "Creating", "Updating", @@ -7332,1924 +11195,1770 @@ "type": "string", "readOnly": true, "x-ms-enum": { - "name": "ServiceRegistryProvisioningState", + "name": "CertificateResourceProvisioningState", "modelAsString": true } + } + }, + "discriminator": "type" + }, + "KeyVaultCertificateProperties": { + "description": "Properties of certificate imported from key vault.", + "required": [ + "type", + "vaultUri", + "keyVaultCertName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CertificateProperties" + } + ], + "properties": { + "vaultUri": { + "description": "The vault uri of user key vault.", + "type": "string" }, - "resourceRequests": { - "$ref": "#/definitions/ServiceRegistryResourceRequests", - "description": "The requested resource quantity for required CPU and Memory." + "keyVaultCertName": { + "description": "The certificate name of key vault.", + "type": "string" }, - "instances": { - "description": "Collection of instances belong to Service Registry.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ServiceRegistryInstance" - }, - "readOnly": true + "certVersion": { + "description": "The certificate version of key vault.", + "type": "string" + }, + "excludePrivateKey": { + "description": "Optional. If set to true, it will not import private key from key vault.", + "type": "boolean", + "default": false + }, + "autoSync": { + "description": "Indicates whether to automatically synchronize certificate from key vault or not.", + "enum": [ + "Disabled", + "Enabled" + ], + "default": "Disabled", + "type": "string", + "x-ms-enum": { + "name": "KeyVaultCertificateAutoSync", + "modelAsString": true + } } - } + }, + "x-ms-discriminator-value": "KeyVaultCertificate" }, - "ServiceRegistryResourceRequests": { - "description": "Resource request payload of Service Registry", + "ContentCertificateProperties": { + "description": "Properties of certificate imported from key vault.", + "required": [ + "type" + ], "type": "object", - "readOnly": true, + "allOf": [ + { + "$ref": "#/definitions/CertificateProperties" + } + ], "properties": { - "cpu": { - "description": "Cpu allocated to each Service Registry instance", - "type": "string", - "readOnly": true - }, - "memory": { - "description": "Memory allocated to each Service Registry instance", + "content": { + "description": "The content of uploaded certificate.", "type": "string", - "readOnly": true + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "x-ms-discriminator-value": "ContentCertificate" + }, + "CertificateResourceCollection": { + "description": "Collection compose of certificate resources list and a possible link for next page.", + "type": "object", + "properties": { + "value": { + "description": "The certificate resources list.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/CertificateResource" + } }, - "instanceCount": { - "format": "int32", - "description": "Instance count of the Service Registry", - "type": "integer", - "readOnly": true + "nextLink": { + "description": "The link to next page of certificate list.", + "type": "string" } } }, - "ServiceRegistryInstance": { - "description": "Collection of instances belong to the Service Registry", + "StorageResource": { + "description": "Storage resource payload.", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], "properties": { - "name": { - "description": "Name of the Service Registry instance", - "type": "string", - "readOnly": true - }, - "status": { - "description": "Status of the Service Registry instance", - "type": "string", - "readOnly": true + "properties": { + "$ref": "#/definitions/StorageProperties", + "description": "Properties of the storage resource payload.", + "x-ms-client-flatten": false } } }, - "Sku": { - "description": "Sku of Azure Spring Apps", + "StorageProperties": { + "description": "Storage resource payload.", "type": "object", + "required": [ + "storageType" + ], "properties": { - "name": { - "description": "Name of the Sku", - "type": "string", - "default": "S0" - }, - "tier": { - "description": "Tier of the Sku", + "storageType": { + "description": "The type of the storage.", + "enum": [ + "StorageAccount" + ], "type": "string", - "default": "Standard" - }, - "capacity": { - "format": "int32", - "description": "Current capacity of the target resource", - "type": "integer" + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } } - } + }, + "discriminator": "storageType" }, - "ConfigServerSettingsValidateResult": { - "description": "Validation result for config server settings", + "StorageAccount": { + "description": "storage resource of type Azure Storage Account.", "type": "object", + "required": [ + "storageType", + "accountName", + "accountKey" + ], + "allOf": [ + { + "$ref": "#/definitions/StorageProperties" + } + ], "properties": { - "isValid": { - "description": "Indicate if the config server settings are valid", - "type": "boolean" + "accountName": { + "description": "The account name of the Azure Storage Account.", + "type": "string" }, - "details": { - "description": "The detail validation results", - "type": "array", - "items": { - "$ref": "#/definitions/ConfigServerSettingsErrorRecord" - } + "accountKey": { + "description": "The account key of the Azure Storage Account.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] } - } + }, + "x-ms-discriminator-value": "StorageAccount" }, - "ConfigServerSettingsErrorRecord": { - "description": "Error record of the config server settings", + "StorageResourceCollection": { + "description": "Collection compose of storage resources list and a possible link for next page.", "type": "object", "properties": { - "name": { - "description": "The name of the config server settings error record", - "type": "string" - }, - "uri": { - "description": "The uri of the config server settings error record", - "type": "string" - }, - "messages": { - "description": "The detail error messages of the record", + "value": { + "description": "The storage resources list.", + "uniqueItems": false, "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/StorageResource" } + }, + "nextLink": { + "description": "The link to next page of storage list.", + "type": "string" } } }, - "ConfigServerResource": { - "description": "Config Server resource", + "CustomPersistentDiskResource": { + "description": "Custom persistent disk resource payload.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } + "required": [ + "storageId" ], "properties": { - "properties": { - "$ref": "#/definitions/ConfigServerProperties", - "description": "Properties of the Config Server resource", + "customPersistentDiskProperties": { + "$ref": "#/definitions/CustomPersistentDiskProperties", + "description": "Properties of the custom persistent disk resource payload.", "x-ms-client-flatten": false + }, + "storageId": { + "description": "The resource id of Azure Spring Apps Storage resource.", + "type": "string" } } }, - "ConfigServerProperties": { - "description": "Config server git properties payload", + "CustomPersistentDiskProperties": { + "description": "Custom persistent disk resource payload.", + "required": [ + "type", + "mountPath" + ], "type": "object", "properties": { - "provisioningState": { - "description": "State of the config server.", + "type": { + "description": "The type of the underlying resource to mount as a persistent disk.", "enum": [ - "NotAvailable", - "Deleted", - "Failed", - "Succeeded", - "Updating" + "AzureFileVolume" ], "type": "string", - "readOnly": true, "x-ms-enum": { - "name": "ConfigServerState", + "name": "Type", "modelAsString": true } }, - "error": { - "$ref": "#/definitions/Error", - "description": "Error when apply config server settings." + "mountPath": { + "description": "The mount path of the persistent disk.", + "type": "string" }, - "configServer": { - "$ref": "#/definitions/ConfigServerSettings", - "description": "Settings of config server." + "readOnly": { + "description": "Indicates whether the persistent disk is a readOnly one.", + "type": "boolean" + }, + "enableSubPath": { + "description": "If set to true, it will create and mount a dedicated directory for every individual app instance.", + "type": "boolean", + "default": false + }, + "mountOptions": { + "description": "These are the mount options for a persistent disk.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } } + }, + "discriminator": "type" + }, + "CustomPersistentDiskCollection": { + "description": "Collection of persistent disk resources list and a possible link for next page.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomPersistentDiskResource" } }, - "MonitoringSettingResource": { - "description": "Monitoring Setting resource", + "AzureFileVolume": { + "description": "The properties of the Azure File volume. Azure File shares are mounted as volumes.", "type": "object", + "required": [ + "type", + "mountPath" + ], "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "#/definitions/CustomPersistentDiskProperties" } ], "properties": { - "properties": { - "$ref": "#/definitions/MonitoringSettingProperties", - "description": "Properties of the Monitoring Setting resource", - "x-ms-client-flatten": false + "shareName": { + "description": "The share name of the Azure File share.", + "type": "string" } - } + }, + "x-ms-discriminator-value": "AzureFileVolume" }, - "MonitoringSettingProperties": { - "description": "Monitoring Setting properties payload", + "NameAvailabilityParameters": { + "description": "Name availability parameters payload", + "required": [ + "type", + "name" + ], "type": "object", "properties": { - "provisioningState": { - "description": "State of the Monitoring Setting.", - "enum": [ - "NotAvailable", - "Failed", - "Succeeded", - "Updating" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "MonitoringSettingState", - "modelAsString": true - } - }, - "error": { - "$ref": "#/definitions/Error", - "description": "Error when apply Monitoring Setting changes." - }, - "traceEnabled": { - "description": "Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not", - "type": "boolean" - }, - "appInsightsInstrumentationKey": { - "description": "Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings", + "type": { + "description": "Type of the resource to check name availability", "type": "string" }, - "appInsightsSamplingRate": { - "description": "Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]", - "format": "double", - "maximum": 100.0, - "minimum": 0.0, - "type": "number" - }, - "appInsightsAgentVersions": { - "$ref": "#/definitions/applicationInsightsAgentVersions", - "description": "Indicates the versions of application insight agent" - } - } - }, - "applicationInsightsAgentVersions": { - "description": "Application Insights agent versions properties payload", - "type": "object", - "properties": { - "java": { - "description": "Indicates the version of application insight java agent", - "type": "string", - "readOnly": true + "name": { + "description": "Name to be checked", + "type": "string" } } }, - "NetworkProfile": { - "description": "Service network profile payload", + "NameAvailability": { + "description": "Name availability result payload", "type": "object", "properties": { - "serviceRuntimeSubnetId": { - "description": "Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "appSubnetId": { - "description": "Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "serviceCidr": { - "description": "Azure Spring Apps service reserved CIDR", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "serviceRuntimeNetworkResourceGroup": { - "description": "Name of the resource group containing network resources of Azure Spring Apps Service Runtime", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "appNetworkResourceGroup": { - "description": "Name of the resource group containing network resources for customer apps in Azure Spring Apps", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "outboundIPs": { - "description": "Desired outbound IP resources for Azure Spring Apps resource.", - "type": "object", - "readOnly": true, - "properties": { - "publicIPs": { - "type": "array", - "readOnly": true, - "items": { - "type": "string" - }, - "description": "A list of public IP addresses." - } - } - }, - "requiredTraffics": { - "description": "Required inbound or outbound traffics for Azure Spring Apps resource.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/RequiredTraffic" - } + "nameAvailable": { + "description": "Indicates whether the name is available", + "type": "boolean" }, - "ingressConfig": { - "description": "Ingress configuration payload for Azure Spring Apps resource.", - "$ref": "#/definitions/IngressConfig" + "reason": { + "description": "Reason why the name is not available", + "type": "string" }, - "outboundType": { - "description": "The egress traffic type of Azure Spring Apps VNet instances.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] + "message": { + "description": "Message why the name is not available", + "type": "string" + } + }, + "readOnly": true + }, + "CustomDomainResource": { + "description": "Custom domain resource payload.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CustomDomainProperties", + "description": "Properties of the custom domain resource.", + "x-ms-client-flatten": false } } }, - "RequiredTraffic": { - "description": "Required inbound or outbound traffic for Azure Spring Apps resource.", + "CustomDomainProperties": { + "description": "Custom domain of app resource payload.", "type": "object", "properties": { - "protocol": { - "description": "The protocol of required traffic", - "type": "string", - "readOnly": true + "thumbprint": { + "description": "The thumbprint of bound certificate.", + "type": "string" }, - "port": { - "description": "The port of required traffic", - "type": "integer", - "format": "int32", + "appName": { + "description": "The app name of domain.", + "type": "string", "readOnly": true }, - "ips": { - "description": "The ip list of required traffic", - "type": "array", - "readOnly": true, - "items": { - "type": "string" - } - }, - "fqdns": { - "description": "The FQDN list of required traffic", - "type": "array", - "readOnly": true, - "items": { - "type": "string" - } + "certName": { + "description": "The bound certificate name of domain.", + "type": "string" }, - "direction": { - "description": "The direction of required traffic", - "type": "string", - "readOnly": true, + "provisioningState": { + "description": "Provisioning state of the Domain", "enum": [ - "Inbound", - "Outbound" + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" ], + "type": "string", + "readOnly": true, "x-ms-enum": { - "name": "trafficDirection", + "name": "CustomDomainResourceProvisioningState", "modelAsString": true } } } }, - "IngressConfig": { - "description": "Ingress configuration payload for Azure Spring Apps resource.", + "CustomDomainResourceCollection": { + "description": "Collection compose of a custom domain resources list and a possible link for next page.", "type": "object", "properties": { - "readTimeoutInSeconds": { - "format": "int32", - "description": "Ingress read time out in seconds.", - "type": "integer" + "value": { + "description": "The custom domain resources list.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "nextLink": { + "description": "The link to next page of custom domain list.", + "type": "string" } } }, - "Error": { - "description": "The error code compose of code and message.", + "CustomDomainValidatePayload": { + "description": "Custom domain validate payload.", + "required": [ + "name" + ], "type": "object", "properties": { - "code": { - "description": "The code of error.", + "name": { + "description": "Name to be validated", "type": "string" + } + } + }, + "CustomDomainValidateResult": { + "description": "Validation result for custom domain.", + "type": "object", + "properties": { + "isValid": { + "description": "Indicates if domain name is valid.", + "type": "boolean" }, "message": { - "description": "The message of error.", + "description": "Message of why domain name is invalid.", "type": "string" } } }, - "ServiceVNetAddons": { - "description": "Additional Service settings in vnet injection instance", + "RemoteDebuggingPayload": { + "description": "Remote debugging payload.", "type": "object", "properties": { - "logStreamPublicEndpoint": { - "description": "Indicates whether the log stream in vnet injection instance could be accessed from internet.", - "type": "boolean", - "default": false + "port": { + "description": "Application debugging port.", + "type": "integer", + "format": "int32" } } }, - "ConfigServerSettings": { - "description": "The settings of config server.", + "RemoteDebugging": { + "description": "Remote debugging config.", "type": "object", "properties": { - "gitProperty": { - "$ref": "#/definitions/ConfigServerGitProperty", - "description": "Property of git environment." + "port": { + "description": "Application debugging port", + "type": "integer", + "format": "int32" + }, + "enabled": { + "description": "Indicate if remote debugging is enabled", + "type": "boolean" } } }, - "ConfigServerGitProperty": { - "description": "Property of git.", - "required": [ - "uri" + "DeploymentResource": { + "description": "Deployment resource payload", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } ], + "properties": { + "properties": { + "$ref": "#/definitions/DeploymentResourceProperties", + "description": "Properties of the Deployment resource", + "x-ms-client-flatten": false + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the Deployment resource" + } + } + }, + "DeploymentResourceProperties": { + "description": "Deployment resource properties payload", "type": "object", "properties": { - "repositories": { - "description": "Repositories of git.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/GitPatternRepository" + "source": { + "$ref": "#/definitions/UserSourceInfo", + "description": "Uploaded source information of the deployment." + }, + "deploymentSettings": { + "$ref": "#/definitions/DeploymentSettings", + "description": "Deployment settings of the Deployment" + }, + "provisioningState": { + "description": "Provisioning state of the Deployment", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DeploymentResourceProvisioningState", + "modelAsString": true } }, - "uri": { - "description": "URI of the repository", - "type": "string" + "status": { + "description": "Status of the Deployment", + "enum": [ + "Stopped", + "Running" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DeploymentResourceStatus", + "modelAsString": true + } }, - "label": { - "description": "Label of the repository", - "type": "string" + "active": { + "description": "Indicates whether the Deployment is active", + "type": "boolean" }, - "searchPaths": { - "description": "Searching path of the repository", + "instances": { + "description": "Collection of instances belong to the Deployment", "uniqueItems": false, "type": "array", "items": { - "type": "string" - } - }, - "username": { - "description": "Username of git repository basic auth.", - "type": "string" - }, - "password": { - "description": "Password of git repository basic auth.", - "type": "string" - }, - "hostKey": { - "description": "Public sshKey of git repository.", - "type": "string" - }, - "hostKeyAlgorithm": { - "description": "SshKey algorithm of git repository.", - "type": "string" - }, - "privateKey": { - "description": "Private sshKey algorithm of git repository.", - "type": "string" - }, - "strictHostKeyChecking": { - "description": "Strict host key checking or not.", - "type": "boolean" + "$ref": "#/definitions/DeploymentInstance" + }, + "readOnly": true } } }, - "GitPatternRepository": { - "description": "Git repository property payload for config server", + "UserSourceInfo": { + "description": "Source information for a deployment", + "type": "object", "required": [ - "name", - "uri" + "type" ], - "type": "object", "properties": { - "name": { - "description": "Name of the repository", + "type": { + "description": "Type of the source uploaded", "type": "string" }, - "pattern": { - "description": "Collection of pattern of the repository", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "uri": { - "description": "URI of the repository", + "version": { + "description": "Version of the source", "type": "string" - }, - "label": { - "description": "Label of the repository", + } + }, + "discriminator": "type" + }, + "UploadedUserSourceInfo": { + "description": "Source with uploaded location", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UserSourceInfo" + } + ], + "properties": { + "relativePath": { + "description": "Relative path of the storage which stores the source", "type": "string" - }, - "searchPaths": { - "description": "Searching path of the repository", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "username": { - "description": "Username of git repository basic auth.", + } + } + }, + "JarUploadedUserSourceInfo": { + "description": "Uploaded Jar binary for a deployment", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UploadedUserSourceInfo" + } + ], + "properties": { + "runtimeVersion": { + "description": "Runtime version of the Jar file", "type": "string" }, - "password": { - "description": "Password of git repository basic auth.", + "jvmOptions": { + "description": "JVM parameter", "type": "string" - }, - "hostKey": { - "description": "Public sshKey of git repository.", + } + }, + "x-ms-discriminator-value": "Jar" + }, + "WarUploadedUserSourceInfo": { + "description": "Uploaded War binary for a deployment", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UploadedUserSourceInfo" + } + ], + "properties": { + "runtimeVersion": { + "description": "Runtime version of the war file", "type": "string" }, - "hostKeyAlgorithm": { - "description": "SshKey algorithm of git repository.", + "jvmOptions": { + "description": "JVM parameter", "type": "string" }, - "privateKey": { - "description": "Private sshKey algorithm of git repository.", + "serverVersion": { + "description": "Server version, currently only Apache Tomcat is supported", "type": "string" - }, - "strictHostKeyChecking": { - "description": "Strict host key checking or not.", - "type": "boolean" } - } + }, + "x-ms-discriminator-value": "War" }, - "TestKeys": { - "description": "Test keys payload", + "SourceUploadedUserSourceInfo": { + "description": "Uploaded Java source code binary for a deployment", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UploadedUserSourceInfo" + } + ], "properties": { - "primaryKey": { - "description": "Primary key", - "type": "string" - }, - "secondaryKey": { - "description": "Secondary key", - "type": "string" - }, - "primaryTestEndpoint": { - "description": "Primary test endpoint", + "artifactSelector": { + "description": "Selector for the artifact to be used for the deployment for multi-module projects. This should be\r\nthe relative path to the target module/project.", "type": "string" }, - "secondaryTestEndpoint": { - "description": "Secondary test endpoint", + "runtimeVersion": { + "description": "Runtime version of the source file", "type": "string" - }, - "enabled": { - "description": "Indicates whether the test endpoint feature enabled or not", - "type": "boolean" } - } + }, + "x-ms-discriminator-value": "Source" }, - "RegenerateTestKeyRequestPayload": { - "description": "Regenerate test key request payload", - "required": [ - "keyType" - ], + "NetCoreZipUploadedUserSourceInfo": { + "description": "Uploaded Jar binary for a deployment", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UploadedUserSourceInfo" + } + ], "properties": { - "keyType": { - "description": "Type of the test key", - "enum": [ - "Primary", - "Secondary" - ], - "type": "string", - "x-ms-enum": { - "name": "TestKeyType", - "modelAsString": true - } + "netCoreMainEntryPath": { + "description": "The path to the .NET executable relative to zip root", + "type": "string" + }, + "runtimeVersion": { + "description": "Runtime version of the .Net file", + "type": "string" } - } + }, + "x-ms-discriminator-value": "NetCoreZip" }, - "AppResource": { - "description": "App resource payload", + "BuildResultUserSourceInfo": { + "description": "Reference to a build result", "type": "object", + "x-ms-discriminator-value": "BuildResult", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "#/definitions/UserSourceInfo" } ], "properties": { - "properties": { - "$ref": "#/definitions/AppResourceProperties", - "description": "Properties of the App resource", - "x-ms-client-flatten": false - }, - "identity": { - "$ref": "#/definitions/ManagedIdentityProperties", - "description": "The Managed Identity type of the app resource" - }, - "location": { - "description": "The GEO location of the application, always the same with its parent resource", + "buildResultId": { + "description": "Resource id of an existing succeeded build result under the same Spring instance.", "type": "string" } } }, - "ProxyResource": { - "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.", + "CustomContainerUserSourceInfo": { + "description": "Custom container user source info", "type": "object", + "x-ms-discriminator-value": "Container", "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "#/definitions/UserSourceInfo" } ], - "properties": {} + "properties": { + "customContainer": { + "$ref": "#/definitions/CustomContainer" + } + } }, - "AppResourceProperties": { - "description": "App resource properties payload", + "CustomContainer": { + "description": "Custom container payload", "type": "object", "properties": { - "public": { - "description": "Indicates whether the App exposes public endpoint", - "type": "boolean" - }, - "url": { - "description": "URL of the App", - "type": "string", - "readOnly": true - }, - "addonConfigs": { - "description": "Collection of addons", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "provisioningState": { - "description": "Provisioning state of the App", - "enum": [ - "Succeeded", - "Failed", - "Creating", - "Updating", - "Deleting" - ], + "server": { "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AppResourceProvisioningState", - "modelAsString": true - } + "description": "The name of the registry that contains the container image" }, - "fqdn": { - "description": "Fully qualified dns Name.", + "containerImage": { "type": "string", - "readOnly": true - }, - "httpsOnly": { - "description": "Indicate if only https is allowed.", - "type": "boolean", - "default": false - }, - "temporaryDisk": { - "$ref": "#/definitions/TemporaryDisk", - "description": "Temporary disk settings" - }, - "persistentDisk": { - "$ref": "#/definitions/PersistentDisk", - "description": "Persistent disk settings" - }, - "customPersistentDisks": { - "$ref": "#/definitions/CustomPersistentDiskCollection", - "description": "List of custom persistent disks" + "description": "Container image of the custom container. This should be in the form of : without the server name of the registry" }, - "enableEndToEndTLS": { - "description": "Indicate if end to end TLS is enabled.", - "type": "boolean", - "default": false + "command": { + "description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } }, - "loadedCertificates": { - "description": "Collection of loaded certificates", - "$ref": "#/definitions/LoadedCertificateCollection" + "args": { + "description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } }, - "vnetAddons": { - "description": "Additional App settings in vnet injection instance", - "$ref": "#/definitions/AppVNetAddons" + "imageRegistryCredential": { + "$ref": "#/definitions/ImageRegistryCredential", + "description": "Credential of the image registry" }, - "ingressSettings": { - "description": "App ingress settings payload.", - "$ref": "#/definitions/IngressSettings" + "languageFramework": { + "description": "Language framework of the container image uploaded. Supported values: \"springboot\", \"\", null.", + "type": "string" } } }, - "TemporaryDisk": { - "description": "Temporary disk payload", + "ImageRegistryCredential": { + "description": "Credential of the image registry", "type": "object", "properties": { - "sizeInGB": { - "format": "int32", - "description": "Size of the temporary disk in GB", - "maximum": 5.0, - "minimum": 0.0, - "type": "integer" + "username": { + "type": "string", + "description": "The username of the image registry credential" }, - "mountPath": { - "description": "Mount path of the temporary disk", + "password": { "type": "string", - "default": "/tmp" + "description": "The password of the image registry credential" } } }, - "PersistentDisk": { - "description": "Persistent disk payload", + "DeploymentSettings": { + "description": "Deployment settings payload", "type": "object", "properties": { - "sizeInGB": { - "format": "int32", - "description": "Size of the persistent disk in GB", - "maximum": 50.0, - "minimum": 0.0, - "type": "integer" + "resourceRequests": { + "$ref": "#/definitions/ResourceRequests", + "description": "The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required CPU and Memory, the old field cpu and memoryInGB will be deprecated later." }, - "usedInGB": { + "environmentVariables": { + "description": "Collection of environment variables", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "apms": { + "$ref": "#/definitions/ApmReferenceCollection", + "description": "Collection of ApmReferences" + }, + "addonConfigs": { + "description": "Collection of addons", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "livenessProbe": { + "$ref": "#/definitions/Probe", + "description": "Periodic probe of App Instance liveness. App Instance will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + }, + "readinessProbe": { + "$ref": "#/definitions/Probe", + "description": "Periodic probe of App Instance service readiness. App Instance will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + }, + "startupProbe": { + "$ref": "#/definitions/Probe", + "description": "StartupProbe indicates that the App Instance has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a App Instance's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + }, + "terminationGracePeriodSeconds": { + "description": "Optional duration in seconds the App Instance needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the App Instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 90 seconds.", "format": "int32", - "description": "Size of the used persistent disk in GB", - "maximum": 50.0, - "minimum": 0.0, "type": "integer", - "readOnly": true + "default": 90 }, - "mountPath": { - "description": "Mount path of the persistent disk", - "type": "string" + "containerProbeSettings": { + "$ref": "#/definitions/ContainerProbeSettings" } } }, - "LoadedCertificate": { - "description": "Loaded certificate payload", + "Probe": { + "description": "Probe describes a health check to be performed against an App Instance to determine whether it is alive or ready to receive traffic.", + "type": "object", "required": [ - "resourceId" + "disableProbe" ], - "type": "object", "properties": { - "resourceId": { - "description": "Resource Id of loaded certificate", - "type": "string" + "probeAction": { + "$ref": "#/definitions/ProbeAction", + "description": "The action of the probe." }, - "loadTrustStore": { - "description": "Indicate whether the certificate will be loaded into default trust store, only work for Java runtime.", - "type": "boolean", - "default": false - } - } - }, - "LoadedCertificateCollection": { - "description": "Collection of loaded certificate resources list and a possible link for next page.", - "type": "array", - "items": { - "$ref": "#/definitions/LoadedCertificate" - } - }, - "AppVNetAddons": { - "description": "Additional App settings in vnet injection instance", - "type": "object", - "properties": { - "publicEndpoint": { - "description": "Indicates whether the App in vnet injection instance exposes endpoint which could be accessed from internet.", + "disableProbe": { + "description": "Indicate whether the probe is disabled.", "type": "boolean", "default": false }, - "publicEndpointUrl": { - "description": "URL of the App in vnet injection instance which could be accessed from internet", - "type": "string", - "readOnly": true - } - } - }, - "IngressSettings": { - "description": "App ingress settings payload.", - "type": "object", - "properties": { - "readTimeoutInSeconds": { + "initialDelaySeconds": { + "description": "Number of seconds after the App Instance has started before probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", - "description": "Ingress read time out in seconds.", "type": "integer" }, - "sendTimeoutInSeconds": { + "periodSeconds": { + "description": "How often (in seconds) to perform the probe. Minimum value is 1.", "format": "int32", - "description": "Ingress send time out in seconds.", "type": "integer" }, - "sessionAffinity": { - "description": "Type of the affinity, set this to Cookie to enable session affinity.", - "enum": [ - "Cookie", - "None" - ], - "type": "string", - "x-ms-enum": { - "name": "SessionAffinity", - "modelAsString": true - } - }, - "sessionCookieMaxAge": { - "description": "Time in seconds until the cookie expires.", + "timeoutSeconds": { + "description": "Number of seconds after which the probe times out. Minimum value is 1.", "format": "int32", "type": "integer" }, - "backendProtocol": { - "description": "How ingress should communicate with this app backend service.", - "enum": [ - "GRPC", - "Default" - ], - "type": "string", - "x-ms-enum": { - "name": "BackendProtocol", - "modelAsString": true - } - }, - "clientAuth": { - "description": "Client-Certification Authentication.", - "type": "object", - "properties": { - "certificates": { - "description": "Collection of certificate resource id.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "AppResourceCollection": { - "description": "Object that includes an array of App resources and a possible link for next set", - "type": "object", - "properties": { - "value": { - "description": "Collection of App resources", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/AppResource" - } + "failureThreshold": { + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.", + "format": "int32", + "type": "integer" }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" + "successThreshold": { + "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 for liveness and startup. Minimum value is 1.", + "format": "int32", + "type": "integer" } } }, - "ActiveDeploymentCollection": { - "description": "Object that includes an array of Deployment resource name and set them as active.", + "ProbeAction": { + "description": "The action of the probe.", + "required": [ + "type" + ], "type": "object", "properties": { - "activeDeploymentNames": { - "description": "Collection of Deployment name.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" + "type": { + "description": "The type of the action to take to perform the health check.", + "enum": [ + "HTTPGetAction", + "TCPSocketAction", + "ExecAction" + ], + "type": "string", + "x-ms-enum": { + "name": "ProbeActionType", + "modelAsString": true } } - } + }, + "discriminator": "type" }, - "ResourceUploadDefinition": { - "description": "Resource upload definition payload", - "type": "object", + "HTTPGetAction": { + "description": "HTTPGetAction describes an action based on HTTP Get requests.", "properties": { - "relativePath": { - "description": "Source relative path", + "path": { + "description": "Path to access on the HTTP server.", "type": "string" }, - "uploadUrl": { - "description": "Upload URL", - "type": "string" + "scheme": { + "description": "Scheme to use for connecting to the host. Defaults to HTTP.\n\nPossible enum values:\n - `\"HTTP\"` means that the scheme used will be http://\n - `\"HTTPS\"` means that the scheme used will be https://", + "enum": [ + "HTTP", + "HTTPS" + ], + "type": "string", + "x-ms-enum": { + "name": "HTTPSchemeType", + "modelAsString": true + } } - } - }, - "BindingResource": { - "description": "Binding resource payload", + }, "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "#/definitions/ProbeAction" } ], - "properties": { - "properties": { - "$ref": "#/definitions/BindingResourceProperties", - "description": "Properties of the Binding resource", - "x-ms-client-flatten": false - } - } + "x-ms-discriminator-value": "HTTPGetAction" }, - "BindingResourceProperties": { - "description": "Binding resource properties payload", - "type": "object", + "ExecAction": { + "description": "ExecAction describes a \"run in container\" action.", "properties": { - "resourceName": { - "description": "The name of the bound resource", - "type": "string", - "readOnly": true - }, - "resourceType": { - "description": "The standard Azure resource type of the bound resource", - "type": "string", - "readOnly": true - }, - "resourceId": { - "description": "The Azure resource id of the bound resource", - "type": "string" - }, - "key": { - "description": "The key of the bound resource", - "type": "string" - }, - "bindingParameters": { - "description": "Binding parameters of the Binding resource", - "type": "object", - "additionalProperties": { + "command": { + "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.", + "items": { "type": "string" - } - }, - "generatedProperties": { - "description": "The generated Spring Boot property file for this binding. The secret will be deducted.", - "type": "string", - "readOnly": true - }, - "createdAt": { - "description": "Creation time of the Binding resource", - "type": "string", - "readOnly": true - }, - "updatedAt": { - "description": "Update time of the Binding resource", - "type": "string", - "readOnly": true + }, + "type": "array", + "x-ms-identifiers": [] } - } - }, - "BindingResourceCollection": { - "description": "Object that includes an array of Binding resources and a possible link for next set", + }, "type": "object", - "properties": { - "value": { - "description": "Collection of Binding resources", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/BindingResource" - } - }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" + "allOf": [ + { + "$ref": "#/definitions/ProbeAction" } - } + ], + "x-ms-discriminator-value": "ExecAction" }, - "CertificateResource": { - "description": "Certificate resource payload.", + "TCPSocketAction": { + "description": "TCPSocketAction describes an action based on opening a socket", + "properties": {}, "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "#/definitions/ProbeAction" } ], + "x-ms-discriminator-value": "TCPSocketAction" + }, + "ContainerProbeSettings": { + "description": "Container liveness and readiness probe settings", + "type": "object", "properties": { - "properties": { - "$ref": "#/definitions/CertificateProperties", - "description": "Properties of the certificate resource payload.", - "x-ms-client-flatten": false + "disableProbe": { + "description": "Indicates whether disable the liveness and readiness probe", + "type": "boolean" } } }, - "CertificateProperties": { - "description": "Certificate resource payload.", - "required": [ - "type" - ], + "DeploymentInstance": { + "description": "Deployment instance payload", "type": "object", "properties": { - "type": { - "description": "The type of the certificate source.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "thumbprint": { - "description": "The thumbprint of certificate.", + "name": { + "description": "Name of the deployment instance", "type": "string", "readOnly": true }, - "issuer": { - "description": "The issuer of certificate.", + "status": { + "description": "Status of the deployment instance", "type": "string", "readOnly": true }, - "issuedDate": { - "description": "The issue date of certificate.", + "reason": { + "description": "Failed reason of the deployment instance", "type": "string", "readOnly": true }, - "expirationDate": { - "description": "The expiration date of certificate.", + "discoveryStatus": { + "description": "Discovery status of the deployment instance", "type": "string", "readOnly": true }, - "activateDate": { - "description": "The activate date of certificate.", + "startTime": { + "description": "Start time of the deployment instance", "type": "string", "readOnly": true }, - "subjectName": { - "description": "The subject name of certificate.", + "zone": { + "description": "Availability zone information of the deployment instance", "type": "string", "readOnly": true - }, - "dnsNames": { - "description": "The domain list of certificate.", + } + } + }, + "DeploymentList": { + "description": "A list of deployments resource ids.", + "type": "object", + "properties": { + "deployments": { + "description": "A list of deployment resource ids.", "uniqueItems": false, "type": "array", "items": { "type": "string" - }, - "readOnly": true - }, - "provisioningState": { - "description": "Provisioning state of the Certificate", - "enum": [ - "Creating", - "Updating", - "Succeeded", - "Failed", - "Deleting" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "CertificateResourceProvisioningState", - "modelAsString": true } } - }, - "discriminator": "type" - }, - "KeyVaultCertificateProperties": { - "description": "Properties of certificate imported from key vault.", - "required": [ - "type", - "vaultUri", - "keyVaultCertName" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CertificateProperties" - } - ], - "properties": { - "vaultUri": { - "description": "The vault uri of user key vault.", - "type": "string" - }, - "keyVaultCertName": { - "description": "The certificate name of key vault.", - "type": "string" - }, - "certVersion": { - "description": "The certificate version of key vault.", - "type": "string" - }, - "excludePrivateKey": { - "description": "Optional. If set to true, it will not import private key from key vault.", - "type": "boolean", - "default": false - } - }, - "x-ms-discriminator-value": "KeyVaultCertificate" - }, - "ContentCertificateProperties": { - "description": "Properties of certificate imported from key vault.", - "required": [ - "type" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CertificateProperties" - } - ], - "properties": { - "content": { - "description": "The content of uploaded certificate.", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - } - }, - "x-ms-discriminator-value": "ContentCertificate" + } }, - "CertificateResourceCollection": { - "description": "Collection compose of certificate resources list and a possible link for next page.", + "DeploymentResourceCollection": { + "description": "Object that includes an array of App resources and a possible link for next set", "type": "object", "properties": { "value": { - "description": "The certificate resources list.", + "description": "Collection of Deployment resources", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/CertificateResource" + "$ref": "#/definitions/DeploymentResource" } }, "nextLink": { - "description": "The link to next page of certificate list.", + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", "type": "string" } } }, - "StorageResource": { - "description": "Storage resource payload.", + "ResourceRequests": { + "description": "Deployment resource request payload", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], "properties": { - "properties": { - "$ref": "#/definitions/StorageProperties", - "description": "Properties of the storage resource payload.", - "x-ms-client-flatten": false + "cpu": { + "description": "Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier.", + "type": "string" + }, + "memory": { + "description": "Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier.", + "type": "string" } } }, - "StorageProperties": { - "description": "Storage resource payload.", - "type": "object", + "LogFileUrlResponse": { + "description": "Log file URL payload", "required": [ - "storageType" + "url" ], + "type": "object", "properties": { - "storageType": { - "description": "The type of the storage.", - "enum": [ - "StorageAccount" - ], - "type": "string", - "x-ms-enum": { - "name": "StorageType", - "modelAsString": true - } + "url": { + "description": "URL of the log file", + "type": "string" } - }, - "discriminator": "storageType" + } }, - "StorageAccount": { - "description": "storage resource of type Azure Storage Account.", + "DiagnosticParameters": { + "description": "Diagnostic parameters of diagnostic operations", "type": "object", - "required": [ - "storageType", - "accountName", - "accountKey" - ], - "allOf": [ - { - "$ref": "#/definitions/StorageProperties" - } - ], "properties": { - "accountName": { - "description": "The account name of the Azure Storage Account.", + "appInstance": { + "description": "App instance name", "type": "string" }, - "accountKey": { - "description": "The account key of the Azure Storage Account.", - "type": "string", - "x-ms-secret": true, - "x-ms-mutability": [ - "create", - "update" - ] + "filePath": { + "description": "Your target file path in your own BYOS", + "type": "string" + }, + "duration": { + "description": "Duration of your JFR. 1 min can be represented by 1m or 60s.", + "type": "string" } - }, - "x-ms-discriminator-value": "StorageAccount" + } }, - "StorageResourceCollection": { - "description": "Collection compose of storage resources list and a possible link for next page.", + "ServiceResourceList": { + "description": "Object that includes an array of Service resources and a possible link for next set", "type": "object", "properties": { "value": { - "description": "The storage resources list.", + "description": "Collection of Service resources", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/StorageResource" + "$ref": "#/definitions/ServiceResource" } }, "nextLink": { - "description": "The link to next page of storage list.", + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", "type": "string" } } }, - "CustomPersistentDiskResource": { - "description": "Custom persistent disk resource payload.", + "AvailableOperations": { + "description": "Available operations of the service", "type": "object", - "required": [ - "storageId" - ], "properties": { - "customPersistentDiskProperties": { - "$ref": "#/definitions/CustomPersistentDiskProperties", - "description": "Properties of the custom persistent disk resource payload.", - "x-ms-client-flatten": false + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OperationDetail" + } }, - "storageId": { - "description": "The resource id of Azure Spring Apps Storage resource.", + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", "type": "string" } } }, - "CustomPersistentDiskProperties": { - "description": "Custom persistent disk resource payload.", - "required": [ - "type", - "mountPath" - ], + "OperationDetail": { + "description": "Operation detail payload", "type": "object", "properties": { - "type": { - "description": "The type of the underlying resource to mount as a persistent disk.", + "name": { + "description": "Name of the operation", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Display of the operation" + }, + "actionType": { + "description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", + "type": "string", + "readOnly": true, "enum": [ - "AzureFileVolume" + "Internal" ], - "type": "string", "x-ms-enum": { - "name": "Type", + "name": "ActionType", "modelAsString": true } }, - "mountPath": { - "description": "The mount path of the persistent disk.", + "origin": { + "description": "Origin of the operation", "type": "string" }, - "readOnly": { - "description": "Indicates whether the persistent disk is a readOnly one.", - "type": "boolean" - }, - "mountOptions": { - "description": "These are the mount options for a persistent disk.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of the operation" } - }, - "discriminator": "type" + } }, - "CustomPersistentDiskCollection": { - "description": "Collection of persistent disk resources list and a possible link for next page.", - "type": "array", - "items": { - "$ref": "#/definitions/CustomPersistentDiskResource" + "OperationDisplay": { + "description": "Operation display payload", + "type": "object", + "properties": { + "provider": { + "description": "Resource provider of the operation", + "type": "string" + }, + "resource": { + "description": "Resource of the operation", + "type": "string" + }, + "operation": { + "description": "Localized friendly name for the operation", + "type": "string" + }, + "description": { + "description": "Localized friendly description for the operation", + "type": "string" + } } }, - "AzureFileVolume": { - "description": "The properties of the Azure File volume. Azure File shares are mounted as volumes.", + "OperationProperties": { + "description": "Extra Operation properties", "type": "object", - "required": [ - "type", - "mountPath", - "shareName" - ], - "allOf": [ - { - "$ref": "#/definitions/CustomPersistentDiskProperties" + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "Service specifications of the operation" } - ], + } + }, + "ServiceSpecification": { + "description": "Service specification payload", + "type": "object", "properties": { - "shareName": { - "description": "The share name of the Azure File share.", - "type": "string" + "logSpecifications": { + "description": "Specifications of the Log for Azure Monitoring", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + }, + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } } - }, - "x-ms-discriminator-value": "AzureFileVolume" + } }, - "NameAvailabilityParameters": { - "description": "Name availability parameters payload", - "required": [ - "type", - "name" - ], + "LogSpecification": { + "description": "Specifications of the Log for Azure Monitoring", "type": "object", "properties": { - "type": { - "description": "Type of the resource to check name availability", + "name": { + "description": "Name of the log", "type": "string" }, - "name": { - "description": "Name to be checked", + "displayName": { + "description": "Localized friendly display name of the log", + "type": "string" + }, + "blobDuration": { + "description": "Blob duration of the log", "type": "string" } } }, - "NameAvailability": { - "description": "Name availability result payload", + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring", "type": "object", "properties": { - "nameAvailable": { - "description": "Indicates whether the name is available", - "type": "boolean" + "name": { + "description": "Name of the metric", + "type": "string" }, - "reason": { - "description": "Reason why the name is not available", + "displayName": { + "description": "Localized friendly display name of the metric", "type": "string" }, - "message": { - "description": "Message why the name is not available", + "displayDescription": { + "description": "Localized friendly description of the metric", "type": "string" - } - }, - "readOnly": true - }, - "CustomDomainResource": { - "description": "Custom domain resource payload.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/CustomDomainProperties", - "description": "Properties of the custom domain resource.", - "x-ms-client-flatten": false - } - } - }, - "CustomDomainProperties": { - "description": "Custom domain of app resource payload.", - "type": "object", - "properties": { - "thumbprint": { - "description": "The thumbprint of bound certificate.", + }, + "unit": { + "description": "Unit that makes sense for the metric", "type": "string" }, - "appName": { - "description": "The app name of domain.", - "type": "string", - "readOnly": true + "category": { + "description": "Name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" }, - "certName": { - "description": "The bound certificate name of domain.", + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", "type": "string" }, - "provisioningState": { - "description": "Provisioning state of the Domain", - "enum": [ - "Creating", - "Updating", - "Succeeded", - "Failed", - "Deleting" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "CustomDomainResourceProvisioningState", - "modelAsString": true + "supportedAggregationTypes": { + "description": "Supported aggregation types", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" } - } - } - }, - "CustomDomainResourceCollection": { - "description": "Collection compose of a custom domain resources list and a possible link for next page.", - "type": "object", - "properties": { - "value": { - "description": "The custom domain resources list.", + }, + "supportedTimeGrainTypes": { + "description": "Supported time grain types", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/CustomDomainResource" + "type": "string" } }, - "nextLink": { - "description": "The link to next page of custom domain list.", + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.", + "type": "boolean" + }, + "dimensions": { + "description": "Dimensions of the metric", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension" + } + }, + "sourceMdmNamespace": { + "description": "Name of the MDM namespace. Optional.", "type": "string" } } }, - "CustomDomainValidatePayload": { - "description": "Custom domain validate payload.", - "required": [ - "name" - ], + "MetricDimension": { + "description": "Specifications of the Dimension of metrics", "type": "object", "properties": { "name": { - "description": "Name to be validated", + "description": "Name of the dimension", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension", "type": "string" + }, + "toBeExportedForShoebox": { + "description": "Whether this dimension should be included for the Shoebox export scenario", + "type": "boolean" } } }, - "CustomDomainValidateResult": { - "description": "Validation result for custom domain.", + "ResourceSkuCollection": { + "description": "Object that includes an array of Azure Spring Apps SKU and a possible link for next set", "type": "object", "properties": { - "isValid": { - "description": "Indicates if domain name is valid.", - "type": "boolean" + "value": { + "description": "Collection of resource SKU", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSku" + } }, - "message": { - "description": "Message of why domain name is invalid.", + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", "type": "string" } } }, - "RemoteDebuggingPayload": { - "description": "Remote debugging payload.", + "ResourceSku": { + "description": "Describes an available Azure Spring Apps SKU.", "type": "object", "properties": { - "port": { - "description": "Application debugging port.", - "type": "integer", - "format": "int32" + "resourceType": { + "description": "Gets the type of resource the SKU applies to.", + "type": "string" + }, + "name": { + "description": "Gets the name of SKU.", + "type": "string" + }, + "tier": { + "description": "Gets the tier of SKU.", + "type": "string" + }, + "capacity": { + "$ref": "#/definitions/SkuCapacity", + "description": "Gets the capacity of SKU." + }, + "locations": { + "description": "Gets the set of locations that the SKU is available.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "locationInfo": { + "description": "Gets a list of locations and availability zones in those locations where the SKU is available.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuLocationInfo" + } + }, + "restrictions": { + "description": "Gets the restrictions because of which SKU cannot be used. This is\r\nempty if there are no restrictions.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuRestrictions" + } } } }, - "RemoteDebugging": { - "description": "Remote debugging config.", + "SkuCapacity": { + "description": "The SKU capacity", + "required": [ + "minimum" + ], "type": "object", "properties": { - "port": { - "description": "Application debugging port", - "type": "integer", - "format": "int32" + "minimum": { + "format": "int32", + "description": "Gets or sets the minimum.", + "type": "integer" }, - "enabled": { - "description": "Indicate if remote debugging is enabled", - "type": "boolean" + "maximum": { + "format": "int32", + "description": "Gets or sets the maximum.", + "type": "integer" + }, + "default": { + "format": "int32", + "description": "Gets or sets the default.", + "type": "integer" + }, + "scaleType": { + "description": "Gets or sets the type of the scale.", + "enum": [ + "None", + "Manual", + "Automatic" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuScaleType", + "modelAsString": true + } } } }, - "DeploymentResource": { - "description": "Deployment resource payload", + "ResourceSkuLocationInfo": { + "description": "Locations and availability zones where the SKU is available", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], "properties": { - "properties": { - "$ref": "#/definitions/DeploymentResourceProperties", - "description": "Properties of the Deployment resource", - "x-ms-client-flatten": false + "location": { + "description": "Gets location of the SKU", + "type": "string" }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "Sku of the Deployment resource" + "zones": { + "description": "Gets list of availability zones where the SKU is supported.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "zoneDetails": { + "description": "Gets details of capabilities available to a SKU in specific zones.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuZoneDetails" + } } } }, - "DeploymentResourceProperties": { - "description": "Deployment resource properties payload", + "ResourceSkuRestrictions": { + "description": "Restrictions where the SKU cannot be used", "type": "object", "properties": { - "source": { - "$ref": "#/definitions/UserSourceInfo", - "description": "Uploaded source information of the deployment." - }, - "deploymentSettings": { - "$ref": "#/definitions/DeploymentSettings", - "description": "Deployment settings of the Deployment" - }, - "provisioningState": { - "description": "Provisioning state of the Deployment", + "type": { + "description": "Gets the type of restrictions. Possible values include: 'Location', 'Zone'", "enum": [ - "Creating", - "Updating", - "Succeeded", - "Failed" + "Location", + "Zone" ], "type": "string", - "readOnly": true, "x-ms-enum": { - "name": "DeploymentResourceProvisioningState", + "name": "ResourceSkuRestrictionsType", "modelAsString": true } }, - "status": { - "description": "Status of the Deployment", + "values": { + "description": "Gets the value of restrictions. If the restriction type is set to\r\nlocation. This would be different locations where the SKU is restricted.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "restrictionInfo": { + "$ref": "#/definitions/ResourceSkuRestrictionInfo", + "description": "Gets the information about the restriction where the SKU cannot be used." + }, + "reasonCode": { + "description": "Gets the reason for restriction. Possible values include: 'QuotaId', 'NotAvailableForSubscription'", "enum": [ - "Stopped", - "Running" + "QuotaId", + "NotAvailableForSubscription" ], "type": "string", - "readOnly": true, "x-ms-enum": { - "name": "DeploymentResourceStatus", + "name": "ResourceSkuRestrictionsReasonCode", "modelAsString": true } - }, - "active": { - "description": "Indicates whether the Deployment is active", - "type": "boolean" - }, - "instances": { - "description": "Collection of instances belong to the Deployment", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/DeploymentInstance" - }, - "readOnly": true } } }, - "UserSourceInfo": { - "description": "Source information for a deployment", + "ResourceSkuZoneDetails": { + "description": "Details of capabilities available to a SKU in specific zones", "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "description": "Type of the source uploaded", - "type": "string" + "name": { + "description": "Gets the set of zones that the SKU is available in with the\r\nspecified capabilities.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } }, - "version": { - "description": "Version of the source", - "type": "string" + "capabilities": { + "description": "Gets a list of capabilities that are available for the SKU in the\r\nspecified list of zones.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuCapabilities" + } } - }, - "discriminator": "type" + } }, - "UploadedUserSourceInfo": { - "description": "Source with uploaded location", + "ResourceSkuRestrictionInfo": { + "description": "Information about the restriction where the SKU cannot be used", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/UserSourceInfo" - } - ], "properties": { - "relativePath": { - "description": "Relative path of the storage which stores the source", - "type": "string" + "locations": { + "description": "Gets locations where the SKU is restricted", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "zones": { + "description": "Gets list of availability zones where the SKU is restricted.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } } } }, - "JarUploadedUserSourceInfo": { - "description": "Uploaded Jar binary for a deployment", + "ResourceSkuCapabilities": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/UploadedUserSourceInfo" - } - ], "properties": { - "runtimeVersion": { - "description": "Runtime version of the Jar file", + "name": { + "description": "Gets an invariant to describe the feature.", "type": "string" }, - "jvmOptions": { - "description": "JVM parameter", + "value": { + "description": "Gets an invariant if the feature is measured by quantity.", "type": "string" } - }, - "x-ms-discriminator-value": "Jar" + } }, - "SourceUploadedUserSourceInfo": { - "description": "Uploaded Java source code binary for a deployment", + "CloudError": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/UploadedUserSourceInfo" - } - ], + "description": "An error response from the service.", "properties": { - "artifactSelector": { - "description": "Selector for the artifact to be used for the deployment for multi-module projects. This should be\r\nthe relative path to the target module/project.", - "type": "string" - }, - "runtimeVersion": { - "description": "Runtime version of the source file", - "type": "string" + "error": { + "description": "An error response from the service.", + "$ref": "#/definitions/CloudErrorBody" } }, - "x-ms-discriminator-value": "Source" + "x-ms-external": true }, - "NetCoreZipUploadedUserSourceInfo": { - "description": "Uploaded Jar binary for a deployment", + "CloudErrorBody": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/UploadedUserSourceInfo" - } - ], + "description": "An error response from the service.", "properties": { - "netCoreMainEntryPath": { - "description": "The path to the .NET executable relative to zip root", + "code": { + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", "type": "string" }, - "runtimeVersion": { - "description": "Runtime version of the .Net file", + "message": { + "description": "A message describing the error, intended to be suitable for display in a user interface.", "type": "string" + }, + "target": { + "description": "The target of the particular error. For example, the name of the property in error.", + "type": "string" + }, + "details": { + "description": "A list of additional details about the error.", + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + } } }, - "x-ms-discriminator-value": "NetCoreZip" + "x-ms-external": true }, - "BuildResultUserSourceInfo": { - "description": "Reference to a build result", + "AvailableRuntimeVersions": { "type": "object", - "x-ms-discriminator-value": "BuildResult", - "allOf": [ - { - "$ref": "#/definitions/UserSourceInfo" - } - ], "properties": { - "buildResultId": { - "description": "Resource id of an existing succeeded build result under the same Spring instance.", - "type": "string" + "value": { + "description": "A list of all supported runtime versions.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SupportedRuntimeVersion" + }, + "readOnly": true } - } + }, + "readOnly": true }, - "CustomContainerUserSourceInfo": { - "description": "Custom container user source info", + "SupportedRuntimeVersion": { + "description": "Supported deployment runtime version descriptor.", "type": "object", - "x-ms-discriminator-value": "Container", - "allOf": [ - { - "$ref": "#/definitions/UserSourceInfo" - } - ], "properties": { - "customContainer": { - "$ref": "#/definitions/CustomContainer" + "value": { + "description": "The raw value which could be passed to deployment CRUD operations.", + "enum": [ + "Java_8", + "Java_11", + "Java_17", + "NetCore_31" + ], + "type": "string", + "x-ms-enum": { + "name": "SupportedRuntimeValue", + "modelAsString": true + } + }, + "platform": { + "description": "The platform of this runtime version (possible values: \"Java\" or \".NET\").", + "enum": [ + "Java", + ".NET Core" + ], + "type": "string", + "x-ms-enum": { + "name": "SupportedRuntimePlatform", + "modelAsString": true + } + }, + "version": { + "description": "The detailed version (major.minor) of the platform.", + "type": "string" } - } + }, + "readOnly": true }, - "CustomContainer": { - "description": "Custom container payload", + "SupportedServerVersions": { + "description": "Supported server versions.", "type": "object", "properties": { - "server": { - "type": "string", - "description": "The name of the registry that contains the container image" - }, - "containerImage": { - "type": "string", - "description": "Container image of the custom container. This should be in the form of : without the server name of the registry" - }, - "command": { - "description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "args": { - "description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided.", + "value": { + "description": "Collection of the supported server versions.", "uniqueItems": false, "type": "array", + "x-ms-identifiers": [ + "value" + ], "items": { - "type": "string" + "$ref": "#/definitions/SupportedServerVersion" } }, - "imageRegistryCredential": { - "$ref": "#/definitions/ImageRegistryCredential", - "description": "Credential of the image registry" - }, - "languageFramework": { - "description": "Language framework of the container image uploaded", + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", "type": "string" } } }, - "ImageRegistryCredential": { - "description": "Credential of the image registry", + "SupportedServerVersion": { + "description": "Supported server version.", "type": "object", "properties": { - "username": { - "type": "string", - "description": "The username of the image registry credential" + "value": { + "description": "The raw server version value which could be passed to deployment CRUD operations.", + "type": "string" }, - "password": { - "type": "string", - "description": "The password of the image registry credential" + "server": { + "description": "The server name.", + "type": "string" + }, + "version": { + "description": "The Server version.", + "type": "string" } - } + }, + "readOnly": true }, - "DeploymentSettings": { - "description": "Deployment settings payload", + "BuildpackBindingResourceCollection": { + "description": "Object that includes an array of BuildpackBinding resources and a possible link for next set", "type": "object", "properties": { - "resourceRequests": { - "$ref": "#/definitions/ResourceRequests", - "description": "The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required CPU and Memory, the old field cpu and memoryInGB will be deprecated later." - }, - "environmentVariables": { - "description": "Collection of environment variables", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "addonConfigs": { - "description": "Collection of addons", - "type": "object", - "additionalProperties": { - "type": "object" + "value": { + "description": "Collection of BuildpackBinding resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BuildpackBindingResource" } }, - "livenessProbe": { - "$ref": "#/definitions/Probe", - "description": "Periodic probe of App Instance liveness. App Instance will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" - }, - "readinessProbe": { - "$ref": "#/definitions/Probe", - "description": "Periodic probe of App Instance service readiness. App Instance will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" - }, - "startupProbe": { - "$ref": "#/definitions/Probe", - "description": "StartupProbe indicates that the App Instance has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a App Instance's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" - }, - "terminationGracePeriodSeconds": { - "description": "Optional duration in seconds the App Instance needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the App Instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 90 seconds.", - "format": "int32", - "type": "integer", - "default": 90 - }, - "containerProbeSettings": { - "$ref": "#/definitions/ContainerProbeSettings" + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" } } }, - "Probe": { - "description": "Probe describes a health check to be performed against an App Instance to determine whether it is alive or ready to receive traffic.", + "BuildpackBindingResource": { + "description": "Buildpack Binding Resource object", "type": "object", - "required": [ - "disableProbe" + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } ], "properties": { - "probeAction": { - "$ref": "#/definitions/ProbeAction", - "description": "The action of the probe." - }, - "disableProbe": { - "description": "Indicate whether the probe is disabled.", - "type": "boolean", - "default": false - }, - "initialDelaySeconds": { - "description": "Number of seconds after the App Instance has started before probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", - "format": "int32", - "type": "integer" - }, - "periodSeconds": { - "description": "How often (in seconds) to perform the probe. Minimum value is 1.", - "format": "int32", - "type": "integer" - }, - "timeoutSeconds": { - "description": "Number of seconds after which the probe times out. Minimum value is 1.", - "format": "int32", - "type": "integer" - }, - "failureThreshold": { - "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.", - "format": "int32", - "type": "integer" - }, - "successThreshold": { - "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 for liveness and startup. Minimum value is 1.", - "format": "int32", - "type": "integer" + "properties": { + "description": "Properties of a buildpack binding", + "$ref": "#/definitions/BuildpackBindingProperties" } } }, - "ProbeAction": { - "description": "The action of the probe.", - "required": [ - "type" - ], + "BuildpackBindingProperties": { + "description": "Properties of a buildpack binding", "type": "object", "properties": { - "type": { - "description": "The type of the action to take to perform the health check.", + "bindingType": { + "description": "Buildpack Binding Type", "enum": [ - "HTTPGetAction", - "TCPSocketAction", - "ExecAction" + "ApplicationInsights", + "ApacheSkyWalking", + "AppDynamics", + "Dynatrace", + "NewRelic", + "ElasticAPM" ], "type": "string", "x-ms-enum": { - "name": "ProbeActionType", + "name": "bindingType", "modelAsString": true } - } - }, - "discriminator": "type" - }, - "HTTPGetAction": { - "description": "HTTPGetAction describes an action based on HTTP Get requests.", - "properties": { - "path": { - "description": "Path to access on the HTTP server.", - "type": "string" }, - "scheme": { - "description": "Scheme to use for connecting to the host. Defaults to HTTP.\n\nPossible enum values:\n - `\"HTTP\"` means that the scheme used will be http://\n - `\"HTTPS\"` means that the scheme used will be https://", + "provisioningState": { + "description": "State of the Buildpack Binding.", "enum": [ - "HTTP", - "HTTPS" + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" ], "type": "string", + "readOnly": true, "x-ms-enum": { - "name": "HTTPSchemeType", + "name": "BuildpackBindingProvisioningState", "modelAsString": true } + }, + "launchProperties": { + "description": "The object describes the buildpack binding launch properties", + "$ref": "#/definitions/BuildpackBindingLaunchProperties" } - }, - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProbeAction" - } - ], - "x-ms-discriminator-value": "HTTPGetAction" + } }, - "ExecAction": { - "description": "ExecAction describes a \"run in container\" action.", + "BuildpackBindingLaunchProperties": { + "description": "Buildpack Binding Launch Properties", + "type": "object", "properties": { - "command": { - "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.", - "items": { + "properties": { + "description": "Non-sensitive properties for launchProperties", + "type": "object", + "additionalProperties": { "type": "string" - }, - "type": "array", - "x-ms-identifiers": [] + } + }, + "secrets": { + "description": "Sensitive properties for launchProperties", + "type": "object", + "additionalProperties": { + "type": "string" + } } - }, + } + }, + "ApmResourceCollection": { + "description": "Object that includes an array of APM resources and a possible link for next set", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProbeAction" + "properties": { + "value": { + "description": "Collection of APM resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ApmResource" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" } - ], - "x-ms-discriminator-value": "ExecAction" - }, - "TCPSocketAction": { - "description": "TCPSocketAction describes an action based on opening a socket", - "properties": {}, + } + }, + "ApmResource": { + "description": "APM Resource object", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProbeAction" + "$ref": "#/definitions/ProxyResource" } ], - "x-ms-discriminator-value": "TCPSocketAction" - }, - "ContainerProbeSettings": { - "description": "Container liveness and readiness probe settings", - "type": "object", "properties": { - "disableProbe": { - "description": "Indicates whether disable the liveness and readiness probe", - "type": "boolean" + "properties": { + "$ref": "#/definitions/ApmProperties", + "description": "Properties of an APM", + "x-ms-client-flatten": false } } }, - "DeploymentInstance": { - "description": "Deployment instance payload", + "ApmProperties": { + "description": "Properties of an APM", "type": "object", + "required": [ + "type" + ], "properties": { - "name": { - "description": "Name of the deployment instance", - "type": "string", - "readOnly": true - }, - "status": { - "description": "Status of the deployment instance", - "type": "string", - "readOnly": true - }, - "reason": { - "description": "Failed reason of the deployment instance", - "type": "string", - "readOnly": true + "type": { + "description": "APM Type", + "type": "string" }, - "discoveryStatus": { - "description": "Discovery status of the deployment instance", + "provisioningState": { + "description": "State of the APM.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "ApmProvisioningState", + "modelAsString": true + } }, - "startTime": { - "description": "Start time of the deployment instance", - "type": "string", - "readOnly": true + "properties": { + "description": "Non-sensitive properties for the APM", + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "zone": { - "description": "Availability zone information of the deployment instance", - "type": "string", - "readOnly": true + "secrets": { + "description": "Sensitive properties for the APM", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] } } }, - "DeploymentList": { - "description": "A list of deployments resource ids.", + "ApmSecretKeys": { + "description": "Keys of APM sensitive properties", "type": "object", "properties": { - "deployments": { - "description": "A list of deployment resource ids.", + "value": { + "description": "Collection of the keys for the APM sensitive properties", "uniqueItems": false, "type": "array", "items": { @@ -9258,16 +12967,19 @@ } } }, - "DeploymentResourceCollection": { - "description": "Object that includes an array of App resources and a possible link for next set", + "SupportedApmTypes": { + "description": "Supported APM types payload", "type": "object", "properties": { "value": { - "description": "Collection of Deployment resources", + "description": "Collection of the supported APM type", "uniqueItems": false, "type": "array", + "x-ms-identifiers": [ + "name" + ], "items": { - "$ref": "#/definitions/DeploymentResource" + "$ref": "#/definitions/SupportedApmType" } }, "nextLink": { @@ -9276,61 +12988,102 @@ } } }, - "ResourceRequests": { - "description": "Deployment resource request payload", + "SupportedApmType": { + "description": "Supported APM type", "type": "object", "properties": { - "cpu": { - "description": "Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier.", - "type": "string" - }, - "memory": { - "description": "Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier.", + "name": { + "description": "The name of the supported APM type", "type": "string" } } }, - "LogFileUrlResponse": { - "description": "Log file URL payload", + "GloballyEnabledApms": { + "description": "Globally enabled APMs payload", + "type": "object", + "properties": { + "value": { + "description": "Collection of the globally enabled APMs", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ApmReference": { + "description": "A reference to the APM", "required": [ - "url" + "resourceId" ], "type": "object", "properties": { - "url": { - "description": "URL of the log file", - "type": "string" + "resourceId": { + "description": "Resource Id of the APM", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AppPlatform/Spring/apms" + } + ] + } } } }, - "DiagnosticParameters": { - "description": "Diagnostic parameters of diagnostic operations", + "ApmReferenceCollection": { + "description": "Collection of ApmReferences", + "type": "array", + "x-ms-identifiers": [ + "resourceId" + ], + "items": { + "$ref": "#/definitions/ApmReference" + } + }, + "CertificateReference": { + "description": "A reference to the certificate", + "required": [ + "resourceId" + ], "type": "object", "properties": { - "appInstance": { - "description": "App instance name", - "type": "string" - }, - "filePath": { - "description": "Your target file path in your own BYOS", - "type": "string" - }, - "duration": { - "description": "Duration of your JFR. 1 min can be represented by 1m or 60s.", - "type": "string" + "resourceId": { + "description": "Resource Id of the certificate", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AppPlatform/Spring/certificates" + } + ] + } } } }, - "ServiceResourceList": { - "description": "Object that includes an array of Service resources and a possible link for next set", + "CertificateReferenceCollection": { + "description": "Collection of CertificateReferences", + "type": "array", + "x-ms-identifiers": [ + "resourceId" + ], + "items": { + "$ref": "#/definitions/CertificateReference" + } + }, + "GatewayResourceCollection": { + "description": "Object that includes an array of gateway resources and a possible link for next set", "type": "object", "properties": { "value": { - "description": "Collection of Service resources", + "description": "Collection of gateway resources", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/ServiceResource" + "$ref": "#/definitions/GatewayResource" } }, "nextLink": { @@ -9339,419 +13092,421 @@ } } }, - "AvailableOperations": { - "description": "Available operations of the service", + "GatewayResource": { + "description": "Spring Cloud Gateway resource", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], "properties": { - "value": { - "description": "Collection of available operation details", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/OperationDetail" - } + "properties": { + "$ref": "#/definitions/GatewayProperties" }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the Spring Cloud Gateway resource" } } }, - "OperationDetail": { - "description": "Operation detail payload", + "SkuObject": { + "description": "Resource Sku object used for scaling out and scaling in.", "type": "object", "properties": { - "name": { - "description": "Name of the operation", - "type": "string" - }, - "isDataAction": { - "description": "Indicates whether the operation is a data action", - "type": "boolean" - }, - "display": { - "$ref": "#/definitions/OperationDisplay", - "description": "Display of the operation" - }, - "actionType": { - "description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", - "type": "string", - "readOnly": true, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the Spring Cloud Gateway resource" + } + } + }, + "GatewayProperties": { + "description": "Spring Cloud Gateway properties payload", + "type": "object", + "properties": { + "provisioningState": { + "description": "State of the Spring Cloud Gateway.", "enum": [ - "Internal" + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" ], + "type": "string", + "readOnly": true, "x-ms-enum": { - "name": "ActionType", + "name": "GatewayProvisioningState", "modelAsString": true } }, - "origin": { - "description": "Origin of the operation", - "type": "string" + "public": { + "description": "Indicates whether the Spring Cloud Gateway exposes endpoint.", + "type": "boolean", + "default": false + }, + "url": { + "description": "URL of the Spring Cloud Gateway, exposed when 'public' is true.", + "type": "string", + "readOnly": true + }, + "httpsOnly": { + "description": "Indicate if only https is allowed.", + "type": "boolean", + "default": false + }, + "ssoProperties": { + "$ref": "#/definitions/SsoProperties" + }, + "apiMetadataProperties": { + "$ref": "#/definitions/GatewayApiMetadataProperties" + }, + "corsProperties": { + "$ref": "#/definitions/GatewayCorsProperties" + }, + "clientAuth": { + "description": "Client-Certification Authentication.", + "type": "object", + "properties": { + "certificates": { + "description": "Collection of certificate resource Ids in Azure Spring Apps.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "certificateVerification": { + "description": "Whether to enable certificate verification or not", + "type": "string", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "GatewayCertificateVerification", + "values": [ + { + "description": "Enable certificate verification in Spring Cloud Gateway.", + "value": "Enabled" + }, + { + "description": "Disable certificate verification in Spring Cloud Gateway.", + "value": "Disabled" + } + ] + } + } + } + }, + "apms": { + "$ref": "#/definitions/ApmReferenceCollection", + "description": "Collection of ApmReferences in service level" }, - "properties": { - "$ref": "#/definitions/OperationProperties", - "description": "Properties of the operation" - } - } - }, - "OperationDisplay": { - "description": "Operation display payload", - "type": "object", - "properties": { - "provider": { - "description": "Resource provider of the operation", - "type": "string" + "environmentVariables": { + "description": "Environment variables of Spring Cloud Gateway", + "type": "object", + "properties": { + "properties": { + "description": "Non-sensitive properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "secrets": { + "description": "Sensitive properties", + "type": "object", + "x-ms-secret": true, + "additionalProperties": { + "type": "string" + } + } + } }, - "resource": { - "description": "Resource of the operation", - "type": "string" + "resourceRequests": { + "$ref": "#/definitions/GatewayResourceRequests", + "description": "The requested resource quantity for required CPU and Memory." }, - "operation": { - "description": "Localized friendly name for the operation", - "type": "string" + "instances": { + "description": "Collection of instances belong to Spring Cloud Gateway.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GatewayInstance" + }, + "readOnly": true }, - "description": { - "description": "Localized friendly description for the operation", - "type": "string" - } - } - }, - "OperationProperties": { - "description": "Extra Operation properties", - "type": "object", - "properties": { - "serviceSpecification": { - "$ref": "#/definitions/ServiceSpecification", - "description": "Service specifications of the operation" + "operatorProperties": { + "$ref": "#/definitions/GatewayOperatorProperties", + "readOnly": true } } }, - "ServiceSpecification": { - "description": "Service specification payload", + "SsoProperties": { + "description": "Single sign-on related configuration", "type": "object", "properties": { - "logSpecifications": { - "description": "Specifications of the Log for Azure Monitoring", + "scope": { + "description": "It defines the specific actions applications can be allowed to do on a user's behalf", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/LogSpecification" + "type": "string" } }, - "metricSpecifications": { - "description": "Specifications of the Metrics for Azure Monitoring", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/MetricSpecification" - } - } - } - }, - "LogSpecification": { - "description": "Specifications of the Log for Azure Monitoring", - "type": "object", - "properties": { - "name": { - "description": "Name of the log", + "clientId": { + "description": "The public identifier for the application", "type": "string" }, - "displayName": { - "description": "Localized friendly display name of the log", + "clientSecret": { + "description": "The secret known only to the application and the authorization server", "type": "string" }, - "blobDuration": { - "description": "Blob duration of the log", + "issuerUri": { + "description": "The URI of Issuer Identifier", "type": "string" } } }, - "MetricSpecification": { - "description": "Specifications of the Metrics for Azure Monitoring", + "GatewayApiMetadataProperties": { + "description": "API metadata property for Spring Cloud Gateway", "type": "object", "properties": { - "name": { - "description": "Name of the metric", + "title": { + "description": "Title describing the context of the APIs available on the Gateway instance (default: `Spring Cloud Gateway for K8S`)", "type": "string" }, - "displayName": { - "description": "Localized friendly display name of the metric", + "description": { + "description": "Detailed description of the APIs available on the Gateway instance (default: `Generated OpenAPI 3 document that describes the API routes configured.`)", "type": "string" }, - "displayDescription": { - "description": "Localized friendly description of the metric", + "documentation": { + "description": "Location of additional documentation for the APIs available on the Gateway instance", "type": "string" }, - "unit": { - "description": "Unit that makes sense for the metric", + "version": { + "description": "Version of APIs available on this Gateway instance (default: `unspecified`).", "type": "string" }, - "category": { - "description": "Name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "serverUrl": { + "description": "Base URL that API consumers will use to access APIs on the Gateway instance.", "type": "string" + } + } + }, + "GatewayCorsProperties": { + "description": "Cross-Origin Resource Sharing property", + "type": "object", + "properties": { + "allowedOrigins": { + "description": "Allowed origins to make cross-site requests. The special value `*` allows all domains.", + "type": "array", + "items": { + "type": "string" + } }, - "aggregationType": { - "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", - "type": "string" + "allowedOriginPatterns": { + "description": "Allowed origin patterns to make cross-site requests.", + "type": "array", + "items": { + "type": "string" + } }, - "supportedAggregationTypes": { - "description": "Supported aggregation types", - "uniqueItems": false, + "allowedMethods": { + "description": "Allowed HTTP methods on cross-site requests. The special value `*` allows all methods. If not set, `GET` and `HEAD` are allowed by default.", "type": "array", "items": { "type": "string" } }, - "supportedTimeGrainTypes": { - "description": "Supported time grain types", - "uniqueItems": false, + "allowedHeaders": { + "description": "Allowed headers in cross-site requests. The special value `*` allows actual requests to send any header.", "type": "array", "items": { "type": "string" } }, - "fillGapWithZero": { - "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.", + "maxAge": { + "format": "int32", + "description": "How long, in seconds, the response from a pre-flight request can be cached by clients.", + "type": "integer" + }, + "allowCredentials": { + "description": "Whether user credentials are supported on cross-site requests. Valid values: `true`, `false`.", "type": "boolean" }, - "dimensions": { - "description": "Dimensions of the metric", - "uniqueItems": false, + "exposedHeaders": { + "description": "HTTP response headers to expose for cross-site requests.", "type": "array", "items": { - "$ref": "#/definitions/MetricDimension" + "type": "string" } - }, - "sourceMdmNamespace": { - "description": "Name of the MDM namespace. Optional.", - "type": "string" } } }, - "MetricDimension": { - "description": "Specifications of the Dimension of metrics", + "GatewayResourceRequests": { + "description": "Resource request payload of Spring Cloud Gateway.", "type": "object", "properties": { - "name": { - "description": "Name of the dimension", - "type": "string" - }, - "displayName": { - "description": "Localized friendly display name of the dimension", - "type": "string" + "cpu": { + "description": "Cpu allocated to each Spring Cloud Gateway instance.", + "type": "string", + "default": "1" }, - "toBeExportedForShoebox": { - "description": "Whether this dimension should be included for the Shoebox export scenario", - "type": "boolean" + "memory": { + "description": "Memory allocated to each Spring Cloud Gateway instance.", + "type": "string", + "default": "2Gi" } } }, - "ResourceSkuCollection": { - "description": "Object that includes an array of Azure Spring Apps SKU and a possible link for next set", + "GatewayOperatorProperties": { + "description": "Properties of the Spring Cloud Gateway Operator.", "type": "object", + "readOnly": true, "properties": { - "value": { - "description": "Collection of resource SKU", + "resourceRequests": { + "$ref": "#/definitions/GatewayOperatorResourceRequests", + "description": "The requested resource quantity for required CPU and Memory." + }, + "instances": { + "description": "Collection of instances belong to Spring Cloud Gateway operator.", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/ResourceSku" - } - }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" + "$ref": "#/definitions/GatewayInstance" + }, + "readOnly": true } } }, - "ResourceSku": { - "description": "Describes an available Azure Spring Apps SKU.", + "GatewayOperatorResourceRequests": { + "description": "Properties of the Spring Cloud Gateway Operator.", "type": "object", + "readOnly": true, "properties": { - "resourceType": { - "description": "Gets the type of resource the SKU applies to.", - "type": "string" - }, - "name": { - "description": "Gets the name of SKU.", - "type": "string" - }, - "tier": { - "description": "Gets the tier of SKU.", - "type": "string" - }, - "capacity": { - "$ref": "#/definitions/SkuCapacity", - "description": "Gets the capacity of SKU." - }, - "locations": { - "description": "Gets the set of locations that the SKU is available.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } + "cpu": { + "description": "Cpu allocated to each Spring Cloud Gateway Operator instance.", + "type": "string", + "readOnly": true }, - "locationInfo": { - "description": "Gets a list of locations and availability zones in those locations where the SKU is available.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ResourceSkuLocationInfo" - } + "memory": { + "description": "Memory allocated to each Spring Cloud Gateway Operator instance.", + "type": "string", + "readOnly": true }, - "restrictions": { - "description": "Gets the restrictions because of which SKU cannot be used. This is\r\nempty if there are no restrictions.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ResourceSkuRestrictions" - } + "instanceCount": { + "format": "int32", + "description": "Instance count of the Spring Cloud Gateway Operator.", + "type": "integer", + "readOnly": true } } }, - "SkuCapacity": { - "description": "The SKU capacity", - "required": [ - "minimum" - ], + "GatewayInstance": { + "description": "Collection of instances belong to the Spring Cloud Gateway", "type": "object", + "readOnly": true, "properties": { - "minimum": { - "format": "int32", - "description": "Gets or sets the minimum.", - "type": "integer" - }, - "maximum": { - "format": "int32", - "description": "Gets or sets the maximum.", - "type": "integer" - }, - "default": { - "format": "int32", - "description": "Gets or sets the default.", - "type": "integer" + "name": { + "description": "Name of the Spring Cloud Gateway instance", + "type": "string", + "readOnly": true }, - "scaleType": { - "description": "Gets or sets the type of the scale.", - "enum": [ - "None", - "Manual", - "Automatic" - ], + "status": { + "description": "Status of the Spring Cloud Gateway instance", "type": "string", - "x-ms-enum": { - "name": "SkuScaleType", - "modelAsString": true - } + "readOnly": true } } }, - "ResourceSkuLocationInfo": { - "description": "Locations and availability zones where the SKU is available", + "GatewayEnvSecrets": { + "description": "Sensitive properties for Spring Cloud Gateway", + "type": "object", + "x-ms-secret": true, + "additionalProperties": { + "type": "string" + } + }, + "GatewayRouteConfigResource": { + "description": "Spring Cloud Gateway route config resource", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], "properties": { - "location": { - "description": "Gets location of the SKU", - "type": "string" - }, - "zones": { - "description": "Gets list of availability zones where the SKU is supported.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "zoneDetails": { - "description": "Gets details of capabilities available to a SKU in specific zones.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ResourceSkuZoneDetails" - } + "properties": { + "$ref": "#/definitions/GatewayRouteConfigProperties" } } }, - "ResourceSkuRestrictions": { - "description": "Restrictions where the SKU cannot be used", + "GatewayRouteConfigProperties": { + "description": "API route config of the Spring Cloud Gateway", "type": "object", "properties": { - "type": { - "description": "Gets the type of restrictions. Possible values include: 'Location', 'Zone'", + "provisioningState": { + "description": "State of the Spring Cloud Gateway route config.", "enum": [ - "Location", - "Zone" + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" ], "type": "string", + "readOnly": true, "x-ms-enum": { - "name": "ResourceSkuRestrictionsType", + "name": "GatewayProvisioningState", "modelAsString": true } }, - "values": { - "description": "Gets the value of restrictions. If the restriction type is set to\r\nlocation. This would be different locations where the SKU is restricted.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } + "appResourceId": { + "description": "The resource Id of the Azure Spring Apps app, required unless route defines `uri`.", + "type": "string" }, - "restrictionInfo": { - "$ref": "#/definitions/ResourceSkuRestrictionInfo", - "description": "Gets the information about the restriction where the SKU cannot be used." + "openApi": { + "$ref": "#/definitions/GatewayRouteConfigOpenApiProperties" }, - "reasonCode": { - "description": "Gets the reason for restriction. Possible values include: 'QuotaId', 'NotAvailableForSubscription'", + "protocol": { + "description": "Protocol of routed Azure Spring Apps applications.", "enum": [ - "QuotaId", - "NotAvailableForSubscription" + "HTTP", + "HTTPS" ], + "default": "HTTP", "type": "string", "x-ms-enum": { - "name": "ResourceSkuRestrictionsReasonCode", + "name": "GatewayRouteConfigProtocol", "modelAsString": true } - } - } - }, - "ResourceSkuZoneDetails": { - "description": "Details of capabilities available to a SKU in specific zones", - "type": "object", - "properties": { - "name": { - "description": "Gets the set of zones that the SKU is available in with the\r\nspecified capabilities.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } }, - "capabilities": { - "description": "Gets a list of capabilities that are available for the SKU in the\r\nspecified list of zones.", + "routes": { + "description": "Array of API routes, each route contains properties such as `title`, `uri`, `ssoEnabled`, `predicates`, `filters`.", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/ResourceSkuCapabilities" + "$ref": "#/definitions/GatewayApiRoute" } - } - } - }, - "ResourceSkuRestrictionInfo": { - "description": "Information about the restriction where the SKU cannot be used", - "type": "object", - "properties": { - "locations": { - "description": "Gets locations where the SKU is restricted", + }, + "ssoEnabled": { + "description": "Enable Single Sign-On in app level.", + "type": "boolean" + }, + "predicates": { + "description": "A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.", "uniqueItems": false, "type": "array", "items": { "type": "string" } }, - "zones": { - "description": "Gets list of availability zones where the SKU is restricted.", + "filters": { + "description": "To modify the request before sending it to the target endpoint, or the received response in app level.", "uniqueItems": false, "type": "array", "items": { @@ -9760,118 +13515,81 @@ } } }, - "ResourceSkuCapabilities": { + "GatewayRouteConfigOpenApiProperties": { + "description": "OpenAPI properties of Spring Cloud Gateway route config.", "type": "object", "properties": { - "name": { - "description": "Gets an invariant to describe the feature.", - "type": "string" - }, - "value": { - "description": "Gets an invariant if the feature is measured by quantity.", + "uri": { + "description": "The URI of OpenAPI specification.", "type": "string" } } }, - "CloudError": { - "type": "object", - "description": "An error response from the service.", - "properties": { - "error": { - "description": "An error response from the service.", - "$ref": "#/definitions/CloudErrorBody" - } - }, - "x-ms-external": true - }, - "CloudErrorBody": { + "GatewayApiRoute": { + "description": "API route config of the Spring Cloud Gateway", "type": "object", - "description": "An error response from the service.", "properties": { - "code": { - "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", + "title": { + "description": "A title, will be applied to methods in the generated OpenAPI documentation.", "type": "string" }, - "message": { - "description": "A message describing the error, intended to be suitable for display in a user interface.", + "description": { + "description": "A description, will be applied to methods in the generated OpenAPI documentation.", "type": "string" }, - "target": { - "description": "The target of the particular error. For example, the name of the property in error.", + "uri": { + "description": "Full uri, will override `appName`.", "type": "string" }, - "details": { - "description": "A list of additional details about the error.", + "ssoEnabled": { + "description": "Enable sso validation.", + "type": "boolean" + }, + "tokenRelay": { + "description": "Pass currently-authenticated user's identity token to application service, default is 'false'", + "type": "boolean" + }, + "predicates": { + "description": "A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.", + "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/CloudErrorBody" + "type": "string" } - } - }, - "x-ms-external": true - }, - "AvailableRuntimeVersions": { - "type": "object", - "properties": { - "value": { - "description": "A list of all supported runtime versions.", + }, + "filters": { + "description": "To modify the request before sending it to the target endpoint, or the received response.", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/SupportedRuntimeVersion" - }, - "readOnly": true - } - }, - "readOnly": true - }, - "SupportedRuntimeVersion": { - "description": "Supported deployment runtime version descriptor.", - "type": "object", - "properties": { - "value": { - "description": "The raw value which could be passed to deployment CRUD operations.", - "enum": [ - "Java_8", - "Java_11", - "Java_17", - "NetCore_31" - ], - "type": "string", - "x-ms-enum": { - "name": "SupportedRuntimeValue", - "modelAsString": true + "type": "string" } }, - "platform": { - "description": "The platform of this runtime version (possible values: \"Java\" or \".NET\").", - "enum": [ - "Java", - ".NET Core" - ], - "type": "string", - "x-ms-enum": { - "name": "SupportedRuntimePlatform", - "modelAsString": true - } + "order": { + "description": "Route processing order.", + "type": "integer", + "format": "int32" }, - "version": { - "description": "The detailed version (major.minor) of the platform.", - "type": "string" + "tags": { + "description": "Classification tags, will be applied to methods in the generated OpenAPI documentation.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } } - }, - "readOnly": true + } }, - "BuildpackBindingResourceCollection": { - "description": "Object that includes an array of BuildpackBinding resources and a possible link for next set", + "GatewayRouteConfigResourceCollection": { + "description": "Object that includes an array of Spring Cloud Gateway route config resources and a possible link for next set", "type": "object", "properties": { "value": { - "description": "Collection of BuildpackBinding resources", + "description": "Collection of Spring Cloud Gateway route config resources", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/BuildpackBindingResource" + "$ref": "#/definitions/GatewayRouteConfigResource" } }, "nextLink": { @@ -9880,8 +13598,8 @@ } } }, - "BuildpackBindingResource": { - "description": "Buildpack Binding Resource object", + "GatewayCustomDomainResource": { + "description": "Custom domain of the Spring Cloud Gateway", "type": "object", "allOf": [ { @@ -9890,83 +13608,48 @@ ], "properties": { "properties": { - "description": "Properties of a buildpack binding", - "$ref": "#/definitions/BuildpackBindingProperties" + "$ref": "#/definitions/GatewayCustomDomainProperties" } } }, - "BuildpackBindingProperties": { - "description": "Properties of a buildpack binding", + "GatewayCustomDomainProperties": { + "description": "The properties of custom domain for Spring Cloud Gateway", "type": "object", "properties": { - "bindingType": { - "description": "Buildpack Binding Type", - "enum": [ - "ApplicationInsights", - "ApacheSkyWalking", - "AppDynamics", - "Dynatrace", - "NewRelic", - "ElasticAPM" - ], - "type": "string", - "x-ms-enum": { - "name": "bindingType", - "modelAsString": true - } - }, - "provisioningState": { - "description": "State of the Buildpack Binding.", - "enum": [ - "Creating", - "Updating", - "Succeeded", - "Failed", - "Deleting" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BuildpackBindingProvisioningState", - "modelAsString": true - } - }, - "launchProperties": { - "description": "The object describes the buildpack binding launch properties", - "$ref": "#/definitions/BuildpackBindingLaunchProperties" + "thumbprint": { + "description": "The thumbprint of bound certificate.", + "type": "string" } } }, - "BuildpackBindingLaunchProperties": { - "description": "Buildpack Binding Launch Properties", + "GatewayCustomDomainResourceCollection": { + "description": "Object that includes an array of Spring Cloud Gateway custom domain resources and a possible link for next set", "type": "object", "properties": { - "properties": { - "description": "Non-sensitive properties for launchProperties", - "type": "object", - "additionalProperties": { - "type": "string" + "value": { + "description": "Collection of Spring Cloud Gateway custom domain resources", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/GatewayCustomDomainResource" } }, - "secrets": { - "description": "Sensitive properties for launchProperties", - "type": "object", - "additionalProperties": { - "type": "string" - } + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" } } }, - "GatewayResourceCollection": { - "description": "Object that includes an array of gateway resources and a possible link for next set", + "ApiPortalResourceCollection": { + "description": "Object that includes an array of API portal resources and a possible link for next set", "type": "object", "properties": { "value": { - "description": "Collection of gateway resources", + "description": "Collection of API portal resources", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/GatewayResource" + "$ref": "#/definitions/ApiPortalResource" } }, "nextLink": { @@ -9975,8 +13658,8 @@ } } }, - "GatewayResource": { - "description": "Spring Cloud Gateway resource", + "ApiPortalResource": { + "description": "API portal resource", "type": "object", "allOf": [ { @@ -9985,20 +13668,20 @@ ], "properties": { "properties": { - "$ref": "#/definitions/GatewayProperties" + "$ref": "#/definitions/ApiPortalProperties" }, "sku": { "$ref": "#/definitions/Sku", - "description": "Sku of the Spring Cloud Gateway resource" + "description": "Sku of the API portal resource" } } }, - "GatewayProperties": { - "description": "Spring Cloud Gateway properties payload", + "ApiPortalProperties": { + "description": "API portal properties payload", "type": "object", "properties": { "provisioningState": { - "description": "State of the Spring Cloud Gateway.", + "description": "State of the API portal.", "enum": [ "Creating", "Updating", @@ -10009,17 +13692,17 @@ "type": "string", "readOnly": true, "x-ms-enum": { - "name": "GatewayProvisioningState", + "name": "ApiPortalProvisioningState", "modelAsString": true } }, "public": { - "description": "Indicates whether the Spring Cloud Gateway exposes endpoint.", + "description": "Indicates whether the API portal exposes endpoint.", "type": "boolean", "default": false }, "url": { - "description": "URL of the Spring Cloud Gateway, exposed when 'public' is true.", + "description": "URL of the API portal, exposed when 'public' is true.", "type": "string", "readOnly": true }, @@ -10028,207 +13711,271 @@ "type": "boolean", "default": false }, - "ssoProperties": { - "$ref": "#/definitions/SsoProperties" + "gatewayIds": { + "description": "The array of resource Ids of gateway to integrate with API portal.", + "type": "array", + "items": { + "type": "string" + } }, - "apiMetadataProperties": { - "$ref": "#/definitions/GatewayApiMetadataProperties" + "sourceUrls": { + "description": "Collection of OpenAPI source URL locations.", + "type": "array", + "items": { + "type": "string" + } }, - "corsProperties": { - "$ref": "#/definitions/GatewayCorsProperties" + "ssoProperties": { + "$ref": "#/definitions/SsoProperties" }, "resourceRequests": { - "$ref": "#/definitions/GatewayResourceRequests", - "description": "The requested resource quantity for required CPU and Memory." + "$ref": "#/definitions/ApiPortalResourceRequests", + "description": "The requested resource quantity for required CPU and Memory.", + "readOnly": true }, "instances": { - "description": "Collection of instances belong to Spring Cloud Gateway.", + "description": "Collection of instances belong to API portal.", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/GatewayInstance" + "$ref": "#/definitions/ApiPortalInstance" }, "readOnly": true }, - "operatorProperties": { - "$ref": "#/definitions/GatewayOperatorProperties", - "readOnly": true + "apiTryOutEnabledState": { + "description": "Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.", + "type": "string", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ApiPortalApiTryOutEnabledState", + "modelAsString": true + } } } }, - "SsoProperties": { - "description": "Single sign-on related configuration", + "ApiPortalResourceRequests": { + "description": "Resource requests of the API portal", "type": "object", "properties": { - "scope": { - "description": "It defines the specific actions applications can be allowed to do on a user's behalf", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "clientId": { - "description": "The public identifier for the application", - "type": "string" - }, - "clientSecret": { - "description": "The secret known only to the application and the authorization server", - "type": "string" + "cpu": { + "description": "Cpu allocated to each API portal instance", + "type": "string", + "readOnly": true }, - "issuerUri": { - "description": "The URI of Issuer Identifier", - "type": "string" + "memory": { + "description": "Memory allocated to each API portal instance", + "type": "string", + "readOnly": true } } }, - "GatewayApiMetadataProperties": { - "description": "API metadata property for Spring Cloud Gateway", + "ApiPortalInstance": { + "description": "Collection of instances belong to the API portal", "type": "object", "properties": { - "title": { - "description": "Title describing the context of the APIs available on the Gateway instance (default: `Spring Cloud Gateway for K8S`)", - "type": "string" - }, - "description": { - "description": "Detailed description of the APIs available on the Gateway instance (default: `Generated OpenAPI 3 document that describes the API routes configured.`)", - "type": "string" - }, - "documentation": { - "description": "Location of additional documentation for the APIs available on the Gateway instance", - "type": "string" - }, - "version": { - "description": "Version of APIs available on this Gateway instance (default: `unspecified`).", - "type": "string" + "name": { + "description": "Name of the API portal instance", + "type": "string", + "readOnly": true }, - "serverUrl": { - "description": "Base URL that API consumers will use to access APIs on the Gateway instance.", + "status": { + "description": "Status of the API portal instance", + "type": "string", + "readOnly": true + } + } + }, + "ApiPortalCustomDomainResource": { + "description": "Custom domain of the API portal", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ApiPortalCustomDomainProperties" + } + } + }, + "ApiPortalCustomDomainProperties": { + "description": "The properties of custom domain for API portal", + "type": "object", + "properties": { + "thumbprint": { + "description": "The thumbprint of bound certificate.", "type": "string" } } }, - "GatewayCorsProperties": { - "description": "Cross-Origin Resource Sharing property", + "ApiPortalCustomDomainResourceCollection": { + "description": "Object that includes an array of API portal custom domain resources and a possible link for next set", "type": "object", "properties": { - "allowedOrigins": { - "description": "Allowed origins to make cross-site requests. The special value `*` allows all domains.", - "type": "array", - "items": { - "type": "string" - } - }, - "allowedMethods": { - "description": "Allowed HTTP methods on cross-site requests. The special value `*` allows all methods. If not set, `GET` and `HEAD` are allowed by default.", + "value": { + "description": "Collection of API portal custom domain resources", + "uniqueItems": false, "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/ApiPortalCustomDomainResource" } }, - "allowedHeaders": { - "description": "Allowed headers in cross-site requests. The special value `*` allows actual requests to send any header.", + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ApplicationAcceleratorResourceCollection": { + "description": "Object that includes an array of application accelerator resources and a possible link for next set", + "type": "object", + "properties": { + "value": { + "description": "Collection of application accelerator resources", + "uniqueItems": false, "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/ApplicationAcceleratorResource" } }, - "maxAge": { - "format": "int32", - "description": "How long, in seconds, the response from a pre-flight request can be cached by clients.", - "type": "integer" - }, - "allowCredentials": { - "description": "Whether user credentials are supported on cross-site requests. Valid values: `true`, `false`.", - "type": "boolean" + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "ApplicationAcceleratorResource": { + "description": "Application accelerator resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationAcceleratorProperties" }, - "exposedHeaders": { - "description": "HTTP response headers to expose for cross-site requests.", - "type": "array", - "items": { - "type": "string" - } + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the application accelerator resource" } } }, - "GatewayResourceRequests": { - "description": "Resource request payload of Spring Cloud Gateway.", + "ApplicationAcceleratorProperties": { + "description": "Application accelerator properties payload", "type": "object", "properties": { - "cpu": { - "description": "Cpu allocated to each Spring Cloud Gateway instance.", + "provisioningState": { + "description": "State of the application accelerator.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], "type": "string", - "default": "1" + "readOnly": true, + "x-ms-enum": { + "name": "ApplicationAcceleratorProvisioningState", + "modelAsString": true + } }, - "memory": { - "description": "Memory allocated to each Spring Cloud Gateway instance.", - "type": "string", - "default": "2Gi" + "components": { + "description": "Collection of components belong to application accelerator.", + "uniqueItems": false, + "type": "array", + "x-ms-identifiers": [ + "name" + ], + "items": { + "$ref": "#/definitions/ApplicationAcceleratorComponent" + }, + "readOnly": true } } }, - "GatewayOperatorProperties": { - "description": "Properties of the Spring Cloud Gateway Operator.", + "ApplicationAcceleratorComponent": { "type": "object", - "readOnly": true, "properties": { + "name": { + "type": "string", + "readOnly": true + }, "resourceRequests": { - "$ref": "#/definitions/GatewayOperatorResourceRequests", - "description": "The requested resource quantity for required CPU and Memory." + "$ref": "#/definitions/ApplicationAcceleratorResourceRequests" }, "instances": { - "description": "Collection of instances belong to Spring Cloud Gateway operator.", - "uniqueItems": false, "type": "array", + "x-ms-identifiers": [ + "name" + ], "items": { - "$ref": "#/definitions/GatewayInstance" + "$ref": "#/definitions/ApplicationAcceleratorInstance" }, "readOnly": true } } }, - "GatewayOperatorResourceRequests": { - "description": "Properties of the Spring Cloud Gateway Operator.", + "ApplicationAcceleratorResourceRequests": { "type": "object", - "readOnly": true, "properties": { "cpu": { - "description": "Cpu allocated to each Spring Cloud Gateway Operator instance.", + "description": "Cpu allocated to each application accelerator component. 1 core can be represented by 1 or 1000m", "type": "string", "readOnly": true }, "memory": { - "description": "Memory allocated to each Spring Cloud Gateway Operator instance.", + "description": "Memory allocated to each application accelerator component. 1 GB can be represented by 1Gi or 1024Mi.", "type": "string", "readOnly": true }, "instanceCount": { "format": "int32", - "description": "Instance count of the Spring Cloud Gateway Operator.", + "description": "Instance count of the application accelerator component.", "type": "integer", "readOnly": true } } }, - "GatewayInstance": { - "description": "Collection of instances belong to the Spring Cloud Gateway", + "ApplicationAcceleratorInstance": { "type": "object", - "readOnly": true, "properties": { "name": { - "description": "Name of the Spring Cloud Gateway instance", + "description": "Name of the Application Accelerator instance.", "type": "string", "readOnly": true }, "status": { - "description": "Status of the Spring Cloud Gateway instance", + "description": "Status of the Application Accelerator instance. It can be Pending, Running, Succeeded, Failed, Unknown.", "type": "string", "readOnly": true } } }, - "GatewayRouteConfigResource": { - "description": "Spring Cloud Gateway route config resource", + "CustomizedAcceleratorResourceCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomizedAcceleratorResource" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "CustomizedAcceleratorResource": { + "description": "Customized accelerator resource", "type": "object", "allOf": [ { @@ -10237,205 +13984,294 @@ ], "properties": { "properties": { - "$ref": "#/definitions/GatewayRouteConfigProperties" + "$ref": "#/definitions/CustomizedAcceleratorProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the customized accelerator resource" } } }, - "GatewayRouteConfigProperties": { - "description": "API route config of the Spring Cloud Gateway", + "CustomizedAcceleratorProperties": { + "description": "Customized accelerator properties payload", + "required": [ + "gitRepository" + ], "type": "object", "properties": { "provisioningState": { - "description": "State of the Spring Cloud Gateway route config.", + "description": "State of the customized accelerator.", "enum": [ "Creating", "Updating", "Succeeded", "Failed", - "Deleting" + "Deleting", + "Canceled" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "GatewayProvisioningState", + "name": "CustomizedAcceleratorProvisioningState", "modelAsString": true } }, - "appResourceId": { - "description": "The resource Id of the Azure Spring Apps app, required unless route defines `uri`.", - "type": "string" - }, - "openApi": { - "$ref": "#/definitions/GatewayRouteConfigOpenApiProperties" - }, - "protocol": { - "description": "Protocol of routed Azure Spring Apps applications.", + "acceleratorType": { + "description": "Type of the customized accelerator.", "enum": [ - "HTTP", - "HTTPS" + "Accelerator", + "Fragment" ], - "default": "HTTP", "type": "string", "x-ms-enum": { - "name": "GatewayRouteConfigProtocol", + "name": "CustomizedAcceleratorType", "modelAsString": true } }, - "routes": { - "description": "Array of API routes, each route contains properties such as `title`, `uri`, `ssoEnabled`, `predicates`, `filters`.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/GatewayApiRoute" - } - } - } - }, - "GatewayRouteConfigOpenApiProperties": { - "description": "OpenAPI properties of Spring Cloud Gateway route config.", - "type": "object", - "properties": { - "uri": { - "description": "The URI of OpenAPI specification.", - "type": "string" - } - } - }, - "GatewayApiRoute": { - "description": "API route config of the Spring Cloud Gateway", - "type": "object", - "properties": { - "title": { - "description": "A title, will be applied to methods in the generated OpenAPI documentation.", + "displayName": { "type": "string" }, "description": { - "description": "A description, will be applied to methods in the generated OpenAPI documentation.", "type": "string" }, - "uri": { - "description": "Full uri, will override `appName`.", + "iconUrl": { "type": "string" }, - "ssoEnabled": { - "description": "Enable sso validation.", - "type": "boolean" - }, - "tokenRelay": { - "description": "Pass currently-authenticated user's identity token to application service, default is 'false'", - "type": "boolean" - }, - "predicates": { - "description": "A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.", - "uniqueItems": false, + "acceleratorTags": { "type": "array", "items": { "type": "string" } }, - "filters": { - "description": "To modify the request before sending it to the target endpoint, or the received response.", - "uniqueItems": false, + "imports": { "type": "array", + "readOnly": true, + "description": "Imports references all imports that this accelerator/fragment depends upon.", "items": { "type": "string" } }, - "order": { - "description": "Route processing order.", - "type": "integer", - "format": "int32" + "gitRepository": { + "$ref": "#/definitions/AcceleratorGitRepository" + } + } + }, + "AcceleratorGitRepository": { + "required": [ + "url", + "authSetting" + ], + "type": "object", + "properties": { + "url": { + "description": "Git repository URL for the accelerator.", + "type": "string" }, - "tags": { - "description": "Classification tags, will be applied to methods in the generated OpenAPI documentation.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } + "intervalInSeconds": { + "description": "Interval for checking for updates to Git or image repository.", + "format": "int32", + "type": "integer" + }, + "branch": { + "description": "Git repository branch to be used.", + "type": "string" + }, + "commit": { + "description": "Git repository commit to be used.", + "type": "string" + }, + "gitTag": { + "description": "Git repository tag to be used.", + "type": "string" + }, + "authSetting": { + "$ref": "#/definitions/AcceleratorAuthSetting", + "description": "Properties of the auth setting payload.", + "x-ms-client-flatten": false + }, + "subPath": { + "description": "Folder path inside the git repository to consider as the root of the accelerator or fragment.", + "type": "string" } } }, - "GatewayRouteConfigResourceCollection": { - "description": "Object that includes an array of Spring Cloud Gateway route config resources and a possible link for next set", + "AcceleratorAuthSetting": { + "description": "Auth setting payload.", + "required": [ + "authType" + ], "type": "object", "properties": { - "value": { - "description": "Collection of Spring Cloud Gateway route config resources", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/GatewayRouteConfigResource" + "authType": { + "description": "The type of the auth setting.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "authType" + }, + "AcceleratorPublicSetting": { + "description": "Auth setting for public url.", + "required": [ + "authType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcceleratorAuthSetting" + } + ], + "properties": { + "caCertResourceId": { + "description": "Resource Id of CA certificate for https URL of Git repository.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AppPlatform/Spring/certificates" + } + ] } - }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" } - } + }, + "x-ms-discriminator-value": "Public" }, - "GatewayCustomDomainResource": { - "description": "Custom domain of the Spring Cloud Gateway", + "AcceleratorBasicAuthSetting": { + "description": "Auth setting for basic auth.", + "required": [ + "authType", + "username" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "#/definitions/AcceleratorAuthSetting" } ], "properties": { - "properties": { - "$ref": "#/definitions/GatewayCustomDomainProperties" + "caCertResourceId": { + "description": "Resource Id of CA certificate for https URL of Git repository.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AppPlatform/Spring/certificates" + } + ] + } + }, + "username": { + "description": "Username of git repository basic auth.", + "type": "string" + }, + "password": { + "description": "Password of git repository basic auth.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] } - } + }, + "x-ms-discriminator-value": "BasicAuth" }, - "GatewayCustomDomainProperties": { - "description": "The properties of custom domain for Spring Cloud Gateway", + "AcceleratorSshSetting": { + "description": "Auth setting for SSH auth.", + "required": [ + "authType" + ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcceleratorAuthSetting" + } + ], "properties": { - "thumbprint": { - "description": "The thumbprint of bound certificate.", - "type": "string" + "hostKey": { + "description": "Public SSH Key of git repository.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "hostKeyAlgorithm": { + "description": "SSH Key algorithm of git repository.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "privateKey": { + "description": "Private SSH Key algorithm of git repository.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] } - } + }, + "x-ms-discriminator-value": "SSH" }, - "GatewayCustomDomainResourceCollection": { - "description": "Object that includes an array of Spring Cloud Gateway custom domain resources and a possible link for next set", + "CustomizedAcceleratorValidateResult": { + "description": "Validation result for customized accelerator properties", "type": "object", "properties": { - "value": { - "description": "Collection of Spring Cloud Gateway custom domain resources", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/GatewayCustomDomainResource" + "state": { + "type": "string", + "description": "State of the customized accelerator validation result", + "default": "Valid", + "enum": [ + "Valid", + "Invalid" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "CustomizedAcceleratorValidateResultState", + "values": [ + { + "description": "Customized accelerator properties are valid.", + "value": "Valid" + }, + { + "description": "Customized accelerator properties are invalid.", + "value": "Invalid" + } + ] } }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "errorMessage": { + "description": "The detail validation results", "type": "string" } } }, - "ApiPortalResourceCollection": { - "description": "Object that includes an array of API portal resources and a possible link for next set", + "PredefinedAcceleratorResourceCollection": { "type": "object", "properties": { "value": { - "description": "Collection of API portal resources", - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/ApiPortalResource" + "$ref": "#/definitions/PredefinedAcceleratorResource" } }, "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", "type": "string" } } }, - "ApiPortalResource": { - "description": "API portal resource", + "PredefinedAcceleratorResource": { + "description": "Predefined accelerator resource", "type": "object", "allOf": [ { @@ -10444,153 +14280,75 @@ ], "properties": { "properties": { - "$ref": "#/definitions/ApiPortalProperties" + "$ref": "#/definitions/PredefinedAcceleratorProperties" }, "sku": { "$ref": "#/definitions/Sku", - "description": "Sku of the API portal resource" + "description": "Sku of the predefined accelerator resource" } } }, - "ApiPortalProperties": { - "description": "API portal properties payload", + "PredefinedAcceleratorProperties": { + "description": "Predefined accelerator properties payload", "type": "object", "properties": { "provisioningState": { - "description": "State of the API portal.", + "description": "Provisioning state of the predefined accelerator.", "enum": [ "Creating", "Updating", "Succeeded", "Failed", - "Deleting" + "Canceled" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "ApiPortalProvisioningState", + "name": "PredefinedAcceleratorProvisioningState", "modelAsString": true } }, - "public": { - "description": "Indicates whether the API portal exposes endpoint.", - "type": "boolean", - "default": false - }, - "url": { - "description": "URL of the API portal, exposed when 'public' is true.", + "displayName": { "type": "string", "readOnly": true }, - "httpsOnly": { - "description": "Indicate if only https is allowed.", - "type": "boolean", - "default": false - }, - "gatewayIds": { - "description": "The array of resource Ids of gateway to integrate with API portal.", - "type": "array", - "items": { - "type": "string" - } - }, - "sourceUrls": { - "description": "Collection of OpenAPI source URL locations.", - "type": "array", - "items": { - "type": "string" - } - }, - "ssoProperties": { - "$ref": "#/definitions/SsoProperties" - }, - "resourceRequests": { - "$ref": "#/definitions/ApiPortalResourceRequests", - "description": "The requested resource quantity for required CPU and Memory.", - "readOnly": true - }, - "instances": { - "description": "Collection of instances belong to API portal.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ApiPortalInstance" - }, - "readOnly": true - } - } - }, - "ApiPortalResourceRequests": { - "description": "Resource requests of the API portal", - "type": "object", - "properties": { - "cpu": { - "description": "Cpu allocated to each API portal instance", + "description": { "type": "string", "readOnly": true }, - "memory": { - "description": "Memory allocated to each API portal instance", - "type": "string", - "readOnly": true - } - } - }, - "ApiPortalInstance": { - "description": "Collection of instances belong to the API portal", - "type": "object", - "properties": { - "name": { - "description": "Name of the API portal instance", + "iconUrl": { "type": "string", "readOnly": true }, - "status": { - "description": "Status of the API portal instance", - "type": "string", - "readOnly": true - } - } - }, - "ApiPortalCustomDomainResource": { - "description": "Custom domain of the API portal", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ApiPortalCustomDomainProperties" - } - } - }, - "ApiPortalCustomDomainProperties": { - "description": "The properties of custom domain for API portal", - "type": "object", - "properties": { - "thumbprint": { - "description": "The thumbprint of bound certificate.", - "type": "string" - } - } - }, - "ApiPortalCustomDomainResourceCollection": { - "description": "Object that includes an array of API portal custom domain resources and a possible link for next set", - "type": "object", - "properties": { - "value": { - "description": "Collection of API portal custom domain resources", - "uniqueItems": false, + "acceleratorTags": { "type": "array", + "readOnly": true, "items": { - "$ref": "#/definitions/ApiPortalCustomDomainResource" + "type": "string" } }, - "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" + "state": { + "type": "string", + "description": "State of the predefined accelerator.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PredefinedAcceleratorState", + "values": [ + { + "description": "Enable the predefined accelerator.", + "value": "Enabled" + }, + { + "description": "Disable the predefined accelerator.", + "value": "Disabled" + } + ] + } } } } @@ -10636,6 +14394,15 @@ "type": "string", "x-ms-parameter-location": "method" }, + "ApmNameParameter": { + "name": "apmName", + "in": "path", + "description": "The name of the APM", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9-]*[a-z0-9]$", + "x-ms-parameter-location": "method" + }, "DeploymentNameParameter": { "name": "deploymentName", "in": "path", @@ -10644,6 +14411,15 @@ "type": "string", "x-ms-parameter-location": "method" }, + "ContainerRegistryNameParameter": { + "name": "containerRegistryName", + "in": "path", + "description": "The name of the container registry.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9-]*[a-z0-9]$", + "x-ms-parameter-location": "method" + }, "BuildServiceNameParameter": { "name": "buildServiceName", "in": "path", @@ -10754,6 +14530,7 @@ "description": "The name of Application Configuration Service.", "required": true, "type": "string", + "pattern": "^[a-z][a-z0-9]*$", "x-ms-parameter-location": "method" }, "ServiceRegistryNameParameter": { @@ -10764,12 +14541,31 @@ "type": "string", "x-ms-parameter-location": "method" }, + "ApplicationLiveViewNameParameter": { + "name": "applicationLiveViewName", + "in": "path", + "description": "The name of Application Live View.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + }, + "DevToolPortalNameParameter": { + "name": "devToolPortalName", + "in": "path", + "description": "The name of Dev Tool Portal.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + }, "GatewayNameParameter": { "name": "gatewayName", "in": "path", "description": "The name of Spring Cloud Gateway.", "required": true, "type": "string", + "pattern": "^[a-z][a-z0-9]*$", "x-ms-parameter-location": "method" }, "GatewayRouteConfigNameParameter": { @@ -10803,6 +14599,33 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" + }, + "ApplicationAcceleratorNameParameter": { + "name": "applicationAcceleratorName", + "in": "path", + "description": "The name of the application accelerator.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9-]*[a-z0-9]$", + "x-ms-parameter-location": "method" + }, + "CustomizedAcceleratorNameParameter": { + "name": "customizedAcceleratorName", + "in": "path", + "description": "The name of the customized accelerator.", + "required": true, + "type": "string", + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])$", + "x-ms-parameter-location": "method" + }, + "PredefinedAcceleratorNameParameter": { + "name": "predefinedAcceleratorName", + "in": "path", + "description": "The name of the predefined accelerator.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9-]*[a-z0-9]$", + "x-ms-parameter-location": "method" } }, "securityDefinitions": { diff --git a/swagger-specs/appplatform/resource-manager/api-set.json b/swagger-specs/appplatform/resource-manager/api-set.json index f6237e37d..61ad54aa8 100644 --- a/swagger-specs/appplatform/resource-manager/api-set.json +++ b/swagger-specs/appplatform/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.AppPlatform/stable/2022-12-01/appplatform.json"], "name": "package-2022-12"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.AppPlatform/stable/2023-12-01/appplatform.json"], "name": "package-2023-12"} \ No newline at end of file diff --git a/swagger-specs/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json b/swagger-specs/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json new file mode 100644 index 000000000..3e9036a32 --- /dev/null +++ b/swagger-specs/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json @@ -0,0 +1,1020 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AzureFleet", + "version": "2024-05-01-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Fleets" + }, + { + "name": "VirtualMachineScaleSets" + } + ], + "paths": { + "/providers/Microsoft.AzureFleet/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureFleet/fleets": { + "get": { + "operationId": "Fleets_ListBySubscription", + "tags": [ + "Fleets" + ], + "description": "List Fleet resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FleetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_ListBySubscription": { + "$ref": "./examples/Fleets_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets": { + "get": { + "operationId": "Fleets_ListByResourceGroup", + "tags": [ + "Fleets" + ], + "description": "List Fleet resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FleetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_ListByResourceGroup": { + "$ref": "./examples/Fleets_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}": { + "get": { + "operationId": "Fleets_Get", + "tags": [ + "Fleets" + ], + "description": "Get a Fleet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "fleetName", + "in": "path", + "description": "The name of the Compute Fleet", + "required": true, + "type": "string", + "pattern": "^[^_\\W][\\w-._]{0,79}(?
Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between.", + "enum": [ + "automatic", + "manual", + "rolling" + ], + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": false, + "values": [ + { + "value": "automatic", + "description": "All virtual machines in the scale set are automatically updated at the same time." + }, + { + "value": "manual", + "description": "You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action." + }, + { + "value": "rolling", + "description": "The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date." + } + ] + } + }, + "automaticOSUpgradePolicy": { + "$ref": "#/definitions/AutomaticOSUpgradePolicy", + "title": "Configuration parameters used for performing automatic OS Upgrade.", + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "rollingUpgradePolicy": { + "$ref": "#/definitions/RollingUpgradePolicy", + "title": "The configuration parameters used while performing a rolling upgrade.", + "description": "This property is only supported on Pools with the virtualMachineConfiguration property." + } + }, + "required": [ + "mode" + ], + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "AutomaticOSUpgradePolicy": { + "type": "object", + "properties": { + "disableAutomaticRollback": { + "type": "boolean", + "description": "Whether OS image rollback feature should be disabled." + }, + "enableAutomaticOSUpgrade": { + "type": "boolean", + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/en-us/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true." + }, + "useRollingUpgradePolicy": { + "type": "boolean", + "description": "Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS." + }, + "osRollingUpgradeDeferral": { + "type": "boolean", + "description": "Defer OS upgrades on the TVMs if they are running tasks." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "RollingUpgradePolicy": { + "type": "object", + "properties": { + "enableCrossZoneUpgrade": { + "type": "boolean", + "description": "Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal." + }, + "maxBatchInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent." + }, + "maxUnhealthyInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent." + }, + "maxUnhealthyUpgradedInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "format": "duration", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format." + }, + "prioritizeUnhealthyInstances": { + "type": "boolean", + "description": "Upgrade all unhealthy instances in a scale set before any healthy instances." + }, + "rollbackFailedInstancesOnPolicyBreach": { + "type": "boolean", + "description": "Rollback failed instances to previous model if the Rolling Upgrade policy is violated." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API Version." + }, + "batchUrl": { + "name": "batchUrl", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "description": "The base URL for all Azure Batch service requests." + } + } +} diff --git a/swagger-specs/batch/data-plane/api-set.json b/swagger-specs/batch/data-plane/api-set.json new file mode 100644 index 000000000..fc6d4fb76 --- /dev/null +++ b/swagger-specs/batch/data-plane/api-set.json @@ -0,0 +1 @@ +{"addition_input_file_paths": [], "input_files": ["Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json"], "name": "package-2024-02"} \ No newline at end of file diff --git a/swagger-specs/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/BatchManagement.json b/swagger-specs/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/BatchManagement.json similarity index 94% rename from swagger-specs/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/BatchManagement.json rename to swagger-specs/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/BatchManagement.json index 3771b5fe9..372db6d50 100644 --- a/swagger-specs/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/BatchManagement.json +++ b/swagger-specs/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/BatchManagement.json @@ -3,7 +3,7 @@ "info": { "title": "BatchManagementClient", "description": "The Batch Management Client.", - "version": "2023-05-01" + "version": "2024-02-01" }, "host": "management.azure.com", "schemes": [ @@ -27,7 +27,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", + "description": "Microsoft Entra OAuth 2.0 auth code flow", "scopes": { "user_impersonation": "impersonate your user account" } @@ -2140,6 +2140,9 @@ "CreatePool - Full CloudServiceConfiguration": { "$ref": "./examples/PoolCreate_CloudServiceConfiguration.json" }, + "CreatePool - ResourceTags": { + "$ref": "./examples/PoolCreate_ResourceTags.json" + }, "CreatePool - Custom Image": { "$ref": "./examples/PoolCreate_SharedImageGallery.json" }, @@ -2160,6 +2163,18 @@ }, "CreatePool - accelerated networking": { "$ref": "./examples/PoolCreate_AcceleratedNetworking.json" + }, + "CreatePool - SecurityProfile": { + "$ref": "./examples/PoolCreate_SecurityProfile.json" + }, + "CreatePool - UpgradePolicy": { + "$ref": "./examples/PoolCreate_UpgradePolicy.json" + }, + "CreatePool - VirtualMachineConfiguration ServiceArtifactReference": { + "$ref": "./examples/PoolCreate_VirtualMachineConfiguration_ServiceArtifactReference.json" + }, + "CreatePool - VirtualMachineConfiguration OSDisk": { + "$ref": "./examples/PoolCreate_VirtualMachineConfiguration_ManagedOSDisk.json" } }, "parameters": [ @@ -2373,6 +2388,18 @@ }, "GetPool - AcceleratedNetworking": { "$ref": "./examples/PoolGet_AcceleratedNetworking.json" + }, + "GetPool - SecurityProfile": { + "$ref": "./examples/PoolGet_SecurityProfile.json" + }, + "GetPool - UpgradePolicy": { + "$ref": "./examples/PoolGet_UpgradePolicy.json" + }, + "GetPool - VirtualMachineConfiguration ServiceArtifactReference": { + "$ref": "./examples/PoolGet_VirtualMachineConfiguration_ServiceArtifactReference.json" + }, + "GetPool - VirtualMachineConfiguration OSDisk": { + "$ref": "./examples/PoolGet_VirtualMachineConfiguration_MangedOSDisk.json" } }, "parameters": [ @@ -2655,7 +2682,7 @@ }, "poolAllocationMode": { "title": "The allocation mode to use for creating pools in the Batch account.", - "description": "The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService.", + "description": "The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService.", "$ref": "#/definitions/PoolAllocationMode" }, "keyVaultReference": { @@ -2706,7 +2733,7 @@ }, { "value": "AAD", - "description": "The authentication mode using Azure Active Directory." + "description": "The authentication mode using Microsoft Entra ID." }, { "value": "TaskAuthenticationToken", @@ -4260,6 +4287,18 @@ "$ref": "#/definitions/NodeCommunicationMode", "x-nullable": true, "readOnly": true + }, + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "title": "The upgrade policy for the pool." + }, + "resourceTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "The user-specified tags associated with the pool.", + "description": "The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'." } }, "description": "Pool properties." @@ -4621,6 +4660,20 @@ ] } }, + "ServiceArtifactReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "The service artifact reference id of ServiceArtifactReference", + "description": "The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + }, + "required": [ + "id" + ], + "description": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version." + }, "VirtualMachineConfiguration": { "type": "object", "properties": { @@ -4685,6 +4738,15 @@ "$ref": "#/definitions/OSDisk", "title": "Settings for the operating system disk of the Virtual Machine.", "description": "Contains configuration for ephemeral OSDisk settings." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "title": "Specifies the security profile settings for the virtual machine or virtual machine scale set." + }, + "serviceArtifactReference": { + "$ref": "#/definitions/ServiceArtifactReference", + "title": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.", + "description": "The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" } }, "required": [ @@ -4753,7 +4815,7 @@ "description": "On Linux pool, only \"TemporaryDisk\" is supported; on Windows pool, \"OsDisk\" and \"TemporaryDisk\" must be specified." } }, - "description": "The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image." + "description": "The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Azure Compute Gallery Image." }, "ContainerConfiguration": { "type": "object", @@ -4924,14 +4986,13 @@ }, "version": { "type": "string", - "default": "latest", "title": "The version of the Azure Virtual Machines Marketplace image.", "description": "A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'." }, "id": { "type": "string", - "title": "The ARM resource identifier of the Shared Image Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}.", - "description": "This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration." + "title": "The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}.", + "description": "This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration." } }, "title": "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation." @@ -5124,7 +5185,7 @@ "format": "int32", "default": 0, "title": "The maximum number of times the task may be retried.", - "description": "The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0." + "description": "The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0" }, "waitForSuccess": { "type": "boolean", @@ -5344,10 +5405,11 @@ }, "StorageAccountType": { "type": "string", - "title": "The storage account type for use in creating data disks.", + "title": "The storage account type for use in creating data disks or OS disk.", "enum": [ "Standard_LRS", - "Premium_LRS" + "Premium_LRS", + "StandardSSD_LRS" ], "x-ms-enum": { "name": "StorageAccountType", @@ -5355,11 +5417,15 @@ "values": [ { "value": "Standard_LRS", - "description": "The data disk should use standard locally redundant storage." + "description": "The data disk / OS disk should use standard locally redundant storage." }, { "value": "Premium_LRS", - "description": "The data disk should use premium locally redundant storage." + "description": "The data disk / OS disk should use premium locally redundant storage." + }, + { + "value": "StandardSSD_LRS", + "description": "The data disk / OS disk should use standard SSD locally redundant storage." } ] } @@ -5427,6 +5493,23 @@ "ephemeralOSDiskSettings": { "$ref": "#/definitions/DiffDiskSettings", "title": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." + }, + "caching": { + "$ref": "#/definitions/CachingType", + "title": "Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage." + }, + "managedDisk": { + "$ref": "#/definitions/ManagedDisk", + "title": "The managed disk parameters." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "title": "The initial disk size in GB when creating new OS disk." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "title": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "title": "Settings for the operating system disk of the virtual machine." @@ -5491,8 +5574,8 @@ }, "dynamicVnetAssignmentScope": { "type": "string", - "default": "none", "title": "The scope of dynamic vnet assignment.", + "default": "none", "enum": [ "none", "job" @@ -5886,6 +5969,12 @@ "name" ], "description": "A collection of capabilities which this SKU supports." + }, + "batchSupportEndOfLife": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time when Azure Batch service will retire this SKU." } }, "description": "Describes a Batch supported SKU." @@ -6297,6 +6386,172 @@ } }, "description": "Details about the connection between the Batch service and the endpoint." + }, + "ManagedDisk": { + "type": "object", + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "title": "The storage account type for managed disk." + } + } + }, + "SecurityProfile": { + "type": "object", + "properties": { + "securityType": { + "type": "string", + "title": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.", + "enum": [ + "trustedLaunch" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": false, + "values": [ + { + "value": "trustedLaunch", + "description": "Trusted launch protects against advanced and persistent attack techniques." + } + ] + } + }, + "encryptionAtHost": { + "type": "boolean", + "description": "This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself." + }, + "uefiSettings": { + "$ref": "#/definitions/UefiSettings", + "title": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine.", + "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine." + } + }, + "description": "Specifies the security profile settings for the virtual machine or virtual machine scale set." + }, + "UefiSettings": { + "type": "object", + "properties": { + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Specifies whether vTPM should be enabled on the virtual machine." + } + }, + "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine." + }, + "UpgradePolicy": { + "type": "object", + "properties": { + "mode": { + "type": "string", + "title": "Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between.", + "enum": [ + "automatic", + "manual", + "rolling" + ], + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": false, + "values": [ + { + "value": "automatic", + "description": "All virtual machines in the scale set are automatically updated at the same time." + }, + { + "value": "manual", + "description": "You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action." + }, + { + "value": "rolling", + "description": "The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date." + } + ] + } + }, + "automaticOSUpgradePolicy": { + "$ref": "#/definitions/AutomaticOSUpgradePolicy", + "title": "Configuration parameters used for performing automatic OS Upgrade.", + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "rollingUpgradePolicy": { + "$ref": "#/definitions/RollingUpgradePolicy", + "title": "The configuration parameters used while performing a rolling upgrade.", + "description": "This property is only supported on Pools with the virtualMachineConfiguration property." + } + }, + "required": [ + "mode" + ], + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "AutomaticOSUpgradePolicy": { + "type": "object", + "properties": { + "disableAutomaticRollback": { + "type": "boolean", + "description": "Whether OS image rollback feature should be disabled." + }, + "enableAutomaticOSUpgrade": { + "type": "boolean", + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/en-us/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true." + }, + "useRollingUpgradePolicy": { + "type": "boolean", + "description": "Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS." + }, + "osRollingUpgradeDeferral": { + "type": "boolean", + "description": "Defer OS upgrades on the TVMs if they are running tasks." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "RollingUpgradePolicy": { + "type": "object", + "properties": { + "enableCrossZoneUpgrade": { + "type": "boolean", + "description": "Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal." + }, + "maxBatchInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent." + }, + "maxUnhealthyInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent." + }, + "maxUnhealthyUpgradedInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format." + }, + "prioritizeUnhealthyInstances": { + "type": "boolean", + "description": "Upgrade all unhealthy instances in a scale set before any healthy instances." + }, + "rollbackFailedInstancesOnPolicyBreach": { + "type": "boolean", + "description": "Rollback failed instances to previous model if the Rolling Upgrade policy is violated." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." } }, "parameters": { diff --git a/swagger-specs/batch/resource-manager/api-set.json b/swagger-specs/batch/resource-manager/api-set.json index ba37ff2f7..89ec472ea 100644 --- a/swagger-specs/batch/resource-manager/api-set.json +++ b/swagger-specs/batch/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Batch/stable/2023-05-01/BatchManagement.json"], "name": "package-2023-05"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.Batch/stable/2024-02-01/BatchManagement.json"], "name": "package-2024-02"} \ No newline at end of file diff --git a/swagger-specs/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/blockchain.json b/swagger-specs/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/blockchain.json deleted file mode 100644 index 339b84d20..000000000 --- a/swagger-specs/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/blockchain.json +++ /dev/null @@ -1,1706 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2018-06-01-preview", - "title": "BlockchainManagementClient", - "description": "REST API for Azure Blockchain Service" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}": { - "get": { - "tags": [ - "BlockchainMember" - ], - "description": "Get details about a blockchain member.", - "operationId": "BlockchainMembers_Get", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BlockchainMember" - } - } - }, - "x-ms-examples": { - "BlockchainMembers_Get": { - "$ref": "./examples/BlockchainMembers_Get.json" - } - } - }, - "put": { - "tags": [ - "BlockchainMember" - ], - "description": "Create a blockchain member.", - "operationId": "BlockchainMembers_Create", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name.", - "required": true, - "type": "string" - }, - { - "name": "blockchainMember", - "in": "body", - "description": "Payload to create a blockchain member.", - "required": false, - "schema": { - "$ref": "#/definitions/BlockchainMember" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BlockchainMember" - } - }, - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BlockchainMember" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "BlockchainMembers_Create": { - "$ref": "./examples/BlockchainMembers_Create.json" - } - } - }, - "delete": { - "tags": [ - "BlockchainMember" - ], - "description": "Delete a blockchain member.", - "operationId": "BlockchainMembers_Delete", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "202": { - "description": "Success" - }, - "204": { - "description": "Success" - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "BlockchainMembers_Delete": { - "$ref": "./examples/BlockchainMembers_Delete.json" - } - } - }, - "patch": { - "tags": [ - "BlockchainMember" - ], - "description": "Update a blockchain member.", - "operationId": "BlockchainMembers_Update", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name.", - "required": true, - "type": "string" - }, - { - "name": "blockchainMember", - "in": "body", - "description": "Payload to update the blockchain member.", - "required": false, - "schema": { - "$ref": "#/definitions/BlockchainMemberUpdate" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BlockchainMember" - } - } - }, - "x-ms-examples": { - "BlockchainMembers_Update": { - "$ref": "./examples/BlockchainMembers_Update.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers": { - "get": { - "tags": [ - "BlockchainMember" - ], - "description": "Lists the blockchain members for a resource group.", - "operationId": "BlockchainMembers_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BlockchainMemberCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "BlockchainMembers_List": { - "$ref": "./examples/BlockchainMembers_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Blockchain/blockchainMembers": { - "get": { - "tags": [ - "BlockchainMember" - ], - "description": "Lists the blockchain members for a subscription.", - "operationId": "BlockchainMembers_ListAll", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BlockchainMemberCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "BlockchainMembers_ListAll": { - "$ref": "./examples/BlockchainMembers_ListAll.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/consortiumMembers": { - "get": { - "tags": [ - "BlockchainMember" - ], - "description": "Lists the consortium members for a blockchain member.", - "operationId": "BlockchainMembers_ListConsortiumMembers", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ConsortiumMemberCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "BlockchainMembers_ListConsortiumMembers": { - "$ref": "./examples/BlockchainMembers_ListConsortiumMembers.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/listApiKeys": { - "post": { - "tags": [ - "BlockchainMember" - ], - "description": "Lists the API keys for a blockchain member.", - "operationId": "BlockchainMembers_ListApiKeys", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ApiKeyCollection" - } - } - }, - "x-ms-examples": { - "BlockchainMembers_ListApiKeys": { - "$ref": "./examples/BlockchainMembers_ListApiKeys.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/regenerateApiKeys": { - "post": { - "tags": [ - "BlockchainMember" - ], - "description": "Regenerate the API keys for a blockchain member.", - "operationId": "BlockchainMembers_ListRegenerateApiKeys", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name.", - "required": true, - "type": "string" - }, - { - "name": "apiKey", - "in": "body", - "description": "api key to be regenerate", - "required": false, - "schema": { - "$ref": "#/definitions/ApiKey" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ApiKeyCollection" - } - } - }, - "x-ms-examples": { - "BlockchainMembers_ListRegenerateApiKeys": { - "$ref": "./examples/BlockchainMembers_ListRegenerateApiKeys.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Blockchain/locations/{locationName}/blockchainMemberOperationResults/{operationId}": { - "get": { - "tags": [ - "BlockchainMemberOperationResult" - ], - "description": "Get Async operation result.", - "operationId": "BlockchainMemberOperationResults_Get", - "parameters": [ - { - "name": "locationName", - "in": "path", - "description": "Location name.", - "required": true, - "type": "string" - }, - { - "name": "operationId", - "in": "path", - "description": "Operation Id.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OperationResult" - } - }, - "204": { - "description": "Success" - } - }, - "x-ms-examples": { - "BlockchainMemberOperationResults_Get": { - "$ref": "./examples/BlockchainMemberOperationResults_Get.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Blockchain/locations/{locationName}/checkNameAvailability": { - "post": { - "tags": [ - "Location" - ], - "description": "To check whether a resource name is available.", - "operationId": "Locations_CheckNameAvailability", - "parameters": [ - { - "name": "locationName", - "in": "path", - "description": "Location Name.", - "required": true, - "type": "string" - }, - { - "name": "nameAvailabilityRequest", - "in": "body", - "description": "Name availability request payload.", - "required": false, - "schema": { - "$ref": "#/definitions/NameAvailabilityRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/NameAvailability" - } - } - }, - "x-ms-examples": { - "Locations_CheckNameAvailability": { - "$ref": "./examples/Locations_CheckNameAvailability.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Blockchain/locations/{locationName}/listConsortiums": { - "post": { - "tags": [ - "Location" - ], - "description": "Lists the available consortiums for a subscription.", - "operationId": "Locations_ListConsortiums", - "parameters": [ - { - "name": "locationName", - "in": "path", - "description": "Location Name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ConsortiumCollection" - } - } - }, - "x-ms-examples": { - "Locations_ListConsortiums": { - "$ref": "./examples/Locations_ListConsortiums.json" - } - } - } - }, - "/providers/Microsoft.Blockchain/operations": { - "get": { - "tags": [ - "Operation" - ], - "description": "Lists the available operations of Microsoft.Blockchain resource provider.", - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ResourceProviderOperationCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Blockchain/skus": { - "get": { - "tags": [ - "Sku" - ], - "description": "Lists the Skus of the resource type.", - "operationId": "Skus_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ResourceTypeSkuCollection" - } - } - }, - "x-ms-examples": { - "Skus_List": { - "$ref": "./examples/Skus_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/transactionNodes/{transactionNodeName}": { - "get": { - "tags": [ - "TransactionNode" - ], - "description": "Get the details of the transaction node.", - "operationId": "TransactionNodes_Get", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name.", - "required": true, - "type": "string" - }, - { - "name": "transactionNodeName", - "in": "path", - "description": "Transaction node name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TransactionNode" - } - } - }, - "x-ms-examples": { - "TransactionNodes_Get": { - "$ref": "./examples/TransactionNodes_Get.json" - } - } - }, - "put": { - "tags": [ - "TransactionNode" - ], - "description": "Create or update the transaction node.", - "operationId": "TransactionNodes_Create", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name.", - "required": true, - "type": "string" - }, - { - "name": "transactionNodeName", - "in": "path", - "description": "Transaction node name.", - "required": true, - "type": "string" - }, - { - "name": "transactionNode", - "in": "body", - "description": "Payload to create the transaction node.", - "required": false, - "schema": { - "$ref": "#/definitions/TransactionNode" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TransactionNode" - } - }, - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TransactionNode" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "TransactionNodes_Create": { - "$ref": "./examples/TransactionNodes_Create.json" - } - } - }, - "delete": { - "tags": [ - "TransactionNode" - ], - "description": "Delete the transaction node.", - "operationId": "TransactionNodes_Delete", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name.", - "required": true, - "type": "string" - }, - { - "name": "transactionNodeName", - "in": "path", - "description": "Transaction node name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "202": { - "description": "Success" - }, - "204": { - "description": "Success" - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "TransactionNodes_Delete": { - "$ref": "./examples/TransactionNodes_Delete.json" - } - } - }, - "patch": { - "tags": [ - "TransactionNode" - ], - "description": "Update the transaction node.", - "operationId": "TransactionNodes_Update", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name.", - "required": true, - "type": "string" - }, - { - "name": "transactionNodeName", - "in": "path", - "description": "Transaction node name.", - "required": true, - "type": "string" - }, - { - "name": "transactionNode", - "in": "body", - "description": "Payload to create the transaction node.", - "required": false, - "schema": { - "$ref": "#/definitions/TransactionNodeUpdate" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TransactionNode" - } - } - }, - "x-ms-examples": { - "TransactionNodes_Update": { - "$ref": "./examples/TransactionNodes_Update.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/transactionNodes": { - "get": { - "tags": [ - "TransactionNode" - ], - "description": "Lists the transaction nodes for a blockchain member.", - "operationId": "TransactionNodes_List", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TransactionNodeCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "TransactionNodes_List": { - "$ref": "./examples/TransactionNodes_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/transactionNodes/{transactionNodeName}/listApiKeys": { - "post": { - "tags": [ - "TransactionNode" - ], - "description": "List the API keys for the transaction node.", - "operationId": "TransactionNodes_ListApiKeys", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name.", - "required": true, - "type": "string" - }, - { - "name": "transactionNodeName", - "in": "path", - "description": "Transaction node name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ApiKeyCollection" - } - } - }, - "x-ms-examples": { - "TransactionNodes_ListApiKeys": { - "$ref": "./examples/TransactionNodes_ListApiKeys.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/transactionNodes/{transactionNodeName}/regenerateApiKeys": { - "post": { - "tags": [ - "TransactionNode" - ], - "description": "Regenerate the API keys for the blockchain member.", - "operationId": "TransactionNodes_ListRegenerateApiKeys", - "parameters": [ - { - "name": "blockchainMemberName", - "in": "path", - "description": "Blockchain member name.", - "required": true, - "type": "string" - }, - { - "name": "transactionNodeName", - "in": "path", - "description": "Transaction node name.", - "required": true, - "type": "string" - }, - { - "name": "apiKey", - "in": "body", - "description": "api key to be regenerated", - "required": false, - "schema": { - "$ref": "#/definitions/ApiKey" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ApiKeyCollection" - } - } - }, - "x-ms-examples": { - "TransactionNodes_ListRegenerateApiKeys": { - "$ref": "./examples/TransactionNodes_ListRegenerateApiKeys.json" - } - } - } - } - }, - "definitions": { - "BlockchainMember": { - "description": "Payload of the blockchain member which is exposed in the request/response of the resource provider.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BlockchainMemberProperties", - "description": "Gets or sets the blockchain member properties.", - "x-ms-client-flatten": true - }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets the blockchain member Sku." - } - } - }, - "BlockchainMemberProperties": { - "description": "Payload of the blockchain member properties for a blockchain member.", - "type": "object", - "properties": { - "protocol": { - "description": "Gets or sets the blockchain protocol.", - "enum": [ - "NotSpecified", - "Parity", - "Quorum", - "Corda" - ], - "type": "string", - "x-ms-enum": { - "name": "BlockchainProtocol", - "modelAsString": true - } - }, - "validatorNodesSku": { - "$ref": "#/definitions/BlockchainMemberNodesSku", - "description": "Gets or sets the blockchain validator nodes Sku." - }, - "provisioningState": { - "description": "Gets or sets the blockchain member provision state.", - "enum": [ - "NotSpecified", - "Updating", - "Deleting", - "Succeeded", - "Failed", - "Stale" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "BlockchainMemberProvisioningState", - "modelAsString": true - } - }, - "dns": { - "description": "Gets the dns endpoint of the blockchain member.", - "type": "string", - "readOnly": true - }, - "userName": { - "description": "Gets the auth user name of the blockchain member.", - "type": "string", - "readOnly": true - }, - "password": { - "description": "Sets the basic auth password of the blockchain member.", - "type": "string" - }, - "consortium": { - "description": "Gets or sets the consortium for the blockchain member.", - "type": "string" - }, - "consortiumManagementAccountAddress": { - "description": "Gets the managed consortium management account address.", - "type": "string", - "readOnly": true - }, - "consortiumManagementAccountPassword": { - "description": "Sets the managed consortium management account password.", - "type": "string" - }, - "consortiumRole": { - "description": "Gets the role of the member in the consortium.", - "type": "string" - }, - "consortiumMemberDisplayName": { - "description": "Gets the display name of the member in the consortium.", - "type": "string" - }, - "rootContractAddress": { - "description": "Gets the Ethereum root contract address of the blockchain.", - "type": "string", - "readOnly": true - }, - "publicKey": { - "description": "Gets the public key of the blockchain member (default transaction node).", - "type": "string", - "readOnly": true - }, - "firewallRules": { - "description": "Gets or sets firewall rules", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/FirewallRule" - }, - "x-ms-identifiers": [ - "ruleName" - ] - } - } - }, - "BlockchainMemberUpdate": { - "description": "Update the payload of the blockchain member which is exposed in the request/response of the resource provider.", - "type": "object", - "properties": { - "tags": { - "description": "Tags of the service which is a list of key value pairs that describes the resource.", - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ] - }, - "properties": { - "$ref": "#/definitions/BlockchainMemberPropertiesUpdate", - "description": "Gets or sets the blockchain member update properties.", - "x-ms-client-flatten": true - } - } - }, - "BlockchainMemberPropertiesUpdate": { - "description": "Update the payload of the blockchain member properties for a blockchain member.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TransactionNodePropertiesUpdate" - } - ], - "properties": { - "consortiumManagementAccountPassword": { - "description": "Sets the managed consortium management account password.", - "type": "string" - } - } - }, - "Sku": { - "description": "Blockchain member Sku in payload", - "type": "object", - "properties": { - "name": { - "description": "Gets or sets Sku name", - "type": "string" - }, - "tier": { - "description": "Gets or sets Sku tier", - "type": "string" - } - } - }, - "BlockchainMemberNodesSku": { - "description": "Payload of the blockchain member nodes Sku for a blockchain member.", - "type": "object", - "properties": { - "capacity": { - "format": "int32", - "description": "Gets or sets the nodes capacity.", - "type": "integer" - } - } - }, - "FirewallRule": { - "description": "Ip range for firewall rules", - "type": "object", - "properties": { - "ruleName": { - "description": "Gets or sets the name of the firewall rules.", - "type": "string" - }, - "startIpAddress": { - "description": "Gets or sets the start IP address of the firewall rule range.", - "type": "string" - }, - "endIpAddress": { - "description": "Gets or sets the end IP address of the firewall rule range.", - "type": "string" - } - } - }, - "BlockchainMemberCollection": { - "description": "Collection of the blockchain member payload which is exposed in the request/response of the resource provider.", - "type": "object", - "properties": { - "value": { - "description": "Gets or sets the collection of blockchain members.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/BlockchainMember" - } - }, - "nextLink": { - "description": "Gets or sets the URL, that the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" - } - } - }, - "ConsortiumMemberCollection": { - "description": "Collection of consortium payload.", - "type": "object", - "properties": { - "value": { - "description": "Gets or sets the collection of consortiums.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ConsortiumMember" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "nextLink": { - "description": "Gets or sets the URL, that the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" - } - } - }, - "ConsortiumMember": { - "description": "Consortium approval", - "type": "object", - "properties": { - "name": { - "description": "Gets the consortium member name.", - "type": "string" - }, - "displayName": { - "description": "Gets the consortium member display name.", - "type": "string" - }, - "subscriptionId": { - "description": "Gets the consortium member subscription id.", - "type": "string" - }, - "role": { - "description": "Gets the consortium member role.", - "type": "string" - }, - "status": { - "description": "Gets the consortium member status.", - "type": "string" - }, - "joinDate": { - "format": "date-time", - "description": "Gets the consortium member join date.", - "type": "string" - }, - "dateModified": { - "format": "date-time", - "description": "Gets the consortium member modified date.", - "type": "string" - } - } - }, - "ApiKeyCollection": { - "description": "Collection of the API key payload which is exposed in the response of the resource provider.", - "type": "object", - "properties": { - "keys": { - "description": "Gets or sets the collection of API key.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ApiKey" - }, - "x-ms-identifiers": [ - "keyName" - ] - } - } - }, - "ApiKey": { - "description": "API key payload which is exposed in the request/response of the resource provider.", - "type": "object", - "properties": { - "keyName": { - "description": "Gets or sets the API key name.", - "type": "string" - }, - "value": { - "description": "Gets or sets the API key value.", - "type": "string" - } - } - }, - "OperationResult": { - "description": "Operation result payload which is exposed in the response of the resource provider.", - "type": "object", - "properties": { - "name": { - "description": "Gets or sets the operation name.", - "type": "string" - }, - "startTime": { - "format": "date-time", - "description": "Gets or sets the operation start time.", - "type": "string" - }, - "endTime": { - "format": "date-time", - "description": "Gets or sets the operation end time.", - "type": "string" - } - } - }, - "NameAvailabilityRequest": { - "description": "Name availability request payload which is exposed in the request of the resource provider.", - "type": "object", - "properties": { - "name": { - "description": "Gets or sets the name to check.", - "type": "string" - }, - "type": { - "description": "Gets or sets the type of the resource to check.", - "type": "string" - } - } - }, - "NameAvailability": { - "description": "Name availability payload which is exposed in the response of the resource provider.", - "type": "object", - "properties": { - "nameAvailable": { - "description": "Gets or sets the value indicating whether the name is available.", - "type": "boolean" - }, - "message": { - "description": "Gets or sets the message.", - "type": "string" - }, - "reason": { - "description": "Gets or sets the name availability reason.", - "enum": [ - "NotSpecified", - "AlreadyExists", - "Invalid" - ], - "type": "string", - "x-ms-enum": { - "name": "NameAvailabilityReason", - "modelAsString": true - } - } - } - }, - "ConsortiumCollection": { - "description": "Collection of the consortium payload.", - "type": "object", - "properties": { - "value": { - "description": "Gets or sets the collection of consortiums.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Consortium" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "Consortium": { - "description": "Consortium payload", - "type": "object", - "properties": { - "name": { - "description": "Gets or sets the blockchain member name.", - "type": "string" - }, - "protocol": { - "description": "Gets or sets the protocol for the consortium.", - "enum": [ - "NotSpecified", - "Parity", - "Quorum", - "Corda" - ], - "type": "string", - "x-ms-enum": { - "name": "BlockchainProtocol", - "modelAsString": true - } - } - } - }, - "ResourceProviderOperationCollection": { - "description": "Collection of operation payload which is exposed in the response of the resource provider.", - "type": "object", - "properties": { - "value": { - "description": "Gets or sets the collection of operations.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ResourceProviderOperation" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "nextLink": { - "description": "Gets or sets the URL, that the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" - } - } - }, - "ResourceProviderOperation": { - "description": "Operation payload which is exposed in the response of the resource provider.", - "type": "object", - "properties": { - "origin": { - "description": "Gets or sets the origin.", - "type": "string" - }, - "name": { - "description": "Gets or sets the operation name.", - "type": "string" - }, - "isDataAction": { - "description": "Gets or sets a value indicating whether the operation is a data action or not.", - "type": "boolean" - }, - "display": { - "$ref": "#/definitions/ResourceProviderOperationDisplay", - "description": "Gets or sets operation display" - } - } - }, - "ResourceProviderOperationDisplay": { - "description": "Operation display payload which is exposed in the response of the resource provider.", - "type": "object", - "properties": { - "provider": { - "description": "Gets or sets the name of the provider for display purposes.", - "type": "string" - }, - "resource": { - "description": "Gets or sets the name of the resource type for display purposes.", - "type": "string" - }, - "operation": { - "description": "Gets or sets the name of the operation for display purposes.", - "type": "string" - }, - "description": { - "description": "Gets or sets the description of the provider for display purposes.", - "type": "string" - } - } - }, - "ResourceTypeSkuCollection": { - "description": "Collection of the resource type Sku.", - "type": "object", - "properties": { - "value": { - "description": "Gets or sets the collection of resource type Sku.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ResourceTypeSku" - }, - "x-ms-identifiers": [ - "resourceType" - ] - } - } - }, - "ResourceTypeSku": { - "description": "Resource type Sku.", - "type": "object", - "properties": { - "resourceType": { - "description": "Gets or sets the resource type", - "type": "string" - }, - "skus": { - "description": "Gets or sets the Skus", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/SkuSetting" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "SkuSetting": { - "description": "Sku Setting.", - "type": "object", - "properties": { - "name": { - "description": "Gets or sets the Sku name.", - "type": "string" - }, - "tier": { - "description": "Gets or sets the Sku tier.", - "type": "string" - }, - "locations": { - "description": "Gets or sets the locations.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "requiredFeatures": { - "description": "Gets or sets the required features.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "TransactionNode": { - "description": "Payload of the transaction node which is the request/response of the resource provider.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "Gets or sets the transaction node location.", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/TransactionNodeProperties", - "description": "Gets or sets the blockchain member properties.", - "x-ms-client-flatten": true - } - } - }, - "TransactionNodeProperties": { - "description": "Payload of transaction node properties payload in the transaction node payload.", - "type": "object", - "properties": { - "provisioningState": { - "description": "Gets or sets the blockchain member provision state.", - "enum": [ - "NotSpecified", - "Updating", - "Deleting", - "Succeeded", - "Failed" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "NodeProvisioningState", - "modelAsString": true - } - }, - "dns": { - "description": "Gets or sets the transaction node dns endpoint.", - "type": "string", - "readOnly": true - }, - "publicKey": { - "description": "Gets or sets the transaction node public key.", - "type": "string", - "readOnly": true - }, - "userName": { - "description": "Gets or sets the transaction node dns endpoint basic auth user name.", - "type": "string", - "readOnly": true - }, - "password": { - "description": "Sets the transaction node dns endpoint basic auth password.", - "type": "string" - }, - "firewallRules": { - "description": "Gets or sets the firewall rules.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/FirewallRule" - }, - "x-ms-identifiers": [ - "ruleName" - ] - } - } - }, - "TransactionNodeUpdate": { - "description": "Update the transaction node payload which is exposed in the request/response of the resource provider.", - "type": "object", - "properties": { - "properties": { - "$ref": "#/definitions/TransactionNodePropertiesUpdate", - "description": "Gets or sets the transaction node update properties.", - "x-ms-client-flatten": true - } - } - }, - "TransactionNodePropertiesUpdate": { - "description": "Update the payload of the transaction node properties in the transaction node payload.", - "type": "object", - "properties": { - "password": { - "description": "Sets the transaction node dns endpoint basic auth password.", - "type": "string" - }, - "firewallRules": { - "description": "Gets or sets the firewall rules.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/FirewallRule" - }, - "x-ms-identifiers": [ - "ruleName" - ] - } - } - }, - "TransactionNodeCollection": { - "description": "Collection of transaction node payload which is exposed in the request/response of the resource provider.", - "type": "object", - "properties": { - "value": { - "description": "Gets or sets the collection of transaction nodes.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/TransactionNode" - } - }, - "nextLink": { - "description": "Gets or sets the URL, that the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" - } - } - }, - "TrackedResource": { - "description": "The resource model definition for a top level resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "The GEO location of the blockchain service.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "description": "Tags of the service which is a list of key value pairs that describes the resource.", - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ] - } - } - }, - "Resource": { - "description": "The core properties of the resources.", - "type": "object", - "properties": { - "id": { - "description": "Fully qualified resource Id of the resource.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "The name of the resource.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The type of the service - e.g. \"Microsoft.Blockchain\"", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - } - }, - "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string", - "enum": [ - "2018-06-01-preview" - ] - }, - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Gets the subscription Id which uniquely identifies the Microsoft Azure subscription. The subscription ID is part of the URI for every service call.", - "required": true, - "type": "string" - }, - "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" - } - }, - "securityDefinitions": { - "azure_auth": { - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/swagger-specs/blockchain/resource-manager/api-set.json b/swagger-specs/blockchain/resource-manager/api-set.json deleted file mode 100644 index 18d2670c5..000000000 --- a/swagger-specs/blockchain/resource-manager/api-set.json +++ /dev/null @@ -1 +0,0 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Blockchain/preview/2018-06-01-preview/blockchain.json"], "name": "package-2018-06-01-preview"} \ No newline at end of file diff --git a/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/afdx.json b/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/afdx.json similarity index 99% rename from swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/afdx.json rename to swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/afdx.json index 1a2d4317a..903a4c54b 100644 --- a/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/afdx.json +++ b/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/afdx.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-02-01", "title": "CdnManagementClient", "description": "Use these APIs to manage Azure Front Door resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure." }, @@ -6282,7 +6282,7 @@ "in": "query", "required": true, "type": "string", - "description": "Version of the API to be used with the client request. Current version is 2023-05-01." + "description": "Version of the API to be used with the client request. Current version is 2024-02-01." }, "resourceGroupNameParameter": { "name": "resourceGroupName", diff --git a/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/cdn.json b/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json similarity index 98% rename from swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/cdn.json rename to swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json index d6aa6ae72..e5cbde5aa 100644 --- a/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/cdn.json +++ b/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdn.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-02-01", "title": "CdnManagementClient", "description": "Use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure." }, @@ -2821,6 +2821,36 @@ "format": "int32", "minimum": 16, "exclusiveMinimum": false + }, + "logScrubbing": { + "description": "Defines rules that scrub sensitive fields in the Azure Front Door profile logs.", + "$ref": "#/definitions/ProfileLogScrubbing" + } + } + }, + "ProfileLogScrubbing": { + "description": "Defines rules that scrub sensitive fields in the Azure Front Door profile logs.", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "State of the log scrubbing config. Default value is Enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ProfileScrubbingState", + "modelAsString": true + } + }, + "scrubbingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ProfileScrubbingRules" + }, + "x-ms-identifiers": [], + "description": "List of log scrubbing rules applied to the Azure Front Door profile logs." } } }, @@ -2874,6 +2904,60 @@ "format": "int32", "minimum": 16, "exclusiveMinimum": false + }, + "logScrubbing": { + "description": "Defines rules to scrub sensitive fields in logs", + "$ref": "#/definitions/ProfileLogScrubbing" + } + } + }, + "ProfileScrubbingRules": { + "description": "Defines the contents of the log scrubbing rules.", + "type": "object", + "required": [ + "matchVariable", + "selectorMatchOperator" + ], + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestIPAddress", + "RequestUri", + "QueryStringArgNames" + ], + "description": "The variable to be scrubbed from the logs.", + "x-ms-enum": { + "name": "scrubbingRuleEntryMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "EqualsAny" + ], + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.", + "x-ms-enum": { + "name": " scrubbingRuleEntryMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to." + }, + "state": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Defines the state of a log scrubbing rule. Default value is enabled.", + "x-ms-enum": { + "name": " scrubbingRuleEntryState", + "modelAsString": true + } } } }, @@ -7083,7 +7167,7 @@ "in": "query", "required": true, "type": "string", - "description": "Version of the API to be used with the client request. Current version is 2023-05-01." + "description": "Version of the API to be used with the client request. Current version is 2024-02-01." }, "resourceGroupNameParameter": { "name": "resourceGroupName", diff --git a/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/cdnwebapplicationfirewall.json b/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdnwebapplicationfirewall.json similarity index 99% rename from swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/cdnwebapplicationfirewall.json rename to swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdnwebapplicationfirewall.json index 42548023e..4c75e7cd0 100644 --- a/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/cdnwebapplicationfirewall.json +++ b/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/cdnwebapplicationfirewall.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-05-01", + "version": "2024-02-01", "title": "Azure CDN WebApplicationFirewallManagement", "description": "APIs to manage web application firewall rules for Azure CDN" }, @@ -951,7 +951,7 @@ "in": "query", "required": true, "type": "string", - "description": "Version of the API to be used with the client request. Current version is 2023-05-01." + "description": "Version of the API to be used with the client request. Current version is 2024-02-01." }, "PolicyNameParameter": { "name": "policyName", diff --git a/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml b/swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml similarity index 100% rename from swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml rename to swagger-specs/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml diff --git a/swagger-specs/cdn/resource-manager/api-set.json b/swagger-specs/cdn/resource-manager/api-set.json index fc192f58a..c1eff9f76 100644 --- a/swagger-specs/cdn/resource-manager/api-set.json +++ b/swagger-specs/cdn/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Cdn/stable/2023-05-01/afdx.json", "Microsoft.Cdn/stable/2023-05-01/cdn.json", "Microsoft.Cdn/stable/2023-05-01/cdnwebapplicationfirewall.json"], "name": "package-2023-05"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.Cdn/stable/2024-02-01/afdx.json", "Microsoft.Cdn/stable/2024-02-01/cdn.json", "Microsoft.Cdn/stable/2024-02-01/cdnwebapplicationfirewall.json"], "name": "package-2024-02"} \ No newline at end of file diff --git a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/capabilities.json b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/capabilities.json similarity index 97% rename from swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/capabilities.json rename to swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/capabilities.json index 3b1d565c9..136527d55 100644 --- a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/capabilities.json +++ b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/capabilities.json @@ -3,7 +3,7 @@ "info": { "title": "Chaos Management", "description": "Azure Chaos Resource Provider REST API", - "version": "2023-11-01" + "version": "2024-01-01" }, "host": "management.azure.com", "schemes": [ @@ -77,7 +77,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -134,7 +134,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -186,7 +186,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -247,7 +247,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, diff --git a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/capabilityTypes.json b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/capabilityTypes.json similarity index 96% rename from swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/capabilityTypes.json rename to swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/capabilityTypes.json index 93c5dfd4f..0667c38cb 100644 --- a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/capabilityTypes.json +++ b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/capabilityTypes.json @@ -3,7 +3,7 @@ "info": { "title": "Chaos Management", "description": "Azure Chaos Resource Provider REST API", - "version": "2023-11-01" + "version": "2024-01-01" }, "host": "management.azure.com", "schemes": [ @@ -68,7 +68,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -116,7 +116,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, diff --git a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/experiments.json b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/experiments.json similarity index 96% rename from swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/experiments.json rename to swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/experiments.json index 56c91ed1c..d9ea44736 100644 --- a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/experiments.json +++ b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/experiments.json @@ -3,7 +3,7 @@ "info": { "title": "Chaos Management", "description": "Azure Chaos Resource Provider REST API", - "version": "2023-11-01" + "version": "2024-01-01" }, "host": "management.azure.com", "schemes": [ @@ -65,7 +65,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -113,7 +113,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -155,7 +155,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -199,7 +199,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -254,7 +254,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -307,7 +307,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -350,7 +350,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -393,7 +393,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -439,7 +439,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -487,7 +487,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -532,7 +532,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, diff --git a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/operationStatuses.json b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/operationStatuses.json similarity index 83% rename from swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/operationStatuses.json rename to swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/operationStatuses.json index a3f3fca8d..ec92a2d3e 100644 --- a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/operationStatuses.json +++ b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/operationStatuses.json @@ -3,7 +3,7 @@ "info": { "title": "Chaos Management", "description": "Azure Chaos Resource Provider REST API", - "version": "2023-11-01" + "version": "2024-01-01" }, "host": "management.azure.com", "schemes": [ @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/operationsStatuses/{asyncOperationId}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/operationStatuses/{asyncOperationId}": { "get": { "x-ms-examples": { "Get specific operation status": { @@ -48,11 +48,7 @@ "description": "Get the status of a long running azure asynchronous operation.", "parameters": [ { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The region name of operation." + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" }, { "name": "asyncOperationId", @@ -62,23 +58,23 @@ "description": "The operation Id." }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK. Operation status.", "schema": { - "$ref": "#/definitions/OperationStatus" + "$ref": "#/definitions/operationStatus" } }, "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } } @@ -86,12 +82,12 @@ } }, "definitions": { - "OperationStatus": { + "operationStatus": { "description": "The status of operation.", "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } ], "properties": { diff --git a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/operations.json b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/operations.json similarity index 92% rename from swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/operations.json rename to swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/operations.json index 81e03703d..5b30a1caf 100644 --- a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/operations.json +++ b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/operations.json @@ -3,7 +3,7 @@ "info": { "title": "Chaos Management", "description": "Azure Chaos Resource Provider REST API", - "version": "2023-11-01" + "version": "2024-01-01" }, "host": "management.azure.com", "schemes": [ @@ -50,13 +50,13 @@ "200": { "description": "List of Operations returned if request was successful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } }, "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, diff --git a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/targetTypes.json b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/targetTypes.json similarity index 96% rename from swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/targetTypes.json rename to swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/targetTypes.json index 7ab87bd2e..d479a80c0 100644 --- a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/targetTypes.json +++ b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/targetTypes.json @@ -3,7 +3,7 @@ "info": { "title": "Chaos Management", "description": "Azure Chaos Resource Provider REST API", - "version": "2023-11-01" + "version": "2024-01-01" }, "host": "management.azure.com", "schemes": [ @@ -65,7 +65,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -110,7 +110,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, diff --git a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/targets.json b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/targets.json similarity index 97% rename from swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/targets.json rename to swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/targets.json index c1c1cfe6d..77f2a18ac 100644 --- a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/targets.json +++ b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/targets.json @@ -3,7 +3,7 @@ "info": { "title": "Chaos Management", "description": "Azure Chaos Resource Provider REST API", - "version": "2023-11-01" + "version": "2024-01-01" }, "host": "management.azure.com", "schemes": [ @@ -74,7 +74,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -128,7 +128,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -177,7 +177,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -235,7 +235,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, diff --git a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/capabilities.json b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/capabilities.json similarity index 98% rename from swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/capabilities.json rename to swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/capabilities.json index 5692e35f2..e1dcee880 100644 --- a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/capabilities.json +++ b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/capabilities.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Capability Types", - "version": "2023-11-01" + "version": "2024-01-01" }, "paths": {}, "definitions": { diff --git a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/capabilityTypes.json b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/capabilityTypes.json similarity index 99% rename from swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/capabilityTypes.json rename to swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/capabilityTypes.json index eb6b5d207..35e902fda 100644 --- a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/capabilityTypes.json +++ b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/capabilityTypes.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Capability Metadata Types", - "version": "2023-11-01" + "version": "2024-01-01" }, "paths": {}, "definitions": { diff --git a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/common.json b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/common.json similarity index 96% rename from swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/common.json rename to swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/common.json index 51843a879..15342e9b3 100644 --- a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/common.json +++ b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/common.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Common Types", - "version": "2023-11-01" + "version": "2024-01-01" }, "paths": {}, "definitions": { @@ -45,6 +45,18 @@ ], "additionalProperties": false }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, "url": { "type": "string", "description": "String that represents a URL.", diff --git a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/experiments.json b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/experiments.json similarity index 99% rename from swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/experiments.json rename to swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/experiments.json index 4c8ad6902..acb33ae3f 100644 --- a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/experiments.json +++ b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/experiments.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Experiment Types", - "version": "2023-11-01" + "version": "2024-01-01" }, "paths": {}, "parameters": { @@ -79,6 +79,10 @@ "identity": { "description": "The identity of the experiment resource.", "$ref": "./common.json#/definitions/resourceIdentity" + }, + "tags": { + "description": "The tags of the experiment resource.", + "$ref": "./common.json#/definitions/tags" } } }, diff --git a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/targetTypes.json b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/targetTypes.json similarity index 98% rename from swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/targetTypes.json rename to swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/targetTypes.json index 6b3aa144b..4d89fff21 100644 --- a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/targetTypes.json +++ b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/targetTypes.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Target Metadata Types", - "version": "2023-11-01" + "version": "2024-01-01" }, "paths": {}, "definitions": { diff --git a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/targets.json b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/targets.json similarity index 98% rename from swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/targets.json rename to swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/targets.json index ec1f0e749..b90f136d1 100644 --- a/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2023-11-01/types/targets.json +++ b/swagger-specs/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/types/targets.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Target Types", - "version": "2023-11-01" + "version": "2024-01-01" }, "paths": {}, "definitions": { diff --git a/swagger-specs/chaos/resource-manager/api-set.json b/swagger-specs/chaos/resource-manager/api-set.json index e4247b47c..a628c028e 100644 --- a/swagger-specs/chaos/resource-manager/api-set.json +++ b/swagger-specs/chaos/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Chaos/stable/2023-11-01/capabilities.json", "Microsoft.Chaos/stable/2023-11-01/capabilityTypes.json", "Microsoft.Chaos/stable/2023-11-01/experiments.json", "Microsoft.Chaos/stable/2023-11-01/operationStatuses.json", "Microsoft.Chaos/stable/2023-11-01/operations.json", "Microsoft.Chaos/stable/2023-11-01/targetTypes.json", "Microsoft.Chaos/stable/2023-11-01/targets.json"], "name": "package-2023-11"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.Chaos/stable/2024-01-01/capabilities.json", "Microsoft.Chaos/stable/2024-01-01/capabilityTypes.json", "Microsoft.Chaos/stable/2024-01-01/experiments.json", "Microsoft.Chaos/stable/2024-01-01/operationStatuses.json", "Microsoft.Chaos/stable/2024-01-01/operations.json", "Microsoft.Chaos/stable/2024-01-01/targetTypes.json", "Microsoft.Chaos/stable/2024-01-01/targets.json"], "name": "package-2024-01"} \ No newline at end of file diff --git a/swagger-specs/codesigning/data-plane/api-set.json b/swagger-specs/codesigning/data-plane/api-set.json deleted file mode 100644 index 5269c6317..000000000 --- a/swagger-specs/codesigning/data-plane/api-set.json +++ /dev/null @@ -1 +0,0 @@ -{"addition_input_file_paths": [], "input_files": ["Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json"], "name": "2023-06-15-preview"} \ No newline at end of file diff --git a/swagger-specs/common-types/resource-management/v4/types.json b/swagger-specs/common-types/resource-management/v4/types.json index 4cc37c07a..e9dd5d83e 100644 --- a/swagger-specs/common-types/resource-management/v4/types.json +++ b/swagger-specs/common-types/resource-management/v4/types.json @@ -666,7 +666,6 @@ "type": "string", "description": "The scope at which the operation is performed.", "minLength": 1, - "maxLength": 90, "x-ms-parameter-location": "method", "x-ms-skip-url-encoding": true }, diff --git a/swagger-specs/common-types/resource-management/v5/networksecurityperimeter.json b/swagger-specs/common-types/resource-management/v5/networksecurityperimeter.json new file mode 100644 index 000000000..4fd8b1038 --- /dev/null +++ b/swagger-specs/common-types/resource-management/v5/networksecurityperimeter.json @@ -0,0 +1,433 @@ +{ + "swagger": "2.0", + "host": "management.azure.com", + "schemes": [ + "https" + ], + "info": { + "version": "0000-00-00", + "title": "Network security perimeter common type definitions", + "description": "Common types for network security perimeters based on a shared API specification. These common, versioned type definitions are intended for resource providers (RPs, except Network RP) to use, and reuse, for defining their own API versions that share a set of type definitions that is consistent across providers.", + "contact": {} + }, + "paths": {}, + "definitions": { + "PublicNetworkAccess": { + "type": "string", + "description": "Allow, disallow, or let network security perimeter configuration control public network access to the protected resource. Value is optional but if passed in, it must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'.", + "enum": [ + "Enabled", + "Disabled", + "SecuredByPerimeter" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Allows public network access to the resource" + }, + { + "value": "Disabled", + "description": "Disallows public network access to the resource" + }, + { + "value": "SecuredByPerimeter", + "description": "The network security perimeter configuration rules allow or disallow public network access to the resource. Requires an associated network security perimeter." + } + ] + } + }, + "NetworkSecurityPerimeterConfigurationListResult": { + "description": "Result of a list NSP (network security perimeter) configurations request.", + "type": "object", + "properties": { + "value": { + "description": "Array of network security perimeter results.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "nextLink": { + "description": "The link used to get the next page of results.", + "type": "string", + "format": "uri" + } + } + }, + "NetworkSecurityPerimeterConfiguration": { + "description": "Network security perimeter (NSP) configuration resource", + "type": "object", + "allOf": [ + { + "$ref": "./types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationProperties" + } + } + }, + "NetworkSecurityPerimeterConfigurationProvisioningState": { + "description": "Provisioning state of a network security perimeter configuration that is being created or updated.", + "enum": [ + "Succeeded", + "Creating", + "Updating", + "Deleting", + "Accepted", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NetworkSecurityPerimeterConfigurationProvisioningState", + "modelAsString": true + } + }, + "NetworkSecurityPerimeterConfigurationProperties": { + "description": "Network security configuration properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationProvisioningState" + }, + "provisioningIssues": { + "description": "List of provisioning issues, if any", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ProvisioningIssue" + }, + "x-ms-identifiers": [] + }, + "networkSecurityPerimeter": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + }, + "resourceAssociation": { + "$ref": "#/definitions/ResourceAssociation" + }, + "profile": { + "$ref": "#/definitions/NetworkSecurityProfile" + } + } + }, + "ProvisioningIssue": { + "description": "Describes a provisioning issue for a network security perimeter configuration", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "description": "Name of the issue", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ProvisioningIssueProperties" + } + } + }, + "ProvisioningIssueProperties": { + "description": "Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules", + "type": "object", + "readOnly": true, + "properties": { + "issueType": { + "description": "Type of issue", + "type": "string", + "readOnly": true, + "enum": [ + "Unknown", + "ConfigurationPropagationFailure", + "MissingPerimeterConfiguration", + "MissingIdentityConfiguration" + ], + "x-ms-enum": { + "name": "IssueType", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Unknown issue type" + }, + { + "value": "ConfigurationPropagationFailure", + "description": "An error occurred while applying the network security perimeter (NSP) configuration." + }, + { + "value": "MissingPerimeterConfiguration", + "description": "A network connectivity issue is happening on the resource which could be addressed either by adding new resources to the network security perimeter (NSP) or by modifying access rules." + }, + { + "value": "MissingIdentityConfiguration", + "description": "An managed identity hasn't been associated with the resource. The resource will still be able to validate inbound traffic from the network security perimeter (NSP) or matching inbound access rules, but it won't be able to perform outbound access as a member of the NSP." + } + ] + } + }, + "severity": { + "description": "Severity of the issue.", + "enum": [ + "Warning", + "Error" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "description": { + "description": "Description of the issue", + "type": "string", + "readOnly": true + }, + "suggestedResourceIds": { + "description": "Fully qualified resource IDs of suggested resources that can be associated to the network security perimeter (NSP) to remediate the issue.", + "type": "array", + "readOnly": true, + "items": { + "description": "Fully qualified resource ID of the suggested resource", + "type": "string", + "format": "arm-id", + "readOnly": true + } + }, + "suggestedAccessRules": { + "description": "Access rules that can be added to the network security profile (NSP) to remediate the issue.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AccessRule" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkSecurityPerimeter": { + "description": "Information about a network security perimeter (NSP)", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified Azure resource ID of the NSP resource", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "resourceType": "Microsoft.Network/networkSecurityPerimeters" + } + ] + } + }, + "perimeterGuid": { + "description": "Universal unique ID (UUID) of the network security perimeter", + "type": "string", + "format": "uuid" + }, + "location": { + "description": "Location of the network security perimeter", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + } + }, + "ResourceAssociationAccessMode": { + "description": "Access mode of the resource association", + "enum": [ + "Enforced", + "Learning", + "Audit" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceAssociationAccessMode", + "modelAsString": true, + "values": [ + { + "value": "Enforced", + "description": "Enforced access mode - traffic to the resource that failed access checks is blocked" + }, + { + "value": "Learning", + "description": "Learning access mode - traffic to the resource is enabled for analysis but not blocked" + }, + { + "value": "Audit", + "description": "Audit access mode - traffic to the resource that fails access checks is logged but not blocked" + } + ] + } + }, + "ResourceAssociation": { + "description": "Information about resource association", + "type": "object", + "properties": { + "name": { + "description": "Name of the resource association", + "type": "string" + }, + "accessMode": { + "$ref": "#/definitions/ResourceAssociationAccessMode" + } + } + }, + "NetworkSecurityProfile": { + "description": "Network security perimeter configuration profile", + "type": "object", + "properties": { + "name": { + "description": "Name of the profile", + "type": "string" + }, + "accessRulesVersion": { + "description": "Current access rules version", + "type": "integer", + "format": "int32" + }, + "accessRules": { + "description": "List of Access Rules", + "type": "array", + "items": { + "$ref": "#/definitions/AccessRule" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "diagnosticSettingsVersion": { + "description": "Current diagnostic settings version", + "type": "integer", + "format": "int32" + }, + "enabledLogCategories": { + "description": "List of log categories that are enabled", + "type": "array", + "items": { + "description": "Log category", + "type": "string" + } + } + } + }, + "AccessRule": { + "description": "Access rule in a network security perimeter configuration profile", + "type": "object", + "properties": { + "name": { + "description": "Name of the access rule", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/AccessRuleProperties" + } + } + }, + "AccessRuleDirection": { + "description": "Direction of Access Rule", + "enum": [ + "Inbound", + "Outbound" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessRuleDirection", + "modelAsString": true, + "values": [ + { + "value": "Inbound", + "description": "Applies to inbound network traffic to the secured resources." + }, + { + "value": "Outbound", + "description": "Applies to outbound network traffic from the secured resources" + } + ] + } + }, + "AccessRuleProperties": { + "description": "Properties of Access Rule", + "type": "object", + "properties": { + "direction": { + "$ref": "#/definitions/AccessRuleDirection" + }, + "addressPrefixes": { + "description": "Address prefixes in the CIDR format for inbound rules", + "type": "array", + "items": { + "description": "An IP address prefix (CIDR) for inbound rules", + "type": "string" + } + }, + "subscriptions": { + "description": "Subscriptions for inbound rules", + "type": "array", + "items": { + "description": "Subscription identifiers", + "type": "object", + "properties": { + "id": { + "description": "The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') ", + "type": "string", + "format": "arm-id" + } + } + } + }, + "networkSecurityPerimeters": { + "description": "Network security perimeters for inbound rules", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + } + }, + "fullyQualifiedDomainNames": { + "description": "Fully qualified domain names (FQDN) for outbound rules", + "type": "array", + "items": { + "description": "A fully qualified domain name (FQDN)", + "type": "string" + } + }, + "emailAddresses": { + "description": "Email addresses for outbound rules", + "type": "array", + "items": { + "description": "An email address", + "type": "string" + } + }, + "phoneNumbers": { + "description": "Phone numbers for outbound rules", + "type": "array", + "items": { + "description": "A phone number", + "type": "string" + } + } + } + } + }, + "parameters": { + "NetworkSecurityPerimeterConfigurationNameParameter": { + "name": "networkSecurityPerimeterConfigurationName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 512, + "x-ms-parameter-location": "method", + "description": "The name for a network security perimeter configuration" + } + } +} diff --git a/swagger-specs/common-types/resource-management/v5/types.json b/swagger-specs/common-types/resource-management/v5/types.json index b7cea5ec1..dd5e0cc9b 100644 --- a/swagger-specs/common-types/resource-management/v5/types.json +++ b/swagger-specs/common-types/resource-management/v5/types.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "4.0", + "version": "5.0", "title": "Common types" }, "paths": {}, @@ -672,7 +672,6 @@ "type": "string", "description": "The scope at which the operation is performed.", "minLength": 1, - "maxLength": 90, "x-ms-parameter-location": "method", "x-ms-skip-url-encoding": true }, diff --git a/swagger-specs/common-types/resource-management/v6/managedidentity.json b/swagger-specs/common-types/resource-management/v6/managedidentity.json new file mode 100644 index 000000000..f7c187e11 --- /dev/null +++ b/swagger-specs/common-types/resource-management/v6/managedidentity.json @@ -0,0 +1,110 @@ +{ + "swagger": "2.0", + "info": { + "version": "6.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "UserAssignedIdentity": { + "type": "object", + "description": "User assigned identity properties", + "properties": { + "principalId": { + "description": "The principal ID of the assigned identity.", + "format": "uuid", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "The client ID of the assigned identity.", + "format": "uuid", + "type": "string", + "readOnly": true + } + } + }, + "ManagedServiceIdentityType": { + "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true + } + }, + "ManagedServiceIdentity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "type": { + "$ref": "#/definitions/ManagedServiceIdentityType" + }, + "userAssignedIdentities": { + "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity", + "x-nullable": true + } + } + }, + "required": [ + "type" + ] + }, + "SystemAssignedServiceIdentityType": { + "description": "Type of managed service identity (either system assigned, or none).", + "enum": [ + "None", + "SystemAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "SystemAssignedServiceIdentityType", + "modelAsString": true + } + }, + "SystemAssignedServiceIdentity": { + "description": "Managed service identity (either system assigned, or none)", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "type": { + "$ref": "#/definitions/SystemAssignedServiceIdentityType" + } + }, + "required": [ + "type" + ] + } + } +} diff --git a/swagger-specs/common-types/resource-management/v6/privatelinks.json b/swagger-specs/common-types/resource-management/v6/privatelinks.json new file mode 100644 index 000000000..7b2346c10 --- /dev/null +++ b/swagger-specs/common-types/resource-management/v6/privatelinks.json @@ -0,0 +1,202 @@ +{ + "swagger": "2.0", + "info": { + "version": "6.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "PrivateEndpoint": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for private endpoint." + } + }, + "description": "The private endpoint resource." + }, + "PrivateEndpointConnection": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../v5/types.json#/definitions/Resource" + } + ], + "description": "The private endpoint connection resource." + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "groupIds": { + "description": "The group ids for the private endpoint resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The private endpoint resource." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the private endpoint connection." + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../v5/types.json#/definitions/Resource" + } + ], + "description": "A private link resource." + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + }, + "description": "List of private endpoint connections associated with the specified resource." + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + }, + "description": "A list of private link resources." + } + }, + "parameters": { + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection associated with the Azure resource.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/common-types/resource-management/v6/types.json b/swagger-specs/common-types/resource-management/v6/types.json new file mode 100644 index 000000000..94cb1a2d6 --- /dev/null +++ b/swagger-specs/common-types/resource-management/v6/types.json @@ -0,0 +1,681 @@ +{ + "swagger": "2.0", + "info": { + "version": "6.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "Resource": { + "title": "Resource", + "description": "Common fields that are returned in the response for all Azure Resource Manager resources", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" + }, + "systemData": { + "readOnly": true, + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "#/definitions/systemData" + } + }, + "x-ms-azure-resource": true + }, + "AzureEntityResource": { + "x-ms-client-name": "AzureEntityResource", + "title": "Entity Resource", + "description": "The resource model definition for an Azure Resource Manager resource with an etag.", + "type": "object", + "properties": { + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "TrackedResource": { + "title": "Tracked Resource", + "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "type": "object", + "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" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "title": "Proxy Resource", + "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ResourceModelWithAllowedPropertySet": { + "description": "The resource model definition containing the full set of allowed properties for a resource. Except properties bag, there cannot be a top level property outside of this set.", + "type": "object", + "properties": { + "managedBy": { + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "kind": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", + "pattern": "^[-\\w\\._,\\(\\)]+$" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. " + }, + "identity": { + "$ref": "./managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "plan": { + "$ref": "#/definitions/Plan" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "SkuTier": { + "type": "string", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + }, + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." + }, + "Sku": { + "description": "The resource model definition representing SKU", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. E.g. P3. It is typically a letter+number code" + }, + "tier": { + "$ref": "#/definitions/SkuTier" + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + }, + "required": [ + "name" + ] + }, + "Plan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + }, + "description": "Plan for the resource.", + "required": [ + "name", + "publisher", + "product" + ] + }, + "ErrorDetail": { + "description": "The error detail.", + "type": "object", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The error target." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-identifiers": [ + "message", + "target" + ], + "description": "The error details." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "x-ms-identifiers": [], + "description": "The error additional info." + } + } + }, + "ErrorResponse": { + "title": "Error response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "ErrorAdditionalInfo": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The additional info type." + }, + "info": { + "readOnly": true, + "type": "object", + "description": "The additional info." + } + }, + "description": "The resource management error additional info." + }, + "Operation": { + "title": "REST API Operation", + "description": "Details of a REST API operation, returned from the Resource Provider Operations API", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\"", + "type": "string", + "readOnly": true + }, + "isDataAction": { + "description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.", + "type": "boolean", + "readOnly": true + }, + "display": { + "description": "Localized display information for this particular operation.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.", + "type": "string", + "readOnly": true + } + } + }, + "origin": { + "description": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"", + "type": "string", + "readOnly": true, + "enum": [ + "user", + "system", + "user,system" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true + } + }, + "actionType": { + "description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", + "type": "string", + "readOnly": true, + "enum": [ + "Internal" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + } + } + }, + "OperationListResult": { + "description": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of operations supported by the resource provider", + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + } + }, + "OperationStatusResult": { + "description": "The current status of an async operation.", + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "description": "Fully qualified ID for the async operation.", + "type": "string", + "format": "arm-id" + }, + "resourceId": { + "description": "Fully qualified ID of the resource against which the original async operation was started.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "name": { + "description": "Name of the async operation.", + "type": "string" + }, + "status": { + "description": "Operation status.", + "type": "string" + }, + "percentComplete": { + "description": "Percent of the operation that is complete.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time of the operation.", + "type": "string", + "format": "date-time" + }, + "operations": { + "description": "The operations list.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationStatusResult" + } + }, + "error": { + "description": "If present, details of the operation error.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "locationData": { + "description": "Metadata pertaining to the geographic location of the resource.", + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 256, + "description": "A canonical name for the geographic or physical location." + }, + "city": { + "type": "string", + "description": "The city or locality where the resource is located." + }, + "district": { + "type": "string", + "description": "The district, state, or province where the resource is located." + }, + "countryOrRegion": { + "type": "string", + "description": "The country or region where the resource is located" + } + }, + "required": [ + "name" + ] + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "encryptionProperties": { + "description": "Configuration of key for data encryption", + "type": "object", + "properties": { + "status": { + "description": "Indicates whether or not the encryption is enabled for container registry.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Key vault properties." + } + } + }, + "KeyVaultProperties": { + "type": "object", + "properties": { + "keyIdentifier": { + "description": "Key vault uri to access the encryption key.", + "type": "string" + }, + "identity": { + "description": "The client ID of the identity which will be used to access key vault.", + "type": "string" + } + } + }, + "CheckNameAvailabilityRequest": { + "description": "The check availability request body.", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource for which availability needs to be checked.", + "type": "string" + }, + "type": { + "description": "The resource type.", + "type": "string" + } + } + }, + "CheckNameAvailabilityResponse": { + "description": "The check availability result.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates if the resource name is available.", + "type": "boolean" + }, + "reason": { + "description": "The reason why the given name is not available.", + "type": "string", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "CheckNameAvailabilityReason", + "modelAsString": true + } + }, + "message": { + "description": "Detailed reason why the given name is available.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "The ID of the target subscription. The value must be an UUID." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation.", + "minLength": 1 + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "ManagementGroupNameParameter": { + "name": "managementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the management group. The name is case insensitive.", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "ScopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope at which the operation is performed.", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "TenantIdParameter": { + "name": "tenantId", + "in": "path", + "description": "The Azure tenant ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of an ongoing async operation.", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure region.", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "If-Match": { + "name": "ifMatch", + "in": "header", + "required": true, + "type": "string", + "description": "The If-Match header that makes a request conditional.", + "x-ms-parameter-location": "method" + }, + "If-None-Match": { + "name": "ifNoneMatch", + "in": "header", + "required": true, + "type": "string", + "description": "The If-None-Match header that makes a request conditional.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/communication/data-plane/CallAutomation/api-set.json b/swagger-specs/communication/data-plane/CallAutomation/api-set.json index e81cc0367..34ad699ef 100644 --- a/swagger-specs/communication/data-plane/CallAutomation/api-set.json +++ b/swagger-specs/communication/data-plane/CallAutomation/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["stable/2023-10-15/communicationservicescallautomation.json"], "name": "package-2023-10-15"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["stable/2024-04-15/communicationservicescallautomation.json"], "name": "package-2024-04-15"} \ No newline at end of file diff --git a/swagger-specs/communication/data-plane/CallAutomation/stable/2023-10-15/communicationservicescallautomation.json b/swagger-specs/communication/data-plane/CallAutomation/stable/2024-04-15/communicationservicescallautomation.json similarity index 96% rename from swagger-specs/communication/data-plane/CallAutomation/stable/2023-10-15/communicationservicescallautomation.json rename to swagger-specs/communication/data-plane/CallAutomation/stable/2024-04-15/communicationservicescallautomation.json index 2cb552cb1..072bf469f 100644 --- a/swagger-specs/communication/data-plane/CallAutomation/stable/2023-10-15/communicationservicescallautomation.json +++ b/swagger-specs/communication/data-plane/CallAutomation/stable/2024-04-15/communicationservicescallautomation.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-10-15", + "version": "2024-04-15", "title": "Azure Communication Service Call Automation APIs", "description": "Azure Communication Service Call Automation APIs" }, @@ -722,8 +722,8 @@ "tags": [ "MidConnections" ], - "summary": "Get participants from a call.", - "description": "Get participants from a call.", + "summary": "Get participants from a call. Recording and transcription bots are omitted from this list.", + "description": "Get participants from a call. Recording and transcription bots are omitted from this list.", "operationId": "CallConnection_GetParticipants", "parameters": [ { @@ -1314,13 +1314,13 @@ } }, "CommunicationIdentifierModel": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "PhoneNumberIdentifierModel": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/PhoneNumberIdentifierModel" + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/PhoneNumberIdentifierModel" }, "CommunicationUserIdentifierModel": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationUserIdentifierModel" + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationUserIdentifierModel" }, "CallIntelligenceOptions": { "description": "AI options for the call.", @@ -1332,8 +1332,14 @@ } } }, + "MicrosoftTeamsUserIdentifierModel": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/MicrosoftTeamsUserIdentifierModel" + }, + "MicrosoftTeamsAppIdentifierModel": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/MicrosoftTeamsAppIdentifierModel" + }, "CommunicationErrorResponse": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse" + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationErrorResponse" }, "CallConnectionStateModel": { "description": "The state of the call connection.", @@ -2184,6 +2190,13 @@ "items": { "$ref": "#/definitions/ChannelAffinity" } + }, + "pauseOnStart": { + "description": "When set to true will start recording in Pause mode, which can be resumed.", + "type": "boolean" + }, + "externalStorage": { + "$ref": "#/definitions/ExternalStorage" } } }, @@ -2236,6 +2249,46 @@ } } }, + "RecordingStorageKind": { + "description": "Defines the kind of external storage", + "enum": [ + "azureCommunicationServices", + "azureBlobStorage" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingStorageKind", + "modelAsString": true, + "values": [ + { + "name": "AzureCommunicationServices", + "description": "Storage managed by Azure Communication Services", + "value": "AzureCommunicationServices" + }, + { + "name": "AzureBlobStorage", + "description": "Storage managed by provided Azure blob", + "value": "AzureBlobStorage" + } + ] + } + }, + "ExternalStorage": { + "required": [ + "recordingStorageKind" + ], + "type": "object", + "properties": { + "recordingStorageKind": { + "$ref": "#/definitions/RecordingStorageKind" + }, + "recordingDestinationContainerUrl": { + "format": "uri", + "description": "Uri of a container or a location within a container", + "type": "string" + } + } + }, "RecordingState": { "enum": [ "active", @@ -2247,6 +2300,35 @@ "modelAsString": true } }, + "RecordingKind": { + "enum": [ + "azureCommunicationServices", + "teams", + "teamsCompliance" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingKind", + "modelAsString": true, + "values": [ + { + "name": "AzureCommunicationServices", + "description": "Recording initiated by Azure Communication Services", + "value": "AzureCommunicationServices" + }, + { + "name": "Teams", + "description": "Recording initiated by Teams user", + "value": "Teams" + }, + { + "name": "TeamsCompliance", + "description": "Recording initiated by Teams compliance policy", + "value": "TeamsCompliance" + } + ] + } + }, "RecordingStateResponse": { "type": "object", "properties": { @@ -2255,6 +2337,9 @@ }, "recordingState": { "$ref": "#/definitions/RecordingState" + }, + "recordingKind": { + "$ref": "#/definitions/RecordingKind" } } }, @@ -2615,6 +2700,9 @@ "description": "The time of the recording started", "type": "string", "readOnly": true + }, + "recordingKind": { + "$ref": "#/definitions/RecordingKind" } } }, diff --git a/swagger-specs/communication/data-plane/Chat/api-set.json b/swagger-specs/communication/data-plane/Chat/api-set.json index 4f6ee1d4d..4a7a441bc 100644 --- a/swagger-specs/communication/data-plane/Chat/api-set.json +++ b/swagger-specs/communication/data-plane/Chat/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["preview/2023-11-15-preview/communicationserviceschat.json"], "name": "package-2023-11-15-preview"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["stable/2024-03-07/communicationserviceschat.json"], "name": "package-chat-2024-03-07"} \ No newline at end of file diff --git a/swagger-specs/communication/data-plane/Chat/preview/2023-11-15-preview/communicationserviceschat.json b/swagger-specs/communication/data-plane/Chat/stable/2024-03-07/communicationserviceschat.json similarity index 96% rename from swagger-specs/communication/data-plane/Chat/preview/2023-11-15-preview/communicationserviceschat.json rename to swagger-specs/communication/data-plane/Chat/stable/2024-03-07/communicationserviceschat.json index 095c2649a..112e09249 100644 --- a/swagger-specs/communication/data-plane/Chat/preview/2023-11-15-preview/communicationserviceschat.json +++ b/swagger-specs/communication/data-plane/Chat/stable/2024-03-07/communicationserviceschat.json @@ -3,7 +3,7 @@ "info": { "title": "Azure Communication Chat Service", "description": "Azure Communication Chat Service", - "version": "2023-11-15-preview" + "version": "2024-03-07" }, "paths": { "/chat/threads/{chatThreadId}/readReceipts": { @@ -1130,8 +1130,7 @@ "summary": "Posts a typing event to a thread, on behalf of a user.", "operationId": "ChatThread_SendTypingNotification", "consumes": [ - "application/json", - "application/merge-patch+json" + "application/json" ], "produces": [ "application/json" @@ -1199,16 +1198,19 @@ }, "definitions": { "CommunicationUserIdentifierModel": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationUserIdentifierModel" + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationUserIdentifierModel" }, "CommunicationCloudEnvironment": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationCloudEnvironmentModel" + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationCloudEnvironmentModel" }, "MicrosoftTeamsUserIdentifierModel": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/MicrosoftTeamsUserIdentifierModel" + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/MicrosoftTeamsUserIdentifierModel" + }, + "MicrosoftTeamsAppIdentifierModel": { + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/MicrosoftTeamsAppIdentifierModel" }, "CommunicationIdentifierModel": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "ChatMessageReadReceipt": { "description": "A chat message read receipt indicates the time a chat message was read by a recipient.", @@ -1257,10 +1259,10 @@ } }, "CommunicationError": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationError" + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationError" }, "CommunicationErrorResponse": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse" + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationErrorResponse" }, "SendReadReceiptRequest": { "description": "Request payload for sending a read receipt.", @@ -1289,8 +1291,7 @@ "x-ms-enum": { "name": "ChatMessageType", "modelAsString": true - }, - "example": "html" + } }, "SendChatMessageRequest": { "description": "Details of the message to send.", @@ -1302,7 +1303,7 @@ "content": { "description": "Chat message content.", "type": "string", - "example": "

Come one guys, lets go for lunch together.

" + "example": "Come one guys, lets go for lunch together." }, "senderDisplayName": { "description": "The display name of the chat message sender. This property is used to populate sender name for push notifications.", @@ -1355,13 +1356,6 @@ "description": "Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "example": "2020-10-30T10:50:50Z" - }, - "metadata": { - "description": "Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size.", - "type": "object", - "additionalProperties": { - "type": "string" - } } } }, @@ -1378,7 +1372,7 @@ } }, "ChatAttachment": { - "description": "An attachment in a chat message. Currently only supported in Teams Interop scenarios.", + "description": "An attachment in a chat message.", "required": [ "id", "attachmentType" @@ -1388,7 +1382,7 @@ "id": { "description": "Id of the attachment", "type": "string", - "example": "f508ce15-e878-431f-b871-f530cac5331d" + "example": "A27C7079-626F-4D23-8BEE-582F2C376B5A" }, "attachmentType": { "$ref": "#/definitions/ChatAttachmentType" @@ -1419,7 +1413,7 @@ "message": { "description": "Chat message content for messages of types text or html.", "type": "string", - "example": "

Come one guys, lets go for lunch together.

" + "example": "Come one guys, lets go for lunch together." }, "topic": { "description": "Chat message content for messages of type topicUpdated.", @@ -1618,13 +1612,6 @@ "items": { "$ref": "#/definitions/ChatParticipant" } - }, - "metadata": { - "description": "Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size.", - "type": "object", - "additionalProperties": { - "type": "string" - } } } }, @@ -1662,13 +1649,6 @@ "description": "The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", "type": "string", "example": "2020-10-30T10:50:50Z" - }, - "metadata": { - "description": "Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size.", - "type": "object", - "additionalProperties": { - "type": "string" - } } } }, @@ -1751,13 +1731,6 @@ "description": "Chat thread topic.", "type": "string", "example": "Lunch Thread" - }, - "metadata": { - "description": "Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size.", - "type": "object", - "additionalProperties": { - "type": "string" - } } } }, diff --git a/swagger-specs/communication/data-plane/JobRouter/stable/2023-11-01/communicationservicejobrouter.json b/swagger-specs/communication/data-plane/JobRouter/stable/2023-11-01/communicationservicejobrouter.json index 5d62f34dc..444fcd79e 100644 --- a/swagger-specs/communication/data-plane/JobRouter/stable/2023-11-01/communicationservicejobrouter.json +++ b/swagger-specs/communication/data-plane/JobRouter/stable/2023-11-01/communicationservicejobrouter.json @@ -2221,7 +2221,6 @@ }, "Azure.Core.eTag": { "type": "string", - "format": "eTag", "description": "The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.\nIt lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.\n\nIt is a string of ASCII characters placed between double quotes, like \"675af34563dc-tr34\"." }, "BestWorkerMode": { @@ -3472,7 +3471,7 @@ "maxNumberOfJobs": { "type": "integer", "format": "int32", - "description": "The maximum number of jobs that can be supported concurrently for this channel." + "description": "The maximum number of jobs that can be supported concurrently for this channel. Value must be greater than zero." } }, "required": [ @@ -3524,7 +3523,7 @@ "priority": { "type": "integer", "format": "int32", - "description": "Priority of this job." + "description": "Priority of this job. Value must be between -100 to 100." }, "dispositionCode": { "type": "string", @@ -3646,7 +3645,7 @@ "priority": { "type": "integer", "format": "int32", - "description": "Priority of this job." + "description": "Priority of this job. Value must be between -100 to 100." }, "dispositionCode": { "type": "string", diff --git a/swagger-specs/communication/data-plane/Messages/api-set.json b/swagger-specs/communication/data-plane/Messages/api-set.json index b0ff5bfb4..dbeb683b0 100644 --- a/swagger-specs/communication/data-plane/Messages/api-set.json +++ b/swagger-specs/communication/data-plane/Messages/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["preview/2023-08-24-preview/CommunicationServicesMessages.json"], "name": "package-2023-08-24-preview"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["stable/2024-02-01/communicationservicesmessages.json"], "name": "package-2024-02-01"} \ No newline at end of file diff --git a/swagger-specs/communication/data-plane/Messages/preview/2023-08-24-preview/CommunicationServicesMessages.json b/swagger-specs/communication/data-plane/Messages/preview/2023-08-24-preview/CommunicationServicesMessages.json deleted file mode 100644 index be513b063..000000000 --- a/swagger-specs/communication/data-plane/Messages/preview/2023-08-24-preview/CommunicationServicesMessages.json +++ /dev/null @@ -1,596 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "CommunicationMessagesClient", - "description": "Azure Communication Messages Service", - "version": "2023-08-24-preview" - }, - "paths": { - "/messages/notifications/:send": { - "post": { - "tags": [ - "Notifications" - ], - "operationId": "NotificationMessages_SendMessage", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/SendNotificationRequest" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/SendMessageResult" - } - }, - "default": { - "description": "Communication Error Response", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - }, - "x-ms-error-response": true - } - }, - "x-ms-examples": { - "Send a notification message": { - "$ref": "./examples/SendMessage.json" - } - } - } - }, - "/messages/streams/{id}": { - "get": { - "tags": [ - "Stream" - ], - "summary": "Download the Media payload from a User to Business message.", - "operationId": "Stream_DownloadMedia", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "id", - "description": "The Media Identifier contained in the User to Business message event.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "format": "binary", - "type": "string" - } - }, - "default": { - "description": "Communication Error Response", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - }, - "x-ms-error-response": true - } - }, - "x-ms-examples": { - "Download a media": { - "$ref": "./examples/DownloadMedia.json" - } - } - } - }, - "/messages/channels/{channelId}/templates": { - "get": { - "tags": [ - "Template" - ], - "summary": "List all templates for given ACS channel", - "operationId": "TemplateV2_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "channelId", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "in": "query", - "name": "maxPageSize", - "type": "integer", - "format": "int32" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns the list of waTemplatesInternal.", - "schema": { - "$ref": "#/definitions/ListTemplatesResponse" - } - }, - "default": { - "description": "Communication Error Response", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - }, - "x-ms-error-response": true - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "x-ms-examples": { - "Get a list of templates for a channel": { - "$ref": "./examples/GetTemplates.json" - } - } - } - } - }, - "definitions": { - "ChannelType": { - "enum": [ - "whatsApp" - ], - "type": "string", - "x-ms-enum": { - "name": "ChannelType", - "modelAsString": true - } - }, - "CommunicationError": { - "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationError" - }, - "CommunicationErrorResponse": { - "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" - }, - "CommunicationMessageType": { - "description": "The type of message. Supports text, image, template.", - "enum": [ - "text", - "image", - "template" - ], - "type": "string", - "x-ms-enum": { - "name": "CommunicationMessageType", - "modelAsString": true - } - }, - "ListTemplatesResponse": { - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "description": "The collection of elements", - "type": "array", - "items": { - "$ref": "#/definitions/TemplateResponse" - } - }, - "nextLink": { - "type": "string" - } - } - }, - "MessageReceipt": { - "description": "Receipt of the sending one message.", - "required": [ - "messageId", - "to" - ], - "type": "object", - "properties": { - "messageId": { - "description": "The message id.", - "type": "string" - }, - "to": { - "description": "The native external platform user identifier of the recipient.", - "type": "string" - } - } - }, - "MessageTemplate": { - "description": "The template object used to create templates.", - "required": [ - "language", - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "Name of the template.", - "type": "string", - "example": "appointment_update" - }, - "language": { - "description": "The codes for the supported languages for templates.", - "type": "string", - "example": "en_US" - }, - "values": { - "description": "The template values.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MessageTemplateValue" - } - }, - "bindings": { - "$ref": "#/definitions/MessageTemplateBindings" - } - } - }, - "MessageTemplateBindings": { - "description": "The binding object to link values to the template specific locations", - "type": "object", - "properties": { - "whatsApp": { - "$ref": "#/definitions/MessageTemplateBindingsWhatsApp" - } - } - }, - "MessageTemplateBindingsWhatsApp": { - "description": "The template bindings for WhatsApp", - "type": "object", - "properties": { - "header": { - "type": "array", - "items": { - "$ref": "#/definitions/MessageTemplateBindingsWhatsAppComponent" - } - }, - "body": { - "type": "array", - "items": { - "$ref": "#/definitions/MessageTemplateBindingsWhatsAppComponent" - } - }, - "footer": { - "type": "array", - "items": { - "$ref": "#/definitions/MessageTemplateBindingsWhatsAppComponent" - } - }, - "button": { - "type": "array", - "items": { - "$ref": "#/definitions/MessageTemplateBindingsWhatsAppButton" - } - } - } - }, - "MessageTemplateBindingsWhatsAppButton": { - "description": "The template bindings component button for WhatsApp", - "required": [ - "refValue" - ], - "type": "object", - "properties": { - "subType": { - "$ref": "#/definitions/MessageTemplateValueWhatsAppSubType" - }, - "refValue": { - "description": "The reference to the value in the Microsoft.Azure.Communication.CrossPlatformMessages.Contract.Model.Notifications.V1.Requests.MessageTemplate.Values dictionary.", - "type": "string", - "example": "title" - } - } - }, - "MessageTemplateBindingsWhatsAppComponent": { - "description": "The template bindings component for WhatsApp", - "required": [ - "refValue" - ], - "type": "object", - "properties": { - "refValue": { - "description": "The reference to the value in the Microsoft.Azure.Communication.CrossPlatformMessages.Contract.Model.Notifications.V1.Requests.MessageTemplate.Values dictionary.", - "type": "string", - "example": "title" - } - } - }, - "MessageTemplateParameterLocation": { - "description": "The message template's location value information.", - "type": "object", - "properties": { - "name": { - "description": "The [Optional] name of the location.", - "type": "string", - "example": "Microsoft" - }, - "address": { - "description": "The [Optional] address of the location.", - "type": "string", - "example": "1 Microsoft Way, Redmond, WA 98052, USA" - }, - "latitude": { - "format": "double", - "description": "The latitude of the location.", - "type": "number", - "example": 47.639423 - }, - "longitude": { - "format": "double", - "description": "The longitude of the location.", - "type": "number", - "example": -122.12831 - } - } - }, - "MessageTemplateValue": { - "description": "The class describes a parameter of a template.", - "required": [ - "kind" - ], - "type": "object", - "properties": { - "kind": { - "$ref": "#/definitions/MessageTemplateValueKind" - }, - "text": { - "$ref": "#/definitions/MessageTemplateValueText" - }, - "image": { - "$ref": "#/definitions/MessageTemplateValueMedia" - }, - "document": { - "$ref": "#/definitions/MessageTemplateValueMedia" - }, - "video": { - "$ref": "#/definitions/MessageTemplateValueMedia" - }, - "location": { - "$ref": "#/definitions/MessageTemplateParameterLocation" - }, - "quickAction": { - "$ref": "#/definitions/MessageTemplateValueQuickAction" - } - } - }, - "MessageTemplateValueKind": { - "description": "The template value kind.", - "enum": [ - "text", - "image", - "document", - "video", - "location", - "quick_action" - ], - "type": "string", - "x-ms-enum": { - "name": "MessageTemplateValueKind", - "modelAsString": true - } - }, - "MessageTemplateValueMedia": { - "description": "The message template's media value information.\r\nCould be an image, document or video.", - "type": "object", - "properties": { - "url": { - "format": "uri", - "description": "The (public) URL of the media.", - "type": "string", - "example": "https://www.example.com/image.png" - }, - "caption": { - "description": "The [optional] caption of the media object.", - "type": "string" - }, - "fileName": { - "description": "The [optional] filename of the media file.", - "type": "string" - } - } - }, - "MessageTemplateValueQuickAction": { - "description": "The message template's quick action value information.", - "type": "object", - "properties": { - "text": { - "description": "The [Optional] quick action text", - "type": "string", - "example": "Yes" - }, - "payload": { - "description": "The [Optional] quick action payload", - "type": "string", - "example": "cGF5bG9hZA==" - } - } - }, - "MessageTemplateValueText": { - "description": "The message template's text value information.", - "required": [ - "text" - ], - "type": "object", - "properties": { - "text": { - "description": "The text value.", - "type": "string", - "example": "John DOE" - } - } - }, - "MessageTemplateValueWhatsAppSubType": { - "description": "The WhatsApp button sub type", - "enum": [ - "quickReply", - "url" - ], - "type": "string", - "x-ms-enum": { - "name": "MessageTemplateValueWhatsAppSubType", - "modelAsString": true - } - }, - "SendMessageResult": { - "description": "Result of the send message operation.", - "required": [ - "receipts" - ], - "type": "object", - "properties": { - "receipts": { - "description": "Receipts of the send message operation.", - "type": "array", - "items": { - "$ref": "#/definitions/MessageReceipt" - } - } - } - }, - "SendNotificationRequest": { - "description": "Details of the message to send.", - "required": [ - "channelRegistrationId", - "to", - "type" - ], - "type": "object", - "properties": { - "channelRegistrationId": { - "description": "The Channel Registration ID for the Business Identifier.", - "type": "string" - }, - "to": { - "description": "The native external platform user identifiers of the recipient.", - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "16315551234" - ] - }, - "type": { - "$ref": "#/definitions/CommunicationMessageType" - }, - "content": { - "description": "Message content.", - "type": "string", - "example": "Come on everyone, lets go for lunch together." - }, - "mediaUri": { - "description": "A media url for the file. Required if the type is one of the supported media types, e.g. image", - "type": "string", - "example": "https://IMAGE_URL" - }, - "template": { - "$ref": "#/definitions/MessageTemplate" - } - } - }, - "TemplateResponse": { - "type": "object", - "properties": { - "name": { - "description": "Get the template's Name", - "type": "string" - }, - "language": { - "description": "Get the template's language", - "type": "string" - }, - "channelType": { - "$ref": "#/definitions/ChannelType" - }, - "status": { - "$ref": "#/definitions/TemplateStatus" - }, - "whatsApp": { - "$ref": "#/definitions/TemplateResponseWhatsApp" - } - } - }, - "TemplateResponseWhatsApp": { - "description": "The WhatsApp-specific template response contract", - "type": "object", - "properties": { - "content": { - "description": "WhatsApp platform's template content\r\nThis is the payload returned from WhatsApp API." - } - } - }, - "TemplateStatus": { - "description": "The aggregated template status.", - "enum": [ - "approved", - "rejected", - "pending", - "paused" - ], - "type": "string", - "x-ms-enum": { - "name": "TemplateStatus", - "modelAsString": true - } - } - }, - "parameters": { - "ApiVersionParameter": { - "in": "query", - "name": "api-version", - "description": "Version of API to invoke.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "description": "The communication resource, for example https://my-resource.communication.azure.com", - "required": true, - "type": "string", - "format": "url", - "in": "path", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "client" - } - ] - } -} diff --git a/swagger-specs/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json b/swagger-specs/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json new file mode 100644 index 000000000..10f7cd1b0 --- /dev/null +++ b/swagger-specs/communication/data-plane/Messages/stable/2024-02-01/communicationservicesmessages.json @@ -0,0 +1,1067 @@ +{ + "swagger": "2.0", + "info": { + "title": "CommunicationMessagesClient", + "version": "2024-02-01", + "description": "Azure Communication Messages Service", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "The communication resource, for example https://my-resource.communication.azure.com", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "AadOauth2Auth": [ + "https://communication.azure.com/.default" + ] + }, + { + "ApiKeyAuth": [] + } + ], + "securityDefinitions": { + "AadOauth2Auth": { + "type": "oauth2", + "description": "The Azure Active Directory OAuth2 Flow", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://communication.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + }, + "ApiKeyAuth": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "tags": [ + { + "name": "Template" + }, + { + "name": "Notifications" + }, + { + "name": "Stream" + } + ], + "paths": { + "/messages/channels/{channelId}/templates": { + "get": { + "operationId": "TemplateOperations_ListTemplates", + "tags": [ + "Template" + ], + "description": "List all templates for given Azure Communication Services channel", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "channelId", + "in": "path", + "description": "The registration ID of the channel.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "maxpagesize", + "in": "query", + "description": "Number of objects to return per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedMessageTemplateItem" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a list of templates": { + "$ref": "./examples/Template_ListTemplates.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/messages/notifications:send": { + "post": { + "operationId": "NotificationMessagesOperations_Send", + "tags": [ + "Notifications" + ], + "description": "Sends a notification message from Business to User.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId" + }, + { + "$ref": "#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NotificationContent" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/SendMessageResult" + }, + "headers": { + "Repeatability-Result": { + "type": "string", + "description": "Indicates whether the repeatable request was accepted or rejected.", + "enum": [ + "accepted", + "rejected" + ], + "x-ms-enum": { + "name": "RepeatabilityResult", + "modelAsString": false, + "values": [ + { + "name": "accepted", + "value": "accepted", + "description": "If the request was accepted and the server guarantees that the server state reflects a single execution of the operation." + }, + { + "name": "rejected", + "value": "rejected", + "description": "If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid\nor because the Repeatability-First-Sent value was outside the range of values held by the server." + } + ] + } + }, + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Sends a notification message - Template": { + "$ref": "./examples/NotificationMessages_SendTemplate.json" + }, + "Sends a notification message - image": { + "$ref": "./examples/NotificationMessages_SendImage.json" + }, + "Sends a notification message - text": { + "$ref": "./examples/NotificationMessages_SendText.json" + } + } + } + }, + "/messages/streams/{id}": { + "get": { + "operationId": "StreamOperations_GetMedia", + "tags": [ + "Stream" + ], + "description": "Download the Media payload from a User to Business message.", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "description": "The stream ID.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "file" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Download media": { + "$ref": "./examples/Stream_GetMedia.json" + } + } + } + } + }, + "definitions": { + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "CommunicationMessageKind": { + "type": "string", + "description": "The type of message. Supports text, image, template.", + "enum": [ + "text", + "image", + "template" + ], + "x-ms-enum": { + "name": "CommunicationMessageKind", + "modelAsString": true, + "values": [ + { + "name": "text", + "value": "text", + "description": "Text message type." + }, + { + "name": "image", + "value": "image", + "description": "Image message type." + }, + { + "name": "template", + "value": "template", + "description": "Template message type." + } + ] + } + }, + "CommunicationMessagesChannel": { + "type": "string", + "description": "The type of the communication messages channel.", + "enum": [ + "whatsApp" + ], + "x-ms-enum": { + "name": "CommunicationMessagesChannel", + "modelAsString": true, + "values": [ + { + "name": "whatsApp", + "value": "whatsApp", + "description": "The WhatsApp communication messages channel type." + } + ] + } + }, + "MediaNotificationContent": { + "type": "object", + "description": "A request to send a media notification.", + "properties": { + "content": { + "type": "string", + "description": "Optional text content." + }, + "mediaUri": { + "type": "string", + "format": "uri", + "description": "A media url for the file. Required if the type is one of the supported media types, e.g. image" + } + }, + "required": [ + "mediaUri" + ], + "allOf": [ + { + "$ref": "#/definitions/NotificationContent" + } + ], + "x-ms-discriminator-value": "image" + }, + "MessageReceipt": { + "type": "object", + "description": "Receipt of the sending one message.", + "properties": { + "messageId": { + "type": "string", + "description": "The message id." + }, + "to": { + "type": "string", + "description": "The native external platform user identifier of the recipient." + } + }, + "required": [ + "messageId", + "to" + ] + }, + "MessageTemplate": { + "type": "object", + "description": "The template object used to create templates.", + "properties": { + "name": { + "type": "string", + "description": "Name of the template." + }, + "language": { + "type": "string", + "description": "The template's language, in the ISO 639 format, consist of a two-letter language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'." + }, + "values": { + "type": "array", + "description": "The template values.", + "items": { + "$ref": "#/definitions/MessageTemplateValue" + }, + "x-ms-identifiers": [] + }, + "bindings": { + "$ref": "#/definitions/MessageTemplateBindings", + "description": "The binding object to link values to the template specific locations" + } + }, + "required": [ + "name", + "language" + ] + }, + "MessageTemplateBindings": { + "type": "object", + "description": "The binding object to link values to the template specific locations", + "properties": { + "kind": { + "$ref": "#/definitions/MessageTemplateBindingsKind", + "description": "The type discriminator describing a template bindings type." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "MessageTemplateBindingsKind": { + "type": "string", + "description": "The type of the message template.", + "enum": [ + "whatsApp" + ], + "x-ms-enum": { + "name": "MessageTemplateBindingsKind", + "modelAsString": true, + "values": [ + { + "name": "whatsApp", + "value": "whatsApp", + "description": "The WhatsApp template type." + } + ] + } + }, + "MessageTemplateDocument": { + "type": "object", + "description": "The message template's document value information.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "The (public) URL of the media." + }, + "caption": { + "type": "string", + "description": "The [optional] caption of the media object." + }, + "fileName": { + "type": "string", + "description": "The [optional] filename of the media file." + } + }, + "required": [ + "url" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageTemplateValue" + } + ], + "x-ms-discriminator-value": "document" + }, + "MessageTemplateImage": { + "type": "object", + "description": "The message template's image value information.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "The (public) URL of the media." + }, + "caption": { + "type": "string", + "description": "The [optional] caption of the media object." + }, + "fileName": { + "type": "string", + "description": "The [optional] filename of the media file." + } + }, + "required": [ + "url" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageTemplateValue" + } + ], + "x-ms-discriminator-value": "image" + }, + "MessageTemplateItem": { + "type": "object", + "description": "The message template as returned from the service.", + "properties": { + "name": { + "type": "string", + "description": "The template's name.", + "readOnly": true + }, + "language": { + "type": "string", + "description": "The template's language, in the ISO 639 format, consist of a two-letter language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'." + }, + "status": { + "$ref": "#/definitions/MessageTemplateStatus", + "description": "The aggregated template status." + }, + "kind": { + "$ref": "#/definitions/CommunicationMessagesChannel", + "description": "The type discriminator describing a template type." + } + }, + "discriminator": "kind", + "required": [ + "name", + "language", + "status", + "kind" + ] + }, + "MessageTemplateLocation": { + "type": "object", + "description": "The message template's location value information.", + "properties": { + "locationName": { + "type": "string", + "description": "The [Optional] name of the location." + }, + "address": { + "type": "string", + "description": "The [Optional] address of the location." + }, + "latitude": { + "type": "number", + "format": "double", + "description": "The latitude of the location." + }, + "longitude": { + "type": "number", + "format": "double", + "description": "The longitude of the location." + } + }, + "required": [ + "latitude", + "longitude" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageTemplateValue" + } + ], + "x-ms-discriminator-value": "location" + }, + "MessageTemplateQuickAction": { + "type": "object", + "description": "The message template's quick action value information.", + "properties": { + "text": { + "type": "string", + "description": "The [Optional] quick action text" + }, + "payload": { + "type": "string", + "description": "The [Optional] quick action payload" + } + }, + "allOf": [ + { + "$ref": "#/definitions/MessageTemplateValue" + } + ], + "x-ms-discriminator-value": "quickAction" + }, + "MessageTemplateStatus": { + "type": "string", + "description": "The aggregated template status.", + "enum": [ + "approved", + "rejected", + "pending", + "paused" + ], + "x-ms-enum": { + "name": "MessageTemplateStatus", + "modelAsString": true, + "values": [ + { + "name": "approved", + "value": "approved", + "description": "Message template is approved." + }, + { + "name": "rejected", + "value": "rejected", + "description": "Message template is rejected." + }, + { + "name": "pending", + "value": "pending", + "description": "Message template is pending." + }, + { + "name": "paused", + "value": "paused", + "description": "Message template is paused." + } + ] + } + }, + "MessageTemplateText": { + "type": "object", + "description": "The message template's text value information.", + "properties": { + "text": { + "type": "string", + "description": "The text value." + } + }, + "required": [ + "text" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageTemplateValue" + } + ], + "x-ms-discriminator-value": "text" + }, + "MessageTemplateValue": { + "type": "object", + "description": "The class describes a parameter of a template.", + "properties": { + "name": { + "type": "string", + "description": "Template binding reference name" + }, + "kind": { + "$ref": "#/definitions/MessageTemplateValueKind", + "description": "The type discriminator describing a template parameter type." + } + }, + "discriminator": "kind", + "required": [ + "name", + "kind" + ] + }, + "MessageTemplateValueKind": { + "type": "string", + "description": "The type of the template parameter.", + "enum": [ + "text", + "image", + "document", + "video", + "location", + "quickAction" + ], + "x-ms-enum": { + "name": "MessageTemplateValueKind", + "modelAsString": true, + "values": [ + { + "name": "text", + "value": "text", + "description": "The text template parameter type." + }, + { + "name": "image", + "value": "image", + "description": "The image template parameter type." + }, + { + "name": "document", + "value": "document", + "description": "The document template parameter type." + }, + { + "name": "video", + "value": "video", + "description": "The video template parameter type." + }, + { + "name": "location", + "value": "location", + "description": "The location template parameter type." + }, + { + "name": "quickAction", + "value": "quickAction", + "description": "The quick action template parameter type." + } + ] + } + }, + "MessageTemplateVideo": { + "type": "object", + "description": "The message template's video value information.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "The (public) URL of the media." + }, + "caption": { + "type": "string", + "description": "The [optional] caption of the media object." + }, + "fileName": { + "type": "string", + "description": "The [optional] filename of the media file." + } + }, + "required": [ + "url" + ], + "allOf": [ + { + "$ref": "#/definitions/MessageTemplateValue" + } + ], + "x-ms-discriminator-value": "video" + }, + "NotificationContent": { + "type": "object", + "description": "Details of the message to send.", + "properties": { + "channelRegistrationId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The Channel Registration ID for the Business Identifier." + }, + "to": { + "type": "array", + "description": "The native external platform user identifiers of the recipient.", + "items": { + "type": "string" + } + }, + "kind": { + "$ref": "#/definitions/CommunicationMessageKind", + "description": "The type discriminator describing a notification type." + } + }, + "discriminator": "kind", + "required": [ + "channelRegistrationId", + "to", + "kind" + ] + }, + "PagedMessageTemplateItem": { + "type": "object", + "description": "Paged collection of MessageTemplateItem items", + "properties": { + "value": { + "type": "array", + "description": "The MessageTemplateItem items on this page", + "items": { + "$ref": "#/definitions/MessageTemplateItem" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SendMessageResult": { + "type": "object", + "description": "Result of the send message operation.", + "properties": { + "receipts": { + "type": "array", + "description": "Receipts of the send message operation.", + "items": { + "$ref": "#/definitions/MessageReceipt" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "receipts" + ] + }, + "TemplateNotificationContent": { + "type": "object", + "description": "A request to send a template notification.", + "properties": { + "template": { + "$ref": "#/definitions/MessageTemplate", + "description": "The template object used to create templates." + } + }, + "required": [ + "template" + ], + "allOf": [ + { + "$ref": "#/definitions/NotificationContent" + } + ], + "x-ms-discriminator-value": "template" + }, + "TextNotificationContent": { + "type": "object", + "description": "A request to send a text notification.", + "properties": { + "content": { + "type": "string", + "description": "Message content." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/NotificationContent" + } + ], + "x-ms-discriminator-value": "text" + }, + "WhatsAppMessageButtonSubType": { + "type": "string", + "description": "The WhatsApp button sub type.", + "enum": [ + "quickReply", + "url" + ], + "x-ms-enum": { + "name": "WhatsAppMessageButtonSubType", + "modelAsString": true, + "values": [ + { + "name": "quickReply", + "value": "quickReply", + "description": "The WhatsApp button sub type is quick reply." + }, + { + "name": "url", + "value": "url", + "description": "The WhatsApp button sub type is url." + } + ] + } + }, + "WhatsAppMessageTemplateBindings": { + "type": "object", + "description": "The template bindings for WhatsApp", + "properties": { + "header": { + "type": "array", + "description": "The header template bindings", + "items": { + "$ref": "#/definitions/WhatsAppMessageTemplateBindingsComponent" + }, + "x-ms-identifiers": [] + }, + "body": { + "type": "array", + "description": "The body template bindings", + "items": { + "$ref": "#/definitions/WhatsAppMessageTemplateBindingsComponent" + }, + "x-ms-identifiers": [] + }, + "footer": { + "type": "array", + "description": "The footer template bindings", + "items": { + "$ref": "#/definitions/WhatsAppMessageTemplateBindingsComponent" + }, + "x-ms-identifiers": [] + }, + "buttons": { + "type": "array", + "description": "The button template bindings", + "items": { + "$ref": "#/definitions/WhatsAppMessageTemplateBindingsButton" + }, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/MessageTemplateBindings" + } + ], + "x-ms-discriminator-value": "whatsApp" + }, + "WhatsAppMessageTemplateBindingsButton": { + "type": "object", + "description": "The template bindings component button for WhatsApp", + "properties": { + "subType": { + "$ref": "#/definitions/WhatsAppMessageButtonSubType", + "description": "The WhatsApp button sub type" + }, + "refValue": { + "type": "string", + "description": "The name of the referenced item in the template values." + } + }, + "required": [ + "subType", + "refValue" + ] + }, + "WhatsAppMessageTemplateBindingsComponent": { + "type": "object", + "description": "The template bindings component for WhatsApp", + "properties": { + "refValue": { + "type": "string", + "description": "The name of the referenced item in the template values." + } + }, + "required": [ + "refValue" + ] + }, + "WhatsAppMessageTemplateItem": { + "type": "object", + "description": "The WhatsApp-specific template response contract", + "properties": { + "content": { + "description": "WhatsApp platform's template content. This is the payload returned from WhatsApp API." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MessageTemplateItem" + } + ], + "x-ms-discriminator-value": "whatsApp" + } + }, + "parameters": { + "Azure.Core.ClientRequestIdHeader": { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method", + "x-ms-client-name": "clientRequestId" + }, + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent": { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "Specifies the date and time at which the request was first created.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method", + "x-ms-client-name": "repeatabilityFirstSent" + }, + "Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId": { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-client-name": "repeatabilityRequestId" + } + } +} diff --git a/swagger-specs/communication/data-plane/Rooms/api-set.json b/swagger-specs/communication/data-plane/Rooms/api-set.json index f709ee8fa..79a5d165a 100644 --- a/swagger-specs/communication/data-plane/Rooms/api-set.json +++ b/swagger-specs/communication/data-plane/Rooms/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["preview/2023-10-30-preview/communicationservicesrooms.json"], "name": "package-rooms-2023-10-30-preview"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["stable/2024-04-15/communicationservicesrooms.json"], "name": "package-rooms-2024-04-15"} \ No newline at end of file diff --git a/swagger-specs/communication/data-plane/Rooms/preview/2023-10-30-preview/communicationservicesrooms.json b/swagger-specs/communication/data-plane/Rooms/stable/2024-04-15/communicationservicesrooms.json similarity index 99% rename from swagger-specs/communication/data-plane/Rooms/preview/2023-10-30-preview/communicationservicesrooms.json rename to swagger-specs/communication/data-plane/Rooms/stable/2024-04-15/communicationservicesrooms.json index 35b935edd..df51e72c0 100644 --- a/swagger-specs/communication/data-plane/Rooms/preview/2023-10-30-preview/communicationservicesrooms.json +++ b/swagger-specs/communication/data-plane/Rooms/stable/2024-04-15/communicationservicesrooms.json @@ -3,7 +3,7 @@ "info": { "title": "Azure Communication Room Service", "description": "Azure Communication Room Service", - "version": "2023-10-30-preview" + "version": "2024-04-15" }, "paths": { "/rooms": { @@ -385,10 +385,10 @@ }, "definitions": { "CommunicationError": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationError" + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationError" }, "CommunicationErrorResponse": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse" + "$ref": "../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationErrorResponse" }, "CreateRoomRequest": { "description": "Request payload for creating new room.", diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/availabilitySet.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/availabilitySet.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/availabilitySet.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/availabilitySet.json index 070785a6a..6923ffeab 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/availabilitySet.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/availabilitySet.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/capacityReservation.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/capacityReservation.json similarity index 95% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/capacityReservation.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/capacityReservation.json index a1476d740..f2ee3bd4b 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/capacityReservation.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/capacityReservation.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ @@ -40,7 +40,7 @@ "CapacityReservationGroups" ], "operationId": "CapacityReservationGroups_CreateOrUpdate", - "description": "The operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags may be modified. Please refer to https://aka.ms/CapacityReservation for more details.", + "description": "The operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified. Please refer to https://aka.ms/CapacityReservation for more details.", "parameters": [ { "name": "resourceGroupName", @@ -103,7 +103,7 @@ "CapacityReservationGroups" ], "operationId": "CapacityReservationGroups_Update", - "description": "The operation to update a capacity reservation group. When updating a capacity reservation group, only tags may be modified.", + "description": "The operation to update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified.", "parameters": [ { "name": "resourceGroupName", @@ -730,6 +730,29 @@ ], "readOnly": true, "description": "List of instance view of the capacity reservations under the capacity reservation group." + }, + "sharedSubscriptionIds": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "x-ms-identifiers": [ + "id" + ], + "readOnly": true, + "description": "List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details." + } + } + }, + "ResourceSharingProfile": { + "type": "object", + "properties": { + "subscriptionIds": { + "type": "array", + "description": "Specifies an array of subscription resource IDs that capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } } } }, @@ -756,6 +779,10 @@ "$ref": "#/definitions/CapacityReservationGroupInstanceView", "readOnly": true, "description": "The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group." + }, + "sharingProfile": { + "$ref": "#/definitions/ResourceSharingProfile", + "description": "Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details." } }, "description": "capacity reservation group Properties." diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/computeRPCommon.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/computeRPCommon.json similarity index 95% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/computeRPCommon.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/computeRPCommon.json index 88768a747..d090e37bf 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/computeRPCommon.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/computeRPCommon.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ @@ -753,10 +753,11 @@ "properties": { "securityEncryptionType": { "type": "string", - "description": "Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. **Note:** It can be set for only Confidential VMs.", + "description": "Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs.", "enum": [ "VMGuestStateOnly", - "DiskWithVMGuestState" + "DiskWithVMGuestState", + "NonPersistedTPM" ], "x-ms-enum": { "name": "securityEncryptionTypes", @@ -1089,6 +1090,43 @@ }, "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01." }, + "EncryptionIdentity": { + "type": "object", + "properties": { + "userAssignedIdentityResourceId": { + "type": "string", + "description": "Specifies ARM Resource ID of one of the user identities associated with the VM." + } + }, + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault operations." + }, + "ProxyAgentSettings": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set." + }, + "mode": { + "type": "string", + "description": "Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode.", + "enum": [ + "Audit", + "Enforce" + ], + "x-ms-enum": { + "name": "Mode", + "modelAsString": true + } + }, + "keyIncarnationId": { + "type": "integer", + "format": "int32", + "description": "Increase the value of this property allows user to reset the key used for securing communication channel between guest and host." + } + }, + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01." + }, "SecurityProfile": { "properties": { "uefiSettings": { @@ -1110,6 +1148,14 @@ "name": "SecurityTypes", "modelAsString": true } + }, + "encryptionIdentity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault operations." + }, + "proxyAgentSettings": { + "$ref": "#/definitions/ProxyAgentSettings", + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01." } }, "description": "Specifies the Security profile settings for the virtual machine or virtual machine scale set." @@ -1913,6 +1959,69 @@ } }, "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings." + }, + "AttachDetachDataDisksRequest": { + "type": "object", + "properties": { + "dataDisksToAttach": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/DataDisksToAttach" + }, + "x-ms-identifiers": [ + "diskId" + ], + "description": "The list of managed data disks to be attached." + }, + "dataDisksToDetach": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/DataDisksToDetach" + }, + "x-ms-identifiers": [ + "diskId" + ], + "description": "The list of managed data disks to be detached." + } + }, + "description": "Specifies the input for attaching and detaching a list of managed data disks." + }, + "DataDisksToAttach": { + "type": "object", + "properties": { + "diskId": { + "type": "string", + "description": "ID of the managed data disk." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "The logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. If not specified, lun would be auto assigned." + } + }, + "required": [ + "diskId" + ], + "description": "Describes the data disk to be attached." + }, + "DataDisksToDetach": { + "type": "object", + "properties": { + "diskId": { + "type": "string", + "description": "ID of the managed data disk." + }, + "detachOption": { + "$ref": "#/definitions/DetachOption", + "description": "Supported options available for Detach of a disk from a VM. Refer to DetachOption object reference for more details." + } + }, + "required": [ + "diskId" + ], + "description": "Describes the data disk to be detached." } } } diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/dedicatedHost.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/dedicatedHost.json similarity index 94% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/dedicatedHost.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/dedicatedHost.json index 7f9831518..c543ec2bb 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/dedicatedHost.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/dedicatedHost.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ @@ -757,6 +757,68 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/redeploy": { + "post": { + "tags": [ + "DedicatedHost" + ], + "operationId": "DedicatedHosts_Redeploy", + "description": "Redeploy the dedicated host. The operation will complete successfully once the dedicated host has migrated to a new node and is running. To determine the health of VMs deployed on the dedicated host after the redeploy check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "description": "The name of the dedicated host." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Redeploy Dedicated Host.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Redeploy.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/hostSizes": { "get": { "tags": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/image.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/image.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/image.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/image.json index a99599dc9..dfa6615d3 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/image.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/image.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/logAnalytic.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/logAnalytic.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/logAnalytic.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/logAnalytic.json index 90ccd427d..752db1b7c 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/logAnalytic.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/logAnalytic.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/proximityPlacementGroup.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/proximityPlacementGroup.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/proximityPlacementGroup.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/proximityPlacementGroup.json index d801f56de..f30264e66 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/proximityPlacementGroup.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/proximityPlacementGroup.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/restorePoint.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/restorePoint.json similarity index 97% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/restorePoint.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/restorePoint.json index f90ae5d2f..b39c49270 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/restorePoint.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/restorePoint.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ @@ -717,10 +717,27 @@ "lun" ], "description": "Gets the data disks of the VM captured at the time of the restore point creation." + }, + "diskControllerType": { + "$ref": "#/definitions/RestorePointSourceVMDiskControllerType", + "readOnly": true, + "description": "Gets the disk controller type of the VM captured at the time of the restore point creation." } }, "description": "Describes the storage profile." }, + "RestorePointSourceVMDiskControllerType": { + "type": "string", + "enum": [ + "SCSI", + "NVMe" + ], + "x-ms-enum": { + "name": "DiskControllerTypes", + "modelAsString": true + }, + "description": "Provides the disk controller type configured for the VM. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2). For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes." + }, "RestorePointSourceVMOSDisk": { "properties": { "osType": { diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/runCommand.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/runCommand.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/runCommand.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/runCommand.json index 3e84c763d..679c0a924 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/runCommand.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/runCommand.json @@ -3,7 +3,7 @@ "info": { "title": "RunCommandsClient", "description": "The Run Commands Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/sshPublicKey.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/sshPublicKey.json similarity index 92% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/sshPublicKey.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/sshPublicKey.json index 6299b8fa1..84d228e0d 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/sshPublicKey.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/sshPublicKey.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ @@ -371,6 +371,15 @@ "type": "string", "description": "The name of the SSH public key." }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SshGenerateKeyPairInputParameters" + }, + "description": "Parameters supplied to generate the SSH public key." + }, { "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, @@ -395,6 +404,12 @@ "x-ms-examples": { "Generate an SSH key pair.": { "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair.json" + }, + "Generate an SSH key pair with RSA encryption.": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithRSA.json" + }, + "Generate an SSH key pair with Ed25519 encryption.": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithEd25519.json" } } } @@ -480,6 +495,24 @@ "value" ], "description": "The list SSH public keys operation response." + }, + "SshGenerateKeyPairInputParameters": { + "type": "object", + "properties": { + "encryptionType": { + "type": "string", + "description": "The encryption type of the SSH keys to be generated. See SshEncryptionTypes for possible set of values. If not provided, will default to RSA", + "enum": [ + "RSA", + "Ed25519" + ], + "x-ms-enum": { + "name": "SshEncryptionTypes", + "modelAsString": true + } + } + }, + "description": "Parameters for GenerateSshKeyPair." } } } diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachine.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachine.json similarity index 96% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachine.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachine.json index e80f91654..dff9d26cf 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachine.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachine.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ @@ -514,6 +514,22 @@ }, { "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported." } ], "responses": { @@ -628,6 +644,9 @@ "Create a VM with Uefi Settings of secureBoot and vTPM.": { "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithUefiSettings.json" }, + "Create a VM with ProxyAgent Settings of enabled and mode.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithProxyAgentSettings.json" + }, "Create a vm from a generalized shared image.": { "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromAGeneralizedSharedImage.json" }, @@ -667,8 +686,14 @@ "Create a VM with securityType ConfidentialVM with Customer Managed Keys": { "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithCustomerManagedKeys.json" }, + "Create a VM with securityType ConfidentialVM with NonPersistedTPM securityEncryptionType": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithNonPersistedTPM.json" + }, "Create a VM with Disk Controller Type": { "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithDiskControllerType.json" + }, + "Create a VM with encryption identity": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionIdentity.json" } } }, @@ -707,6 +732,22 @@ }, { "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported." } ], "responses": { @@ -1894,6 +1935,80 @@ "final-state-via": "location" } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/attachDetachDataDisks": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_AttachDetachDataDisks", + "description": "Attach and detach data disks to/from the virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./computeRPCommon.json#/definitions/AttachDetachDataDisksRequest" + }, + "description": "Parameters supplied to the attach and detach data disks operation on the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./computeRPCommon.json#/definitions/StorageProfile" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json" + }, + "VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json" + } + } + } } }, "definitions": { @@ -3069,6 +3184,11 @@ "patchStatus": { "$ref": "#/definitions/VirtualMachinePatchStatus", "description": "[Preview Feature] The status of virtual machine patch operations." + }, + "isVMInStandbyPool": { + "type": "boolean", + "readOnly": true, + "description": "[Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool." } }, "description": "The instance view of a virtual machine." @@ -3220,6 +3340,16 @@ "extendedLocation": { "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", "description": "The extended location of the Virtual Machine." + }, + "managedBy": { + "readOnly": true, + "type": "string", + "description": "ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates." } }, "allOf": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineExtensionImage.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineExtensionImage.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineExtensionImage.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineExtensionImage.json index 3c6b2c428..7c100a32b 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineExtensionImage.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineExtensionImage.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineImage.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineImage.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineImage.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineImage.json index 12cd61578..890608e85 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineImage.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineImage.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json similarity index 94% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json index 97b51a7a6..0626c555a 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2023-07-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ @@ -117,6 +117,22 @@ }, { "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported." } ], "responses": { @@ -213,6 +229,9 @@ "Create a scale set with Uefi Settings of secureBoot and vTPM.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUefiSettings.json" }, + "Create a scale set with ProxyAgent Settings of enabled and mode.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProxyAgentSettings.json" + }, "Create a scale set from a generalized shared image.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromAGeneralizedSharedImage.json" }, @@ -260,6 +279,15 @@ }, "Create a scale set with Security Posture Reference": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityPostureReference.json" + }, + "Create a scale set with Resilient VM Creation enabled": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMCreationPolicy.json" + }, + "Create a scale set with Resilient VM Deletion enabled": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMDeletionPolicy.json" + }, + "Create a scale set with SecurityType as ConfidentialVM and NonPersistedTPM securityEncryptionType": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVMWithNonPersistedTPM.json" } } }, @@ -298,6 +326,22 @@ }, { "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported." } ], "responses": { @@ -1758,6 +1802,68 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/approveRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ApproveRollingUpgrade", + "description": "Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_ApproveRollingUpgrade": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ApproveRollingUpgrade.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": { "post": { "tags": [ @@ -2648,6 +2754,66 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/approveRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_ApproveRollingUpgrade", + "description": "Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetVM_ApproveRollingUpgrade": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ApproveRollingUpgrade.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/deallocate": { "post": { "tags": [ @@ -2752,6 +2918,22 @@ }, { "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported." } ], "responses": { @@ -3492,6 +3674,87 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/attachDetachDataDisks": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_AttachDetachDataDisks", + "description": "Attach and detach data disks to/from a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./computeRPCommon.json#/definitions/AttachDetachDataDisksRequest" + }, + "description": "Parameters supplied to the attach and detach data disks operation on a Virtual Machine Scale Sets VM." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./computeRPCommon.json#/definitions/StorageProfile" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen.json" + } + } + } } }, "definitions": { @@ -3614,6 +3877,10 @@ "useRollingUpgradePolicy": { "type": "boolean", "description": "Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS." + }, + "osRollingUpgradeDeferral": { + "type": "boolean", + "description": "Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call." } }, "description": "The configuration parameters used for performing automatic OS upgrade." @@ -3644,6 +3911,40 @@ }, "description": "Describes an upgrade policy - automatic, manual, or rolling." }, + "ResiliencyPolicy": { + "type": "object", + "properties": { + "resilientVMCreationPolicy": { + "$ref": "#/definitions/ResilientVMCreationPolicy", + "description": "The configuration parameters used while performing resilient VM creation." + }, + "resilientVMDeletionPolicy": { + "$ref": "#/definitions/ResilientVMDeletionPolicy", + "description": "The configuration parameters used while performing resilient VM deletion." + } + }, + "description": "Describes an resiliency policy - resilientVMCreationPolicy and/or resilientVMDeletionPolicy." + }, + "ResilientVMCreationPolicy": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false." + } + }, + "description": "The configuration parameters used while performing resilient VM creation." + }, + "ResilientVMDeletionPolicy": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false." + } + }, + "description": "The configuration parameters used while performing resilient VM deletion." + }, "RollingUpgradePolicy": { "properties": { "maxBatchInstancePercent": { @@ -4874,6 +5175,12 @@ "securityPostureReference": { "$ref": "#/definitions/SecurityPostureReference", "description": "Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01" + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01." } }, "description": "Describes a virtual machine scale set virtual machine profile." @@ -5009,6 +5316,10 @@ "constrainedMaximumCapacity": { "type": "boolean", "description": "Optional property which must either be set to True or omitted." + }, + "resiliencyPolicy": { + "$ref": "#/definitions/ResiliencyPolicy", + "description": "Policy for Resiliency" } }, "description": "Describes the properties of a Virtual Machine Scale Set." @@ -5058,6 +5369,10 @@ "spotRestorePolicy": { "$ref": "#/definitions/SpotRestorePolicy", "description": "Specifies the Spot Restore properties for the virtual machine scale set." + }, + "resiliencyPolicy": { + "$ref": "#/definitions/ResiliencyPolicy", + "description": "Policy for Resiliency" } }, "description": "Describes the properties of a Virtual Machine Scale Set." @@ -5090,6 +5405,11 @@ "extendedLocation": { "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", "description": "The extended location of the Virtual Machine Scale Set." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates" } }, "allOf": [ @@ -5656,6 +5976,11 @@ "identity": { "$ref": "./virtualMachine.json#/definitions/VirtualMachineIdentity", "description": "The identity of the virtual machine, if configured." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates." } }, "allOf": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/availabilitySet.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/availabilitySet.json new file mode 100644 index 000000000..a9116ed80 --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/availabilitySet.json @@ -0,0 +1,514 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}": { + "put": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_CreateOrUpdate", + "description": "Create or update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "Parameters supplied to the Create Availability Set operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create an availability set.": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Create.json" + } + } + }, + "patch": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Update", + "description": "Update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySetUpdate" + }, + "description": "Parameters supplied to the Update Availability Set operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AvailabilitySet_Update_MaximumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Update_MaximumSet_Gen.json" + }, + "AvailabilitySet_Update_MinimumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Delete", + "description": "Delete an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AvailabilitySet_Delete_MaximumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Delete_MaximumSet_Gen.json" + }, + "AvailabilitySet_Delete_MinimumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Get", + "description": "Retrieves information about an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AvailabilitySet_Get_MaximumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Get_MaximumSet_Gen.json" + }, + "AvailabilitySet_Get_MinimumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListBySubscription", + "description": "Lists all availability sets in a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List availability sets in a subscription.": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_List", + "description": "Lists all availability sets in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvailabilitySet_List_MaximumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_List_MaximumSet_Gen.json" + }, + "AvailabilitySet_List_MinimumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListAvailableSizes", + "description": "Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./computeRPCommon.json#/definitions/VirtualMachineSizeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "AvailabilitySet_ListAvailableSizes_MaximumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_ListAvailableSizes_MaximumSet_Gen.json" + }, + "AvailabilitySet_ListAvailableSizes_MinimumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_ListAvailableSizes_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AvailabilitySetProperties": { + "properties": { + "platformUpdateDomainCount": { + "type": "integer", + "format": "int32", + "description": "Update Domain count." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "A list of references to all virtual machines in the availability set." + }, + "proximityPlacementGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01." + }, + "statuses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of a resource." + }, + "AvailabilitySetSkuType": { + "type": "string", + "description": "Specifies the sku of an Availability Set. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.", + "enum": [ + "Classic", + "Aligned" + ], + "x-ms-enum": { + "name": "AvailabilitySetSkuTypes", + "modelAsString": true + } + }, + "AvailabilitySet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to an availability set at creation time. An existing VM cannot be added to an availability set." + }, + "AvailabilitySetUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "Sku of the availability set" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated." + }, + "AvailabilitySetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "The list of availability sets" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets." + } + }, + "required": [ + "value" + ], + "description": "The List Availability Set operation response." + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/capacityReservation.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/capacityReservation.json new file mode 100644 index 000000000..e35eb8a65 --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/capacityReservation.json @@ -0,0 +1,1036 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}": { + "put": { + "tags": [ + "CapacityReservationGroups" + ], + "operationId": "CapacityReservationGroups_CreateOrUpdate", + "description": "The operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified. Please refer to https://aka.ms/CapacityReservation for more details.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CapacityReservationGroup" + }, + "description": "Parameters supplied to the Create capacity reservation Group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CapacityReservationGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or update a capacity reservation group.": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "CapacityReservationGroups" + ], + "operationId": "CapacityReservationGroups_Update", + "description": "The operation to update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CapacityReservationGroupUpdate" + }, + "description": "Parameters supplied to the Update capacity reservation Group operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CapacityReservationGroup_Update_MaximumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Update_MaximumSet_Gen.json" + }, + "CapacityReservationGroup_Update_MinimumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "CapacityReservationGroups" + ], + "operationId": "CapacityReservationGroups_Delete", + "description": "The operation to delete a capacity reservation group. This operation is allowed only if all the associated resources are disassociated from the reservation group and all capacity reservations under the reservation group have also been deleted. Please refer to https://aka.ms/CapacityReservation for more details.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CapacityReservationGroup_Delete_MaximumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Delete_MaximumSet_Gen.json" + }, + "CapacityReservationGroup_Delete_MinimumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "CapacityReservationGroups" + ], + "operationId": "CapacityReservationGroups_Get", + "description": "The operation that retrieves information about a capacity reservation group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "CapacityReservationGroupInstanceViewTypes", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a capacity reservation Group.": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups": { + "get": { + "tags": [ + "CapacityReservationGroups" + ], + "operationId": "CapacityReservationGroups_ListByResourceGroup", + "description": "Lists all of the capacity reservation groups in the specified resource group. Use the nextLink property in the response to get the next page of capacity reservation groups.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.", + "enum": [ + "virtualMachineScaleSetVMs/$ref", + "virtualMachines/$ref" + ], + "x-ms-enum": { + "name": "ExpandTypesForGetCapacityReservationGroups", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List capacity reservation groups in resource group.": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/capacityReservationGroups": { + "get": { + "tags": [ + "CapacityReservationGroups" + ], + "operationId": "CapacityReservationGroups_ListBySubscription", + "description": "Lists all of the capacity reservation groups in the subscription. Use the nextLink property in the response to get the next page of capacity reservation groups.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.", + "enum": [ + "virtualMachineScaleSetVMs/$ref", + "virtualMachines/$ref" + ], + "x-ms-enum": { + "name": "ExpandTypesForGetCapacityReservationGroups", + "modelAsString": true + } + }, + { + "name": "resourceIdsOnly", + "in": "query", + "required": false, + "type": "string", + "description": "The query option to fetch Capacity Reservation Group Resource Ids.
'CreatedInSubscription' enables fetching Resource Ids for all capacity reservation group resources created in the subscription.
'SharedWithSubscription' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription.
'All' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription and created in the subscription.", + "enum": [ + "CreatedInSubscription", + "SharedWithSubscription", + "All" + ], + "x-ms-enum": { + "name": "ResourceIdOptionsForGetCapacityReservationGroups", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List capacity reservation groups in subscription.": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_ListBySubscription.json" + }, + "List capacity reservation groups with resource Ids only in subscription.": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_ListBySubscriptionWithResourceIdsQuery.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}": { + "put": { + "tags": [ + "CapacityReservations" + ], + "operationId": "CapacityReservations_CreateOrUpdate", + "description": "The operation to create or update a capacity reservation. Please note some properties can be set only during capacity reservation creation. Please refer to https://aka.ms/CapacityReservation for more details.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "capacityReservationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CapacityReservation" + }, + "description": "Parameters supplied to the Create capacity reservation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CapacityReservation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or update a capacity reservation .": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "CapacityReservations" + ], + "operationId": "CapacityReservations_Update", + "description": "The operation to update a capacity reservation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "capacityReservationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CapacityReservationUpdate" + }, + "description": "Parameters supplied to the Update capacity reservation operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservation" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CapacityReservation_Update_MaximumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_Update_MaximumSet_Gen.json" + }, + "CapacityReservation_Update_MinimumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "CapacityReservations" + ], + "operationId": "CapacityReservations_Delete", + "description": "The operation to delete a capacity reservation. This operation is allowed only when all the associated resources are disassociated from the capacity reservation. Please refer to https://aka.ms/CapacityReservation for more details.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "capacityReservationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CapacityReservation_Delete_MaximumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_Delete_MaximumSet_Gen.json" + }, + "CapacityReservation_Delete_MinimumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "CapacityReservations" + ], + "operationId": "CapacityReservations_Get", + "description": "The operation that retrieves information about the capacity reservation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "capacityReservationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "CapacityReservationInstanceViewTypes", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a capacity reservation.": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations": { + "get": { + "tags": [ + "CapacityReservation" + ], + "operationId": "CapacityReservations_ListByCapacityReservationGroup", + "description": "Lists all of the capacity reservations in the specified capacity reservation group. Use the nextLink property in the response to get the next page of capacity reservations.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List capacity reservations in reservation group.": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_ListByReservationGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "CapacityReservationGroupInstanceView": { + "type": "object", + "properties": { + "capacityReservations": { + "type": "array", + "items": { + "$ref": "#/definitions/CapacityReservationInstanceViewWithName" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true, + "description": "List of instance view of the capacity reservations under the capacity reservation group." + }, + "sharedSubscriptionIds": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "x-ms-identifiers": [ + "id" + ], + "readOnly": true, + "description": "List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2024-03-01. Please refer to https://aka.ms/computereservationsharing for more details." + } + } + }, + "ResourceSharingProfile": { + "type": "object", + "properties": { + "subscriptionIds": { + "type": "array", + "description": "Specifies an array of subscription resource IDs that capacity reservation group is shared with. **Note:** Minimum api-version: 2024-03-01. Please refer to https://aka.ms/computereservationsharing for more details.", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + } + } + }, + "CapacityReservationGroupProperties": { + "type": "object", + "properties": { + "capacityReservations": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of all capacity reservation resource ids that belong to capacity reservation group." + }, + "virtualMachinesAssociated": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all virtual machines associated to the capacity reservation group." + }, + "instanceView": { + "$ref": "#/definitions/CapacityReservationGroupInstanceView", + "readOnly": true, + "description": "The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group." + }, + "sharingProfile": { + "$ref": "#/definitions/ResourceSharingProfile", + "description": "Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. **Note:** Minimum api-version: 2024-03-01. Please refer to https://aka.ms/computereservationsharing for more details." + } + }, + "description": "capacity reservation group Properties." + }, + "CapacityReservationGroup": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CapacityReservationGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the capacity reservation group that the capacity reservations should be assigned to. Currently, a capacity reservation can only be added to a capacity reservation group at creation time. An existing capacity reservation cannot be added or moved to another capacity reservation group." + }, + "CapacityReservationGroupUpdate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CapacityReservationGroupProperties" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the capacity reservation group. Only tags can be updated." + }, + "CapacityReservationGroupListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CapacityReservationGroup" + }, + "description": "The list of capacity reservation groups" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of capacity reservation groups. Call ListNext() with this URI to fetch the next page of capacity reservation groups." + } + }, + "required": [ + "value" + ], + "description": "The List capacity reservation group with resource group response." + }, + "CapacityReservationInstanceView": { + "type": "object", + "properties": { + "utilizationInfo": { + "$ref": "#/definitions/CapacityReservationUtilization", + "description": "Unutilized capacity of the capacity reservation." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of a capacity reservation that provides as snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations." + }, + "CapacityReservationUtilization": { + "type": "object", + "properties": { + "currentCapacity": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01." + }, + "virtualMachinesAllocated": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of all virtual machines resource ids allocated against the capacity reservation." + } + }, + "description": "Represents the capacity reservation utilization in terms of resources allocated." + }, + "CapacityReservationInstanceViewWithName": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the capacity reservation." + } + }, + "allOf": [ + { + "$ref": "#/definitions/CapacityReservationInstanceView" + } + ], + "description": "The instance view of a capacity reservation that includes the name of the capacity reservation. It is used for the response to the instance view of a capacity reservation group." + }, + "CapacityReservationProperties": { + "type": "object", + "properties": { + "reservationId": { + "readOnly": true, + "type": "string", + "description": "A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource." + }, + "platformFaultDomainCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. **Note:** The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01." + }, + "virtualMachinesAssociated": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of all virtual machine resource ids that are associated with the capacity reservation." + }, + "provisioningTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The date time when the capacity reservation was last updated." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/CapacityReservationInstanceView", + "readOnly": true, + "description": "The Capacity reservation instance view." + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01." + } + }, + "description": "Properties of the Capacity reservation." + }, + "CapacityReservation": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CapacityReservationProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "required": [ + "sku" + ], + "description": "Specifies information about the capacity reservation." + }, + "CapacityReservationUpdate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CapacityReservationProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values." + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the capacity reservation. Only tags and sku.capacity can be updated." + }, + "CapacityReservationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CapacityReservation" + }, + "description": "The list of capacity reservations" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of capacity reservations. Call ListNext() with this URI to fetch the next page of capacity reservations." + } + }, + "required": [ + "value" + ], + "description": "The list capacity reservation operation response." + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/computeRPCommon.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/computeRPCommon.json new file mode 100644 index 000000000..ad2441485 --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/computeRPCommon.json @@ -0,0 +1,2107 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Compute/operations": { + "get": { + "tags": [ + "ComputeOperations" + ], + "operationId": "Operations_List", + "description": "Gets a list of compute operations.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComputeOperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/computeRPCommonExamples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet_Gen": { + "$ref": "./examples/computeRPCommonExamples/Operations_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usage_List", + "description": "Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Usage_List_MaximumSet_Gen": { + "$ref": "./examples/computeRPCommonExamples/Usage_List_MaximumSet_Gen.json" + }, + "Usage_List_MinimumSet_Gen": { + "$ref": "./examples/computeRPCommonExamples/Usage_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "This API is deprecated. Use [Resources Skus](https://docs.microsoft.com/rest/api/compute/resourceskus/list)", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "VirtualMachineSizes_List_MaximumSet_Gen": { + "$ref": "./examples/computeRPCommonExamples/VirtualMachineSizes_List_MaximumSet_Gen.json" + }, + "VirtualMachineSizes_List_MinimumSet_Gen": { + "$ref": "./examples/computeRPCommonExamples/VirtualMachineSizes_List_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "ComputeOperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ComputeOperationValue" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "ComputeOperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ComputeOperationValueDisplay" + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "ComputeOperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Compute Operation Value Display." + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "description": "The current usage of the resource." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes Compute Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [], + "description": "The list of compute resource usages." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information." + } + }, + "required": [ + "value" + ], + "description": "The List Usages operation response." + }, + "HyperVGenerationType": { + "type": "string", + "description": "Specifies the HyperVGeneration Type", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGenerationTypes", + "modelAsString": true + } + }, + "InstanceViewStatus": { + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": false + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "type": "object", + "description": "Instance view status." + }, + "SubResourceWithColocationStatus": { + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "properties": { + "colocationStatus": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "Describes colocation status of a resource in the Proximity Placement Group." + } + }, + "x-ms-azure-resource": true + }, + "VirtualMachineSize": { + "properties": { + "name": { + "type": "string", + "description": "The name of the virtual machine size." + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "The number of cores supported by the virtual machine size. For Constrained vCPU capable VM sizes, this number represents the total vCPUs of quota that the VM uses. For accurate vCPU count, please refer to https://docs.microsoft.com/azure/virtual-machines/constrained-vcpu or https://docs.microsoft.com/rest/api/compute/resourceskus/list" + }, + "osDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The OS disk size, in MB, allowed by the virtual machine size." + }, + "resourceDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The resource disk size, in MB, allowed by the virtual machine size." + }, + "memoryInMB": { + "type": "integer", + "format": "int32", + "description": "The amount of memory, in MB, supported by the virtual machine size." + }, + "maxDataDiskCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of data disks that can be attached to the virtual machine size." + } + }, + "description": "Describes the properties of a VM size." + }, + "VirtualMachineSizeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of virtual machine sizes." + } + }, + "description": "The List Virtual Machine operation response." + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "HardwareProfile": { + "properties": { + "vmSize": { + "type": "string", + "description": "Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set.", + "enum": [ + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_B1s", + "Standard_B1ms", + "Standard_B2s", + "Standard_B2ms", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_DS13-4_v2", + "Standard_DS13-2_v2", + "Standard_DS14-8_v2", + "Standard_DS14-4_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_E32-16_v3", + "Standard_E32-8s_v3", + "Standard_E64-32s_v3", + "Standard_E64-16s_v3", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_GS4-8", + "Standard_GS4-4", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_M64-32ms", + "Standard_M64-16ms", + "Standard_M128-64ms", + "Standard_M128-32ms", + "Standard_NC6", + "Standard_NC12", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC6s_v2", + "Standard_NC12s_v2", + "Standard_NC24s_v2", + "Standard_NC24rs_v2", + "Standard_NC6s_v3", + "Standard_NC12s_v3", + "Standard_NC24s_v3", + "Standard_NC24rs_v3", + "Standard_ND6s", + "Standard_ND12s", + "Standard_ND24s", + "Standard_ND24rs", + "Standard_NV6", + "Standard_NV12", + "Standard_NV24" + ], + "x-ms-enum": { + "name": "VirtualMachineSizeTypes", + "modelAsString": true + } + }, + "vmSizeProperties": { + "$ref": "#/definitions/VMSizeProperties", + "description": "Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details." + } + }, + "description": "Specifies the hardware settings for the virtual machine." + }, + "ScheduledEventsPolicy": { + "type": "object", + "description": "Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations.", + "properties": { + "userInitiatedRedeploy": { + "$ref": "#/definitions/UserInitiatedRedeploy", + "description": "The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation." + }, + "userInitiatedReboot": { + "$ref": "#/definitions/UserInitiatedReboot", + "description": "The configuration parameters used while creating userInitiatedReboot scheduled event setting creation." + }, + "scheduledEventsAdditionalPublishingTargets": { + "$ref": "#/definitions/ScheduledEventsAdditionalPublishingTargets", + "description": "The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets." + } + } + }, + "UserInitiatedRedeploy": { + "type": "object", + "description": "Specifies Redeploy related Scheduled Event related configurations.", + "properties": { + "automaticallyApprove": { + "type": "boolean", + "description": "Specifies Redeploy Scheduled Event related configurations." + } + } + }, + "UserInitiatedReboot": { + "type": "object", + "description": "Specifies Reboot related Scheduled Event related configurations.", + "properties": { + "automaticallyApprove": { + "type": "boolean", + "description": "Specifies Reboot Scheduled Event related configurations." + } + } + }, + "ScheduledEventsAdditionalPublishingTargets": { + "type": "object", + "properties": { + "eventGridAndResourceGraph": { + "$ref": "#/definitions/EventGridAndResourceGraph", + "description": "The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting." + } + } + }, + "EventGridAndResourceGraph": { + "type": "object", + "description": "Specifies eventGridAndResourceGraph related Scheduled Event related configurations.", + "properties": { + "enable": { + "type": "boolean", + "description": "Specifies if event grid and resource graph is enabled for Scheduled event related configurations." + } + } + }, + "VMSizeProperties": { + "type": "object", + "properties": { + "vCPUsAvailable": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)." + }, + "vCPUsPerCore": { + "type": "integer", + "format": "int32", + "description": "Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.**" + } + }, + "description": "Specifies VM Size Property settings on the virtual machine." + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input." + }, + "exactVersion": { + "type": "string", + "readOnly": true, + "description": "Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'." + }, + "sharedGalleryImageId": { + "type": "string", + "description": "Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call." + }, + "communityGalleryImageId": { + "type": "string", + "description": "Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "DiskControllerType": { + "type": "string", + "enum": [ + "SCSI", + "NVMe" + ], + "x-ms-enum": { + "name": "DiskControllerTypes", + "modelAsString": true + }, + "description": "Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes." + }, + "KeyVaultSecretReference": { + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the secret." + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "DiskEncryptionSetParameters": { + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.", + "x-ms-azure-resource": true + }, + "KeyVaultKeyReference": { + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the key." + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" + }, + "DiskEncryptionSettings": { + "properties": { + "diskEncryptionKey": { + "$ref": "#/definitions/KeyVaultSecretReference", + "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyVaultKeyReference", + "description": "Specifies the location of the key encryption key in Key Vault." + }, + "enabled": { + "type": "boolean", + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "VMDiskSecurityProfile": { + "type": "object", + "properties": { + "securityEncryptionType": { + "type": "string", + "description": "Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs.", + "enum": [ + "VMGuestStateOnly", + "DiskWithVMGuestState", + "NonPersistedTPM" + ], + "x-ms-enum": { + "name": "securityEncryptionTypes", + "modelAsString": true + } + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob." + } + }, + "description": "Specifies the security profile settings for the managed disk. **Note:** It can only be set for Confidential VMs." + }, + "VirtualHardDisk": { + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "Caching": { + "type": "string", + "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "CreateOption": { + "type": "string", + "description": "Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point.", + "enum": [ + "FromImage", + "Empty", + "Attach", + "Copy", + "Restore" + ], + "x-ms-enum": { + "name": "DiskCreateOptionTypes", + "modelAsString": true + } + }, + "DetachOption": { + "type": "string", + "description": "Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values are: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. **This feature is still in preview** mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.", + "enum": [ + "ForceDetach" + ], + "x-ms-enum": { + "name": "DiskDetachOptionTypes", + "modelAsString": true + } + }, + "DeleteOption": { + "type": "string", + "description": "Specifies the behavior of the managed disk when the VM gets deleted, for example whether the managed disk is deleted or detached. Supported values are: **Delete.** If this value is used, the managed disk is deleted when VM gets deleted. **Detach.** If this value is used, the managed disk is retained after VM gets deleted. Minimum api-version: 2021-03-01.", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DiskDeleteOptionTypes", + "modelAsString": true + } + }, + "StorageAccountType": { + "type": "string", + "description": "Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS", + "Premium_ZRS", + "StandardSSD_ZRS", + "PremiumV2_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountTypes", + "modelAsString": true + } + }, + "DiffDiskOption": { + "type": "string", + "description": "Specifies the ephemeral disk option for operating system disk.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "DiffDiskOptions", + "modelAsString": true + } + }, + "DiffDiskPlacement": { + "type": "string", + "description": "Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk, resource disk or nvme disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Minimum api-version for NvmeDisk: 2024-03-01.", + "enum": [ + "CacheDisk", + "ResourceDisk", + "NvmeDisk" + ], + "x-ms-enum": { + "name": "DiffDiskPlacement", + "modelAsString": true + } + }, + "DiffDiskSettings": { + "properties": { + "option": { + "$ref": "#/definitions/DiffDiskOption", + "description": "Specifies the ephemeral disk settings for operating system disk." + }, + "placement": { + "$ref": "#/definitions/DiffDiskPlacement", + "description": "Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01." + } + }, + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk. **Note:** The ephemeral disk settings can only be specified for managed disk." + }, + "ManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed disk." + }, + "securityProfile": { + "$ref": "#/definitions/VMDiskSecurityProfile", + "description": "Specifies the security profile for the managed disk." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "description": "The parameters of a managed disk." + }, + "OSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "encryptionSettings": { + "$ref": "#/definitions/DiskEncryptionSettings", + "description": "Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + }, + "deleteOption": { + "$ref": "#/definitions/DeleteOption", + "description": "Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk." + } + }, + "required": [ + "createOption" + ], + "description": "Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "DataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + }, + "sourceResource": { + "$ref": "#/definitions/ApiEntityReference", + "description": "The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk." + }, + "toBeDetached": { + "type": "boolean", + "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset" + }, + "diskIOPSReadWrite": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set." + }, + "diskMBpsReadWrite": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set." + }, + "detachOption": { + "$ref": "#/definitions/DetachOption", + "description": "Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. **This feature is still in preview** mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'." + }, + "deleteOption": { + "$ref": "#/definitions/DeleteOption", + "description": "Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**." + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a data disk." + }, + "CapacityReservationProfile": { + "type": "object", + "properties": { + "capacityReservationGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details." + } + }, + "description": "The parameters of a capacity reservation Profile." + }, + "StorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/OSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "diskControllerType": { + "$ref": "#/definitions/DiskControllerType", + "description": "Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "UefiSettings": { + "properties": { + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01." + } + }, + "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01." + }, + "EncryptionIdentity": { + "type": "object", + "properties": { + "userAssignedIdentityResourceId": { + "type": "string", + "description": "Specifies ARM Resource ID of one of the user identities associated with the VM." + } + }, + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault operations." + }, + "ProxyAgentSettings": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set." + }, + "mode": { + "type": "string", + "description": "Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode.", + "enum": [ + "Audit", + "Enforce" + ], + "x-ms-enum": { + "name": "Mode", + "modelAsString": true + } + }, + "keyIncarnationId": { + "type": "integer", + "format": "int32", + "description": "Increase the value of this property allows user to reset the key used for securing communication channel between guest and host." + } + }, + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2024-03-01." + }, + "SecurityProfile": { + "properties": { + "uefiSettings": { + "$ref": "#/definitions/UefiSettings", + "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01." + }, + "encryptionAtHost": { + "type": "boolean", + "description": "This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource." + }, + "securityType": { + "type": "string", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.", + "enum": [ + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": true + } + }, + "encryptionIdentity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault operations." + }, + "proxyAgentSettings": { + "$ref": "#/definitions/ProxyAgentSettings", + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2024-03-01." + } + }, + "description": "Specifies the Security profile settings for the virtual machine or virtual machine scale set." + }, + "VMGalleryApplication": { + "type": "object", + "properties": { + "tags": { + "type": "string", + "description": "Optional, Specifies a passthrough value for more generic context." + }, + "order": { + "type": "integer", + "format": "int32", + "description": "Optional, Specifies the order in which the packages have to be installed" + }, + "packageReferenceId": { + "type": "string", + "description": "Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}" + }, + "configurationReference": { + "type": "string", + "description": "Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided" + }, + "treatFailureAsDeploymentFailure": { + "type": "boolean", + "description": "Optional, If true, any failure for any operation in the VmApplication will fail the deployment" + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS" + } + }, + "required": [ + "packageReferenceId" + ], + "description": "Specifies the required information to reference a compute gallery application version" + }, + "ApplicationProfile": { + "type": "object", + "properties": { + "galleryApplications": { + "type": "array", + "items": { + "$ref": "#/definitions/VMGalleryApplication" + }, + "x-ms-identifiers": [ + "packageReferenceId" + ], + "description": "Specifies the gallery applications that should be made available to the VM/VMSS" + } + }, + "description": "Contains the list of gallery applications that should be made available to the VM/VMSS" + }, + "AdditionalCapabilities": { + "properties": { + "ultraSSDEnabled": { + "type": "boolean", + "description": "The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled." + }, + "hibernationEnabled": { + "type": "boolean", + "description": "The flag that enables or disables hibernation capability on the VM." + } + }, + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "AdditionalUnattendContent": { + "properties": { + "passName": { + "type": "string", + "description": "The pass name. Currently, the only allowable value is OobeSystem.", + "enum": [ + "OobeSystem" + ], + "x-ms-enum": { + "name": "PassNames", + "modelAsString": false + } + }, + "componentName": { + "type": "string", + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ], + "x-ms-enum": { + "name": "ComponentNames", + "modelAsString": false + } + }, + "settingName": { + "type": "string", + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ], + "x-ms-enum": { + "name": "SettingNames", + "modelAsString": false + } + }, + "content": { + "type": "string", + "description": "Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "WinRMListener": { + "properties": { + "protocol": { + "type": "string", + "description": "Specifies the protocol of WinRM listener. Possible values are: **http,** **https.**", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProtocolTypes", + "modelAsString": false + } + }, + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." + } + }, + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" + }, + "WinRMConfiguration": { + "properties": { + "listeners": { + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + }, + "x-ms-identifiers": [], + "description": "The list of Windows Remote Management listeners" + } + }, + "description": "Describes Windows Remote Management configuration of the VM" + }, + "WindowsConfiguration": { + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." + }, + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones)." + }, + "additionalUnattendContent": { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + }, + "x-ms-identifiers": [], + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + }, + "patchSettings": { + "$ref": "#/definitions/PatchSettings", + "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Windows." + }, + "winRM": { + "$ref": "#/definitions/WinRMConfiguration", + "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." + }, + "enableVMAgentPlatformUpdates": { + "type": "boolean", + "description": "Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false." + } + }, + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "SshPublicKey": { + "properties": { + "path": { + "type": "string", + "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)." + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + }, + "SshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "path" + ], + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "LinuxConfiguration": { + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." + }, + "patchSettings": { + "$ref": "#/definitions/LinuxPatchSettings", + "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Linux." + }, + "enableVMAgentPlatformUpdates": { + "type": "boolean", + "description": "Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false." + } + }, + "description": "Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)." + }, + "VaultCertificate": { + "properties": { + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted." + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "properties": { + "sourceVault": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "x-ms-identifiers": [ + "certificateUrl" + ], + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Describes a set of certificates which are all in the same Key Vault." + }, + "OSProfile": { + "properties": { + "computerName": { + "type": "string", + "description": "Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules)." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in \".\"

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

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

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

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

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

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)", + "x-ms-secret": true + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)." + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "x-ms-identifiers": [ + "sourceVault/id" + ], + "description": "Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." + }, + "allowExtensionOperations": { + "type": "boolean", + "description": "Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine." + }, + "requireGuestProvisionSignal": { + "type": "boolean", + "description": "Optional property which must either be set to True or omitted." + } + }, + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "NetworkInterfaceReferenceProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "deleteOption": { + "type": "string", + "description": "Specify what happens to the network interface when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true + } + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkInterfaceReference": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "description": "Describes a network interface reference.", + "x-ms-azure-resource": true + }, + "PublicIPAddressSku": { + "properties": { + "name": { + "type": "string", + "description": "Specify public IP sku name", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Specify public IP sku tier", + "enum": [ + "Regional", + "Global" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuTier", + "modelAsString": true + } + } + }, + "description": "Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible." + }, + "NetworkProfile": { + "properties": { + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceReference" + }, + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." + }, + "networkApiVersion": { + "type": "string", + "description": "specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations", + "enum": [ + "2020-11-01" + ], + "x-ms-enum": { + "name": "NetworkApiVersion", + "modelAsString": true + } + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "./virtualMachine.json#/definitions/VirtualMachineNetworkInterfaceConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Specifies the networking configurations that will be used to create the virtual machine networking resources." + } + }, + "description": "Specifies the network interfaces or the networking configuration of the virtual machine." + }, + "BootDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "DiagnosticsProfile": { + "properties": { + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnostics", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15." + }, + "priority": { + "type": "string", + "description": "Specifies the priority for a standalone virtual machine or the virtual machines in the scale set. 'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS.", + "enum": [ + "Regular", + "Low", + "Spot" + ], + "x-ms-enum": { + "name": "VirtualMachinePriorityTypes", + "modelAsString": true + } + }, + "evictionPolicy": { + "type": "string", + "description": "Specifies the eviction policy for the Azure Spot VM/VMSS", + "enum": [ + "Deallocate", + "Delete" + ], + "x-ms-enum": { + "name": "VirtualMachineEvictionPolicyTypes", + "modelAsString": true + } + }, + "BillingProfile": { + "properties": { + "maxPrice": { + "type": "number", + "format": "double", + "description": "Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01." + } + }, + "description": "Specifies the billing related details of a Azure Spot VM or VMSS. Minimum api-version: 2019-03-01." + }, + "DiskInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "encryptionSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + "x-ms-identifiers": [ + "diskEncryptionKey/sourceVault/id" + ], + "description": "Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15" + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of the disk." + }, + "BootDiagnosticsInstanceView": { + "properties": { + "consoleScreenshotBlobUri": { + "readOnly": true, + "type": "string", + "description": "The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage." + }, + "serialConsoleLogBlobUri": { + "readOnly": true, + "type": "string", + "description": "The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/InstanceViewStatus", + "description": "The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics." + } + }, + "description": "The instance view of a virtual machine boot diagnostics." + }, + "MaintenanceRedeployStatus": { + "properties": { + "isCustomerInitiatedMaintenanceAllowed": { + "type": "boolean", + "description": "True, if customer is allowed to perform Maintenance." + }, + "preMaintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Pre Maintenance Window." + }, + "preMaintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Pre Maintenance Window." + }, + "maintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Maintenance Window." + }, + "maintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Maintenance Window." + }, + "lastOperationResultCode": { + "type": "string", + "description": "The Last Maintenance Operation Result Code.", + "enum": [ + "None", + "RetryLater", + "MaintenanceAborted", + "MaintenanceCompleted" + ], + "x-ms-enum": { + "name": "MaintenanceOperationResultCodeTypes", + "modelAsString": false + } + }, + "lastOperationMessage": { + "type": "string", + "description": "Message returned for the last Maintenance Operation." + } + }, + "description": "Maintenance Operation Status." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic**" + }, + "capacity": { + "type": "integer", + "format": "int64", + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "ApiEntityReference": { + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "RollbackStatusInfo": { + "properties": { + "successfullyRolledbackInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which have been successfully rolled back." + }, + "failedRolledbackInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which failed to rollback." + }, + "rollbackError": { + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "readOnly": true, + "description": "Error details if OS rollback failed." + } + }, + "description": "Information about rollback on failed VM instances after a OS Upgrade operation." + }, + "ScheduledEventsProfile": { + "type": "object", + "properties": { + "terminateNotificationProfile": { + "$ref": "#/definitions/TerminateNotificationProfile", + "description": "Specifies Terminate Scheduled Event related configurations." + }, + "osImageNotificationProfile": { + "$ref": "#/definitions/OSImageNotificationProfile", + "description": "Specifies OS Image Scheduled Event related configurations." + } + } + }, + "TerminateNotificationProfile": { + "type": "object", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)" + }, + "enable": { + "type": "boolean", + "description": "Specifies whether the Terminate Scheduled event is enabled or disabled." + } + } + }, + "OSImageNotificationProfile": { + "type": "object", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M)" + }, + "enable": { + "type": "boolean", + "description": "Specifies whether the OS Image Scheduled event is enabled or disabled." + } + } + }, + "ProxyResource": { + "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" + } + }, + "description": "The resource model definition for an Azure Resource Manager proxy resource. It will not have tags and a location", + "x-ms-azure-resource": true + }, + "UpdateResource": { + "type": "object", + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + } + }, + "PatchSettings": { + "properties": { + "patchMode": { + "type": "string", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ", + "enum": [ + "Manual", + "AutomaticByOS", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "WindowsVMGuestPatchMode", + "modelAsString": true + } + }, + "enableHotpatching": { + "type": "boolean", + "description": "Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'." + }, + "assessmentMode": { + "type": "string", + "description": "Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "WindowsPatchAssessmentMode", + "modelAsString": true + } + }, + "automaticByPlatformSettings": { + "$ref": "#/definitions/WindowsVMGuestPatchAutomaticByPlatformSettings", + "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows." + } + }, + "description": "Specifies settings related to VM Guest Patching on Windows." + }, + "LinuxPatchSettings": { + "properties": { + "patchMode": { + "type": "string", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "LinuxVMGuestPatchMode", + "modelAsString": true + } + }, + "assessmentMode": { + "type": "string", + "description": "Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "LinuxPatchAssessmentMode", + "modelAsString": true + } + }, + "automaticByPlatformSettings": { + "$ref": "#/definitions/LinuxVMGuestPatchAutomaticByPlatformSettings", + "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux." + } + }, + "description": "Specifies settings related to VM Guest Patching on Linux." + }, + "WindowsVMGuestPatchAutomaticByPlatformSettings": { + "type": "object", + "properties": { + "rebootSetting": { + "type": "string", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation operations.", + "enum": [ + "Unknown", + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "WindowsVMGuestPatchAutomaticByPlatformRebootSetting", + "modelAsString": true + } + }, + "bypassPlatformSafetyChecksOnUserSchedule": { + "type": "boolean", + "description": "Enables customer to schedule patching without accidental upgrades" + } + }, + "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings." + }, + "LinuxVMGuestPatchAutomaticByPlatformSettings": { + "type": "object", + "properties": { + "rebootSetting": { + "type": "string", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation operations.", + "enum": [ + "Unknown", + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "LinuxVMGuestPatchAutomaticByPlatformRebootSetting", + "modelAsString": true + } + }, + "bypassPlatformSafetyChecksOnUserSchedule": { + "type": "boolean", + "description": "Enables customer to schedule patching without accidental upgrades" + } + }, + "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings." + }, + "AttachDetachDataDisksRequest": { + "type": "object", + "properties": { + "dataDisksToAttach": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/DataDisksToAttach" + }, + "x-ms-identifiers": [ + "diskId" + ], + "description": "The list of managed data disks to be attached." + }, + "dataDisksToDetach": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/DataDisksToDetach" + }, + "x-ms-identifiers": [ + "diskId" + ], + "description": "The list of managed data disks to be detached." + } + }, + "description": "Specifies the input for attaching and detaching a list of managed data disks." + }, + "DataDisksToAttach": { + "type": "object", + "properties": { + "diskId": { + "type": "string", + "description": "ID of the managed data disk." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "The logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. If not specified, lun would be auto assigned." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.**" + }, + "deleteOption": { + "$ref": "#/definitions/DeleteOption", + "description": "Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed disk." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "diskId" + ], + "description": "Describes the data disk to be attached." + }, + "DataDisksToDetach": { + "type": "object", + "properties": { + "diskId": { + "type": "string", + "description": "ID of the managed data disk." + }, + "detachOption": { + "$ref": "#/definitions/DetachOption", + "description": "Supported options available for Detach of a disk from a VM. Refer to DetachOption object reference for more details." + } + }, + "required": [ + "diskId" + ], + "description": "Describes the data disk to be detached." + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/dedicatedHost.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/dedicatedHost.json new file mode 100644 index 000000000..7ddea6dc0 --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/dedicatedHost.json @@ -0,0 +1,1209 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}": { + "put": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_CreateOrUpdate", + "description": "Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + }, + "description": "Parameters supplied to the Create Dedicated Host Group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or update a dedicated host group.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json" + }, + "Create or update a dedicated host group with Ultra SSD support.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json" + } + } + }, + "patch": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Update", + "description": "Update an dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostGroupUpdate" + }, + "description": "Parameters supplied to the Update Dedicated Host Group operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DedicatedHostGroup_Update_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Update_MaximumSet_Gen.json" + }, + "DedicatedHostGroup_Update_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Delete", + "description": "Delete a dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DedicatedHostGroup_Delete_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Delete_MaximumSet_Gen.json" + }, + "DedicatedHostGroup_Delete_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Get", + "description": "Retrieves information about a dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated hosts under the dedicated host group. 'UserData' is not supported for dedicated host group.", + "enum": [ + "instanceView", + "userData" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a dedicated host group.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Get.json" + }, + "Create an ultraSSDEnabled dedicated host group.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Get_UltraSSDEnabledDedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups": { + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_ListByResourceGroup", + "description": "Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen.json" + }, + "DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/hostGroups": { + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_ListBySubscription", + "description": "Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DedicatedHostGroup_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_ListBySubscription_MaximumSet_Gen.json" + }, + "DedicatedHostGroup_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}": { + "put": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_CreateOrUpdate", + "description": "Create or update a dedicated host .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host ." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHost" + }, + "description": "Parameters supplied to the Create Dedicated Host." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or update a dedicated host .": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Update", + "description": "Update a dedicated host .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host ." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostUpdate" + }, + "description": "Parameters supplied to the Update Dedicated Host operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DedicatedHost_Update_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Update_MaximumSet_Gen.json" + }, + "DedicatedHost_Update_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Update_MinimumSet_Gen.json" + }, + "DedicatedHost_Update_Resize": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Update_Resize.json" + } + } + }, + "delete": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Delete", + "description": "Delete a dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DedicatedHost_Delete_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Delete_MaximumSet_Gen.json" + }, + "DedicatedHost_Delete_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Get", + "description": "Retrieves information about a dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated host. 'UserData' is not supported for dedicated host.", + "enum": [ + "instanceView", + "userData" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a dedicated host.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts": { + "get": { + "tags": [ + "DedicatedHost" + ], + "operationId": "DedicatedHosts_ListByHostGroup", + "description": "Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DedicatedHost_ListByHostGroup_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MaximumSet_Gen.json" + }, + "DedicatedHost_ListByHostGroup_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/restart": { + "post": { + "tags": [ + "DedicatedHost" + ], + "operationId": "DedicatedHosts_Restart", + "description": "Restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Restart Dedicated Host.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/redeploy": { + "post": { + "tags": [ + "DedicatedHost" + ], + "operationId": "DedicatedHosts_Redeploy", + "description": "Redeploy the dedicated host. The operation will complete successfully once the dedicated host has migrated to a new node and is running. To determine the health of VMs deployed on the dedicated host after the redeploy check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "description": "The name of the dedicated host." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Redeploy Dedicated Host.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Redeploy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/hostSizes": { + "get": { + "tags": [ + "DedicatedHost" + ], + "operationId": "DedicatedHosts_ListAvailableSizes", + "description": "Lists all available dedicated host sizes to which the specified dedicated host can be resized. NOTE: The dedicated host sizes provided can be used to only scale up the existing dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "description": "The name of the dedicated host." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostSizeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Get Available Dedicated Host Sizes.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_ListAvailableSizes.json" + } + } + } + } + }, + "definitions": { + "DedicatedHostGroupInstanceView": { + "properties": { + "hosts": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostInstanceViewWithName" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of instance view of the dedicated hosts under the dedicated host group." + } + } + }, + "DedicatedHostGroupProperties": { + "properties": { + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "Number of fault domains that the host group can span." + }, + "hosts": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all dedicated hosts in the dedicated host group." + }, + "instanceView": { + "$ref": "#/definitions/DedicatedHostGroupInstanceView", + "readOnly": true, + "description": "The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group." + }, + "supportAutomaticPlacement": { + "type": "boolean", + "description": "Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01." + }, + "additionalCapabilities": { + "type": "object", + "properties": { + "ultraSSDEnabled": { + "type": "boolean", + "description": "The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01." + } + }, + "description": "Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01." + } + }, + "required": [ + "platformFaultDomainCount" + ], + "description": "Dedicated Host Group Properties." + }, + "DedicatedHostGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the dedicated host group that the dedicated hosts should be assigned to. Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group." + }, + "DedicatedHostGroupUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated." + }, + "DedicatedHostGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostGroup" + }, + "description": "The list of dedicated host groups" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups." + } + }, + "required": [ + "value" + ], + "description": "The List Dedicated Host Group with resource group response." + }, + "DedicatedHostLicenseType": { + "type": "string", + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.**", + "enum": [ + "None", + "Windows_Server_Hybrid", + "Windows_Server_Perpetual" + ], + "x-ms-enum": { + "name": "DedicatedHostLicenseTypes", + "modelAsString": false + } + }, + "DedicatedHostAllocatableVM": { + "properties": { + "vmSize": { + "type": "string", + "description": "VM size in terms of which the unutilized capacity is represented." + }, + "count": { + "type": "number", + "format": "double", + "description": "Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity." + } + }, + "description": "Represents the dedicated host unutilized capacity in terms of a specific VM size." + }, + "DedicatedHostAvailableCapacity": { + "properties": { + "allocatableVMs": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostAllocatableVM" + }, + "x-ms-identifiers": [], + "description": "The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host." + } + }, + "description": "Dedicated host unutilized capacity." + }, + "DedicatedHostInstanceView": { + "properties": { + "assetId": { + "readOnly": true, + "type": "string", + "description": "Specifies the unique id of the dedicated physical machine on which the dedicated host resides." + }, + "availableCapacity": { + "$ref": "#/definitions/DedicatedHostAvailableCapacity", + "description": "Unutilized capacity of the dedicated host." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of a dedicated host." + }, + "DedicatedHostInstanceViewWithName": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the dedicated host." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DedicatedHostInstanceView" + } + ], + "description": "The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group." + }, + "DedicatedHostProperties": { + "properties": { + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Fault domain of the dedicated host within a dedicated host group." + }, + "autoReplaceOnFailure": { + "type": "boolean", + "description": "Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided." + }, + "hostId": { + "readOnly": true, + "type": "string", + "description": "A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all virtual machines in the Dedicated Host." + }, + "licenseType": { + "$ref": "#/definitions/DedicatedHostLicenseType", + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.**" + }, + "provisioningTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The date when the host was first provisioned." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/DedicatedHostInstanceView", + "readOnly": true, + "description": "The dedicated host instance view." + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01." + } + }, + "description": "Properties of the dedicated host." + }, + "DedicatedHost": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "required": [ + "sku" + ], + "description": "Specifies information about the Dedicated host." + }, + "DedicatedHostUpdate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "[List all available dedicated host sizes for resizing] (https://docs.microsoft.com/rest/api/compute/dedicated-hosts/listavailablesizes). Resizing can be only used to scale up DedicatedHost. Only name is required to be set. " + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated." + }, + "DedicatedHostListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHost" + }, + "description": "The list of dedicated hosts" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of dedicated hosts. Call ListNext() with this URI to fetch the next page of dedicated hosts." + } + }, + "required": [ + "value" + ], + "description": "The list dedicated host operation response." + }, + "DedicatedHostSizeListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of dedicated host sizes." + } + }, + "description": "The List Dedicated Host sizes operation response." + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/image.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/image.json new file mode 100644 index 000000000..5418b8af8 --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/image.json @@ -0,0 +1,597 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}": { + "put": { + "tags": [ + "Images" + ], + "operationId": "Images_CreateOrUpdate", + "description": "Create or update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Image" + }, + "description": "Parameters supplied to the Create Image operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a virtual machine image from a blob.": { + "$ref": "./examples/imageExamples/Image_CreateFromABlob.json" + }, + "Create a virtual machine image from a snapshot.": { + "$ref": "./examples/imageExamples/Image_CreateFromASnapshot.json" + }, + "Create a virtual machine image from a managed disk.": { + "$ref": "./examples/imageExamples/Image_CreateFromAManagedDisk.json" + }, + "Create a virtual machine image from an existing virtual machine.": { + "$ref": "./examples/imageExamples/Image_CreateFromAVM.json" + }, + "Create a virtual machine image that includes a data disk from a blob.": { + "$ref": "./examples/imageExamples/Image_Create_DataDiskFromABlobIncluded.json" + }, + "Create a virtual machine image that includes a data disk from a snapshot.": { + "$ref": "./examples/imageExamples/Image_Create_DataDiskFromASnapshotIncluded.json" + }, + "Create a virtual machine image that includes a data disk from a managed disk.": { + "$ref": "./examples/imageExamples/Image_Create_DataDiskFromAManagedDiskIncluded.json" + }, + "Create a virtual machine image from a blob with DiskEncryptionSet resource.": { + "$ref": "./examples/imageExamples/Image_CreateFromABlobWithDiskEncryptionSet.json" + }, + "Create a virtual machine image from a snapshot with DiskEncryptionSet resource.": { + "$ref": "./examples/imageExamples/Image_CreateFromASnapshotWithDiskEncryptionSet.json" + }, + "Create a virtual machine image from a managed disk with DiskEncryptionSet resource.": { + "$ref": "./examples/imageExamples/Image_CreateFromAManagedDiskWithDiskEncryptionSet.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Images" + ], + "operationId": "Images_Update", + "description": "Update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUpdate" + }, + "description": "Parameters supplied to the Update Image operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates tags of an Image.": { + "$ref": "./examples/imageExamples/Image_Update.json" + } + } + }, + "delete": { + "tags": [ + "Images" + ], + "operationId": "Images_Delete", + "description": "Deletes an Image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Image_Delete_MaximumSet_Gen": { + "$ref": "./examples/imageExamples/Images_Delete_MaximumSet_Gen.json" + }, + "Image_Delete_MinimumSet_Gen": { + "$ref": "./examples/imageExamples/Images_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_Get", + "description": "Gets an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get information about a virtual machine image.": { + "$ref": "./examples/imageExamples/Image_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_ListByResourceGroup", + "description": "Gets the list of images under a resource group. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a resource group.": { + "$ref": "./examples/imageExamples/Image_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_List", + "description": "Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a subscription.": { + "$ref": "./examples/imageExamples/Image_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ImageOSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "The OS State. For managed images, use Generalized.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false, + "values": [ + { + "value": "Generalized", + "description": "Generalized image. Needs to be provisioned during deployment time." + }, + { + "value": "Specialized", + "description": "Specialized image. Contains already provisioned OS Disk." + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageDisk" + } + ], + "required": [ + "osType", + "osState" + ], + "description": "Describes an Operating System disk." + }, + "ImageDataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageDisk" + } + ], + "required": [ + "lun" + ], + "description": "Describes a data disk." + }, + "ImageDisk": { + "properties": { + "snapshot": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The snapshot." + }, + "managedDisk": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The managedDisk." + }, + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "type": "string", + "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB." + }, + "storageAccountType": { + "$ref": "./computeRPCommon.json#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." + }, + "diskEncryptionSet": { + "$ref": "./computeRPCommon.json#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed image disk." + } + }, + "description": "Describes a image disk." + }, + "ImageStorageProfile": { + "properties": { + "osDisk": { + "$ref": "#/definitions/ImageOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "zoneResilient": { + "type": "boolean", + "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." + } + }, + "description": "Describes a storage profile." + }, + "ImageProperties": { + "properties": { + "sourceVirtualMachine": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The source virtual machine from which Image is created." + }, + "storageProfile": { + "$ref": "#/definitions/ImageStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state." + }, + "hyperVGeneration": { + "$ref": "./computeRPCommon.json#/definitions/HyperVGenerationType", + "description": "Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource." + } + }, + "description": "Describes the properties of an Image." + }, + "Image": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location of the Image." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "ImageUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "The source user image virtual hard disk. Only tags may be updated." + }, + "ImageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "description": "The list of Images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images." + } + }, + "required": [ + "value" + ], + "description": "The List Image operation response." + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/logAnalytic.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/logAnalytic.json new file mode 100644 index 000000000..806f2d2e5 --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/logAnalytic.json @@ -0,0 +1,259 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getRequestRateByInterval": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportRequestRateByInterval", + "x-ms-examples": { + "Export logs which contain all Api requests made to Compute Resource Provider within the given time period broken down by intervals.": { + "$ref": "./examples/logAnalyticExamples/LogAnalytics_RequestRateByInterval.json" + } + }, + "description": "Export logs that show Api requests made by this subscription in the given time window to show throttling activities.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RequestRateByIntervalInput" + }, + "description": "Parameters supplied to the LogAnalytics getRequestRateByInterval Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getThrottledRequests": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportThrottledRequests", + "x-ms-examples": { + "Export logs which contain all throttled Api requests made to Compute Resource Provider within the given time period.": { + "$ref": "./examples/logAnalyticExamples/LogAnalytics_ThrottledRequests.json" + } + }, + "description": "Export logs that show total throttled Api requests for this subscription in the given time window.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThrottledRequestsInput" + }, + "description": "Parameters supplied to the LogAnalytics getThrottledRequests Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "RequestRateByIntervalInput": { + "properties": { + "intervalLength": { + "type": "string", + "description": "Interval value in minutes used to create LogAnalytics call rate logs.", + "enum": [ + "ThreeMins", + "FiveMins", + "ThirtyMins", + "SixtyMins" + ], + "x-ms-enum": { + "name": "IntervalInMins", + "modelAsString": false + } + } + }, + "required": [ + "intervalLength" + ], + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getRequestRateByInterval Api." + }, + "ThrottledRequestsInput": { + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getThrottledRequests Api." + }, + "LogAnalyticsInputBase": { + "properties": { + "blobContainerSasUri": { + "type": "string", + "description": "SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to." + }, + "fromTime": { + "type": "string", + "format": "date-time", + "description": "From time of the query" + }, + "toTime": { + "type": "string", + "format": "date-time", + "description": "To time of the query" + }, + "groupByThrottlePolicy": { + "type": "boolean", + "description": "Group query result by Throttle Policy applied." + }, + "groupByOperationName": { + "type": "boolean", + "description": "Group query result by Operation Name." + }, + "groupByResourceName": { + "type": "boolean", + "description": "Group query result by Resource Name." + }, + "groupByClientApplicationId": { + "type": "boolean", + "description": "Group query result by Client Application ID." + }, + "groupByUserAgent": { + "type": "boolean", + "description": "Group query result by User Agent." + } + }, + "required": [ + "blobContainerSasUri", + "fromTime", + "toTime" + ], + "description": "Api input base class for LogAnalytics Api." + }, + "LogAnalyticsOperationResult": { + "properties": { + "properties": { + "readOnly": true, + "$ref": "#/definitions/LogAnalyticsOutput", + "description": "LogAnalyticsOutput" + } + }, + "description": "LogAnalytics operation status response" + }, + "LogAnalyticsOutput": { + "properties": { + "output": { + "readOnly": true, + "type": "string", + "description": "Output file Uri path to blob container." + } + }, + "description": "LogAnalytics output properties" + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/proximityPlacementGroup.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/proximityPlacementGroup.json new file mode 100644 index 000000000..e56cadd6d --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/proximityPlacementGroup.json @@ -0,0 +1,455 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}": { + "put": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_CreateOrUpdate", + "description": "Create or update a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + }, + "description": "Parameters supplied to the Create Proximity Placement Group operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or Update a proximity placement group.": { + "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Update", + "description": "Update a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupUpdate" + }, + "description": "Parameters supplied to the Update Proximity Placement Group operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update a proximity placement group.": { + "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Patch.json" + } + } + }, + "delete": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Delete", + "description": "Delete a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a proximity placement group.": { + "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Delete.json" + } + } + }, + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Get", + "description": "Retrieves information about a proximity placement group .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "includeColocationStatus", + "in": "query", + "required": false, + "type": "string", + "description": "includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get proximity placement groups.": { + "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/proximityPlacementGroups": { + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_ListBySubscription", + "description": "Lists all proximity placement groups in a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List proximity placement groups.": { + "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups": { + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_ListByResourceGroup", + "description": "Lists all proximity placement groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List proximity placement group.": { + "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListByResourceGroup.json" + } + } + } + } + }, + "definitions": { + "ProximityPlacementGroupProperties": { + "properties": { + "proximityPlacementGroupType": { + "type": "string", + "description": "Specifies the type of the proximity placement group. Possible values are: **Standard** : Co-locate resources within an Azure region or Availability Zone. **Ultra** : For future use.", + "enum": [ + "Standard", + "Ultra" + ], + "x-ms-enum": { + "name": "ProximityPlacementGroupType", + "modelAsString": true + } + }, + "virtualMachines": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all virtual machines in the proximity placement group." + }, + "virtualMachineScaleSets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all virtual machine scale sets in the proximity placement group." + }, + "availabilitySets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all availability sets in the proximity placement group." + }, + "colocationStatus": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus", + "description": "Describes colocation status of the Proximity Placement Group." + }, + "intent": { + "type": "object", + "properties": { + "vmSizes": { + "type": "array", + "description": "Specifies possible sizes of virtual machines that can be created in the proximity placement group.", + "items": { + "type": "string", + "description": "Specifies the size of the virtual machine. Recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set." + } + } + }, + "description": "Specifies the user intent of the proximity placement group." + } + }, + "description": "Describes the properties of a Proximity Placement Group." + }, + "ProximityPlacementGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProximityPlacementGroupProperties", + "description": "Describes the properties of a Proximity Placement Group." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the proximity placement group." + }, + "ProximityPlacementGroupUpdate": { + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the proximity placement group." + }, + "ProximityPlacementGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProximityPlacementGroup" + }, + "description": "The list of proximity placement groups" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of proximity placement groups." + } + }, + "required": [ + "value" + ], + "description": "The List Proximity Placement Group operation response." + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/restorePoint.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/restorePoint.json new file mode 100644 index 000000000..e2a318eb4 --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/restorePoint.json @@ -0,0 +1,1004 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}": { + "put": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_CreateOrUpdate", + "description": "The operation to create or update the restore point collection. Please refer to https://aka.ms/RestorePoints for more details. When updating a restore point collection, only tags may be modified.", + "x-ms-examples": { + "Create or update a restore point collection.": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_CreateOrUpdate.json" + }, + "Create or update a restore point collection for cross region copy.": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_CreateOrUpdate_ForCrossRegionCopy.json" + } + }, + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point collection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RestorePointCollection" + }, + "description": "Parameters supplied to the Create or Update restore point collection operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollection" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/RestorePointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_Update", + "description": "The operation to update the restore point collection.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point collection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RestorePointCollectionUpdate" + }, + "description": "Parameters supplied to the Update restore point collection operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "RestorePointCollection_Update_MaximumSet_Gen": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_Update_MaximumSet_Gen.json" + }, + "RestorePointCollection_Update_MinimumSet_Gen": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_Delete", + "description": "The operation to delete the restore point collection. This operation will also delete all the contained restore points.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Restore Point Collection." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RestorePointCollection_Delete_MaximumSet_Gen": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_Delete_MaximumSet_Gen.json" + }, + "RestorePointCollection_Delete_MinimumSet_Gen": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_Get", + "description": "The operation to get the restore point collection.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point collection." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. If expand=restorePoints, server will return all contained restore points in the restorePointCollection.", + "enum": [ + "restorePoints" + ], + "x-ms-enum": { + "name": "RestorePointCollectionExpandOptions", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Get a restore point collection (but not the restore points contained in the restore point collection)": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_Get.json" + }, + "Get a restore point collection, including the restore points contained in the restore point collection": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_Get_WithContainedRestorePoints.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections": { + "get": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_List", + "description": "Gets the list of restore point collections in a resource group.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Gets the list of restore point collections in a resource group.": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_ListByResourceGroup.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/restorePointCollections": { + "get": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_ListAll", + "description": "Gets the list of restore point collections in the subscription. Use nextLink property in the response to get the next page of restore point collections. Do this till nextLink is not null to fetch all the restore point collections.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets the list of restore point collections in a subscription": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}": { + "put": { + "operationId": "RestorePoints_Create", + "description": "The operation to create the restore point. Updating properties of an existing restore point is not allowed", + "x-ms-examples": { + "Create a restore point": { + "$ref": "./examples/restorePointExamples/RestorePoint_Create.json" + }, + "Copy a restore point to a different region": { + "$ref": "./examples/restorePointExamples/RestorePoint_Copy_BetweenRegions.json" + } + }, + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point collection." + }, + { + "name": "restorePointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RestorePoint" + }, + "description": "Parameters supplied to the Create restore point operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/RestorePoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RestorePoints_Delete", + "description": "The operation to delete the restore point.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Restore Point Collection." + }, + { + "name": "restorePointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RestorePoint_Delete_MaximumSet_Gen": { + "$ref": "./examples/restorePointExamples/RestorePoint_Delete_MaximumSet_Gen.json" + }, + "RestorePoint_Delete_MinimumSet_Gen": { + "$ref": "./examples/restorePointExamples/RestorePoint_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "operationId": "RestorePoints_Get", + "description": "The operation to get the restore point.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point collection." + }, + { + "name": "restorePointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "RestorePointExpandOptions", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Get a restore point": { + "$ref": "./examples/restorePointExamples/RestorePoint_Get.json" + }, + "Get restore point with instance view": { + "$ref": "./examples/restorePointExamples/RestorePoint_Get_WithInstanceView.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "RestorePointCollectionSourceProperties": { + "properties": { + "location": { + "type": "string", + "readOnly": true, + "description": "Location of the source resource used to create this restore point collection." + }, + "id": { + "type": "string", + "description": "Resource Id of the source resource used to create this restore point collection" + } + }, + "description": "The properties of the source resource that this restore point collection is created from." + }, + "RestorePointCollectionProperties": { + "properties": { + "source": { + "$ref": "#/definitions/RestorePointCollectionSourceProperties" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the restore point collection." + }, + "restorePointCollectionId": { + "type": "string", + "readOnly": true, + "description": "The unique id of the restore point collection." + }, + "restorePoints": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RestorePoint" + }, + "description": "A list containing all restore points created under this restore point collection." + } + }, + "description": "The restore point collection properties." + }, + "RestorePointCollection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestorePointCollectionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Create or update Restore Point collection parameters." + }, + "RestorePointCollectionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestorePointCollectionProperties" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Update Restore Point collection parameters." + }, + "RestorePointCollectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RestorePointCollection" + }, + "description": "Gets the list of restore point collections." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of RestorePointCollections. Call ListNext() with this to fetch the next page of RestorePointCollections" + } + }, + "description": "The List restore point collection operation response." + }, + "RestorePointSourceMetadata": { + "properties": { + "hardwareProfile": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/HardwareProfile", + "description": "Gets the hardware profile." + }, + "storageProfile": { + "$ref": "#/definitions/RestorePointSourceVMStorageProfile", + "description": "Gets the storage profile." + }, + "osProfile": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/OSProfile", + "description": "Gets the OS profile." + }, + "diagnosticsProfile": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile", + "description": "Gets the diagnostics profile." + }, + "licenseType": { + "type": "string", + "readOnly": true, + "description": "Gets the license type, which is for bring your own license scenario." + }, + "vmId": { + "type": "string", + "readOnly": true, + "description": "Gets the virtual machine unique id." + }, + "securityProfile": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", + "description": "Gets the security profile." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "Location of the VM from which the restore point was created." + }, + "userData": { + "type": "string", + "readOnly": true, + "description": "UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value." + }, + "hyperVGeneration": { + "$ref": "./computeRPCommon.json#/definitions/HyperVGenerationType", + "readOnly": true, + "description": "HyperVGeneration of the source VM for which restore point is captured." + } + }, + "description": "Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation." + }, + "RestorePointSourceVMStorageProfile": { + "properties": { + "osDisk": { + "$ref": "#/definitions/RestorePointSourceVMOSDisk", + "description": "Gets the OS disk of the VM captured at the time of the restore point creation." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/RestorePointSourceVMDataDisk" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "Gets the data disks of the VM captured at the time of the restore point creation." + }, + "diskControllerType": { + "$ref": "#/definitions/RestorePointSourceVMDiskControllerType", + "readOnly": true, + "description": "Gets the disk controller type of the VM captured at the time of the restore point creation." + } + }, + "description": "Describes the storage profile." + }, + "RestorePointSourceVMDiskControllerType": { + "type": "string", + "enum": [ + "SCSI", + "NVMe" + ], + "x-ms-enum": { + "name": "DiskControllerTypes", + "modelAsString": true + }, + "description": "Provides the disk controller type configured for the VM. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2). For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes." + }, + "RestorePointSourceVMOSDisk": { + "properties": { + "osType": { + "type": "string", + "readOnly": true, + "description": "Gets the Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemType", + "modelAsString": true + } + }, + "encryptionSettings": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/DiskEncryptionSettings", + "description": "Gets the disk encryption settings." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the disk name." + }, + "caching": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/Caching", + "description": "Gets the caching type." + }, + "diskSizeGB": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "Gets the disk size in GB." + }, + "managedDisk": { + "$ref": "./computeRPCommon.json#/definitions/ManagedDiskParameters", + "description": "Gets the managed disk details" + }, + "diskRestorePoint": { + "$ref": "#/definitions/DiskRestorePointAttributes", + "description": "Contains Disk Restore Point properties." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "readOnly": true, + "description": "Shows true if the disk is write-accelerator enabled." + } + }, + "description": "Describes an Operating System disk." + }, + "RestorePointSourceVMDataDisk": { + "properties": { + "lun": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "Gets the logical unit number." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the disk name." + }, + "caching": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/Caching", + "description": "Gets the caching type." + }, + "diskSizeGB": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks." + }, + "managedDisk": { + "$ref": "./computeRPCommon.json#/definitions/ManagedDiskParameters", + "description": "Contains the managed disk details." + }, + "diskRestorePoint": { + "$ref": "#/definitions/DiskRestorePointAttributes", + "description": "Contains Disk Restore Point properties." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "readOnly": true, + "description": "Shows true if the disk is write-accelerator enabled." + } + }, + "description": "Describes a data disk." + }, + "DiskRestorePointAttributes": { + "type": "object", + "properties": { + "encryption": { + "$ref": "#/definitions/RestorePointEncryption" + }, + "sourceDiskRestorePoint": { + "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", + "description": "Resource Id of the source disk restore point." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + } + ], + "description": "Disk Restore Point details." + }, + "RestorePointEncryption": { + "type": "object", + "properties": { + "diskEncryptionSet": { + "$ref": "./computeRPCommon.json#/definitions/DiskEncryptionSetParameters" + }, + "type": { + "$ref": "#/definitions/RestorePointEncryptionType" + } + }, + "description": "Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point." + }, + "RestorePointEncryptionType": { + "type": "string", + "description": "The type of key used to encrypt the data of the disk restore point.", + "enum": [ + "EncryptionAtRestWithPlatformKey", + "EncryptionAtRestWithCustomerKey", + "EncryptionAtRestWithPlatformAndCustomerKeys" + ], + "x-ms-enum": { + "name": "RestorePointEncryptionType", + "modelAsString": true, + "values": [ + { + "value": "EncryptionAtRestWithPlatformKey", + "description": "Disk Restore Point is encrypted at rest with Platform managed key. " + }, + { + "value": "EncryptionAtRestWithCustomerKey", + "description": "Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer." + }, + { + "value": "EncryptionAtRestWithPlatformAndCustomerKeys", + "description": "Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed." + } + ] + } + }, + "RestorePoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestorePointProperties" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/ProxyResource" + } + ], + "description": "Restore Point details." + }, + "RestorePointInstanceView": { + "type": "object", + "properties": { + "diskRestorePoints": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskRestorePointInstanceView" + }, + "description": "The disk restore points information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of a restore point." + }, + "DiskRestorePointInstanceView": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Disk restore point Id." + }, + "replicationStatus": { + "$ref": "#/definitions/DiskRestorePointReplicationStatus", + "description": "The disk restore point replication status information." + } + }, + "description": "The instance view of a disk restore point." + }, + "DiskRestorePointReplicationStatus": { + "type": "object", + "properties": { + "status": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus", + "description": "The resource status information." + }, + "completionPercent": { + "type": "integer", + "format": "int32", + "description": "Replication completion percentage." + } + }, + "description": "The instance view of a disk restore point." + }, + "RestorePointProperties": { + "type": "object", + "properties": { + "excludeDisks": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference" + }, + "description": "List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included." + }, + "sourceMetadata": { + "$ref": "#/definitions/RestorePointSourceMetadata", + "description": "Gets the details of the VM captured at the time of the restore point creation." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Gets the provisioning state of the restore point." + }, + "consistencyMode": { + "type": "string", + "enum": [ + "CrashConsistent", + "FileSystemConsistent", + "ApplicationConsistent" + ], + "x-ms-enum": { + "name": "ConsistencyModeTypes", + "modelAsString": true + }, + "description": "ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details." + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Gets the creation time of the restore point." + }, + "sourceRestorePoint": { + "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", + "description": "Resource Id of the source restore point from which a copy needs to be created." + }, + "instanceView": { + "$ref": "#/definitions/RestorePointInstanceView", + "readOnly": true, + "description": "The restore point instance view." + } + }, + "description": "The restore point properties." + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/runCommand.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/runCommand.json new file mode 100644 index 000000000..18a93072e --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/runCommand.json @@ -0,0 +1,1332 @@ +{ + "swagger": "2.0", + "info": { + "title": "RunCommandsClient", + "description": "The Run Commands Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_List", + "x-ms-examples": { + "VirtualMachineRunCommandList": { + "$ref": "./examples/runCommandExamples/RunCommand_List.json" + } + }, + "description": "Lists all available run commands for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which run commands is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_Get", + "x-ms-examples": { + "VirtualMachineRunCommandGet": { + "$ref": "./examples/runCommandExamples/RunCommand_Get.json" + } + }, + "description": "Gets specific run command for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which run commands is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "The command id." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandDocument" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_RunCommand", + "x-ms-examples": { + "VirtualMachineRunCommand": { + "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand.json" + } + }, + "description": "Run command on the VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandInput" + }, + "description": "Parameters supplied to the Run command operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/runCommand": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_RunCommand", + "x-ms-examples": { + "VirtualMachineScaleSetVMs_RunCommand": { + "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand.json" + } + }, + "description": "Run command on a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandInput" + }, + "description": "Parameters supplied to the Run command operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}": { + "put": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_CreateOrUpdate", + "description": "The operation to create or update the run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the run command should be created or updated." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "name": "runCommand", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + }, + "description": "Parameters supplied to the Create Virtual Machine RunCommand operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_Update", + "description": "The operation to update the run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the run command should be updated." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "name": "runCommand", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommandUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine RunCommand operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_Update.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_Delete", + "description": "The operation to delete the run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the run command should be deleted." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_Delete.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_GetByVirtualMachine", + "description": "The operation to get the run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the run command." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_ListByVirtualMachine", + "description": "The operation to get all run commands of a Virtual Machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the run command." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommandsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List run commands in a Virtual Machine.": { + "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetVMRunCommands" + ], + "operationId": "VirtualMachineScaleSetVMRunCommands_CreateOrUpdate", + "description": "The operation to create or update the VMSS VM run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "name": "runCommand", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + }, + "description": "Parameters supplied to the Create Virtual Machine RunCommand operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create VirtualMachineScaleSet VM run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSetVMRunCommands" + ], + "operationId": "VirtualMachineScaleSetVMRunCommands_Update", + "description": "The operation to update the VMSS VM run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "name": "runCommand", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommandUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine RunCommand operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update VirtualMachineScaleSet VM run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Update.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetVMRunCommands" + ], + "operationId": "VirtualMachineScaleSetVMRunCommands_Delete", + "description": "The operation to delete the VMSS VM run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete VirtualMachineScaleSet VM run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Delete.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMRunCommands" + ], + "operationId": "VirtualMachineScaleSetVMRunCommands_Get", + "description": "The operation to get the VMSS VM run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get VirtualMachineScaleSet VM run commands.": { + "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMRunCommands" + ], + "operationId": "VirtualMachineScaleSetVMRunCommands_List", + "description": "The operation to get all run commands of an instance in Virtual Machine Scaleset.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommandsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List run commands in Vmss instance.": { + "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_List.json" + } + } + } + } + }, + "definitions": { + "RunCommandInputParameter": { + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "value": { + "type": "string", + "description": "The run command parameter value." + } + }, + "required": [ + "name", + "value" + ], + "type": "object", + "description": "Describes the properties of a run command parameter." + }, + "RunCommandInput": { + "properties": { + "commandId": { + "type": "string", + "description": "The run command id." + }, + "script": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. The script to be executed. When this value is given, the given script will override the default script of the command." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The run command parameters." + } + }, + "required": [ + "commandId" + ], + "type": "object", + "description": "Capture Virtual Machine parameters." + }, + "RunCommandParameterDefinition": { + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "type": { + "type": "string", + "description": "The run command parameter type." + }, + "defaultValue": { + "type": "string", + "description": "The run command parameter default value." + }, + "required": { + "type": "boolean", + "description": "The run command parameter required.", + "default": false + } + }, + "required": [ + "name", + "type" + ], + "type": "object", + "description": "Describes the properties of a run command parameter." + }, + "RunCommandDocumentBase": { + "properties": { + "$schema": { + "type": "string", + "description": "The VM run command schema." + }, + "id": { + "type": "string", + "description": "The VM run command id." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "label": { + "type": "string", + "description": "The VM run command label." + }, + "description": { + "type": "string", + "description": "The VM run command description." + } + }, + "required": [ + "$schema", + "id", + "osType", + "label", + "description" + ], + "type": "object", + "description": "Describes the properties of a Run Command metadata." + }, + "RunCommandDocument": { + "allOf": [ + { + "$ref": "#/definitions/RunCommandDocumentBase" + } + ], + "properties": { + "script": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The script to be executed." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandParameterDefinition" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "description": "The parameters used by the script." + } + }, + "required": [ + "script" + ], + "type": "object", + "description": "Describes the properties of a Run Command." + }, + "RunCommandListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandDocumentBase" + }, + "description": "The list of virtual machine run commands." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands." + } + }, + "required": [ + "value" + ], + "type": "object", + "description": "The List Virtual Machine operation response." + }, + "RunCommandManagedIdentity": { + "properties": { + "clientId": { + "type": "string", + "description": "Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided." + }, + "objectId": { + "type": "string", + "description": "Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided." + } + }, + "type": "object", + "description": " Contains clientId or objectId (use only one, not both) of a user-assigned managed identity that has access to storage blob used in Run Command. Use an empty RunCommandManagedIdentity object in case of system-assigned identity. Make sure the Azure storage blob exists in case of scriptUri, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment with scriptUri blob and 'Storage Blob Data Contributor' for Append blobs(outputBlobUri, errorBlobUri). In case of user assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged." + }, + "RunCommandResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "Run command operation response." + } + }, + "type": "object" + }, + "VirtualMachineRunCommandInstanceView": { + "properties": { + "executionState": { + "type": "string", + "description": "Script execution status.", + "enum": [ + "Unknown", + "Pending", + "Running", + "Failed", + "Succeeded", + "TimedOut", + "Canceled" + ], + "x-ms-enum": { + "name": "ExecutionState", + "modelAsString": true + } + }, + "executionMessage": { + "type": "string", + "description": "Communicate script configuration errors or execution messages." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "description": "Exit code returned from script execution." + }, + "output": { + "type": "string", + "description": "Script output stream." + }, + "error": { + "type": "string", + "description": "Script error stream." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Script start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Script end time." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "type": "object", + "description": "The instance view of a virtual machine run command." + }, + "VirtualMachineRunCommandScriptSource": { + "properties": { + "script": { + "type": "string", + "description": "Specifies the script content to be executed on the VM." + }, + "scriptUri": { + "type": "string", + "description": "Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI." + }, + "commandId": { + "type": "string", + "description": "Specifies a commandId of predefined built-in script." + }, + "scriptUriManagedIdentity": { + "$ref": "#/definitions/RunCommandManagedIdentity", + "description": "User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged." + } + }, + "type": "object", + "description": "Describes the script sources for run command. Use only one of script, scriptUri, commandId." + }, + "VirtualMachineRunCommandProperties": { + "properties": { + "source": { + "$ref": "#/definitions/VirtualMachineRunCommandScriptSource", + "description": "The source of the run command script." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The parameters used by the script." + }, + "protectedParameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The parameters used by the script." + }, + "asyncExecution": { + "type": "boolean", + "description": "Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.", + "default": false + }, + "runAsUser": { + "type": "string", + "description": "Specifies the user account on the VM when executing the run command." + }, + "runAsPassword": { + "type": "string", + "description": "Specifies the user account password on the VM when executing the run command." + }, + "timeoutInSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout in seconds to execute the run command." + }, + "outputBlobUri": { + "type": "string", + "description": "Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter. " + }, + "errorBlobUri": { + "type": "string", + "description": "Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter." + }, + "outputBlobManagedIdentity": { + "$ref": "#/definitions/RunCommandManagedIdentity", + "description": "User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged " + }, + "errorBlobManagedIdentity": { + "$ref": "#/definitions/RunCommandManagedIdentity", + "description": "User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged " + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results " + }, + "instanceView": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineRunCommandInstanceView", + "description": "The virtual machine run command instance view." + }, + "treatFailureAsDeploymentFailure": { + "type": "boolean", + "description": "Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ", + "default": false + } + }, + "type": "object", + "description": "Describes the properties of a Virtual Machine run command." + }, + "VirtualMachineRunCommand": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineRunCommandProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "type": "object", + "description": "Describes a Virtual Machine run command." + }, + "VirtualMachineRunCommandUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineRunCommandProperties" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "type": "object", + "description": "Describes a Virtual Machine run command." + }, + "VirtualMachineRunCommandsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineRunCommand" + }, + "description": "The list of run commands" + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of run commands." + } + }, + "required": [ + "value" + ], + "type": "object", + "description": "The List run command operation response" + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/sshPublicKey.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/sshPublicKey.json new file mode 100644 index 000000000..798267490 --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/sshPublicKey.json @@ -0,0 +1,518 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/sshPublicKeys": { + "get": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_ListBySubscription", + "description": "Lists all of the SSH public keys in the subscription. Use the nextLink property in the response to get the next page of SSH public keys.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeysGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SshPublicKey_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_ListBySubscription_MaximumSet_Gen.json" + }, + "SshPublicKey_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys": { + "get": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_ListByResourceGroup", + "description": "Lists all of the SSH public keys in the specified resource group. Use the nextLink property in the response to get the next page of SSH public keys.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeysGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SshPublicKey_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_ListByResourceGroup_MaximumSet_Gen.json" + }, + "SshPublicKey_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}": { + "put": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_Create", + "description": "Creates a new SSH public key resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + }, + "description": "Parameters supplied to create the SSH public key." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a new SSH public key resource.": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Create.json" + } + } + }, + "patch": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_Update", + "description": "Updates a new SSH public key resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SshPublicKeyUpdateResource" + }, + "description": "Parameters supplied to update the SSH public key." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "SshPublicKey_Update_MaximumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Update_MaximumSet_Gen.json" + }, + "SshPublicKey_Update_MinimumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_Delete", + "description": "Delete an SSH public key.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "SshPublicKey_Delete_MaximumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Delete_MaximumSet_Gen.json" + }, + "SshPublicKey_Delete_MinimumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_Get", + "description": "Retrieves information about an SSH public key.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get an ssh public key.": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}/generateKeyPair": { + "post": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_GenerateKeyPair", + "description": "Generates and returns a public/private key pair and populates the SSH public key resource with the public key. The length of the key will be 3072 bits. This operation can only be performed once per SSH public key resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SshGenerateKeyPairInputParameters" + }, + "description": "Parameters supplied to generate the SSH public key." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyGenerateKeyPairResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Generate an SSH key pair.": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair.json" + }, + "Generate an SSH key pair with RSA encryption.": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithRSA.json" + }, + "Generate an SSH key pair with Ed25519 encryption.": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithEd25519.json" + } + } + } + } + }, + "definitions": { + "SshPublicKeyGenerateKeyPairResult": { + "properties": { + "privateKey": { + "type": "string", + "description": "Private key portion of the key pair used to authenticate to a virtual machine through ssh. The private key is returned in RFC3447 format and should be treated as a secret." + }, + "publicKey": { + "type": "string", + "description": "Public key portion of the key pair used to authenticate to a virtual machine through ssh. The public key is in ssh-rsa format." + }, + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{SshPublicKeyName}" + } + }, + "required": [ + "privateKey", + "publicKey", + "id" + ], + "description": "Response from generation of an SSH key pair." + }, + "SshPublicKeyResourceProperties": { + "properties": { + "publicKey": { + "type": "string", + "description": "SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format." + } + }, + "description": "Properties of the SSH public key." + }, + "SshPublicKeyResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SshPublicKeyResourceProperties", + "description": "Properties of the SSH public key." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the SSH public key." + }, + "SshPublicKeyUpdateResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SshPublicKeyResourceProperties", + "description": "Properties of the SSH public key." + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the SSH public key." + }, + "SshPublicKeysGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKeyResource" + }, + "description": "The list of SSH public keys" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of SSH public keys. Call ListNext() with this URI to fetch the next page of SSH public keys." + } + }, + "required": [ + "value" + ], + "description": "The list SSH public keys operation response." + }, + "SshGenerateKeyPairInputParameters": { + "type": "object", + "properties": { + "encryptionType": { + "type": "string", + "description": "The encryption type of the SSH keys to be generated. See SshEncryptionTypes for possible set of values. If not provided, will default to RSA", + "enum": [ + "RSA", + "Ed25519" + ], + "x-ms-enum": { + "name": "SshEncryptionTypes", + "modelAsString": true + } + } + }, + "description": "Parameters for GenerateSshKeyPair." + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachine.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachine.json new file mode 100644 index 000000000..2b8db8b31 --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachine.json @@ -0,0 +1,3591 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}": { + "put": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_CreateOrUpdate", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be created or updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "Parameters supplied to the Create Virtual Machine Extension operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen.json" + }, + "VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Update", + "description": "The operation to update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine Extension operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update VM extension.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_Update.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be deleted." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineExtension_Delete_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_Delete_MaximumSet_Gen.json" + }, + "VirtualMachineExtension_Delete_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineExtension_Get_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_Get_MaximumSet_Gen.json" + }, + "VirtualMachineExtension_Get_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions": { + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_List", + "description": "The operation to get all extensions of a Virtual Machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineExtension_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_List_MaximumSet_Gen.json" + }, + "VirtualMachineExtension_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListByLocation", + "description": "Gets all the virtual machines under the specified subscription for the specified location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which virtual machines under the subscription are queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Lists all the virtual machines under the specified subscription for the specified location.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_ListBySubscription_ByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Capture", + "description": "Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureParameters" + }, + "description": "Parameters supplied to the Capture Virtual Machine operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureResult" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VirtualMachine_Capture_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Capture_MaximumSet_Gen.json" + }, + "VirtualMachine_Capture_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Capture_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { + "put": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_CreateOrUpdate", + "description": "The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "Parameters supplied to the Create Virtual Machine operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a vm with password authentication.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithPasswordAuthentication.json" + }, + "Create a vm with ssh authentication.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithSshAuthentication.json" + }, + "Create a vm with premium storage.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithPremiumStorage.json" + }, + "Create a vm in a Virtual Machine Scale Set with customer assigned platformFaultDomain.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_InAVmssWithCustomerAssignedPlatformFaultDomain.json" + }, + "Create a vm in an availability set.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_InAnAvailabilitySet.json" + }, + "Create a vm with Scheduled Events Profile": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithScheduledEventsProfile.json" + }, + "Create a vm with boot diagnostics.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithBootDiagnostics.json" + }, + "Create a vm with managed boot diagnostics.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithManagedBootDiagnostics.json" + }, + "Create a vm with empty data disks.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithEmptyDataDisks.json" + }, + "Create a vm with data disks using 'Copy' and 'Restore' options.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithDataDisksFromSourceResource.json" + }, + "Create a vm with a marketplace image plan.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithAMarketplaceImagePlan.json" + }, + "Create a vm from a custom image.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromACustomImage.json" + }, + "Create a platform-image vm with unmanaged os and data disks.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_PlatformImageVmWithUnmanagedOsAndDataDisks.json" + }, + "Create a custom-image vm from an unmanaged generalized os image.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_CustomImageVmFromAnUnmanagedGeneralizedOsImage.json" + }, + "Create a vm with ephemeral os disk.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDisk.json" + }, + "Create a vm with DiskEncryptionSet resource id in the os disk and data disk.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithDiskEncryptionSetResource.json" + }, + "Create a vm with ephemeral os disk provisioning in Resource disk using placement property.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json" + }, + "Create a vm with ephemeral os disk provisioning in Cache disk using placement property.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json" + }, + "Create a vm with ephemeral os disk provisioning in Nvme disk using placement property.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsNvmeDisk.json" + }, + "Create a vm with Host Encryption using encryptionAtHost property.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionAtHost.json" + }, + "Create a Windows vm with a patch setting patchMode of AutomaticByOS.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByOS.json" + }, + "Create a Windows vm with a patch setting patchMode of AutomaticByPlatform and AutomaticByPlatformSettings.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithAutomaticByPlatformSettings.json" + }, + "Create a Windows vm with patch settings patchMode and assessmentMode set to AutomaticByPlatform.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModesOfAutomaticByPlatform.json" + }, + "Create a Windows vm with a patch setting patchMode of Manual.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfManual.json" + }, + "Create a Windows vm with a patch setting assessmentMode of ImageDefault.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingAssessmentModeOfImageDefault.json" + }, + "Create a Windows vm with a patch setting patchMode of AutomaticByPlatform and enableHotpatching set to true.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByPlatformAndEnableHotPatchingTrue.json" + }, + "Create a Linux vm with a patch settings patchMode and assessmentMode set to AutomaticByPlatform.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModesOfAutomaticByPlatform.json" + }, + "Create a Linux vm with a patch setting patchMode of ImageDefault.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModeOfImageDefault.json" + }, + "Create a Linux vm with a patch setting patchMode of AutomaticByPlatform and AutomaticByPlatformSettings.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithAutomaticByPlatformSettings.json" + }, + "Create a Linux vm with a patch setting assessmentMode of ImageDefault.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingAssessmentModeOfImageDefault.json" + }, + "Create a vm with an extensions time budget.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithExtensionsTimeBudget.json" + }, + "Create a VM with Uefi Settings of secureBoot and vTPM.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithUefiSettings.json" + }, + "Create a VM with ProxyAgent Settings of enabled and mode.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithProxyAgentSettings.json" + }, + "Create a vm from a generalized shared image.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromAGeneralizedSharedImage.json" + }, + "Create a vm from a specialized shared image.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromASpecializedSharedImage.json" + }, + "Create a VM with network interface configuration": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfiguration.json" + }, + "Create a VM with network interface configuration with public ip address dns settings": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfigurationDnsSettings.json" + }, + "Create a VM with UserData": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithUserData.json" + }, + "Create a vm with Application Profile.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithApplicationProfile.json" + }, + "Create a VM with HibernationEnabled": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithHibernationEnabled.json" + }, + "Create a VM with VM Size Properties": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithVMSizeProperties.json" + }, + "Create or update a VM with capacity reservation": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithCapacityReservation.json" + }, + "Create a VM from a shared gallery image": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromASharedGalleryImage.json" + }, + "Create a VM from a community gallery image": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromACommunityGalleryImage.json" + }, + "Create a VM with securityType ConfidentialVM with Platform Managed Keys": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVM.json" + }, + "Create a VM with securityType ConfidentialVM with Customer Managed Keys": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithCustomerManagedKeys.json" + }, + "Create a VM with securityType ConfidentialVM with NonPersistedTPM securityEncryptionType": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithNonPersistedTPM.json" + }, + "Create a VM with Disk Controller Type": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithDiskControllerType.json" + }, + "Create a VM with encryption identity": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionIdentity.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Update", + "description": "The operation to update a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a VM by detaching data disk": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Update_DetachDataDiskUsingToBeDetachedProperty.json" + }, + "Update a VM by force-detaching data disk": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Update_ForceDetachDataDisk.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Delete", + "description": "The operation to delete a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "forceDeletion", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to force delete virtual machines." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Force delete a VM": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Delete_Force.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Get", + "description": "Retrieves information about the model view or the instance view of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the virtual machine that is managed by the platform and can change outside of control plane operations. 'UserData' retrieves the UserData property as part of the VM model view that was provided by the user during the VM Create/Update operation.", + "enum": [ + "instanceView", + "userData" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a Virtual Machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get.json" + }, + "Get a virtual machine placed on a dedicated host group through automatic placement": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json" + }, + "Get a virtual machine with VM Size Properties": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json" + }, + "Get a virtual machine with Disk Controller Type Properties": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_InstanceView", + "description": "Retrieves information about the run-time state of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceView" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Virtual Machine Instance View.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json" + }, + "Get instance view of a virtual machine placed on a dedicated host group through automatic placement.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ConvertToManagedDisks", + "description": "Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachine_ConvertToManagedDisks_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_ConvertToManagedDisks_MaximumSet_Gen.json" + }, + "VirtualMachine_ConvertToManagedDisks_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_ConvertToManagedDisks_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Deallocate", + "description": "Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "hibernate", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to hibernate a virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachine_Deallocate_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Deallocate_MaximumSet_Gen.json" + }, + "VirtualMachine_Deallocate_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Deallocate_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Generalize", + "description": "Sets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation. For Windows, please refer to [Create a managed image of a generalized VM in Azure](https://docs.microsoft.com/azure/virtual-machines/windows/capture-image-resource). For Linux, please refer to [How to create an image of a virtual machine or VHD](https://docs.microsoft.com/azure/virtual-machines/linux/capture-image).", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Generalize a Virtual Machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Generalize.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_List", + "description": "Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}'" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "ExpandTypeForListVMs", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachine_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_List_MaximumSet_Gen.json" + }, + "VirtualMachine_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAll", + "description": "Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "statusOnly", + "in": "query", + "required": false, + "type": "string", + "description": "statusOnly=true enables fetching run time status of all Virtual Machines in the subscription." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}'" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "ExpandTypesForListVMs", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachine_ListAll_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_ListAll_MaximumSet_Gen.json" + }, + "VirtualMachine_ListAll_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_ListAll_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAvailableSizes", + "description": "Lists all available virtual machine sizes to which the specified virtual machine can be resized.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./computeRPCommon.json#/definitions/VirtualMachineSizeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Lists all available virtual machine sizes to which the specified virtual machine can be resized": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_ListAvailableVmSizes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PowerOff", + "description": "The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachine_PowerOff_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_PowerOff_MaximumSet_Gen.json" + }, + "VirtualMachine_PowerOff_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_PowerOff_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reapply": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Reapply", + "description": "The operation to reapply a virtual machine's state.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reapply the state of a virtual machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Reapply.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Restart", + "description": "The operation to restart a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachine_Restart_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Restart_MaximumSet_Gen.json" + }, + "VirtualMachine_Restart_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Restart_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Start", + "description": "The operation to start a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachine_Start_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Start_MaximumSet_Gen.json" + }, + "VirtualMachine_Start_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Start_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Redeploy", + "description": "Shuts down the virtual machine, moves it to a new node, and powers it back on.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachine_Redeploy_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Redeploy_MaximumSet_Gen.json" + }, + "VirtualMachine_Redeploy_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Redeploy_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Reimage", + "description": "Reimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. NOTE: The retaining of old OS disk depends on the value of deleteOption of OS disk. If deleteOption is detach, the old OS disk will be preserved after reimage. If deleteOption is delete, the old OS disk will be deleted after reimage. The deleteOption of the OS disk should be updated accordingly before performing the reimage.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineReimageParameters" + }, + "description": "Parameters supplied to the Reimage Virtual Machine operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reimage a Virtual Machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Reimage.json" + }, + "Reimage a Non-Ephemeral Virtual Machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/retrieveBootDiagnosticsData": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_RetrieveBootDiagnosticsData", + "description": "The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "sasUriExpirationTimeInMinutes", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. **Note:** If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RetrieveBootDiagnosticsDataResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "RetrieveBootDiagnosticsData of a virtual machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_RetrieveBootDiagnosticsData.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PerformMaintenance", + "description": "The operation to perform maintenance on a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachine_PerformMaintenance_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_PerformMaintenance_MaximumSet_Gen.json" + }, + "VirtualMachine_PerformMaintenance_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_PerformMaintenance_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/simulateEviction": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_SimulateEviction", + "description": "The operation to simulate the eviction of spot virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Simulate Eviction a virtual machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_SimulateEviction.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/assessPatches": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_AssessPatches", + "x-ms-examples": { + "Assess patch state of a virtual machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_AssessPatches.json" + } + }, + "description": "Assess patches on the VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineAssessPatchesResult" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/installPatches": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_InstallPatches", + "description": "Installs patches on the VM.", + "x-ms-examples": { + "Install patch state of a virtual machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_InstallPatches.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "installPatchesInput", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineInstallPatchesParameters" + }, + "description": "Input for InstallPatches as directly received by the API" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineInstallPatchesResult" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/attachDetachDataDisks": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_AttachDetachDataDisks", + "description": "Attach and detach data disks to/from the virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./computeRPCommon.json#/definitions/AttachDetachDataDisksRequest" + }, + "description": "Parameters supplied to the attach and detach data disks operation on the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./computeRPCommon.json#/definitions/StorageProfile" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json" + }, + "VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "RetrieveBootDiagnosticsDataResult": { + "properties": { + "consoleScreenshotBlobUri": { + "type": "string", + "readOnly": true, + "description": "The console screenshot blob URI" + }, + "serialConsoleLogBlobUri": { + "type": "string", + "readOnly": true, + "description": "The serial console log blob URI." + } + }, + "description": "The SAS URIs of the console screenshot and serial log blobs." + }, + "VirtualMachineExtensionInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The virtual machine extension name." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "substatuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView", + "description": "The virtual machine extension instance view." + }, + "suppressFailures": { + "type": "boolean", + "description": "Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false." + }, + "protectedSettingsFromKeyVault": { + "$ref": "./computeRPCommon.json#/definitions/KeyVaultSecretReference", + "description": "The extensions protected settings that are passed by reference, and consumed from key vault" + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdateProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "suppressFailures": { + "type": "boolean", + "description": "Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false." + }, + "protectedSettingsFromKeyVault": { + "$ref": "./computeRPCommon.json#/definitions/KeyVaultSecretReference", + "description": "The extensions protected settings that are passed by reference, and consumed from key vault" + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtension": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/ResourceWithOptionalLocation" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The list of extensions" + } + }, + "description": "The List Extension operation response" + }, + "VirtualMachineSoftwarePatchProperties": { + "properties": { + "patchId": { + "type": "string", + "readOnly": true, + "description": "A unique identifier for the patch." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The friendly name of the patch." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "The version number of the patch. This property applies only to Linux patches." + }, + "kbId": { + "type": "string", + "readOnly": true, + "description": "The KBID of the patch. Only applies to Windows patches." + }, + "classifications": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The classification(s) of the patch as provided by the patch publisher." + }, + "rebootBehavior": { + "type": "string", + "readOnly": true, + "description": "Describes the reboot requirements of the patch.", + "enum": [ + "Unknown", + "NeverReboots", + "AlwaysRequiresReboot", + "CanRequestReboot" + ], + "x-ms-enum": { + "name": "VMGuestPatchRebootBehavior", + "modelAsString": true + } + }, + "activityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs." + }, + "publishedDate": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the repository published this patch." + }, + "lastModifiedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp of the last update to this patch record." + }, + "assessmentState": { + "type": "string", + "readOnly": true, + "description": "Describes the availability of a given patch.", + "enum": [ + "Unknown", + "Available" + ], + "x-ms-enum": { + "name": "PatchAssessmentState", + "modelAsString": true + } + } + }, + "description": "Describes the properties of a Virtual Machine software patch." + }, + "VirtualMachineAssessPatchesResult": { + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"", + "enum": [ + "Unknown", + "InProgress", + "Failed", + "Succeeded", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "PatchOperationStatus", + "modelAsString": true + } + }, + "assessmentActivityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs." + }, + "rebootPending": { + "type": "boolean", + "readOnly": true, + "description": "The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred." + }, + "criticalAndSecurityPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of critical or security patches that have been detected as available and not yet installed." + }, + "otherPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of all available patches excluding critical and security." + }, + "startDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "availablePatches": { + "type": "array", + "readOnly": true, + "items": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineSoftwarePatchProperties" + }, + "x-ms-identifiers": [ + "patchId" + ], + "description": "The list of patches that have been detected as available for installation." + }, + "error": { + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "readOnly": true, + "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." + } + }, + "description": "Describes the properties of an AssessPatches result." + }, + "VirtualMachineInstallPatchesParameters": { + "properties": { + "maximumDuration": { + "type": "string", + "description": "Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours)" + }, + "rebootSetting": { + "type": "string", + "description": "Defines when it is acceptable to reboot a VM during a software update operation.", + "enum": [ + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "VMGuestPatchRebootSetting", + "modelAsString": true + } + }, + "windowsParameters": { + "$ref": "#/definitions/WindowsParameters", + "description": "Input for InstallPatches on a Windows VM, as directly received by the API" + }, + "linuxParameters": { + "$ref": "#/definitions/LinuxParameters", + "description": "Input for InstallPatches on a Linux VM, as directly received by the API" + } + }, + "required": [ + "rebootSetting" + ], + "description": "Input for InstallPatches as directly received by the API" + }, + "WindowsParameters": { + "properties": { + "classificationsToInclude": { + "type": "array", + "description": "The update classifications to select when installing patches for Windows.", + "items": { + "type": "string", + "enum": [ + "Critical", + "Security", + "UpdateRollUp", + "FeaturePack", + "ServicePack", + "Definition", + "Tools", + "Updates" + ], + "x-ms-enum": { + "name": "VMGuestPatchClassification_Windows", + "modelAsString": true + } + } + }, + "kbNumbersToInclude": { + "type": "array", + "description": "Kbs to include in the patch operation", + "items": { + "type": "string" + } + }, + "kbNumbersToExclude": { + "type": "array", + "description": "Kbs to exclude in the patch operation", + "items": { + "type": "string" + } + }, + "excludeKbsRequiringReboot": { + "type": "boolean", + "description": "Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true." + }, + "maxPatchPublishDate": { + "type": "string", + "format": "date-time", + "description": "This is used to install patches that were published on or before this given max published date." + } + }, + "description": "Input for InstallPatches on a Windows VM, as directly received by the API" + }, + "LinuxParameters": { + "properties": { + "classificationsToInclude": { + "type": "array", + "description": "The update classifications to select when installing patches for Linux.", + "items": { + "type": "string", + "enum": [ + "Critical", + "Security", + "Other" + ], + "x-ms-enum": { + "name": "VMGuestPatchClassification_Linux", + "modelAsString": true + } + } + }, + "packageNameMasksToInclude": { + "type": "array", + "description": "packages to include in the patch operation. Format: packageName_packageVersion", + "items": { + "type": "string" + } + }, + "packageNameMasksToExclude": { + "type": "array", + "description": "packages to exclude in the patch operation. Format: packageName_packageVersion", + "items": { + "type": "string" + } + }, + "maintenanceRunId": { + "type": "string", + "description": "This is used as a maintenance run identifier for Auto VM Guest Patching in Linux." + } + }, + "description": "Input for InstallPatches on a Linux VM, as directly received by the API" + }, + "VirtualMachineInstallPatchesResult": { + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Failed\", \"Succeeded\", \"Unknown\" or \"CompletedWithWarnings.\"", + "enum": [ + "Unknown", + "InProgress", + "Failed", + "Succeeded", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "PatchOperationStatus", + "modelAsString": true + } + }, + "installationActivityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs." + }, + "rebootStatus": { + "type": "string", + "readOnly": true, + "description": "The reboot state of the VM following completion of the operation.", + "enum": [ + "Unknown", + "NotNeeded", + "Required", + "Started", + "Failed", + "Completed" + ], + "x-ms-enum": { + "name": "VMGuestPatchRebootStatus", + "modelAsString": true + } + }, + "maintenanceWindowExceeded": { + "type": "boolean", + "readOnly": true, + "description": "Whether the operation ran out of time before it completed all its intended actions." + }, + "excludedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that were not installed due to the user blocking their installation." + }, + "notSelectedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that were detected as available for install, but did not meet the operation's criteria." + }, + "pendingPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true." + }, + "installedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches successfully installed." + }, + "failedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that could not be installed due to some issue. See errors for details." + }, + "patches": { + "type": "array", + "readOnly": true, + "items": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PatchInstallationDetail" + }, + "x-ms-identifiers": [ + "patchId" + ], + "description": "The patches that were installed during the operation." + }, + "startDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "error": { + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "readOnly": true, + "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." + } + }, + "description": "The result summary of an installation operation." + }, + "PatchInstallationDetail": { + "properties": { + "patchId": { + "type": "string", + "readOnly": true, + "description": "A unique identifier for the patch." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The friendly name of the patch." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "The version string of the package. It may conform to Semantic Versioning. Only applies to Linux." + }, + "kbId": { + "type": "string", + "readOnly": true, + "description": "The KBID of the patch. Only applies to Windows patches." + }, + "classifications": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The classification(s) of the patch as provided by the patch publisher." + }, + "installationState": { + "type": "string", + "readOnly": true, + "description": "The state of the patch after the installation operation completed.", + "enum": [ + "Unknown", + "Installed", + "Failed", + "Excluded", + "NotSelected", + "Pending" + ], + "x-ms-enum": { + "name": "PatchInstallationState", + "modelAsString": true + } + } + }, + "description": "Information about a specific patch that was encountered during an installation action." + }, + "VirtualMachineReimageParameters": { + "properties": { + "tempDisk": { + "type": "boolean", + "description": "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk." + }, + "exactVersion": { + "type": "string", + "description": "Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk." + }, + "osProfile": { + "$ref": "#/definitions/OSProfileProvisioningData", + "description": "Specifies information required for reimaging the non-ephemeral OS disk." + } + }, + "description": "Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged" + }, + "OSProfileProvisioningData": { + "type": "object", + "properties": { + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

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

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)", + "x-ms-secret": true + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). If using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)." + } + }, + "description": "Additional parameters for Reimaging Non-Ephemeral Virtual Machine." + }, + "VirtualMachineCaptureParameters": { + "properties": { + "vhdPrefix": { + "type": "string", + "description": "The captured virtual hard disk's name prefix." + }, + "destinationContainerName": { + "type": "string", + "description": "The destination container name." + }, + "overwriteVhds": { + "type": "boolean", + "description": "Specifies whether to overwrite the destination virtual hard disk, in case of conflict." + } + }, + "required": [ + "vhdPrefix", + "destinationContainerName", + "overwriteVhds" + ], + "description": "Capture Virtual Machine parameters." + }, + "VirtualMachineCaptureResult": { + "properties": { + "$schema": { + "readOnly": true, + "type": "string", + "description": "the schema of the captured virtual machine" + }, + "contentVersion": { + "readOnly": true, + "type": "string", + "description": "the version of the content" + }, + "parameters": { + "readOnly": true, + "type": "object", + "description": "parameters of the captured virtual machine" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "type": "object", + "description": "resource item" + }, + "x-ms-identifiers": [], + "description": "a list of resource items of the captured virtual machine" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "description": "Output of virtual machine capture operation.", + "x-ms-azure-resource": true + }, + "VirtualMachineIpTag": { + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "Contains the IP tag associated with the public IP address." + }, + "VirtualMachinePublicIPAddressDnsSettingsConfiguration": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID." + }, + "domainNameLabelScope": { + "type": "string", + "description": "The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID.", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "x-ms-enum": { + "name": "DomainNameLabelScopeTypes", + "modelAsString": true + } + } + }, + "required": [ + "domainNameLabel" + ], + "description": "Describes a virtual machines network configuration's DNS settings." + }, + "VirtualMachinePublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "deleteOption": { + "type": "string", + "description": "Specify what happens to the public IP address when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true + } + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachinePublicIPAddressDnsSettingsConfiguration", + "description": "The dns settings to be applied on the publicIP addresses ." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineIpTag" + }, + "x-ms-identifiers": [], + "description": "The list of IP tags associated with the public IP address." + }, + "publicIPPrefix": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The PublicIPPrefix from which to allocate publicIP addresses." + }, + "publicIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersions", + "modelAsString": true + } + }, + "publicIPAllocationMethod": { + "type": "string", + "description": "Specify the public IP allocation type", + "enum": [ + "Dynamic", + "Static" + ], + "x-ms-enum": { + "name": "PublicIPAllocationMethod", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machines IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachinePublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachinePublicIPAddressConfigurationProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/PublicIPAddressSku" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineNetworkInterfaceIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachinePublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersions", + "modelAsString": true + } + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]." + } + }, + "description": "Describes a virtual machine network interface IP configuration properties." + }, + "VirtualMachineNetworkInterfaceIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineNetworkInterfaceIPConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine network profile's IP configuration." + }, + "VirtualMachineNetworkInterfaceDnsSettingsConfiguration": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses" + } + }, + "description": "Describes a virtual machines network configuration's DNS settings." + }, + "VirtualMachineNetworkInterfaceConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "deleteOption": { + "type": "string", + "description": "Specify what happens to the network interface when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true + } + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "disableTcpStateTracking": { + "type": "boolean", + "description": "Specifies whether the network interface is disabled for tcp state tracking." + }, + "enableFpga": { + "type": "boolean", + "description": "Specifies whether the network interface is FPGA networking-enabled." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + }, + "networkSecurityGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineNetworkInterfaceDnsSettingsConfiguration", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineNetworkInterfaceIPConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Specifies the IP configurations of the network interface." + }, + "dscpConfiguration": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "auxiliaryMode": { + "type": "string", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface resource.", + "enum": [ + "None", + "AcceleratedConnections", + "Floating" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliaryMode", + "modelAsString": true + } + }, + "auxiliarySku": { + "type": "string", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface resource.", + "enum": [ + "None", + "A1", + "A2", + "A4", + "A8" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliarySku", + "modelAsString": true + } + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine network profile's IP configuration." + }, + "VirtualMachineNetworkInterfaceConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network interface configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineNetworkInterfaceConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine network interface configurations." + }, + "VirtualMachineExtensionHandlerInstanceView": { + "properties": { + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "status": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus", + "description": "The extension handler status." + } + }, + "description": "The instance view of a virtual machine extension handler." + }, + "VirtualMachineAgentInstanceView": { + "properties": { + "vmAgentVersion": { + "type": "string", + "description": "The VM Agent full version." + }, + "extensionHandlers": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionHandlerInstanceView" + }, + "x-ms-identifiers": [], + "description": "The virtual machine extension handler instance view." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of the VM Agent running on the virtual machine." + }, + "VirtualMachineIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "$ref": "../../../common-types/v1/common.json#/definitions/UserAssignedIdentities", + "description": "The list of user identities associated with the Virtual Machine. 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 virtual machine." + }, + "VirtualMachineInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the update domain of the virtual machine." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the fault domain of the virtual machine." + }, + "computerName": { + "type": "string", + "description": "The computer name assigned to the virtual machine." + }, + "osName": { + "type": "string", + "description": "The Operating System running on the virtual machine." + }, + "osVersion": { + "type": "string", + "description": "The version of Operating System running on the virtual machine." + }, + "hyperVGeneration": { + "type": "string", + "description": "Specifies the HyperVGeneration Type associated with a resource", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGenerationType", + "modelAsString": true + } + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "./computeRPCommon.json#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/DiskInstanceView" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The virtual machine disk information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "description": "The extensions information." + }, + "vmHealth": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineHealthStatus", + "description": "The health status for the VM." + }, + "bootDiagnostics": { + "$ref": "./computeRPCommon.json#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "assignedHost": { + "type": "string", + "readOnly": true, + "description": "Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + }, + "patchStatus": { + "$ref": "#/definitions/VirtualMachinePatchStatus", + "description": "[Preview Feature] The status of virtual machine patch operations." + }, + "isVMInStandbyPool": { + "type": "boolean", + "readOnly": true, + "description": "[Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool." + } + }, + "description": "The instance view of a virtual machine." + }, + "VirtualMachineProperties": { + "properties": { + "hardwareProfile": { + "$ref": "./computeRPCommon.json#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "scheduledEventsPolicy": { + "$ref": "./computeRPCommon.json#/definitions/ScheduledEventsPolicy", + "description": "Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine." + }, + "storageProfile": { + "$ref": "./computeRPCommon.json#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "additionalCapabilities": { + "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine." + }, + "osProfile": { + "$ref": "./computeRPCommon.json#/definitions/OSProfile", + "description": "Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "networkProfile": { + "$ref": "./computeRPCommon.json#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "securityProfile": { + "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference." + }, + "virtualMachineScaleSet": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01." + }, + "proximityPlacementGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01." + }, + "priority": { + "$ref": "./computeRPCommon.json#/definitions/priority", + "description": "Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01" + }, + "evictionPolicy": { + "$ref": "./computeRPCommon.json#/definitions/evictionPolicy", + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + }, + "billingProfile": { + "$ref": "./computeRPCommon.json#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01." + }, + "host": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01." + }, + "hostGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15" + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands." + }, + "extensionsTimeBudget": { + "type": "string", + "description": "Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01." + }, + "scheduledEventsProfile": { + "$ref": "./computeRPCommon.json#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + }, + "userData": { + "type": "string", + "description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01." + }, + "capacityReservation": { + "$ref": "./computeRPCommon.json#/definitions/CapacityReservationProfile", + "description": "Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01." + }, + "applicationProfile": { + "$ref": "./computeRPCommon.json#/definitions/ApplicationProfile", + "description": "Specifies the gallery applications that should be made available to the VM/VMSS." + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01." + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachine": { + "properties": { + "plan": { + "$ref": "./computeRPCommon.json#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "managedBy": { + "readOnly": true, + "type": "string", + "description": "ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine." + }, + "VirtualMachineUpdate": { + "properties": { + "plan": { + "$ref": "./computeRPCommon.json#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Update." + }, + "VirtualMachineListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "The list of virtual machines." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineHealthStatus": { + "properties": { + "status": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus", + "description": "The health status information for the VM." + } + }, + "description": "The health status of the VM." + }, + "VirtualMachinePatchStatus": { + "properties": { + "availablePatchSummary": { + "$ref": "#/definitions/AvailablePatchSummary", + "description": "The available patch summary of the latest assessment operation for the virtual machine." + }, + "lastPatchInstallationSummary": { + "$ref": "#/definitions/LastPatchInstallationSummary", + "description": "The installation summary of the latest installation operation for the virtual machine." + }, + "configurationStatuses": { + "description": "The enablement status of the specified patchMode", + "readOnly": true, + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [] + } + }, + "description": "The status of virtual machine patch operations." + }, + "AvailablePatchSummary": { + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"", + "enum": [ + "Unknown", + "InProgress", + "Failed", + "Succeeded", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "PatchOperationStatus", + "modelAsString": true + } + }, + "assessmentActivityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs." + }, + "rebootPending": { + "type": "boolean", + "readOnly": true, + "description": "The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred." + }, + "criticalAndSecurityPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of critical or security patches that have been detected as available and not yet installed." + }, + "otherPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of all available patches excluding critical and security." + }, + "startTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "lastModifiedTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "error": { + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "readOnly": true, + "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." + } + }, + "description": "Describes the properties of an virtual machine instance view for available patch summary." + }, + "LastPatchInstallationSummary": { + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"", + "enum": [ + "Unknown", + "InProgress", + "Failed", + "Succeeded", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "PatchOperationStatus", + "modelAsString": true + } + }, + "installationActivityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs." + }, + "maintenanceWindowExceeded": { + "type": "boolean", + "readOnly": true, + "description": "Describes whether the operation ran out of time before it completed all its intended actions" + }, + "notSelectedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry." + }, + "excludedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of all available patches but excluded explicitly by a customer-specified exclusion list match." + }, + "pendingPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of all available patches expected to be installed over the course of the patch installation operation." + }, + "installedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The count of patches that successfully installed." + }, + "failedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The count of patches that failed installation." + }, + "startTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "lastModifiedTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "error": { + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "readOnly": true, + "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." + } + }, + "description": "Describes the properties of the last installed patch summary." + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineExtensionImage.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineExtensionImage.json new file mode 100644 index 000000000..972c4220f --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineExtensionImage.json @@ -0,0 +1,289 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_Get", + "description": "Gets a virtual machine extension image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineExtensionImage_Get_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_Get_MaximumSet_Gen.json" + }, + "VirtualMachineExtensionImage_Get_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListTypes", + "description": "Gets a list of virtual machine extension image types.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineExtensionImage_ListTypes_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListTypes_MaximumSet_Gen.json" + }, + "VirtualMachineExtensionImage_ListTypes_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListTypes_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListVersions", + "description": "Gets a list of virtual machine extension image versions.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineExtensionImage", + "x-ms-examples": { + "VirtualMachineExtensionImage_ListVersions_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListVersions_MaximumSet_Gen.json" + }, + "VirtualMachineExtensionImage_ListVersions_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListVersions_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "VirtualMachineExtensionImageProperties": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system this extension supports." + }, + "computeRole": { + "type": "string", + "description": "The type of role (IaaS or PaaS) this extension supports." + }, + "handlerSchema": { + "type": "string", + "description": "The schema defined by publisher, where extension consumers should provide settings in a matching schema." + }, + "vmScaleSetEnabled": { + "type": "boolean", + "description": "Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS." + }, + "supportsMultipleExtensions": { + "type": "boolean", + "description": "Whether the handler can support multiple extensions." + } + }, + "required": [ + "operatingSystem", + "computeRole", + "handlerSchema" + ], + "description": "Describes the properties of a Virtual Machine Extension Image." + }, + "VirtualMachineExtensionImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension Image." + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineImage.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineImage.json new file mode 100644 index 000000000..7c4a48112 --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineImage.json @@ -0,0 +1,1064 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_Get", + "description": "Gets a virtual machine image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU version." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImage_Get_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_Get_MaximumSet_Gen.json" + }, + "VirtualMachineImage_Get_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_List", + "description": "Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImage_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_List_MaximumSet_Gen.json" + }, + "VirtualMachineImage_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListOffers", + "description": "Gets a list of virtual machine image offers for the specified location and publisher.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImage_ListOffers_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_ListOffers_MaximumSet_Gen.json" + }, + "VirtualMachineImage_ListOffers_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_ListOffers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListPublishers", + "description": "Gets a list of virtual machine image publishers for the specified Azure location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImage_ListPublishers_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_ListPublishers_MaximumSet_Gen.json" + }, + "VirtualMachineImage_ListPublishers_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_ListPublishers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListSkus", + "description": "Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImage_ListSkus_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_ListSkus_MaximumSet_Gen.json" + }, + "VirtualMachineImage_ListSkus_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_ListSkus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImagesEdgeZone_Get", + "description": "Gets a virtual machine image in an edge zone.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "edgeZone", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the edge zone." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU version." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImagesEdgeZone_Get_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MaximumSet_Gen.json" + }, + "VirtualMachineImagesEdgeZone_Get_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImagesEdgeZone_List", + "description": "Gets a list of all virtual machine image versions for the specified location, edge zone, publisher, offer, and SKU.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "edgeZone", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the edge zone." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "An integer value specifying the number of images to return that matches supplied values." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the order of the results returned. Formatted as an OData query." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImagesEdgeZone_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MaximumSet_Gen.json" + }, + "VirtualMachineImagesEdgeZone_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImagesEdgeZone_ListOffers", + "description": "Gets a list of virtual machine image offers for the specified location, edge zone and publisher.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "edgeZone", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the edge zone." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImagesEdgeZone_ListOffers_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MaximumSet_Gen.json" + }, + "VirtualMachineImagesEdgeZone_ListOffers_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImagesEdgeZone_ListPublishers", + "description": "Gets a list of virtual machine image publishers for the specified Azure location and edge zone.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "edgeZone", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the edge zone." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImagesEdgeZone_ListPublishers_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MaximumSet_Gen.json" + }, + "VirtualMachineImagesEdgeZone_ListPublishers_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/vmimages": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListByEdgeZone", + "description": "Gets a list of all virtual machine image versions for the specified edge zone", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "edgeZone", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the edge zone." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VmImagesInEdgeZoneListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImagesEdgeZone_ListByEdgeZone_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MaximumSet_Gen.json" + }, + "VirtualMachineImagesEdgeZone_ListByEdgeZone_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImagesEdgeZone_ListSkus", + "description": "Gets a list of virtual machine image SKUs for the specified location, edge zone, publisher, and offer.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "edgeZone", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the edge zone." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImagesEdgeZone_ListSkus_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MaximumSet_Gen.json" + }, + "VirtualMachineImagesEdgeZone_ListSkus_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "DisallowedConfiguration": { + "properties": { + "vmDiskType": { + "type": "string", + "description": "VM disk types which are disallowed.", + "enum": [ + "None", + "Unmanaged" + ], + "x-ms-enum": { + "name": "VmDiskTypes", + "modelAsString": true + } + } + }, + "description": "Specifies the disallowed configuration for a virtual machine image." + }, + "VirtualMachineImageResource": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "location": { + "type": "string", + "description": "The supported Azure location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md)." + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "description": "Virtual machine image resource information." + }, + "PurchasePlan": { + "properties": { + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + } + }, + "required": [ + "publisher", + "name", + "product" + ], + "description": "Used for establishing the purchase context of any 3rd Party artifact through MarketPlace." + }, + "OSDiskImage": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system of the osDiskImage.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + } + }, + "required": [ + "operatingSystem" + ], + "description": "Contains the os disk image information." + }, + "DataDiskImage": { + "properties": { + "lun": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "description": "Contains the data disk images information." + }, + "AutomaticOSUpgradeProperties": { + "properties": { + "automaticOSUpgradeSupported": { + "type": "boolean", + "description": "Specifies whether automatic OS upgrade is supported on the image." + } + }, + "required": [ + "automaticOSUpgradeSupported" + ], + "description": "Describes automatic OS upgrade properties on the image." + }, + "ImageDeprecationStatus": { + "type": "object", + "properties": { + "imageState": { + "type": "string", + "description": "Describes the state of the image.", + "enum": [ + "Active", + "ScheduledForDeprecation", + "Deprecated" + ], + "x-ms-enum": { + "name": "ImageState", + "modelAsString": true + } + }, + "scheduledDeprecationTime": { + "type": "string", + "format": "date-time", + "description": "The time, in future, at which this image will be marked as deprecated. This scheduled time is chosen by the Publisher." + }, + "alternativeOption": { + "$ref": "#/definitions/AlternativeOption" + } + }, + "description": "Describes image deprecation status properties on the image." + }, + "AlternativeOption": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Describes the type of the alternative option.", + "enum": [ + "None", + "Offer", + "Plan" + ], + "x-ms-enum": { + "name": "AlternativeType", + "modelAsString": true + } + }, + "value": { + "type": "string", + "description": "Indicates the alternative option value specified by the Publisher. This is the Offer name when the type is Offer or the Plan name when the type is Plan." + } + }, + "description": "Describes the alternative option specified by the Publisher for this image when this image is deprecated." + }, + "VirtualMachineImageFeature": { + "properties": { + "name": { + "type": "string", + "description": "The name of the feature." + }, + "value": { + "type": "string", + "description": "The corresponding value for the feature." + } + }, + "description": "Specifies additional capabilities supported by the image" + }, + "VirtualMachineImageProperties": { + "properties": { + "plan": { + "$ref": "#/definitions/PurchasePlan" + }, + "osDiskImage": { + "$ref": "#/definitions/OSDiskImage" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDiskImage" + }, + "x-ms-identifiers": [ + "lun" + ] + }, + "automaticOSUpgradeProperties": { + "$ref": "#/definitions/AutomaticOSUpgradeProperties" + }, + "hyperVGeneration": { + "$ref": "./computeRPCommon.json#/definitions/HyperVGenerationType" + }, + "disallowed": { + "$ref": "#/definitions/DisallowedConfiguration", + "description": "Specifies disallowed configuration for the VirtualMachine created from the image" + }, + "features": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageFeature" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "architecture": { + "$ref": "#/definitions/ArchitectureType" + }, + "imageDeprecationStatus": { + "$ref": "#/definitions/ImageDeprecationStatus" + } + }, + "description": "Describes the properties of a Virtual Machine Image." + }, + "VirtualMachineImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineImageResource" + } + ], + "description": "Describes a Virtual Machine Image." + }, + "VmImagesInEdgeZoneListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + }, + "description": "The list of VMImages in EdgeZone" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of VMImages in EdgeZone. Call ListNext() with this URI to fetch the next page of VmImages." + } + }, + "description": "The List VmImages in EdgeZone operation response." + }, + "ArchitectureType": { + "type": "string", + "description": "Specifies the Architecture Type", + "enum": [ + "x64", + "Arm64" + ], + "x-ms-enum": { + "name": "ArchitectureTypes", + "modelAsString": true + } + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json new file mode 100644 index 000000000..40974f0e3 --- /dev/null +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json @@ -0,0 +1,6384 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListByLocation", + "description": "Gets all the VM scale sets under the specified subscription for the specified location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which VM scale sets under the subscription are queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Lists all the VM scale sets under the specified subscription for the specified location.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListBySubscription_ByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { + "put": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_CreateOrUpdate", + "description": "Create or update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The scale set object." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a scale set with password authentication.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPasswordAuthentication.json" + }, + "Create a scale set with ssh authentication.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSshAuthentication.json" + }, + "Create a scale set with premium storage.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPremiumStorage.json" + }, + "Create a scale set with empty data disks on each vm.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEmptyDataDisksOnEachVm.json" + }, + "Create a scale set with an azure load balancer.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureLoadBalancer.json" + }, + "Create a scale set with an azure application gateway.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureApplicationGateway.json" + }, + "Create a scale set with boot diagnostics.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithBootDiagnostics.json" + }, + "Create a scale set with managed boot diagnostics.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithManagedBootDiagnostics.json" + }, + "Create a scale set with a marketplace image plan.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAMarketplaceImagePlan.json" + }, + "Create a scale set from a custom image.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromACustomImage.json" + }, + "Create a platform-image scale set with unmanaged os disks.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_PlatformImageWithUnmanagedOsDisks.json" + }, + "Create a custom-image scale set from an unmanaged generalized os image.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_CustomImageFromAnUnmanagedGeneralizedOsImage.json" + }, + "Create a scale set with virtual machines in different zones.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMsInDifferentZones.json" + }, + "Create a scale set with ephemeral os disks.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiffOsDisk.json" + }, + "Create a scale set with terminate scheduled events enabled.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithTerminateScheduledEventEnabled.json" + }, + "Create a scale set with OS image scheduled events enabled.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithOSImageScheduledEventEnabled.json" + }, + "Create a scale set with automatic repairs enabled": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAutomaticRepairs.json" + }, + "Create a scale set with DiskEncryptionSet resource in os disk and data disk.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskEncryptionSetResource.json" + }, + "Create a scale set with ephemeral os disks using placement property.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_CreateA_WithDiffOsDiskUsingDiffDiskPlacement.json" + }, + "Create a scale set with ephemeral os disk provisioning in Nvme disk using placement property.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_CreateA_WithDiffOsDiskUsingDiffDiskPlacementAsNvmeDisk.json" + }, + "Create a scale set with extension time budget.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsTimeBudget.json" + }, + "Create a scale set with Host Encryption using encryptionAtHost property.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEncryptionAtHost.json" + }, + "Create a scale set with Fpga Network Interfaces.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithFpgaNetworkInterface.json" + }, + "Create a scale set with Network Interfaces with public ip address dns settings.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithNetworkInterfaceWithDnsSettings.json" + }, + "Create a scale set with Uefi Settings of secureBoot and vTPM.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUefiSettings.json" + }, + "Create a scale set with ProxyAgent Settings of enabled and mode.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProxyAgentSettings.json" + }, + "Create a scale set from a generalized shared image.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromAGeneralizedSharedImage.json" + }, + "Create a scale set from a specialized shared image.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromASpecializedSharedImage.json" + }, + "Create a scale set with userData.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUserData.json" + }, + "Create a scale set with Application Profile": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithApplicationProfile.json" + }, + "Create a scale set with scaleInPolicy.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithScaleInPolicy.json" + }, + "Create a VMSS with an extension that has suppressFailures enabled": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsSuppressFailuresEnabled.json" + }, + "Create or update a scale set with capacity reservation.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithCapacityReservation.json" + }, + "Create a scale set with spot restore policy": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSpotRestorePolicy.json" + }, + "Create a scale set with priority mix policy": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPriorityMixPolicy.json" + }, + "Create a VMSS with an extension with protectedSettingsFromKeyVault": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProtectedSettingsFromKeyVault.json" + }, + "Create a scale set with vm size properties": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMSizeProperties.json" + }, + "Create a scale set with SecurityType as ConfidentialVM": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVM.json" + }, + "Create a scale set with Disk Controller Type": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskControllerType.json" + }, + "Create a scale set where nic config has DisableTcpStateTracking property": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithDisableTcpStateTrackingNetworkInterface.json" + }, + "Create a scale set with Service Artifact Reference": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithServiceArtifactReference.json" + }, + "Create a scale set with Security Posture Reference": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityPostureReference.json" + }, + "Create a scale set with Resilient VM Creation enabled": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMCreationPolicy.json" + }, + "Create a scale set with Resilient VM Deletion enabled": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMDeletionPolicy.json" + }, + "Create a scale set with SecurityType as ConfidentialVM and NonPersistedTPM securityEncryptionType": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVMWithNonPersistedTPM.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Update", + "description": "Update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdate" + }, + "description": "The scale set object." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_Update_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_Update_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Delete", + "description": "Deletes a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "forceDeletion", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to force delete a VM scale set. (Feature in Preview)" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Force Delete a VM scale set.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Delete_Force.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Get", + "description": "Display information about a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'UserData' retrieves the UserData property of the VM scale set that was provided by the user during the VM scale set Create/Update operation", + "enum": [ + "userData" + ], + "x-ms-enum": { + "name": "ExpandTypesForGetVMScaleSets", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a virtual machine scale set placed on a dedicated host group through automatic placement.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json" + }, + "Get a virtual machine scale set with UserData": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json" + }, + "Get a virtual machine scale set": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json" + }, + "Get VM scale set VM with Disk Controller Type": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Deallocate", + "description": "Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "name": "hibernate", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to hibernate a virtual machine from the VM scale set. (This feature is available for VMSS with Flexible OrchestrationMode only)" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_Deallocate_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Deallocate_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_Deallocate_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Deallocate_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_DeleteInstances", + "description": "Deletes virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "name": "forceDeletion", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to force delete virtual machines from the VM scale set. (Feature in Preview)" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_DeleteInstances_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_DeleteInstances_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_DeleteInstances_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_DeleteInstances_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetInstanceView", + "description": "Gets the status of a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceView" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_List", + "description": "Gets a list of all VM scale sets under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachineScaleSet_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_CreateOrUpdate", + "description": "The operation to create or update an extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "Parameters supplied to the Create VM scale set Extension operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetExtension_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_CreateOrUpdate_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetExtension_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Update", + "description": "The operation to update an extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be updated." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionUpdate" + }, + "description": "Parameters supplied to the Update VM scale set Extension operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetExtension_Update_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Update_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetExtension_Update_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be deleted." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetExtension_Delete_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Delete_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetExtension_Delete_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineScaleSetExtension_Get_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Get_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetExtension_Get_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions": { + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_List", + "description": "Gets a list of all extensions in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachineScaleSetExtension_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetExtension_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListAll", + "description": "Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListWithLinkResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachineScaleSet_ListAll_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_ListAll_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListSkus", + "description": "Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListSkusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachineScaleSet_ListSkus_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListSkus_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_ListSkus_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListSkus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetOSUpgradeHistory", + "description": "Gets list of OS upgrades on a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListOSUpgradeHistory" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PowerOff", + "description": "Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_PowerOff_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PowerOff_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_PowerOff_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PowerOff_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Restart", + "description": "Restarts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_Restart_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Restart_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_Restart_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Restart_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Start", + "description": "Starts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_Start_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Start_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_Start_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Start_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reapply": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Reapply", + "description": "Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VirtualMachineScaleSets_Reapply_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reapply_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSets_Reapply_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reapply_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Redeploy", + "description": "Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_Redeploy_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Redeploy_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_Redeploy_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Redeploy_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PerformMaintenance", + "description": "Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_PerformMaintenance_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PerformMaintenance_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_PerformMaintenance_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PerformMaintenance_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_UpdateInstances", + "description": "Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_UpdateInstances_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_UpdateInstances_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_UpdateInstances_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_UpdateInstances_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Reimage", + "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmScaleSetReimageInput", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetReimageParameters" + }, + "description": "Parameters for Reimaging VM ScaleSet." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_Reimage_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_Reimage_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ReimageAll", + "description": "Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_ReimageAll_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ReimageAll_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_ReimageAll_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ReimageAll_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/approveRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ApproveRollingUpgrade", + "description": "Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_ApproveRollingUpgrade": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ApproveRollingUpgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_Cancel", + "description": "Cancels the current virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetRollingUpgrade_Cancel_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_Cancel_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetRollingUpgrade_Cancel_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_Cancel_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade", + "description": "Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensionRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade", + "description": "Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start an extension rolling upgrade.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_RollingUpgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest": { + "get": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_GetLatest", + "description": "Gets the status of the latest virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RollingUpgradeStatusInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/forceRecoveryServiceFabricPlatformUpdateDomainWalk": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk", + "description": "Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "platformUpdateDomain", + "in": "query", + "required": true, + "type": "integer", + "description": "The platform update domain for which a manual recovery walk is requested" + }, + { + "name": "zone", + "in": "query", + "required": false, + "type": "string", + "description": "The zone in which the manual recovery walk is requested for cross zone virtual machine scale set" + }, + { + "name": "placementGroupId", + "in": "query", + "required": false, + "type": "string", + "description": "The placement group id for which the manual recovery walk is requested." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryWalkResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/convertToSinglePlacementGroup": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ConvertToSinglePlacementGroup", + "description": "Converts SinglePlacementGroup property to false for a existing virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VMScaleSetConvertToSinglePlacementGroupInput" + }, + "description": "The input object for ConvertToSinglePlacementGroup API." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/setOrchestrationServiceState": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_SetOrchestrationServiceState", + "description": "Changes ServiceState property for a given service", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OrchestrationServiceStateInput" + }, + "description": "The input object for SetOrchestrationServiceState API." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_SetOrchestrationServiceState_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_SetOrchestrationServiceState_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_SetOrchestrationServiceState_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_SetOrchestrationServiceState_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_CreateOrUpdate", + "description": "The operation to create or update the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + }, + "description": "Parameters supplied to the Create Virtual Machine Extension operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Create.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_Update", + "description": "The operation to update the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine Extension operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Update.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_Delete", + "description": "The operation to delete the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Delete.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_Get", + "description": "The operation to get the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_List", + "description": "The operation to get all extensions of an instance in Virtual Machine Scaleset.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List extensions in Vmss instance.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Reimage", + "description": "Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmScaleSetVMReimageInput", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + }, + "description": "Parameters for the Reimaging Virtual machine in ScaleSet." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetVM_Reimage_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Reimage_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_Reimage_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Reimage_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_ReimageAll", + "description": "Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetVM_ReimageAll_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ReimageAll_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_ReimageAll_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ReimageAll_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/approveRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_ApproveRollingUpgrade", + "description": "Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetVM_ApproveRollingUpgrade": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ApproveRollingUpgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Deallocate", + "description": "Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetVM_Deallocate_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Deallocate_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_Deallocate_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Deallocate_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}": { + "put": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Update", + "description": "Updates a virtual machine of a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "Parameters supplied to the Update Virtual Machine Scale Sets VM operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetVM_Update_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Update_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_Update_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Delete", + "description": "Deletes a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "forceDeletion", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to force delete a virtual machine from a VM scale set. (Feature in Preview)" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Force Delete a virtual machine from a VM scale set.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Delete_Force.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Get", + "description": "Gets a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine.", + "enum": [ + "instanceView", + "userData" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get VM scale set VM with UserData": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json" + }, + "Get VM scale set VM with VMSizeProperties": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_GetInstanceView", + "description": "Gets the status of a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through automatic placement.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_List", + "description": "Gets a list of all virtual machines in a VM scale sets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/VirtualMachineScaleSetVM", + "x-ms-examples": { + "VirtualMachineScaleSetVM_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_List_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PowerOff", + "description": "Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetVM_PowerOff_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PowerOff_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_PowerOff_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PowerOff_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Restart", + "description": "Restarts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetVM_Restart_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Restart_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_Restart_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Restart_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Start", + "description": "Starts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetVM_Start_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Start_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_Start_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Start_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Redeploy", + "description": "Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetVM_Redeploy_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Redeploy_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_Redeploy_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Redeploy_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/retrieveBootDiagnosticsData": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_RetrieveBootDiagnosticsData", + "description": "The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "sasUriExpirationTimeInMinutes", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. **Note:** If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./virtualMachine.json#/definitions/RetrieveBootDiagnosticsDataResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "RetrieveBootDiagnosticsData of a virtual machine.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_RetrieveBootDiagnosticsData.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PerformMaintenance", + "description": "Performs maintenance on a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetVM_PerformMaintenance_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PerformMaintenance_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_PerformMaintenance_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PerformMaintenance_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/simulateEviction": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_SimulateEviction", + "description": "The operation to simulate the eviction of spot virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Simulate Eviction a virtual machine.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_SimulateEviction.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/attachDetachDataDisks": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_AttachDetachDataDisks", + "description": "Attach and detach data disks to/from a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./computeRPCommon.json#/definitions/AttachDetachDataDisksRequest" + }, + "description": "Parameters supplied to the attach and detach data disks operation on a Virtual Machine Scale Sets VM." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./computeRPCommon.json#/definitions/StorageProfile" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "VirtualMachineScaleSetVMExtension": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the extension." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "The location of the extension.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a VMSS VM Extension.", + "x-ms-azure-resource": true + }, + "VirtualMachineScaleSetVMExtensionUpdate": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the extension." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtensionUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a VMSS VM Extension.", + "x-ms-azure-resource": true + }, + "VirtualMachineScaleSetVMExtensionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + }, + "description": "The list of VMSS VM extensions" + } + }, + "description": "The List VMSS VM Extension operation response" + }, + "VirtualMachineScaleSetHardwareProfile": { + "type": "object", + "properties": { + "vmSizeProperties": { + "$ref": "./computeRPCommon.json#/definitions/VMSizeProperties", + "description": "Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details." + } + }, + "description": "Specifies the hardware settings for the virtual machine scale set." + }, + "AutomaticRepairsPolicy": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false." + }, + "gracePeriod": { + "type": "string", + "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M)." + }, + "repairAction": { + "type": "string", + "description": "Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.", + "enum": [ + "Replace", + "Restart", + "Reimage" + ], + "x-ms-enum": { + "name": "RepairAction", + "modelAsString": true + } + } + }, + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." + }, + "AutomaticOSUpgradePolicy": { + "properties": { + "enableAutomaticOSUpgrade": { + "type": "boolean", + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true." + }, + "disableAutomaticRollback": { + "type": "boolean", + "description": "Whether OS image rollback feature should be disabled. Default value is false." + }, + "useRollingUpgradePolicy": { + "type": "boolean", + "description": "Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS." + }, + "osRollingUpgradeDeferral": { + "type": "boolean", + "description": "Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "UpgradePolicy": { + "properties": { + "mode": { + "type": "string", + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.", + "enum": [ + "Automatic", + "Manual", + "Rolling" + ], + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": false + } + }, + "rollingUpgradePolicy": { + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "automaticOSUpgradePolicy": { + "$ref": "#/definitions/AutomaticOSUpgradePolicy", + "description": "Configuration parameters used for performing automatic OS Upgrade." + } + }, + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "ResiliencyPolicy": { + "type": "object", + "properties": { + "resilientVMCreationPolicy": { + "$ref": "#/definitions/ResilientVMCreationPolicy", + "description": "The configuration parameters used while performing resilient VM creation." + }, + "resilientVMDeletionPolicy": { + "$ref": "#/definitions/ResilientVMDeletionPolicy", + "description": "The configuration parameters used while performing resilient VM deletion." + } + }, + "description": "Describes an resiliency policy - resilientVMCreationPolicy and/or resilientVMDeletionPolicy." + }, + "ResilientVMCreationPolicy": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false." + } + }, + "description": "The configuration parameters used while performing resilient VM creation." + }, + "ResilientVMDeletionPolicy": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false." + } + }, + "description": "The configuration parameters used while performing resilient VM deletion." + }, + "RollingUpgradePolicy": { + "properties": { + "maxBatchInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." + }, + "maxUnhealthyInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." + }, + "maxUnhealthyUpgradedInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." + }, + "enableCrossZoneUpgrade": { + "type": "boolean", + "description": "Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size." + }, + "prioritizeUnhealthyInstances": { + "type": "boolean", + "description": "Upgrade all unhealthy instances in a scale set before any healthy instances." + }, + "rollbackFailedInstancesOnPolicyBreach": { + "type": "boolean", + "description": "Rollback failed instances to previous model if the Rolling Upgrade policy is violated." + }, + "maxSurge": { + "type": "boolean", + "description": "Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "ScaleInPolicy": { + "properties": { + "rules": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Default", + "OldestVM", + "NewestVM" + ], + "x-ms-enum": { + "name": "VirtualMachineScaleSetScaleInRules", + "modelAsString": true + } + }, + "description": "The rules to be followed when scaling-in a virtual machine scale set.

Possible values are:

**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

" + }, + "forceDeletion": { + "type": "boolean", + "description": "This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)" + } + }, + "description": "Describes a scale-in policy for a virtual machine scale set." + }, + "SpotRestorePolicy": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints" + }, + "restoreTimeout": { + "type": "string", + "description": "Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances" + } + }, + "description": "Specifies the Spot-Try-Restore properties for the virtual machine scale set. With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint." + }, + "PriorityMixPolicy": { + "type": "object", + "properties": { + "baseRegularPriorityCount": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The base number of regular priority VMs that will be created in this scale set as it scales out." + }, + "regularPriorityPercentageAboveBase": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority." + } + }, + "description": "Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode. With this property the customer is able to specify the base number of regular priority VMs created as the VMSS flex instance scales out and the split between Spot and Regular priority VMs after this base target has been reached." + }, + "OrchestrationMode": { + "type": "string", + "description": "Specifies the orchestration mode for the virtual machine scale set.", + "enum": [ + "Uniform", + "Flexible" + ], + "x-ms-enum": { + "name": "OrchestrationMode", + "modelAsString": true + } + }, + "VirtualMachineScaleSetIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "$ref": "../../../common-types/v1/common.json#/definitions/UserAssignedIdentities", + "description": "The list of user identities associated with the virtual machine scale set. 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 virtual machine scale set." + }, + "VirtualMachineScaleSetOSProfile": { + "properties": { + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in \".\"

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

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

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

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

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

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)", + "x-ms-secret": true + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)" + }, + "windowsConfiguration": { + "$ref": "./computeRPCommon.json#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "./computeRPCommon.json#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/VaultSecretGroup" + }, + "x-ms-identifiers": [ + "sourceVault/id" + ], + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." + }, + "allowExtensionOperations": { + "type": "boolean", + "description": "Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set." + }, + "requireGuestProvisionSignal": { + "type": "boolean", + "description": "Optional property which must either be set to True or omitted." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetUpdateOSProfile": { + "properties": { + "customData": { + "type": "string", + "description": "A base-64 encoded string of custom data." + }, + "windowsConfiguration": { + "$ref": "./computeRPCommon.json#/definitions/WindowsConfiguration", + "description": "The Windows Configuration of the OS profile." + }, + "linuxConfiguration": { + "$ref": "./computeRPCommon.json#/definitions/LinuxConfiguration", + "description": "The Linux Configuration of the OS profile." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/VaultSecretGroup" + }, + "x-ms-identifiers": [ + "sourceVault/id" + ], + "description": "The List of certificates for addition to the VM." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "./computeRPCommon.json#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." + }, + "diskEncryptionSet": { + "$ref": "./computeRPCommon.json#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed disk." + }, + "securityProfile": { + "$ref": "./computeRPCommon.json#/definitions/VMDiskSecurityProfile", + "description": "Specifies the security profile for the managed disk." + } + }, + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "VirtualMachineScaleSetOSDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "caching": { + "$ref": "./computeRPCommon.json#/definitions/Caching", + "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "./computeRPCommon.json#/definitions/CreateOption", + "description": "Specifies how the virtual machines in the scale set should be created. The only allowed value is: **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diffDiskSettings": { + "$ref": "./computeRPCommon.json#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023." + }, + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "image": { + "$ref": "./computeRPCommon.json#/definitions/VirtualHardDisk", + "description": "Specifies information about the unmanaged user image to base the scale set on." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the container urls that are used to store operating system disks for the scale set." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + "deleteOption": { + "$ref": "./computeRPCommon.json#/definitions/DeleteOption", + "description": "Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk." + } + }, + "required": [ + "createOption" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetUpdateOSDisk": { + "properties": { + "caching": { + "$ref": "./computeRPCommon.json#/definitions/Caching", + "description": "The caching type." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "diffDiskSettings": { + "$ref": "./computeRPCommon.json#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023" + }, + "image": { + "$ref": "./computeRPCommon.json#/definitions/VirtualHardDisk", + "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of virtual hard disk container uris." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + "deleteOption": { + "$ref": "./computeRPCommon.json#/definitions/DeleteOption", + "description": "Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk." + } + }, + "description": "Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk." + }, + "VirtualMachineScaleSetDataDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "caching": { + "$ref": "./computeRPCommon.json#/definitions/Caching", + "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "./computeRPCommon.json#/definitions/CreateOption", + "description": "The create option." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." + }, + "deleteOption": { + "$ref": "./computeRPCommon.json#/definitions/DeleteOption", + "description": "Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**." + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a virtual machine scale set data disk." + }, + "VirtualMachineScaleSetStorageProfile": { + "properties": { + "imageReference": { + "$ref": "./computeRPCommon.json#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machines in the scale set. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "x-ms-identifiers": [ + "name", + "lun" + ], + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "diskControllerType": { + "type": "string", + "items": { + "$ref": "./computeRPCommon.json#/definitions/DiskControllerType", + "description": "Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01" + } + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "VirtualMachineScaleSetUpdateStorageProfile": { + "properties": { + "imageReference": { + "$ref": "./computeRPCommon.json#/definitions/ImageReference", + "description": "The image reference." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSDisk", + "description": "The OS disk." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "x-ms-identifiers": [ + "name", + "lun" + ], + "description": "The data disks." + }, + "diskControllerType": { + "type": "string", + "items": { + "$ref": "./computeRPCommon.json#/definitions/DiskControllerType", + "description": "Specifies the disk controller type configured for the virtual machines in the scale set. **Note:** You need to deallocate the virtual machines in the scale set before updating its disk controller type based on the upgrade mode configured for the scale set. Minimum api-version: 2022-08-01." + } + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetUpdateIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", + "description": "The subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary IP Configuration in case the network interface has more than one IP Configuration." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "The application gateway backend address pools." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "The load balancer backend address pools." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "The load balancer inbound nat pools." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfigurationProperties" + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration. NOTE: The subnet of a scale set may be modified as long as the original subnet and the new subnet are in the same virtual network", + "x-ms-azure-resource": true + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "disableTcpStateTracking": { + "type": "boolean", + "description": "Specifies whether the network interface is disabled for tcp state tracking." + }, + "enableFpga": { + "type": "boolean", + "description": "Specifies whether the network interface is FPGA networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Specifies the IP configurations of the network interface." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + }, + "deleteOption": { + "type": "string", + "description": "Specify what happens to the network interface when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true + } + }, + "auxiliaryMode": { + "type": "string", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface resource.", + "enum": [ + "None", + "AcceleratedConnections", + "Floating" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliaryMode", + "modelAsString": true + } + }, + "auxiliarySku": { + "type": "string", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface resource.", + "enum": [ + "None", + "A1", + "A2", + "A4", + "A8" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliarySku", + "modelAsString": true + } + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Whether this is a primary NIC on a virtual machine." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "disableTcpStateTracking": { + "type": "boolean", + "description": "Specifies whether the network interface is disabled for tcp state tracking." + }, + "enableFpga": { + "type": "boolean", + "description": "Specifies whether the network interface is FPGA networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The virtual machine scale set IP Configuration." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + }, + "deleteOption": { + "type": "string", + "description": "Specify what happens to the network interface when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true + } + }, + "auxiliaryMode": { + "type": "string", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface resource.", + "enum": [ + "None", + "AcceleratedConnections", + "Floating" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliaryMode", + "modelAsString": true + } + }, + "auxiliarySku": { + "type": "string", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface resource.", + "enum": [ + "None", + "A1", + "A2", + "A4", + "A8" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliarySku", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetUpdateNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfigurationProperties" + } + }, + "description": "Describes a virtual machine scale set network profile's network configurations.", + "x-ms-azure-resource": true + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses" + } + }, + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created" + }, + "domainNameLabelScope": { + "type": "string", + "description": "The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "x-ms-enum": { + "name": "DomainNameLabelScopeTypes", + "modelAsString": true + } + } + }, + "required": [ + "domainNameLabel" + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetIpTag": { + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "Contains the IP tag associated with the public IP address." + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/PublicIPAddressSku" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties" + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + }, + "x-ms-identifiers": [], + "description": "The list of IP tags associated with the public IP address." + }, + "publicIPPrefix": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The PublicIPPrefix from which to allocate publicIP addresses." + }, + "publicIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "deleteOption": { + "type": "string", + "description": "Specify what happens to the public IP when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + }, + "publicIPPrefix": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The PublicIPPrefix from which to allocate publicIP addresses." + }, + "deleteOption": { + "type": "string", + "description": "Specify what happens to the public IP when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetNetworkProfile": { + "properties": { + "healthProbe": { + "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "x-ms-identifiers": [], + "description": "The list of network configurations." + }, + "networkApiVersion": { + "type": "string", + "description": "specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'", + "enum": [ + "2020-11-01" + ], + "x-ms-enum": { + "name": "NetworkApiVersion", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetUpdateNetworkProfile": { + "properties": { + "healthProbe": { + "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of network configurations." + }, + "networkApiVersion": { + "type": "string", + "description": "specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'", + "enum": [ + "2020-11-01" + ], + "x-ms-enum": { + "name": "NetworkApiVersion", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." + }, + "suppressFailures": { + "type": "boolean", + "description": "Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false." + }, + "protectedSettingsFromKeyVault": { + "$ref": "./computeRPCommon.json#/definitions/KeyVaultSecretReference", + "description": "The extensions protected settings that are passed by reference, and consumed from key vault" + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtension": { + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionUpdate": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the extension." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a Virtual Machine Scale Set Extension.", + "x-ms-azure-resource": true + }, + "VirtualMachineScaleSetExtensionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The list of VM scale set extensions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions." + } + }, + "required": [ + "value" + ], + "description": "The List VM scale set extension operation response." + }, + "VirtualMachineScaleSetExtensionProfile": { + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The virtual machine scale set child extension resources." + }, + "extensionsTimeBudget": { + "type": "string", + "description": "Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01." + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", + "description": "Specifies the operating system settings for the virtual machines in the scale set." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", + "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." + }, + "securityProfile": { + "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machines in the scale set." + }, + "diagnosticsProfile": { + "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15" + }, + "priority": { + "$ref": "./computeRPCommon.json#/definitions/priority", + "description": "Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview." + }, + "evictionPolicy": { + "$ref": "./computeRPCommon.json#/definitions/evictionPolicy", + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + }, + "billingProfile": { + "$ref": "./computeRPCommon.json#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01." + }, + "scheduledEventsProfile": { + "$ref": "./computeRPCommon.json#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + }, + "userData": { + "type": "string", + "description": "UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01." + }, + "capacityReservation": { + "$ref": "./computeRPCommon.json#/definitions/CapacityReservationProfile", + "description": "Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01." + }, + "applicationProfile": { + "$ref": "./computeRPCommon.json#/definitions/ApplicationProfile", + "description": "Specifies the gallery applications that should be made available to the VM/VMSS" + }, + "hardwareProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetHardwareProfile", + "description": "Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01." + }, + "serviceArtifactReference": { + "$ref": "#/definitions/ServiceArtifactReference", + "description": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01" + }, + "securityPostureReference": { + "$ref": "#/definitions/SecurityPostureReference", + "description": "Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01" + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2024-03-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2024-03-01." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetUpdateVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSProfile", + "description": "The virtual machine scale set OS profile." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateStorageProfile", + "description": "The virtual machine scale set storage profile." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkProfile", + "description": "The virtual machine scale set network profile." + }, + "securityPostureReference": { + "$ref": "#/definitions/SecurityPostureReferenceUpdate", + "description": "The virtual machine scale set security posture reference." + }, + "securityProfile": { + "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", + "description": "The virtual machine scale set Security profile" + }, + "diagnosticsProfile": { + "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile", + "description": "The virtual machine scale set diagnostics profile." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "The virtual machine scale set extension profile." + }, + "licenseType": { + "type": "string", + "description": "The license type, which is for bring your own license scenario." + }, + "billingProfile": { + "$ref": "./computeRPCommon.json#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01." + }, + "scheduledEventsProfile": { + "$ref": "./computeRPCommon.json#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + }, + "userData": { + "type": "string", + "description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

Minimum api-version: 2021-03-01" + }, + "hardwareProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetHardwareProfile", + "description": "Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "scheduledEventsPolicy": { + "$ref": "./computeRPCommon.json#/definitions/ScheduledEventsPolicy", + "description": "The ScheduledEventsPolicy." + }, + "automaticRepairsPolicy": { + "$ref": "#/definitions/AutomaticRepairsPolicy", + "description": "Policy for automatic repairs." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile", + "description": "The virtual machine profile." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "doNotRunExtensionsOnOverprovisionedVMs": { + "type": "boolean", + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + }, + "uniqueId": { + "readOnly": true, + "type": "string", + "description": "Specifies the ID which uniquely identifies a Virtual Machine Scale Set." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true." + }, + "zoneBalance": { + "type": "boolean", + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count for each placement group." + }, + "proximityPlacementGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01." + }, + "hostGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01." + }, + "additionalCapabilities": { + "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, + "scaleInPolicy": { + "$ref": "#/definitions/ScaleInPolicy", + "description": "Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set." + }, + "orchestrationMode": { + "$ref": "#/definitions/OrchestrationMode", + "description": "Specifies the orchestration mode for the virtual machine scale set." + }, + "spotRestorePolicy": { + "$ref": "#/definitions/SpotRestorePolicy", + "description": "Specifies the Spot Restore properties for the virtual machine scale set." + }, + "priorityMixPolicy": { + "$ref": "#/definitions/PriorityMixPolicy", + "description": "Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance." + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01." + }, + "constrainedMaximumCapacity": { + "type": "boolean", + "description": "Optional property which must either be set to True or omitted." + }, + "resiliencyPolicy": { + "$ref": "#/definitions/ResiliencyPolicy", + "description": "Policy for Resiliency" + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetUpdateProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "automaticRepairsPolicy": { + "$ref": "#/definitions/AutomaticRepairsPolicy", + "description": "Policy for automatic repairs." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateVMProfile", + "description": "The virtual machine profile." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "doNotRunExtensionsOnOverprovisionedVMs": { + "type": "boolean", + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true." + }, + "additionalCapabilities": { + "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, + "scaleInPolicy": { + "$ref": "#/definitions/ScaleInPolicy", + "description": "Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set." + }, + "proximityPlacementGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Minimum api-version: 2018-04-01." + }, + "priorityMixPolicy": { + "$ref": "#/definitions/PriorityMixPolicy", + "description": "Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance." + }, + "spotRestorePolicy": { + "$ref": "#/definitions/SpotRestorePolicy", + "description": "Specifies the Spot Restore properties for the virtual machine scale set." + }, + "resiliencyPolicy": { + "$ref": "#/definitions/ResiliencyPolicy", + "description": "Policy for Resiliency" + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSet": { + "properties": { + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "./computeRPCommon.json#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set" + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine Scale Set." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMReimageParameters": { + "type": "object", + "properties": { + "forceUpdateOSDiskForEphemeral": { + "type": "boolean", + "description": "Parameter to force update ephemeral OS disk for a virtual machine scale set VM" + } + }, + "allOf": [ + { + "$ref": "./virtualMachine.json#/definitions/VirtualMachineReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, + "VirtualMachineScaleSetReimageParameters": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, + "VirtualMachineScaleSetUpdate": { + "properties": { + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "./computeRPCommon.json#/definitions/Plan", + "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMInstanceIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineScaleSetVMInstanceRequiredIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids." + } + }, + "required": [ + "instanceIds" + ], + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineStatusCodeCount": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The instance view status code." + }, + "count": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances having a particular status code." + } + }, + "description": "The status code and count of the virtual machine scale set instance view status summary." + }, + "VirtualMachineScaleSetInstanceViewStatusesSummary": { + "properties": { + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "x-ms-identifiers": [], + "description": "The extensions information." + } + }, + "description": "Instance view statuses summary for virtual machines of a virtual machine scale set." + }, + "VirtualMachineScaleSetVMExtensionsSummary": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The extension name." + }, + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "x-ms-identifiers": [], + "description": "The extensions information." + } + }, + "description": "Extensions summary for virtual machines of a virtual machine scale set." + }, + "OrchestrationServiceSummary": { + "properties": { + "serviceName": { + "type": "string", + "readOnly": true, + "description": "The name of the service.", + "enum": [ + "AutomaticRepairs" + ], + "x-ms-enum": { + "name": "OrchestrationServiceNames", + "modelAsString": true + } + }, + "serviceState": { + "type": "string", + "readOnly": true, + "description": "The current state of the service.", + "enum": [ + "NotRunning", + "Running", + "Suspended" + ], + "x-ms-enum": { + "name": "OrchestrationServiceState", + "modelAsString": true + } + } + }, + "description": "Summary for an orchestration service of a virtual machine scale set." + }, + "VirtualMachineScaleSetInstanceView": { + "properties": { + "virtualMachine": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceViewStatusesSummary", + "readOnly": true, + "description": "The instance view status summary for the virtual machine scale set." + }, + "extensions": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsSummary" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The extensions information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + }, + "orchestrationServices": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/OrchestrationServiceSummary" + }, + "x-ms-identifiers": [ + "serviceName" + ], + "description": "The orchestration services information." + } + }, + "description": "The instance view of a virtual machine scale set." + }, + "VirtualMachineScaleSetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetListWithLinkResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetSkuCapacity": { + "properties": { + "minimum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The minimum capacity." + }, + "maximum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum capacity that can be set." + }, + "defaultCapacity": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The default capacity." + }, + "scaleType": { + "readOnly": true, + "type": "string", + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "None" + ], + "x-ms-enum": { + "name": "VirtualMachineScaleSetSkuScaleType", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a sku." + }, + "VirtualMachineScaleSetSku": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the sku applies to." + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "readOnly": true, + "description": "The Sku." + }, + "capacity": { + "$ref": "#/definitions/VirtualMachineScaleSetSkuCapacity", + "readOnly": true, + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes an available virtual machine scale set sku." + }, + "VirtualMachineScaleSetListSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetSku" + }, + "x-ms-identifiers": [ + "resourceType", + "sku/name" + ], + "description": "The list of skus available for the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus." + } + }, + "required": [ + "value" + ], + "description": "The Virtual Machine Scale Set List Skus operation response." + }, + "UpgradeOperationHistoryStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "UpgradeState", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "End time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "UpgradeOperationHistoricalStatusInfoProperties": { + "properties": { + "runningStatus": { + "$ref": "#/definitions/UpgradeOperationHistoryStatus", + "readOnly": true, + "description": "Information about the overall status of the upgrade operation." + }, + "progress": { + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "readOnly": true, + "description": "Counts of the VMs in each state." + }, + "error": { + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "readOnly": true, + "description": "Error Details for this upgrade if there are any." + }, + "startedBy": { + "readOnly": true, + "type": "string", + "description": "Invoker of the Upgrade Operation", + "enum": [ + "Unknown", + "User", + "Platform" + ], + "x-ms-enum": { + "name": "UpgradeOperationInvoker", + "modelAsString": false + } + }, + "targetImageReference": { + "$ref": "./computeRPCommon.json#/definitions/ImageReference", + "readOnly": true, + "description": "Image Reference details" + }, + "rollbackInfo": { + "$ref": "./computeRPCommon.json#/definitions/RollbackStatusInfo", + "readOnly": true, + "description": "Information about OS rollback if performed" + } + }, + "description": "Describes each OS upgrade on the Virtual Machine Scale Set." + }, + "UpgradeOperationHistoricalStatusInfo": { + "properties": { + "properties": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfoProperties", + "readOnly": true, + "description": "Information about the properties of the upgrade operation." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + } + }, + "description": "Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetListOSUpgradeHistory": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfo" + }, + "x-ms-identifiers": [ + "type", + "location" + ], + "description": "The list of OS upgrades performed on the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades." + } + }, + "required": [ + "value" + ], + "description": "List of Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetVMProperties": { + "properties": { + "latestModelApplied": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the latest model has been applied to the virtual machine." + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Azure VM unique ID." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "hardwareProfile": { + "$ref": "./computeRPCommon.json#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "./computeRPCommon.json#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "additionalCapabilities": { + "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, + "osProfile": { + "$ref": "./computeRPCommon.json#/definitions/OSProfile", + "description": "Specifies the operating system settings for the virtual machine." + }, + "securityProfile": { + "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machine." + }, + "networkProfile": { + "$ref": "./computeRPCommon.json#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "networkProfileConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetVMNetworkProfileConfiguration", + "description": "Specifies the network profile configuration of the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15" + }, + "modelDefinitionApplied": { + "readOnly": true, + "type": "string", + "description": "Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine." + }, + "protectionPolicy": { + "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy", + "description": "Specifies the protection policy of the virtual machine." + }, + "userData": { + "type": "string", + "description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

Minimum api-version: 2021-03-01" + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Virtual Machine resource was created.

Minimum api-version: 2021-11-01." + } + }, + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVM": { + "properties": { + "instanceId": { + "readOnly": true, + "type": "string", + "description": "The virtual machine instance ID." + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "readOnly": true, + "description": "The virtual machine SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + "plan": { + "$ref": "./computeRPCommon.json#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + }, + "identity": { + "$ref": "./virtualMachine.json#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Describes a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVMInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "The Update Domain count." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "The Fault Domain count." + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "./virtualMachine.json#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "./computeRPCommon.json#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/DiskInstanceView" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The disks information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtensionInstanceView" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "description": "The extensions information." + }, + "vmHealth": { + "readOnly": true, + "$ref": "./virtualMachine.json#/definitions/VirtualMachineHealthStatus", + "description": "The health status for the VM." + }, + "bootDiagnostics": { + "$ref": "./computeRPCommon.json#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + }, + "assignedHost": { + "type": "string", + "readOnly": true, + "description": "Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01." + }, + "placementGroupId": { + "type": "string", + "description": "The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId." + }, + "computerName": { + "type": "string", + "description": "Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

**Max-length (Windows):** 15 characters

**Max-length (Linux):** 64 characters.

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "osName": { + "type": "string", + "description": "The Operating System running on the hybrid machine." + }, + "osVersion": { + "type": "string", + "description": "The version of Operating System running on the hybrid machine." + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + } + }, + "description": "The instance view of a virtual machine scale set VM." + }, + "VirtualMachineScaleSetVMNetworkProfileConfiguration": { + "properties": { + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set VM network profile." + }, + "VirtualMachineScaleSetVMProtectionPolicy": { + "properties": { + "protectFromScaleIn": { + "type": "boolean", + "description": "Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation." + }, + "protectFromScaleSetActions": { + "type": "boolean", + "description": "Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM." + } + }, + "description": "The protection policy of a virtual machine scale set VM." + }, + "VirtualMachineScaleSetVMListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "The list of virtual machine scale sets VMs." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs" + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine Scale Set VMs operation response." + }, + "RollingUpgradeStatusInfo": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RollingUpgradeStatusInfoProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeStatusInfoProperties": { + "properties": { + "policy": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The rolling upgrade policies applied for this upgrade." + }, + "runningStatus": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeRunningStatus", + "description": "Information about the current running state of the overall upgrade." + }, + "progress": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "error": { + "readOnly": true, + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "description": "Error details for this upgrade, if there are any." + } + }, + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeRunningStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "RollingUpgradeStatusCode", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "lastAction": { + "type": "string", + "readOnly": true, + "description": "The last action performed on the rolling upgrade.", + "enum": [ + "Start", + "Cancel" + ], + "x-ms-enum": { + "name": "RollingUpgradeActionType", + "modelAsString": false + } + }, + "lastActionTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last action time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "RollingUpgradeProgressInfo": { + "properties": { + "successfulInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have been successfully upgraded." + }, + "failedInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have failed to be upgraded successfully." + }, + "inProgressInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that are currently being upgraded." + }, + "pendingInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have not yet begun to be upgraded." + } + }, + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "RecoveryWalkResponse": { + "properties": { + "walkPerformed": { + "type": "boolean", + "readOnly": true, + "description": "Whether the recovery walk was performed" + }, + "nextPlatformUpdateDomain": { + "type": "integer", + "readOnly": true, + "description": "The next update domain that needs to be walked. Null means walk spanning all update domains has been completed" + } + }, + "description": "Response after calling a manual recovery walk" + }, + "VMScaleSetConvertToSinglePlacementGroupInput": { + "properties": { + "activePlacementGroupId": { + "type": "string", + "description": "Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances." + } + } + }, + "OrchestrationServiceStateInput": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service.", + "enum": [ + "AutomaticRepairs" + ], + "x-ms-enum": { + "name": "OrchestrationServiceNames", + "modelAsString": true + } + }, + "action": { + "type": "string", + "description": "The action to be performed.", + "enum": [ + "Resume", + "Suspend" + ], + "x-ms-enum": { + "name": "OrchestrationServiceStateAction", + "modelAsString": true + } + } + }, + "description": "The input for OrchestrationServiceState", + "required": [ + "serviceName", + "action" + ] + }, + "ServiceArtifactReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + }, + "description": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01" + }, + "SecurityPostureReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest" + }, + "excludeExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of virtual machine extension names to exclude when applying the security posture." + }, + "isOverridable": { + "type": "boolean", + "description": "Whether the security posture can be overridden by the user." + } + }, + "description": "Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01", + "required": [ + "id" + ] + }, + "SecurityPostureReferenceUpdate": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest" + }, + "excludeExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of virtual machine extension names to exclude when applying the security posture." + }, + "isOverridable": { + "type": "boolean", + "description": "Whether the security posture can be overridden by the user." + } + }, + "description": "Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01" + } + } +} diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/disk.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/disk.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/disk.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/disk.json index 5dd4289a1..78db8bd08 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/disk.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/disk.json @@ -3,7 +3,7 @@ "info": { "title": "DiskResourceProviderClient", "description": "The Disk Resource Provider Client.", - "version": "2023-04-02" + "version": "2023-10-02" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskAccess.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/diskAccess.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskAccess.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/diskAccess.json index 1236302c3..425d235e1 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskAccess.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/diskAccess.json @@ -3,7 +3,7 @@ "info": { "title": "DiskResourceProviderClient", "description": "The Disk Resource Provider Client.", - "version": "2023-04-02" + "version": "2023-10-02" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskEncryptionSet.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/diskEncryptionSet.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskEncryptionSet.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/diskEncryptionSet.json index cc6ee6dd3..9c49f104d 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskEncryptionSet.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/diskEncryptionSet.json @@ -3,7 +3,7 @@ "info": { "title": "DiskResourceProviderClient", "description": "The Disk Resource Provider Client.", - "version": "2023-04-02" + "version": "2023-10-02" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskRPCommon.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/diskRPCommon.json similarity index 96% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskRPCommon.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/diskRPCommon.json index 62f71f29b..ded5abd00 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskRPCommon.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/diskRPCommon.json @@ -3,7 +3,7 @@ "info": { "title": "DiskResourceProviderClient", "description": "The Disk Resource Provider Client.", - "version": "2023-04-02" + "version": "2023-10-02" }, "host": "management.azure.com", "schemes": [ @@ -373,6 +373,18 @@ "elasticSanResourceId": { "type": "string", "description": "Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot." + }, + "provisionedBandwidthCopySpeed": { + "type": "string", + "description": "If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.", + "enum": [ + "None", + "Enhanced" + ], + "x-ms-enum": { + "name": "ProvisionedBandwidthCopyOption", + "modelAsString": true + } } }, "required": [ @@ -492,7 +504,8 @@ "TrustedLaunch", "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey", "ConfidentialVM_DiskEncryptedWithPlatformKey", - "ConfidentialVM_DiskEncryptedWithCustomerKey" + "ConfidentialVM_DiskEncryptedWithCustomerKey", + "ConfidentialVM_NonPersistedTPM" ], "x-ms-enum": { "name": "DiskSecurityTypes", @@ -513,6 +526,10 @@ { "value": "ConfidentialVM_DiskEncryptedWithCustomerKey", "description": "Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key" + }, + { + "value": "ConfidentialVM_NonPersistedTPM", + "description": "Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots." } ] } diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskRestorePoint.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/diskRestorePoint.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskRestorePoint.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/diskRestorePoint.json index 56dc8d755..007f9363f 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskRestorePoint.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/diskRestorePoint.json @@ -3,7 +3,7 @@ "info": { "title": "DiskResourceProviderClient", "description": "The Disk Resource Provider Client.", - "version": "2023-04-02" + "version": "2023-10-02" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/snapshot.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/snapshot.json similarity index 98% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/snapshot.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/snapshot.json index 16df843e7..ae561b2fe 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/snapshot.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/snapshot.json @@ -3,7 +3,7 @@ "info": { "title": "DiskResourceProviderClient", "description": "The Disk Resource Provider Client.", - "version": "2023-04-02" + "version": "2023-10-02" }, "host": "management.azure.com", "schemes": [ @@ -93,6 +93,9 @@ }, "Create a snapshot from an elastic san volume snapshot.": { "$ref": "./examples/snapshotExamples/Snapshot_Create_FromAnElasticSanVolumeSnapshot.json" + }, + "Create a snapshot from an existing snapshot in the same or a different subscription in a different region with quicker copy speed.": { + "$ref": "./examples/snapshotExamples/Snapshot_Create_EnhancedProvisionedBandwidthCopySpeed.json" } }, "x-ms-long-running-operation": true diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/communityGallery.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/communityGallery.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/communityGallery.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/communityGallery.json index 8e90e1ce8..5b4ae1981 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/communityGallery.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/communityGallery.json @@ -3,7 +3,7 @@ "info": { "title": "CommunityGalleryServiceClient", "description": "Community Gallery Service Client.", - "version": "2022-08-03" + "version": "2023-07-03" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/gallery.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/gallery.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/gallery.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/gallery.json index 7b42b2865..25a2329be 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/gallery.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/gallery.json @@ -3,7 +3,7 @@ "info": { "title": "SharedImageGalleryServiceClient", "description": "Shared Image Gallery Service Client.", - "version": "2022-08-03" + "version": "2023-07-03" }, "host": "management.azure.com", "schemes": [ @@ -2751,6 +2751,10 @@ "communityGalleryImageId": { "type": "string", "description": "The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source." + }, + "virtualMachineId": { + "type": "string", + "description": "The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version." } }, "allOf": [ @@ -2764,7 +2768,7 @@ "properties": { "id": { "type": "string", - "description": "The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource." + "description": "The id of the gallery artifact version source." } }, "description": "The gallery artifact version source." diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/galleryRPCommon.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/galleryRPCommon.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/galleryRPCommon.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/galleryRPCommon.json index e50b347b1..1fc693498 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/galleryRPCommon.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/galleryRPCommon.json @@ -3,7 +3,7 @@ "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", - "version": "2022-08-03" + "version": "2023-07-03" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/sharedGallery.json b/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/sharedGallery.json similarity index 99% rename from swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/sharedGallery.json rename to swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/sharedGallery.json index c979d5699..07249b964 100644 --- a/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/sharedGallery.json +++ b/swagger-specs/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/sharedGallery.json @@ -3,7 +3,7 @@ "info": { "title": "SharedGalleryServiceClient", "description": "Shared Gallery Service Client.", - "version": "2022-08-03" + "version": "2023-07-03" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/compute/resource-manager/api-set.json b/swagger-specs/compute/resource-manager/api-set.json index 66ee757a9..65dc93c39 100644 --- a/swagger-specs/compute/resource-manager/api-set.json +++ b/swagger-specs/compute/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Compute/common-types/v1/common.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/computeRPCommon.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachine.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineImage.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineExtensionImage.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/availabilitySet.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/proximityPlacementGroup.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/dedicatedHost.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/sshPublicKey.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/image.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/restorePoint.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/capacityReservation.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/logAnalytic.json", "Microsoft.Compute/ComputeRP/stable/2023-07-01/runCommand.json", "Microsoft.Compute/DiskRP/stable/2023-04-02/diskRPCommon.json", "Microsoft.Compute/DiskRP/stable/2023-04-02/disk.json", "Microsoft.Compute/DiskRP/stable/2023-04-02/diskAccess.json", "Microsoft.Compute/DiskRP/stable/2023-04-02/diskEncryptionSet.json", "Microsoft.Compute/DiskRP/stable/2023-04-02/diskRestorePoint.json", "Microsoft.Compute/DiskRP/stable/2023-04-02/snapshot.json", "Microsoft.Compute/Skus/stable/2021-07-01/skus.json", "Microsoft.Compute/GalleryRP/stable/2022-08-03/galleryRPCommon.json", "Microsoft.Compute/GalleryRP/stable/2022-08-03/gallery.json", "Microsoft.Compute/GalleryRP/stable/2022-08-03/sharedGallery.json", "Microsoft.Compute/GalleryRP/stable/2022-08-03/communityGallery.json", "Microsoft.Compute/CloudserviceRP/stable/2022-09-04/cloudService.json"], "name": "package-2022-08-03"} \ No newline at end of file +{"addition_input_file_paths": ["./Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json"], "input_files": ["Microsoft.Compute/common-types/v1/common.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/computeRPCommon.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachine.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineImage.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/virtualMachineExtensionImage.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/availabilitySet.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/proximityPlacementGroup.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/dedicatedHost.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/sshPublicKey.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/image.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/restorePoint.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/capacityReservation.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/logAnalytic.json", "Microsoft.Compute/ComputeRP/stable/2024-03-01/runCommand.json", "Microsoft.Compute/DiskRP/stable/2023-10-02/diskRPCommon.json", "Microsoft.Compute/DiskRP/stable/2023-10-02/disk.json", "Microsoft.Compute/DiskRP/stable/2023-10-02/diskAccess.json", "Microsoft.Compute/DiskRP/stable/2023-10-02/diskEncryptionSet.json", "Microsoft.Compute/DiskRP/stable/2023-10-02/diskRestorePoint.json", "Microsoft.Compute/DiskRP/stable/2023-10-02/snapshot.json", "Microsoft.Compute/Skus/stable/2021-07-01/skus.json", "Microsoft.Compute/GalleryRP/stable/2023-07-03/galleryRPCommon.json", "Microsoft.Compute/GalleryRP/stable/2023-07-03/gallery.json", "Microsoft.Compute/GalleryRP/stable/2023-07-03/sharedGallery.json", "Microsoft.Compute/GalleryRP/stable/2023-07-03/communityGallery.json", "Microsoft.Compute/CloudserviceRP/stable/2022-09-04/cloudService.json"], "name": "package-2024-03-01"} \ No newline at end of file diff --git a/swagger-specs/consumption/resource-manager/Microsoft.Consumption/stable/2023-11-01/consumption.json b/swagger-specs/consumption/resource-manager/Microsoft.Consumption/stable/2023-11-01/consumption.json index ba3fdd74c..d118b5714 100644 --- a/swagger-specs/consumption/resource-manager/Microsoft.Consumption/stable/2023-11-01/consumption.json +++ b/swagger-specs/consumption/resource-manager/Microsoft.Consumption/stable/2023-11-01/consumption.json @@ -3623,6 +3623,18 @@ "name" ], "readOnly": true + }, + "lastUsageDate": { + "description": "The last usage date used for looking back for computing the recommendation.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "totalHours": { + "description": "The total hours for which the cost is covered.", + "type": "integer", + "format": "int32", + "readOnly": true } }, "required": [ @@ -3790,6 +3802,18 @@ "description": "This is the ARM Sku name.", "type": "string", "readOnly": true + }, + "lastUsageDate": { + "description": "The last usage date used for looking back for computing the recommendation.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "totalHours": { + "description": "The total hours for which the cost is covered.", + "type": "integer", + "format": "int32", + "readOnly": true } }, "required": [ diff --git a/swagger-specs/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json b/swagger-specs/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json index 4ce50e99d..a0b571348 100644 --- a/swagger-specs/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json +++ b/swagger-specs/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-07-01-preview/containerstorage.json @@ -67,7 +67,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -106,7 +106,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PoolListResult" } @@ -154,7 +154,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PoolListResult" } @@ -212,7 +212,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Pool" } @@ -274,13 +274,13 @@ ], "responses": { "200": { - "description": "ARM update operation completed successfully", + "description": "Resource 'Pool' update operation succeeded", "schema": { "$ref": "#/definitions/Pool" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'Pool' create operation succeeded", "schema": { "$ref": "#/definitions/Pool" }, @@ -353,7 +353,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Pool" } @@ -361,14 +361,14 @@ "202": { "description": "Resource update request accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -400,7 +400,7 @@ "tags": [ "Pools" ], - "description": "Compliant create or update template/**", + "description": "Delete a Pool", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -426,19 +426,19 @@ "202": { "description": "Resource deletion accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -488,7 +488,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SnapshotListResult" } @@ -550,7 +550,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Snapshot" } @@ -616,13 +616,13 @@ ], "responses": { "200": { - "description": "ARM update operation completed successfully", + "description": "Resource 'Snapshot' update operation succeeded", "schema": { "$ref": "#/definitions/Snapshot" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'Snapshot' create operation succeeded", "schema": { "$ref": "#/definitions/Snapshot" }, @@ -656,7 +656,7 @@ "tags": [ "Snapshots" ], - "description": "Compliant create or update template/**", + "description": "Delete a Snapshot", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -692,19 +692,19 @@ "202": { "description": "Resource deletion accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -754,7 +754,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VolumeListResult" } @@ -816,7 +816,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Volume" } @@ -882,13 +882,13 @@ ], "responses": { "200": { - "description": "ARM update operation completed successfully", + "description": "Resource 'Volume' update operation succeeded", "schema": { "$ref": "#/definitions/Volume" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'Volume' create operation succeeded", "schema": { "$ref": "#/definitions/Volume" }, @@ -965,7 +965,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Volume" } @@ -973,14 +973,14 @@ "202": { "description": "Resource update request accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1006,7 +1006,7 @@ "tags": [ "Volumes" ], - "description": "Compliant create or update template/**", + "description": "Delete a Volume", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1042,19 +1042,19 @@ "202": { "description": "Resource deletion accepted.", "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -1101,7 +1101,7 @@ "AssignmentId": { "type": "string", "format": "arm-id", - "description": "A type definition that refers the id to an ARM resource.", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", "x-ms-arm-id-details": { "allowedResources": [ { diff --git a/swagger-specs/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json b/swagger-specs/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json index 09b9e8562..22be02d88 100644 --- a/swagger-specs/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json +++ b/swagger-specs/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json @@ -497,24 +497,6 @@ "value" ] }, - "Versions": { - "type": "string", - "description": "Versions info.", - "enum": [ - "2022-11-01-preview" - ], - "x-ms-enum": { - "name": "Versions", - "modelAsString": true, - "values": [ - { - "name": "v2022_11_01_Preview", - "value": "2022-11-01-preview", - "description": "The 2022-11-01-preview version." - } - ] - } - }, "WidgetSuite": { "type": "object", "description": "A widget.", diff --git a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/cosmos-db.json b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json similarity index 98% rename from swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/cosmos-db.json rename to swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json index e9c2fa63c..509eaec49 100644 --- a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/cosmos-db.json +++ b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json @@ -3,7 +3,7 @@ "info": { "title": "Cosmos DB", "description": "Azure Cosmos DB Database Service Resource Provider REST API", - "version": "2023-09-15" + "version": "2024-05-15" }, "host": "management.azure.com", "schemes": [ @@ -6918,7 +6918,7 @@ "readOnly": true, "description": "List of Private Endpoint Connections configured for the Cosmos DB account.", "items": { - "$ref": "../../stable/2023-09-15/privateEndpointConnection.json#/definitions/PrivateEndpointConnection" + "$ref": "../../stable/2024-05-15/privateEndpointConnection.json#/definitions/PrivateEndpointConnection" } }, "enableMultipleWriteLocations": { @@ -7036,8 +7036,7 @@ }, "customerManagedKeyStatus": { "description": "Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.", - "type": "string", - "$ref": "#/definitions/CustomerManagedKeyStatus" + "type": "string" } } }, @@ -7195,8 +7194,7 @@ }, "customerManagedKeyStatus": { "description": "Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.", - "type": "string", - "$ref": "#/definitions/CustomerManagedKeyStatus" + "type": "string" } }, "required": [ @@ -7378,8 +7376,7 @@ }, "customerManagedKeyStatus": { "description": "Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.", - "type": "string", - "$ref": "#/definitions/CustomerManagedKeyStatus" + "type": "string" } } }, @@ -8146,6 +8143,14 @@ "id": { "type": "string", "description": "Name of the Cosmos DB SQL database" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" } }, "required": [ @@ -8188,6 +8193,21 @@ "type": "integer", "format": "int64", "description": "Analytical TTL." + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + }, + "computedProperties": { + "description": "List of computed properties", + "type": "array", + "items": { + "$ref": "#/definitions/ComputedProperty" + } } }, "required": [ @@ -8371,6 +8391,20 @@ "modelAsString": true } }, + "ComputedProperty": { + "type": "object", + "description": "The definition of a computed property", + "properties": { + "name": { + "type": "string", + "description": "The name of a computed property, for example - \"cp_lowerName\"" + }, + "query": { + "type": "string", + "description": "The query that evaluates the value for computed property, for example - \"SELECT VALUE LOWER(c.name) FROM c\"" + } + } + }, "ContainerPartitionKey": { "type": "object", "description": "The configuration of the partition key to be used for partitioning data into multiple partitions", @@ -8605,6 +8639,14 @@ "id": { "type": "string", "description": "Name of the Cosmos DB MongoDB database" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" } }, "required": [ @@ -8633,6 +8675,14 @@ "analyticalStorageTtl": { "type": "integer", "description": "Analytical TTL." + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" } }, "required": [ @@ -8698,6 +8748,14 @@ "id": { "type": "string", "description": "Name of the Cosmos DB table" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" } }, "required": [ @@ -8814,6 +8872,14 @@ "id": { "type": "string", "description": "Name of the Cosmos DB Gremlin database" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" } }, "required": [ @@ -8852,6 +8918,14 @@ "type": "integer", "format": "int64", "description": "Analytical TTL." + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" } }, "required": [ @@ -9546,7 +9620,9 @@ "3.2", "3.6", "4.0", - "4.2" + "4.2", + "5.0", + "6.0" ], "description": "Describes the ServerVersion of an a MongoDB account.", "x-ms-enum": { @@ -9610,15 +9686,6 @@ "name": "RestoreMode" } }, - "restoreSource": { - "type": "string", - "description": "The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}" - }, - "restoreTimestampInUtc": { - "type": "string", - "format": "date-time", - "description": "Time to which the account has to be restored (ISO-8601 format)." - }, "databasesToRestore": { "type": "array", "description": "List of specific databases available for restore.", @@ -9640,8 +9707,45 @@ "$ref": "#/definitions/TableName" } } + }, + "allOf": [ + { + "$ref": "#/definitions/RestoreParametersBase" + } + ] + }, + "RestoreParametersBase": { + "type": "object", + "description": "Parameters to indicate the information about the restore.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "restoreSource": { + "type": "string", + "description": "The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}" + }, + "restoreTimestampInUtc": { + "type": "string", + "format": "date-time", + "description": "Time to which the account has to be restored (ISO-8601 format)." + } } }, + "ResourceRestoreParameters": { + "type": "object", + "description": "Parameters to indicate the information about the restore.", + "x-ms-mutability": [ + "read", + "create" + ], + "allOf": [ + { + "$ref": "#/definitions/RestoreParametersBase" + } + ] + }, "DatabaseRestoreResource": { "type": "object", "description": "Specific Databases to restore.", @@ -9940,27 +10044,6 @@ "name": "MinimalTlsVersion", "modelAsString": true } - }, - "CustomerManagedKeyStatus": { - "description": "Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.", - "type": "string", - "enum": [ - "Access to your account is currently revoked because the Azure Cosmos DB service is unable to obtain the AAD authentication token for the account's default identity; for more details about this error and how to restore access to your account please visit https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-active-directory-token-acquisition-error (4000).", - "Access to your account is currently revoked because the Azure Cosmos DB account's key vault key URI does not follow the expected format; for more details about this error and how to restore access to your account please visit https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#improper-syntax-detected-on-the-key-vault-uri-property (4006).", - "Access to your account is currently revoked because the current default identity no longer has permission to the associated Key Vault key; for more details about this error and how to restore access to your account please visit https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#default-identity-is-unauthorized-to-access-the-azure-key-vault-key (4002).", - "Access to your account is currently revoked because the Azure Key Vault DNS name specified by the account's keyvaultkeyuri property could not be resolved; for more details about this error and how to restore access to your account please visit https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#unable-to-resolve-the-key-vaults-dns (4009).", - "Access to your account is currently revoked because the correspondent key is not found on the specified Key Vault; for more details about this error and how to restore access to your account please visit https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4003).", - "Access to your account is currently revoked because the Azure Cosmos DB service is unable to wrap or unwrap the key; for more details about this error and how to restore access to your account please visit https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#internal-unwrapping-procedure-error (4005).", - "Access to your account is currently revoked because the Azure Cosmos DB account has an undefined default identity; for more details about this error and how to restore access to your account please visit https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#invalid-azure-cosmos-db-default-identity (4015).", - "Access to your account is currently revoked because the access rules are blocking outbound requests to the Azure Key Vault service; for more details about this error and how to restore access to your account please visit https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide (4016).", - "Access to your account is currently revoked because the correspondent Azure Key Vault was not found; for more details about this error and how to restore access to your account please visit https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found (4017).", - "Access to your account is currently revoked; for more details about this error and how to restore access to your account please visit https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide", - "Access to the configured customer managed key confirmed." - ], - "x-ms-enum": { - "name": "CustomerManagedKeyStatus", - "modelAsString": true - } } }, "parameters": { diff --git a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/managedCassandra.json b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json similarity index 97% rename from swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/managedCassandra.json rename to swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json index 550ef6a83..bd309fce6 100644 --- a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/managedCassandra.json +++ b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json @@ -3,7 +3,7 @@ "info": { "title": "Cosmos DB - Managed Cassandra", "description": "Azure Cosmos DB Database Service Managed Cassandra REST API", - "version": "2023-09-15" + "version": "2024-05-15" }, "host": "management.azure.com", "schemes": [ @@ -946,6 +946,31 @@ "provisionError": { "$ref": "#/definitions/CassandraError", "description": "Error related to resource provisioning." + }, + "azureConnectionMethod": { + "type": "string", + "description": "How to connect to the azure services needed for running the cluster", + "enum": [ + "None", + "VPN" + ], + "x-ms-enum": { + "name": "AzureConnectionType", + "modelAsString": true + } + }, + "privateLinkResourceId": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/privateLinkServices" + } + ] + }, + "description": "If the Connection Method is VPN, this is the Id of the private link resource that the datacenters need to connect to." } } } @@ -1346,6 +1371,10 @@ "provisionError": { "$ref": "#/definitions/CassandraError", "description": "Error related to resource provisioning." + }, + "privateEndpointIpAddress": { + "type": "string", + "description": "Ip of the VPN Endpoint for this data center." } } } diff --git a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/mongorbac.json b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/mongorbac.json similarity index 99% rename from swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/mongorbac.json rename to swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/mongorbac.json index 42c3e14df..b35423db3 100644 --- a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/mongorbac.json +++ b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/mongorbac.json @@ -3,7 +3,7 @@ "info": { "title": "Cosmos DB", "description": "Azure Cosmos DB API for MongoDB Role Based Access Control Resource Provider REST API", - "version": "2023-09-15" + "version": "2024-05-15" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/notebook.json b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/notebook.json similarity index 96% rename from swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/notebook.json rename to swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/notebook.json index 9d811b4cd..2487db9f0 100644 --- a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/notebook.json +++ b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/notebook.json @@ -3,7 +3,7 @@ "info": { "title": "Cosmos DB", "description": "Azure Cosmos DB Database Service Resource Provider REST API", - "version": "2023-09-15" + "version": "2024-05-15" }, "host": "management.azure.com", "schemes": [ @@ -68,7 +68,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ErrorResponse" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ErrorResponse" } } }, @@ -113,7 +113,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ErrorResponse" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ErrorResponse" } } }, @@ -166,7 +166,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ErrorResponse" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ErrorResponse" } } }, @@ -210,7 +210,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ErrorResponse" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ErrorResponse" } } }, @@ -260,7 +260,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ErrorResponse" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ErrorResponse" } } } @@ -306,7 +306,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ErrorResponse" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ErrorResponse" } } } @@ -352,7 +352,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ErrorResponse" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ErrorResponse" } } } @@ -365,7 +365,7 @@ "type": "object", "allOf": [ { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ARMProxyResource" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ARMProxyResource" } ] }, @@ -394,7 +394,7 @@ }, "allOf": [ { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ARMProxyResource" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ARMProxyResource" } ] }, diff --git a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/privateEndpointConnection.json b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/privateEndpointConnection.json similarity index 98% rename from swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/privateEndpointConnection.json rename to swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/privateEndpointConnection.json index 7714b44c1..69de44a30 100644 --- a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/privateEndpointConnection.json +++ b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/privateEndpointConnection.json @@ -3,7 +3,7 @@ "info": { "title": "Cosmos DB", "description": "Azure Cosmos DB Database Service Resource Provider REST API", - "version": "2023-09-15" + "version": "2024-05-15" }, "host": "management.azure.com", "schemes": [ @@ -155,7 +155,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ErrorResponse" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ErrorResponse" } } }, @@ -199,7 +199,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ErrorResponse" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ErrorResponse" } } }, diff --git a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/privateLinkResources.json b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/privateLinkResources.json similarity index 98% rename from swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/privateLinkResources.json rename to swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/privateLinkResources.json index 28b4969ad..56f776348 100644 --- a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/privateLinkResources.json +++ b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/privateLinkResources.json @@ -3,7 +3,7 @@ "info": { "title": "Cosmos DB", "description": "Azure Cosmos DB Database Service Resource Provider REST API", - "version": "2023-09-15" + "version": "2024-05-15" }, "host": "management.azure.com", "schemes": [ @@ -139,7 +139,7 @@ }, "allOf": [ { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ARMProxyResource" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ARMProxyResource" } ] }, diff --git a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/rbac.json b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/rbac.json similarity index 99% rename from swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/rbac.json rename to swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/rbac.json index 70f99fe5e..66fe0b0cb 100644 --- a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/rbac.json +++ b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/rbac.json @@ -3,7 +3,7 @@ "info": { "title": "Cosmos DB", "description": "Azure Cosmos DB Role Based Access Control Resource Provider REST API", - "version": "2023-09-15" + "version": "2024-05-15" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/restorable.json b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/restorable.json similarity index 95% rename from swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/restorable.json rename to swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/restorable.json index e187bca51..ddbc30d1b 100644 --- a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/restorable.json +++ b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/restorable.json @@ -3,7 +3,7 @@ "info": { "title": "Cosmos DB", "description": "Azure Cosmos DB Database Service Resource Provider REST API", - "version": "2023-09-15" + "version": "2024-05-15" }, "host": "management.azure.com", "schemes": [ @@ -1099,6 +1099,16 @@ "description": "The operation type of this database event.", "$ref": "#/definitions/OperationType" }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this database to identify if this database is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this database can not be restored in same account." + }, "eventTimestamp": { "type": "string", "readOnly": true, @@ -1136,10 +1146,10 @@ }, "allOf": [ { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/SqlDatabaseResource" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/SqlDatabaseResource" }, { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ExtendedResourceProperties" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ExtendedResourceProperties" } ] } @@ -1207,6 +1217,16 @@ "description": "The operation type of this container event.", "$ref": "#/definitions/OperationType" }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this container to identify if this container is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this container can not be restored in same account." + }, "eventTimestamp": { "type": "string", "readOnly": true, @@ -1234,10 +1254,10 @@ }, "allOf": [ { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/SqlContainerResource" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/SqlContainerResource" }, { - "$ref": "../../stable/2023-09-15/cosmos-db.json#/definitions/ExtendedResourceProperties" + "$ref": "../../stable/2024-05-15/cosmos-db.json#/definitions/ExtendedResourceProperties" } ] } @@ -1351,6 +1371,16 @@ "description": "The operation type of this database event.", "$ref": "#/definitions/OperationType" }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this database to identify if this database is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this database can not be restored in same account." + }, "eventTimestamp": { "type": "string", "readOnly": true, @@ -1430,6 +1460,16 @@ "description": "The operation type of this collection event.", "$ref": "#/definitions/OperationType" }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this collection to identify if this container is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this collection can not be restored in same account." + }, "eventTimestamp": { "type": "string", "readOnly": true, @@ -1555,6 +1595,16 @@ "description": "The operation type of this database event.", "$ref": "#/definitions/OperationType" }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this database to identify if this database is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this database can not be restored in same account." + }, "eventTimestamp": { "type": "string", "readOnly": true, @@ -1634,6 +1684,16 @@ "description": "The operation type of this graph event.", "$ref": "#/definitions/OperationType" }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this graph to identify if this graph is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this graph can not be restored in same account." + }, "eventTimestamp": { "type": "string", "readOnly": true, @@ -1760,6 +1820,16 @@ "description": "The operation type of this table event.", "$ref": "#/definitions/OperationType" }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this table to identify if this table is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this table can not be restored in same account." + }, "eventTimestamp": { "type": "string", "readOnly": true, @@ -1822,6 +1892,7 @@ "Create", "Replace", "Delete", + "Recreate", "SystemOperation" ], "x-ms-enum": { diff --git a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/services.json b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/services.json similarity index 88% rename from swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/services.json rename to swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/services.json index 6eb278e60..aa3eb7054 100644 --- a/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-09-15/services.json +++ b/swagger-specs/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/services.json @@ -3,7 +3,7 @@ "info": { "title": "Cosmos DB", "description": "Azure Cosmos DB Database Service Resource Provider REST API", - "version": "2023-09-15" + "version": "2024-05-15" }, "host": "management.azure.com", "schemes": [ @@ -89,7 +89,7 @@ "$ref": "./examples/CosmosDBDataTransferServiceCreate.json" }, "SqlDedicatedGatewayServiceCreate": { - "$ref": "./examples/CosmosDBSqlDedicatedGatewayServiceCreate.json" + "$ref": "./examples/services/sqldedicatedgateway/CosmosDBSqlDedicatedGatewayServiceCreate.json" }, "GraphAPIComputeServiceCreate": { "$ref": "./examples/CosmosDBGraphAPIComputeServiceCreate.json" @@ -170,7 +170,7 @@ "$ref": "./examples/CosmosDBGraphAPIComputeServiceGet.json" }, "SqlDedicatedGatewayServiceGet": { - "$ref": "./examples/CosmosDBSqlDedicatedGatewayServiceGet.json" + "$ref": "./examples/services/sqldedicatedgateway/CosmosDBSqlDedicatedGatewayServiceGet.json" }, "MaterializedViewsBuilderServiceGet": { "$ref": "./examples/CosmosDBMaterializedViewsBuilderServiceGet.json" @@ -222,7 +222,7 @@ "$ref": "./examples/CosmosDBDataTransferServiceDelete.json" }, "SqlDedicatedGatewayServiceDelete": { - "$ref": "./examples/CosmosDBSqlDedicatedGatewayServiceDelete.json" + "$ref": "./examples/services/sqldedicatedgateway/CosmosDBSqlDedicatedGatewayServiceDelete.json" }, "GraphAPIComputeServiceDelete": { "$ref": "./examples/CosmosDBGraphAPIComputeServiceDelete.json" @@ -316,7 +316,7 @@ ] }, "ServiceResourceCreateUpdateParameters": { - "description": "Parameters for Create or Update Request for ServiceResource", + "description": "Parameters for Create or Update request for ServiceResource", "type": "object", "properties": { "properties": { @@ -328,6 +328,7 @@ "ServiceResourceCreateUpdateProperties": { "description": "Properties in ServiceResourceCreateUpdateParameters.", "type": "object", + "discriminator": "serviceType", "properties": { "instanceSize": { "$ref": "#/definitions/ServiceResourceInstanceSize" @@ -341,7 +342,10 @@ "serviceType": { "$ref": "#/definitions/ServiceType" } - } + }, + "required": [ + "serviceType" + ] }, "ServiceResource": { "description": "Properties for the database account.", @@ -402,6 +406,43 @@ } } }, + "DataTransferServiceResourceCreateUpdateParameters": { + "description": "Parameters for Create or Update request for DataTransferServiceResource", + "type": "object", + "x-ms-discriminator-value": "DataTransfer", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceCreateUpdateProperties" + } + ] + }, + "SqlDedicatedGatewayServiceResourceCreateUpdateParameters": { + "description": "Parameters for Create or Update request for SqlDedicatedGatewayServiceResource", + "type": "object", + "x-ms-discriminator-value": "SqlDedicatedGateway", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceCreateUpdateProperties" + } + ], + "properties": { + "dedicatedGatewayType": { + "$ref": "#/definitions/SqlDedicatedGatewayType" + } + } + }, + "SqlDedicatedGatewayType": { + "type": "string", + "enum": [ + "IntegratedCache", + "DistributedQuery" + ], + "description": "DedicatedGatewayType for the service.", + "x-ms-enum": { + "modelAsString": true, + "name": "DedicatedGatewayType" + } + }, "SqlDedicatedGatewayServiceResource": { "description": "Describes the service response property for SqlDedicatedGateway.", "type": "object", @@ -426,6 +467,9 @@ "type": "string", "description": "SqlDedicatedGateway endpoint for the service." }, + "dedicatedGatewayType": { + "$ref": "#/definitions/SqlDedicatedGatewayType" + }, "locations": { "type": "array", "readOnly": true, @@ -470,6 +514,16 @@ } } }, + "GraphAPIComputeServiceResourceCreateUpdateParameters": { + "description": "Parameters for Create or Update request for GraphAPIComputeServiceResource", + "type": "object", + "x-ms-discriminator-value": "GraphAPICompute", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceCreateUpdateProperties" + } + ] + }, "MaterializedViewsBuilderServiceResource": { "description": "Describes the service response property for MaterializedViewsBuilder.", "type": "object", @@ -500,6 +554,16 @@ } } }, + "MaterializedViewsBuilderServiceResourceCreateUpdateParameters": { + "description": "Parameters for Create or Update request for MaterializedViewsBuilderServiceResource", + "type": "object", + "x-ms-discriminator-value": "MaterializedViewsBuilder", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceCreateUpdateProperties" + } + ] + }, "RegionalServiceResource": { "description": "Resource for a regional service location.", "type": "object", diff --git a/swagger-specs/cosmos-db/resource-manager/api-set.json b/swagger-specs/cosmos-db/resource-manager/api-set.json index 10ec0f4d8..ff1816f51 100644 --- a/swagger-specs/cosmos-db/resource-manager/api-set.json +++ b/swagger-specs/cosmos-db/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.DocumentDB/stable/2023-09-15/cosmos-db.json", "Microsoft.DocumentDB/stable/2023-09-15/managedCassandra.json", "Microsoft.DocumentDB/stable/2023-09-15/mongorbac.json", "Microsoft.DocumentDB/stable/2023-09-15/notebook.json", "Microsoft.DocumentDB/stable/2023-09-15/privateEndpointConnection.json", "Microsoft.DocumentDB/stable/2023-09-15/privateLinkResources.json", "Microsoft.DocumentDB/stable/2023-09-15/rbac.json", "Microsoft.DocumentDB/stable/2023-09-15/restorable.json", "Microsoft.DocumentDB/stable/2023-09-15/services.json"], "name": "package-2023-09"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json", "Microsoft.DocumentDB/stable/2024-05-15/managedCassandra.json", "Microsoft.DocumentDB/stable/2024-05-15/mongorbac.json", "Microsoft.DocumentDB/stable/2024-05-15/notebook.json", "Microsoft.DocumentDB/stable/2024-05-15/privateEndpointConnection.json", "Microsoft.DocumentDB/stable/2024-05-15/privateLinkResources.json", "Microsoft.DocumentDB/stable/2024-05-15/rbac.json", "Microsoft.DocumentDB/stable/2024-05-15/restorable.json", "Microsoft.DocumentDB/stable/2024-05-15/services.json"], "name": "package-2024-05"} \ No newline at end of file diff --git a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.pricesheets.json b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.pricesheets.json deleted file mode 100644 index 45c0adc3f..000000000 --- a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.pricesheets.json +++ /dev/null @@ -1,189 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-08-01", - "title": "CostManagementClient" - }, - "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.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/providers/Microsoft.CostManagement/pricesheets/default/download": { - "post": { - "tags": [ - "PriceSheets" - ], - "x-ms-examples": { - "PricesheetDownload": { - "$ref": "./examples/PricesheetDownload.json" - } - }, - "operationId": "PriceSheet_Download", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "description": "Gets a URL to download the pricesheet for an invoice. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingProfileNameParameter" - }, - { - "$ref": "#/parameters/invoiceNameParameter" - } - ], - "responses": { - "202": { - "description": "Accepted.", - "headers": { - "Location": { - "description": "GET this URL to retrieve the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "type": "string" - }, - "OData-EntityId": { - "description": "The operation entity Id GUID.", - "type": "string" - } - } - }, - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "common-types.json#/definitions/DownloadURL" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.CostManagement/pricesheets/default/download": { - "post": { - "tags": [ - "PriceSheets" - ], - "x-ms-examples": { - "PricesheetDownloadByBillingProfile": { - "$ref": "./examples/PricesheetDownloadByBillingProfile.json" - } - }, - "operationId": "PriceSheet_DownloadByBillingProfile", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "description": "Gets a URL to download the current month's pricesheet for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.Due to Azure product growth, the Azure price sheet download experience in this preview version will be updated from a single csv file to a Zip file containing multiple csv files, each with max 200k records.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingProfileNameParameter" - } - ], - "responses": { - "202": { - "description": "Accepted.", - "headers": { - "Location": { - "description": "GET this URL to retrieve the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "type": "string" - }, - "OData-EntityId": { - "description": "The operation entity Id GUID.", - "type": "string" - } - } - }, - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "common-types.json#/definitions/DownloadURL" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "parameters": { - "billingAccountNameParameter": { - "name": "billingAccountName", - "in": "path", - "description": "The ID that uniquely identifies a billing account.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "pattern": "([A-Za-z0-9]+(-[A-Za-z0-9]+)+):([A-Za-z0-9]+(-[A-Za-z0-9]+)+)_[0-9]{4}-[0-9]{2}-[0-9]{2}" - }, - "billingProfileNameParameter": { - "name": "billingProfileName", - "in": "path", - "description": "The ID that uniquely identifies a billing profile.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "pattern": "([A-Za-z0-9]+(-[A-Za-z0-9]+)+)" - }, - "invoiceNameParameter": { - "name": "invoiceName", - "in": "path", - "description": "The ID that uniquely identifies an invoice.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "pattern": "[A-Za-z0-9]+" - } - } -} diff --git a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/common-types.json b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/common-types.json similarity index 99% rename from swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/common-types.json rename to swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/common-types.json index 79848e021..9d58cab6a 100644 --- a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/common-types.json +++ b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/common-types.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-08-01", + "version": "2023-11-01", "title": "CostManagementClient" }, "host": "management.azure.com", diff --git a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costallocation.json b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costallocation.json similarity index 99% rename from swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costallocation.json rename to swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costallocation.json index c084136c2..b2b0d060c 100644 --- a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costallocation.json +++ b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costallocation.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "CostManagementClient", - "version": "2023-08-01" + "version": "2023-11-01" }, "tags": [ { diff --git a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.benefits.json b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.benefits.json similarity index 99% rename from swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.benefits.json rename to swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.benefits.json index 4d8985275..1a52ebc99 100644 --- a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.benefits.json +++ b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.benefits.json @@ -3,7 +3,7 @@ "info": { "title": "CostManagementClient", "description": "CostManagement management client provides access to CostManagement resources for Azure Enterprise Subscriptions.", - "version": "2023-08-01" + "version": "2023-11-01" }, "tags": [ { @@ -1250,19 +1250,19 @@ ], "properties": { "avgUtilizationPercentage": { - "description": "This is the average hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-08-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the avgUtilizationPercentage value will be equal to the average of the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day.", + "description": "This is the average hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-11-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the avgUtilizationPercentage value will be equal to the average of the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day.", "type": "number", "format": "decimal", "readOnly": true }, "minUtilizationPercentage": { - "description": "This is the minimum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-08-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the minUtilizationPercentage value will be equal to the smallest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the lowest utilization percentage was 10% at hour 4, then the value for the minUtilizationPercentage in the response will be 10%.", + "description": "This is the minimum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-11-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the minUtilizationPercentage value will be equal to the smallest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the lowest utilization percentage was 10% at hour 4, then the value for the minUtilizationPercentage in the response will be 10%.", "type": "number", "format": "decimal", "readOnly": true }, "maxUtilizationPercentage": { - "description": "This is the maximum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-08-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the maxUtilizationPercentage value will be equal to the largest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the largest utilization percentage was 90% at hour 5, then the value for the maxUtilizationPercentage in the response will be 90%.", + "description": "This is the maximum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-11-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the maxUtilizationPercentage value will be equal to the largest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the largest utilization percentage was 90% at hour 5, then the value for the maxUtilizationPercentage in the response will be 90%.", "type": "number", "format": "decimal", "readOnly": true diff --git a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.budgets.json b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.budgets.json similarity index 99% rename from swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.budgets.json rename to swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.budgets.json index 05f7e07ed..c59d02085 100644 --- a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.budgets.json +++ b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.budgets.json @@ -3,7 +3,7 @@ "info": { "title": "CostManagementClient", "description": "CostManagement management client provides access to CostManagement resources for Azure Enterprise Subscriptions.", - "version": "2023-08-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.exports.json similarity index 99% rename from swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json rename to swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.exports.json index 147da1bba..d3bb5107f 100644 --- a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json +++ b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.exports.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-08-01", + "version": "2023-11-01", "title": "CostManagementClient" }, "host": "management.azure.com", diff --git a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.generatecostdetailsreport.json b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatecostdetailsreport.json similarity index 99% rename from swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.generatecostdetailsreport.json rename to swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatecostdetailsreport.json index 3f9d6b334..df9293ff8 100644 --- a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.generatecostdetailsreport.json +++ b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatecostdetailsreport.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-08-01", + "version": "2023-11-01", "title": "CostManagementClient" }, "host": "management.azure.com", diff --git a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.generatedetailedcostreport.json b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatedetailedcostreport.json similarity index 99% rename from swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.generatedetailedcostreport.json rename to swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatedetailedcostreport.json index dcf15b581..c38b4e42d 100644 --- a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.generatedetailedcostreport.json +++ b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatedetailedcostreport.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-08-01", + "version": "2023-11-01", "title": "CostManagementClient" }, "host": "management.azure.com", diff --git a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.json b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.json similarity index 99% rename from swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.json rename to swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.json index dc6739eb0..9346d070e 100644 --- a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/costmanagement.json +++ b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-08-01", + "version": "2023-11-01", "title": "CostManagementClient" }, "host": "management.azure.com", diff --git a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.pricesheets.json b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.pricesheets.json new file mode 100644 index 000000000..d549402e6 --- /dev/null +++ b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.pricesheets.json @@ -0,0 +1,577 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01", + "title": "CostManagementClient" + }, + "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.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/providers/Microsoft.CostManagement/pricesheets/default/download": { + "post": { + "tags": [ + "PriceSheets" + ], + "x-ms-examples": { + "PricesheetDownload": { + "$ref": "./examples/PricesheetDownload.json" + } + }, + "operationId": "PriceSheet_DownloadByInvoice", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Gets a URL to download the pricesheet for an invoice. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + }, + "OData-EntityId": { + "description": "The operation entity Id GUID.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "common-types.json#/definitions/DownloadURL" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.CostManagement/pricesheets/default/download": { + "post": { + "tags": [ + "PriceSheets" + ], + "x-ms-examples": { + "PricesheetDownloadByBillingProfile": { + "$ref": "./examples/PricesheetDownloadByBillingProfile.json" + } + }, + "operationId": "PriceSheet_DownloadByBillingProfile", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Gets a URL to download the current month's pricesheet for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.\n \n You can use the new 2023-09-01 API version for billing periods January 2023 onwards. Azure Reserved Instance (RI) pricing is only available through the new version of the API. \n \n Due to Azure product growth, the Azure price sheet download experience in this preview version will be updated from a single csv/json file to a Zip file containing multiple csv/json files, each with max size of 75MB.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + }, + "OData-EntityId": { + "description": "The operation entity Id GUID.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PricesheetDownloadProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download": { + "post": { + "tags": [ + "PriceSheets" + ], + "x-ms-examples": { + "EAPriceSheetForBillingPeriod": { + "$ref": "./examples/EAPriceSheetForBillingPeriod.json" + } + }, + "operationId": "PriceSheet_DownloadByBillingAccount", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Generates the pricesheet for the provided billing period asynchronously based on the Enrollment ID. This is for Enterprise Agreement customers. \n You can use the new 2023-09-01 API version at '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download' for billing periods January 2023 onwards. With a new schema detailed below, the new price sheet provides more information and includes prices for Azure Reserved Instances (RI) for the current billing period.\n \n We recommend downloading an Azure Price Sheet for when entering a new billing period if you would maintain a record of past Azure Reserved Instance (RI) pricing. Due to Azure product growth, the Azure price sheet download experience in this preview version will be updated from a single .csv file to a zip file containing multiple csv files, each with max size of 75MB.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "OperationStatus": { + "description": "The status of the long running operation.", + "type": "object", + "properties": { + "status": { + "description": "The status of the long running operation.", + "type": "string", + "enum": [ + "Running", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "OperationStatusType", + "modelAsString": true + } + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the resource generated.", + "$ref": "#/definitions/EAPricesheetDownloadProperties" + } + } + }, + "EAPricesheetDownloadProperties": { + "description": "The properties of the price sheet download.", + "type": "object", + "properties": { + "downloadUrl": { + "description": "The link (url) to download the pricesheet.", + "type": "string", + "readOnly": true + }, + "validTill": { + "description": "Download link validity.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "downloadFileProperties": { + "description": "The properties in downloaded file", + "type": "object", + "$ref": "#/definitions/EAPriceSheetProperties" + } + } + }, + "PricesheetDownloadProperties": { + "description": "The URL to download the generated report.", + "type": "object", + "properties": { + "expiryTime": { + "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "downloadUrl": { + "description": "The URL to download the generated report.", + "type": "string" + }, + "downloadFileProperties": { + "description": "The properties in downloaded file", + "type": "object", + "$ref": "#/definitions/MCAPriceSheetProperties" + } + } + }, + "MCAPriceSheetProperties": { + "description": "The properties of the price sheet.", + "type": "object", + "properties": { + "billingAccountID": { + "description": "Unique identifier for the billing account.", + "type": "string", + "readOnly": true + }, + "billingAccountName": { + "description": "Name of the billing profile that is set up to receive invoices. The prices in the price sheet are associated with this billing profile.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "Unique identifier for the billing profile.", + "type": "string", + "readOnly": true + }, + "billingProfileName": { + "description": "Name of the billing profile that is set up to receive invoices. The prices in the price sheet are associated with this billing profile.", + "type": "string", + "readOnly": true + }, + "serviceFamily": { + "description": "Type of Azure service. For example, Compute, Analytics, and Security.", + "type": "number", + "readOnly": true + }, + "product": { + "description": "Name of the product accruing the charges.", + "type": "string", + "readOnly": true + }, + "productId": { + "description": "Unique identifier for the product whose meter is consumed.", + "type": "string", + "readOnly": true + }, + "skuId": { + "description": "Unique identifier of the SKU", + "type": "string", + "readOnly": true + }, + "unitOfMeasure": { + "description": "How usage is measured for the service", + "type": "string", + "readOnly": true + }, + "meterName": { + "description": "Name of the meter. The meter represents the deployable resource of an Azure service.", + "type": "string", + "readOnly": true + }, + "meterType": { + "description": "Name of the meter type", + "type": "string", + "readOnly": true + }, + "meterCategory": { + "description": "Name of the classification category for the meter. For example, Cloud services, Networking, etc. ", + "type": "string", + "readOnly": true + }, + "meterSubCategory": { + "description": "Name of the meter subclassification category.", + "type": "string", + "readOnly": true + }, + "meterRegion": { + "description": "Name of the Azure region where the meter for the service is available.", + "type": "string", + "readOnly": true + }, + "tierMinimumUnits": { + "description": "Defines the lower bound of the tier range for which prices are defined. For example, if the range is 0 to 100, tierMinimumUnits would be 0.", + "type": "string", + "readOnly": true + }, + "effectiveStartDate": { + "description": "Effective start date of the Price Sheet billing period", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "effectiveEndDate": { + "description": "Effective end date of the Price Sheet billing period", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "unitPrice": { + "description": "The per-unit price at the time of billing for a given product or service, inclusive of any negotiated discounts on top of the market price.\n\n For PriceType ReservedInstance, unit price reflects the total cost of the 1 or 3-year commitment including discounts.\n\n Note: The unit price isn't the same as the effective price in usage details downloads when services have differential prices across tiers.\n\n If services have multi-tiered pricing, the effective price is a blended rate across the tiers and doesn't show a tier-specific unit price. The blended price or effective price is the net price for the consumed quantity spanning across the multiple tiers (where each tier has a specific unit price).", + "type": "string", + "readOnly": true + }, + "basePrice": { + "description": "The unit price at the time the customer signs on or the unit price at the time of service meter GA launch if it is after sign-on.\n\n This is applicable for Enterprise Agreement users", + "type": "string", + "readOnly": true + }, + "marketPrice": { + "description": "The current list price for a given product or service. This price is without any negotiations and is based on your Microsoft Agreement type.\n\n For PriceType Consumption, market price is reflected as the pay-as-you-go price.\n\n For PriceType Savings Plan, market price reflects the Savings plan benefit on top of pay-as-you-go price for the corresponding commitment term.\n\n For PriceType ReservedInstance, market price reflects the total price of the 1 or 3-year commitment.", + "type": "string", + "readOnly": true + }, + "currency": { + "description": "Currency in which all the prices are reflected.", + "type": "string", + "readOnly": true + }, + "billingCurrency": { + "description": "Currency in which charges are posted.", + "type": "string", + "readOnly": true + }, + "term": { + "description": "Term length for Azure Savings Plan or Reservation term – one year or three years (P1Y or P3Y)", + "type": "string", + "readOnly": true + }, + "priceType": { + "description": "Price type for a product. For example, an Azure resource with a pay-as-you-go rate with priceType as Consumption. Other price types include ReservedInstance and Savings Plan.", + "type": "string", + "readOnly": true + } + } + }, + "EAPriceSheetProperties": { + "description": "The properties of the EA price sheet.", + "type": "object", + "properties": { + "enrollmentNumber": { + "description": "Unique identifier for the EA billing account.", + "type": "string", + "readOnly": true + }, + "serviceFamily": { + "description": "Type of Azure service. For example, Compute, Analytics, and Security.", + "type": "number", + "readOnly": true + }, + "product": { + "description": "Name of the product accruing the charges.", + "type": "string", + "readOnly": true + }, + "productId": { + "description": "Unique identifier for the product whose meter is consumed.", + "type": "string", + "readOnly": true + }, + "skuId": { + "description": "Unique identifier of the SKU", + "type": "string", + "readOnly": true + }, + "unitOfMeasure": { + "description": "How usage is measured for the service", + "type": "string", + "readOnly": true + }, + "meterId": { + "description": "Unique identifier of the meter ", + "type": "string", + "readOnly": true + }, + "meterName": { + "description": "Name of the meter. The meter represents the deployable resource of an Azure service.", + "type": "string", + "readOnly": true + }, + "meterType": { + "description": "Name of the meter type", + "type": "string", + "readOnly": true + }, + "meterCategory": { + "description": "Name of the classification category for the meter. For example, Cloud services, Networking, etc. ", + "type": "string", + "readOnly": true + }, + "meterSubCategory": { + "description": "Name of the meter subclassification category.", + "type": "string", + "readOnly": true + }, + "meterRegion": { + "description": "Name of the Azure region where the meter for the service is available.", + "type": "string", + "readOnly": true + }, + "effectiveStartDate": { + "description": "Effective start date of the Price Sheet billing period", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "effectiveEndDate": { + "description": "Effective end date of the Price Sheet billing period", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "unitPrice": { + "description": "The per-unit price at the time of billing for a given product or service, inclusive of any negotiated discounts on top of the market price.\n\n For PriceType ReservedInstance, unit price reflects the total cost of the 1 or 3-year commitment including discounts.\n\n Note: The unit price isn't the same as the effective price in usage details downloads when services have differential prices across tiers.\n\n If services have multi-tiered pricing, the effective price is a blended rate across the tiers and doesn't show a tier-specific unit price. The blended price or effective price is the net price for the consumed quantity spanning across the multiple tiers (where each tier has a specific unit price).", + "type": "string", + "readOnly": true + }, + "basePrice": { + "description": "The unit price at the time the customer signs on or the unit price at the time of service meter GA launch if it is after sign-on.\n\n This is applicable for Enterprise Agreement users", + "type": "string", + "readOnly": true + }, + "marketPrice": { + "description": "The current list price for a given product or service. This price is without any negotiations and is based on your Microsoft Agreement type.\n\n For PriceType Consumption, market price is reflected as the pay-as-you-go price.\n\n For PriceType Savings Plan, market price reflects the Savings plan benefit on top of pay-as-you-go price for the corresponding commitment term.\n\n For PriceType ReservedInstance, market price reflects the total price of the 1 or 3-year commitment.\n\n Note: For EA customers with no negotiations, market price may appear rounded to a different decimal precision than unit price.", + "type": "string", + "readOnly": true + }, + "includedQuantity": { + "description": "Quantities of a specific service to which an EA customer is entitled to consume without incremental charges.", + "type": "string", + "readOnly": true + }, + "currencyCode": { + "description": "Currency in which the Enterprise Agreement was signed", + "type": "string", + "readOnly": true + }, + "term": { + "description": "Term length for Azure Savings Plan or Reservation term – one year or three years (P1Y or P3Y)", + "type": "string", + "readOnly": true + }, + "priceType": { + "description": "Price type for a product. For example, an Azure resource with a pay-as-you-go rate with priceType as Consumption. Other price types include ReservedInstance and Savings Plan.", + "type": "string", + "readOnly": true + }, + "partNumber": { + "description": "Part number associated with the meter", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "billingAccountNameParameter": { + "name": "billingAccountName", + "in": "path", + "description": "The ID that uniquely identifies a billing account.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "([A-Za-z0-9]+(-[A-Za-z0-9]+)+):([A-Za-z0-9]+(-[A-Za-z0-9]+)+)_[0-9]{4}-[0-9]{2}-[0-9]{2}" + }, + "billingProfileNameParameter": { + "name": "billingProfileName", + "in": "path", + "description": "The ID that uniquely identifies a billing profile.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "([A-Za-z0-9]+(-[A-Za-z0-9]+)+)" + }, + "invoiceNameParameter": { + "name": "invoiceName", + "in": "path", + "description": "The ID that uniquely identifies an invoice.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "[A-Za-z0-9]+" + }, + "billingAccountIdParameter": { + "name": "billingAccountId", + "in": "path", + "description": "BillingAccount ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingPeriodNameParameter": { + "name": "billingPeriodName", + "in": "path", + "description": "Billing Period Name.", + "required": true, + "type": "string", + "pattern": "^[0-9]*$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/scheduledActions.json b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/scheduledActions.json similarity index 99% rename from swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/scheduledActions.json rename to swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/scheduledActions.json index 6d21a0a00..1ba0c3120 100644 --- a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/scheduledActions.json +++ b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/scheduledActions.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "CostManagementClient", - "version": "2023-08-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/settings.json b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/settings.json similarity index 91% rename from swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/settings.json rename to swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/settings.json index b6606621b..140a969dd 100644 --- a/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-08-01/settings.json +++ b/swagger-specs/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/settings.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "CostManagementClient", - "version": "2023-08-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ @@ -275,7 +275,7 @@ ], "properties": { "preferContainerTags": { - "description": "When resource has the same tag as subscription or resource group and this property is set to true - the subscription or resource group tag will be applied. If subscription and resource group tags are also the same, subscription tag will be applied.", + "description": "This property defines the behavior when an inherited tag being applied matches a lower scope tag (Eg. Subscription tag matches the resource tag). If set to true - when tags match, the highest scope tags will be applied. Billing profile is the highest scope, followed by invoice sections, subscriptions and resource groups (allows overriding of lower scope tag values). If set to false - when tags match, the lowest scope tags will be applied. So, if a resource has the same tag as a subscription tag, the resource tag will be applied (does not allow overriding of lower scope tag values).", "type": "boolean" } } @@ -306,7 +306,7 @@ "values": [ { "value": "taginheritance", - "description": "This setting applies, all the resource group and subscription tags to usage data of child resources. Inherited tags will be seen within 24 hours for the current month's usage data.", + "description": "This setting applies billing profile, invoice section, subscription and resource group tags to current month's usage data of child resources.", "name": "taginheritance" } ] diff --git a/swagger-specs/cost-management/resource-manager/api-set.json b/swagger-specs/cost-management/resource-manager/api-set.json index f4823d4e1..e77b12ac1 100644 --- a/swagger-specs/cost-management/resource-manager/api-set.json +++ b/swagger-specs/cost-management/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.CostManagement/stable/2023-08-01/common-types.json", "Microsoft.CostManagement/stable/2023-08-01/costmanagement.benefits.json", "Microsoft.CostManagement/stable/2023-08-01/costmanagement.budgets.json", "Microsoft.CostManagement/stable/2023-08-01/costmanagement.exports.json", "Microsoft.CostManagement/stable/2023-08-01/costmanagement.generatecostdetailsreport.json", "Microsoft.CostManagement/stable/2023-08-01/costmanagement.generatedetailedcostreport.json", "Microsoft.CostManagement/stable/2023-08-01/costmanagement.json", "Microsoft.CostManagement/stable/2023-08-01/costmanagement.pricesheets.json", "Microsoft.CostManagement/stable/2023-08-01/scheduledActions.json", "Microsoft.CostManagement/stable/2023-08-01/costallocation.json", "Microsoft.CostManagement/stable/2023-08-01/settings.json"], "name": "package-2023-08"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.CostManagement/stable/2023-11-01/common-types.json", "Microsoft.CostManagement/stable/2023-11-01/costallocation.json", "Microsoft.CostManagement/stable/2023-11-01/costmanagement.benefits.json", "Microsoft.CostManagement/stable/2023-11-01/costmanagement.budgets.json", "Microsoft.CostManagement/stable/2023-11-01/costmanagement.exports.json", "Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatecostdetailsreport.json", "Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatedetailedcostreport.json", "Microsoft.CostManagement/stable/2023-11-01/costmanagement.json", "Microsoft.CostManagement/stable/2023-11-01/costmanagement.pricesheets.json", "Microsoft.CostManagement/stable/2023-11-01/scheduledActions.json", "Microsoft.CostManagement/stable/2023-11-01/settings.json"], "name": "package-2023-11"} \ No newline at end of file diff --git a/swagger-specs/databox/resource-manager/Microsoft.DataBox/stable/2023-03-01/databox.json b/swagger-specs/databox/resource-manager/Microsoft.DataBox/preview/2024-03-01-preview/databox.json similarity index 97% rename from swagger-specs/databox/resource-manager/Microsoft.DataBox/stable/2023-03-01/databox.json rename to swagger-specs/databox/resource-manager/Microsoft.DataBox/preview/2024-03-01-preview/databox.json index b1a5204fb..b3d92a56f 100644 --- a/swagger-specs/databox/resource-manager/Microsoft.DataBox/stable/2023-03-01/databox.json +++ b/swagger-specs/databox/resource-manager/Microsoft.DataBox/preview/2024-03-01-preview/databox.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-03-01", + "version": "2024-03-01-preview", "title": "DataBoxManagementClient" }, "host": "management.azure.com", @@ -2179,6 +2179,11 @@ } ] } + }, + "model": { + "$ref": "#/definitions/modelName", + "description": "Error, if any, in the stage", + "readOnly": true } }, "x-ms-discriminator-value": "ValidateCreateOrderLimit" @@ -2489,6 +2494,11 @@ } ] } + }, + "model": { + "$ref": "#/definitions/modelName", + "description": "The model name.", + "readOnly": true } } }, @@ -3442,6 +3452,11 @@ } ] } + }, + "model": { + "$ref": "#/definitions/modelName", + "description": "The model name.", + "readOnly": true } }, "x-ms-discriminator-value": "ValidateDataTransferDetails" @@ -3518,6 +3533,93 @@ } } }, + "DeviceCapabilityDetails": { + "description": "Device capability details for a given sku for a given region.", + "type": "object", + "properties": { + "hardwareEncryption": { + "description": "Hardware encryption support for a given sku for a given region.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HardwareEncryption", + "modelAsExtensible": true, + "values": [ + { + "value": "Enabled", + "description": "Hardware-based encryption is enabled." + }, + { + "value": "Disabled", + "description": "Hardware-based encryption is disabled." + } + ] + } + } + } + }, + "DeviceCapabilityRequest": { + "description": "Request body to get the device capabilities for given sku.", + "type": "object", + "properties": { + "skuName": { + "description": "Type of the device.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk." + } + ] + } + }, + "model": { + "$ref": "#/definitions/modelName", + "description": "The model name.", + "readOnly": true + } + } + }, + "DeviceCapabilityResponse": { + "description": "Device capabilities for given sku in a region", + "type": "object", + "properties": { + "deviceCapabilityDetails": { + "description": "List of device capabilities available for a given region and a given sku", + "type": "array", + "items": { + "$ref": "#/definitions/DeviceCapabilityDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, "DiskScheduleAvailabilityRequest": { "description": "Request body to get the availability for scheduling disk orders.", "required": [ @@ -4069,7 +4171,16 @@ "PAR22", "BN7", "SN6", - "BJS20" + "BJS20", + "BL24", + "IDC5", + "TYO23", + "NTG20", + "DXB23", + "DSM11", + "AMS25", + "CPQ21", + "OSA23" ], "type": "string", "readOnly": true, @@ -4253,6 +4364,33 @@ }, { "value": "BJS20" + }, + { + "value": "BL24" + }, + { + "value": "IDC5" + }, + { + "value": "TYO23" + }, + { + "value": "CPQ21" + }, + { + "value": "NTG20" + }, + { + "value": "DXB23" + }, + { + "value": "DSM11" + }, + { + "value": "OSA23" + }, + { + "value": "AMS25" } ] } @@ -4652,6 +4790,11 @@ "description": "Flag to indicate cancellation of scheduled job.", "type": "boolean", "readOnly": true + }, + "allDevicesLost": { + "description": "Flag to indicate if all devices associated with the job are lost.", + "type": "boolean", + "readOnly": true } } }, @@ -5522,6 +5665,11 @@ } ] } + }, + "model": { + "$ref": "#/definitions/modelName", + "description": "The model name.", + "readOnly": true } }, "x-ms-discriminator-value": "ValidatePreferences" @@ -5584,6 +5732,10 @@ "datacenterAddressRequest": { "$ref": "#/definitions/DatacenterAddressRequest", "description": "Request body to get the datacenter address for given sku." + }, + "deviceCapabilityRequest": { + "$ref": "#/definitions/DeviceCapabilityRequest", + "description": "Request body to get the device capabilities for a given sku." } } }, @@ -5605,6 +5757,11 @@ "$ref": "#/definitions/DatacenterAddressResponse", "description": "Datacenter address for given sku in a region.", "readOnly": true + }, + "deviceCapabilityResponse": { + "$ref": "#/definitions/DeviceCapabilityResponse", + "description": "Device capabilities available for a given sku in a region.", + "readOnly": true } } }, @@ -5734,6 +5891,11 @@ "country": { "description": "Country in which storage location should be supported.", "type": "string" + }, + "model": { + "$ref": "#/definitions/modelName", + "description": "The model name.", + "readOnly": true } }, "discriminator": "skuName" @@ -6013,6 +6175,11 @@ "family": { "description": "The sku family.", "type": "string" + }, + "model": { + "$ref": "#/definitions/modelName", + "description": "The model name.", + "readOnly": true } } }, @@ -6093,6 +6260,11 @@ "location": { "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01", "type": "string" + }, + "model": { + "$ref": "#/definitions/modelName", + "description": "The model name.", + "readOnly": true } }, "x-ms-discriminator-value": "ValidateSkuAvailability" @@ -6153,6 +6325,11 @@ "description": "Maximum capacity in TB.", "type": "string", "readOnly": true + }, + "individualSkuUsable": { + "type": "string", + "description": "Maximum capacity per device in TB.", + "readOnly": true } } }, @@ -6613,6 +6790,11 @@ } ] } + }, + "model": { + "$ref": "#/definitions/modelName", + "description": "The model name.", + "readOnly": true } } }, @@ -6816,6 +6998,11 @@ "transportPreferences": { "$ref": "#/definitions/TransportPreferences", "description": "Preferences related to the shipment logistics of the sku." + }, + "model": { + "$ref": "#/definitions/modelName", + "description": "The model name.", + "readOnly": true } }, "x-ms-discriminator-value": "ValidateAddress" @@ -7017,6 +7204,47 @@ "readOnly": true } } + }, + "modelName": { + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy", + "DataBoxCustomerDisk", + "DataBoxV2x100", + "DataBoxV2x500" + ], + "type": "string", + "description": "The customer friendly name of the combination of version and capacity of the device. This field is necessary only at the time of ordering the newer generation device i.e. DataBoxV2x100 and DataBoxV2x500 as of May/2024", + "x-ms-enum": { + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + }, + { + "value": "DataBoxCustomerDisk", + "description": "Data Box Customer Disk" + }, + { + "value": "DataBoxV2x100", + "description": "Data Box V2 100TB." + }, + { + "value": "DataBoxV2x500", + "description": "Data Box V2 500TB." + } + ] + } } }, "parameters": { diff --git a/swagger-specs/databox/resource-manager/api-set.json b/swagger-specs/databox/resource-manager/api-set.json index 7bacf4b95..d44a1a4ba 100644 --- a/swagger-specs/databox/resource-manager/api-set.json +++ b/swagger-specs/databox/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.DataBox/stable/2023-03-01/databox.json"], "name": "package-2023-03"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.DataBox/preview/2024-03-01-preview/databox.json"], "name": "package-2024-03-preview"} \ No newline at end of file diff --git a/swagger-specs/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-07-01/databoxedge.json b/swagger-specs/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/databoxedge.json similarity index 99% rename from swagger-specs/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-07-01/databoxedge.json rename to swagger-specs/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/databoxedge.json index a5a27028a..53c2dc51f 100644 --- a/swagger-specs/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-07-01/databoxedge.json +++ b/swagger-specs/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2023-12-01/databoxedge.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-07-01", + "version": "2023-12-01", "title": "DataBoxEdgeManagementClient" }, "host": "management.azure.com", @@ -6989,6 +6989,13 @@ "description": "Load balancer version", "type": "string", "readOnly": true + }, + "ipRange": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Load balancer ipconfig" } } }, diff --git a/swagger-specs/databoxedge/resource-manager/api-set.json b/swagger-specs/databoxedge/resource-manager/api-set.json index 08e2745dd..045004c88 100644 --- a/swagger-specs/databoxedge/resource-manager/api-set.json +++ b/swagger-specs/databoxedge/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.DataBoxEdge/stable/2023-07-01/databoxedge.json"], "name": "package-2023-07"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.DataBoxEdge/stable/2023-12-01/databoxedge.json"], "name": "package-2023-12-01"} \ No newline at end of file diff --git a/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json b/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json index b78b645cf..12cf1c733 100644 --- a/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json +++ b/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json @@ -4048,7 +4048,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ManagedIdentityCredentialResource" + "$ref": "#/definitions/CredentialResource" } } ], @@ -4056,7 +4056,7 @@ "200": { "description": "OK.", "schema": { - "$ref": "#/definitions/ManagedIdentityCredentialResource" + "$ref": "#/definitions/CredentialResource" } }, "default": { @@ -4106,7 +4106,7 @@ "200": { "description": "OK.", "schema": { - "$ref": "#/definitions/ManagedIdentityCredentialResource" + "$ref": "#/definitions/CredentialResource" } }, "304": { @@ -7645,7 +7645,7 @@ "type": "array", "description": "List of credentials.", "items": { - "$ref": "#/definitions/ManagedIdentityCredentialResource" + "$ref": "#/definitions/CredentialResource" } }, "nextLink": { @@ -7671,24 +7671,6 @@ "properties" ] }, - "ManagedIdentityCredentialResource": { - "description": "Credential resource type.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "properties": { - "properties": { - "$ref": "./entityTypes/Credential.json#/definitions/ManagedIdentityCredential", - "description": "Managed Identity Credential properties." - } - }, - "required": [ - "properties" - ] - }, "ManagedVirtualNetworkListResponse": { "description": "A list of managed Virtual Network resources.", "type": "object", diff --git a/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Credential.json b/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Credential.json index b0bb7fb53..f56f96cb0 100644 --- a/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Credential.json +++ b/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Credential.json @@ -78,6 +78,7 @@ "ManagedIdentityCredential": { "x-ms-discriminator-value": "ManagedIdentity", "description": "Managed identity credential.", + "x-ms-client-flatten": true, "type": "object", "allOf": [ { diff --git a/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index e8091e577..71dc94ec3 100644 --- a/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -2074,6 +2074,38 @@ } } }, + "PostgreSqlV2TableDataset": { + "x-ms-discriminator-value": "PostgreSqlV2Table", + "description": "The PostgreSQLV2 table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "PostgreSQLV2 table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PostgreSqlV2TableDatasetTypeProperties" + } + } + }, + "PostgreSqlV2TableDatasetTypeProperties": { + "description": "PostgreSQLV2 table dataset properties.", + "properties": { + "table": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The PostgreSQL table name. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The PostgreSQL schema name. Type: string (or Expression with resultType string)." + } + } + }, "MicrosoftAccessTableDataset": { "x-ms-discriminator-value": "MicrosoftAccessTable", "description": "The Microsoft Access table dataset.", @@ -2845,6 +2877,38 @@ } } }, + "GoogleBigQueryV2ObjectDataset": { + "x-ms-discriminator-value": "GoogleBigQueryV2Object", + "description": "Google BigQuery service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GoogleBigQueryV2DatasetTypeProperties" + } + } + }, + "GoogleBigQueryV2DatasetTypeProperties": { + "description": "Google BigQuery Dataset Properties", + "properties": { + "table": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The table name of the Google BigQuery. Type: string (or Expression with resultType string)." + }, + "dataset": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The database name of the Google BigQuery. Type: string (or Expression with resultType string)." + } + } + }, "GreenplumTableDataset": { "x-ms-discriminator-value": "GreenplumTable", "description": "Greenplum Database dataset.", @@ -3523,6 +3587,26 @@ "typeProperties" ] }, + "SnowflakeV2Dataset": { + "x-ms-discriminator-value": "SnowflakeV2Table", + "description": "The snowflake dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Snowflake dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnowflakeDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, "SnowflakeDatasetTypeProperties": { "description": "Snowflake dataset properties.", "properties": { @@ -3618,12 +3702,133 @@ "description": "Microsoft Fabric LakeHouse Table dataset properties.", "type": "object", "properties": { + "schema": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The schema name of Microsoft Fabric LakeHouse Table. Type: string (or Expression with resultType string)." + }, "table": { "type": "object", "x-ms-format": "dfe-string", "description": "The name of Microsoft Fabric LakeHouse Table. Type: string (or Expression with resultType string)." } } + }, + "SalesforceV2ObjectDataset": { + "x-ms-discriminator-value": "SalesforceV2Object", + "description": "The Salesforce V2 object dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce V2 object dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceV2ObjectDatasetTypeProperties" + } + } + }, + "SalesforceV2ObjectDatasetTypeProperties": { + "description": "Salesforce V2 object dataset properties.", + "type": "object", + "properties": { + "objectApiName": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The Salesforce V2 object API name. Type: string (or Expression with resultType string)." + }, + "reportId": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The Salesforce V2 report Id. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceServiceCloudV2ObjectDataset": { + "x-ms-discriminator-value": "SalesforceServiceCloudV2Object", + "description": "The Salesforce Service Cloud V2 object dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce Service Cloud V2 object dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceServiceCloudV2ObjectDatasetTypeProperties" + } + } + }, + "SalesforceServiceCloudV2ObjectDatasetTypeProperties": { + "description": "Salesforce Service Cloud V2 object dataset properties.", + "type": "object", + "properties": { + "objectApiName": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The Salesforce Service Cloud V2 object API name. Type: string (or Expression with resultType string)." + }, + "reportId": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The Salesforce Service Cloud V2 reportId. Type: string (or Expression with resultType string)." + } + } + }, + "WarehouseTableDataset": { + "x-ms-discriminator-value": "WarehouseTable", + "description": "Microsoft Fabric Warehouse dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Microsoft Fabric Warehouse dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WarehouseTableDatasetTypeProperties" + } + } + }, + "WarehouseTableDatasetTypeProperties": { + "description": "Microsoft Fabric Warehouse dataset properties.", + "type": "object", + "properties": { + "schema": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The schema name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The table name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string)." + } + } + }, + "ServiceNowV2ObjectDataset": { + "x-ms-discriminator-value": "ServiceNowV2Object", + "description": "ServiceNowV2 server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } } } } diff --git a/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json b/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json index 0e5dc7dc7..60fea2a94 100644 --- a/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json +++ b/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json @@ -478,12 +478,14 @@ "type": "object", "properties": { "targetName": { - "description": "The server name of data source access.", - "type": "object" + "description": "The server name of data source access. Type: string.", + "type": "object", + "x-ms-format": "dfe-string" }, "userName": { - "description": "The user name of data source access.", - "type": "object" + "description": "The user name of data source access. Type: string.", + "type": "object", + "x-ms-format": "dfe-string" }, "password": { "description": "The password of data source access.", diff --git a/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 50c721b67..632413244 100644 --- a/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -223,6 +223,107 @@ } } }, + "SqlServerBaseLinkedServiceTypeProperties": { + "description": "Sql Server family connector common linked service properties.", + "type": "object", + "properties": { + "server": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string)." + }, + "database": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The name of the database, used by recommended version. Type: string (or Expression with resultType string)." + }, + "encrypt": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string)." + }, + "trustServerCertificate": { + "type": "object", + "x-ms-format": "dfe-bool", + "description": "Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean)." + }, + "hostNameInCertificate": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string)." + }, + "applicationIntent": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string)." + }, + "connectTimeout": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer)." + }, + "connectRetryCount": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer)." + }, + "connectRetryInterval": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer)." + }, + "loadBalanceTimeout": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer)." + }, + "commandTimeout": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer)." + }, + "integratedSecurity": { + "type": "object", + "x-ms-format": "dfe-bool", + "description": "Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean)." + }, + "failoverPartner": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string)." + }, + "maxPoolSize": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer)." + }, + "minPoolSize": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer)." + }, + "multipleActiveResultSets": { + "type": "object", + "x-ms-format": "dfe-bool", + "description": "When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean)." + }, + "multiSubnetFailover": { + "type": "object", + "x-ms-format": "dfe-bool", + "description": "If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean)." + }, + "packetSize": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer)." + }, + "pooling": { + "type": "object", + "x-ms-format": "dfe-bool", + "description": "Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean)." + } + } + }, "AzureSqlDWLinkedService": { "x-ms-discriminator-value": "AzureSqlDW", "description": "Azure SQL Data Warehouse linked service.", @@ -246,12 +347,36 @@ "AzureSqlDWLinkedServiceTypeProperties": { "description": "Azure SQL Data Warehouse linked service properties.", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties" + } + ], "properties": { "connectionString": { "type": "object", "x-ms-format": "dfe-string", "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference." }, + "authenticationType": { + "x-ms-enum": { + "name": "AzureSqlDWAuthenticationType", + "modelAsString": true + }, + "enum": [ + "SQL", + "ServicePrincipal", + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity" + ], + "type": "string", + "description": "The type used for authentication. Type: string." + }, + "userName": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The user name to be used when connecting to server. Type: string (or Expression with resultType string)." + }, "password": { "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." @@ -265,6 +390,15 @@ "$ref": "../datafactory.json#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse." }, + "servicePrincipalCredentialType": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." + }, + "servicePrincipalCredential": { + "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, "tenant": { "type": "object", "x-ms-format": "dfe-string", @@ -283,10 +417,7 @@ "$ref": "../datafactory.json#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } - }, - "required": [ - "connectionString" - ] + } }, "SqlServerLinkedService": { "x-ms-discriminator-value": "SqlServer", @@ -311,12 +442,29 @@ "SqlServerLinkedServiceTypeProperties": { "description": "SQL Server linked service properties.", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties" + } + ], "properties": { "connectionString": { "type": "object", "x-ms-format": "dfe-string", "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, + "authenticationType": { + "x-ms-enum": { + "name": "SqlServerAuthenticationType", + "modelAsString": true + }, + "enum": [ + "SQL", + "Windows" + ], + "type": "string", + "description": "The type used for authentication. Type: string." + }, "userName": { "type": "object", "x-ms-format": "dfe-string", @@ -334,10 +482,7 @@ "$ref": "#/definitions/SqlAlwaysEncryptedProperties", "description": "Sql always encrypted properties." } - }, - "required": [ - "connectionString" - ] + } }, "AmazonRdsForSqlServerLinkedService": { "x-ms-discriminator-value": "AmazonRdsForSqlServer", @@ -362,12 +507,29 @@ "AmazonRdsForSqlServerLinkedServiceTypeProperties": { "description": "Amazon Rds for SQL Server linked service properties.", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties" + } + ], "properties": { "connectionString": { "type": "object", "x-ms-format": "dfe-string", "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, + "authenticationType": { + "x-ms-enum": { + "name": "AmazonRdsForSqlAuthenticationType", + "modelAsString": true + }, + "enum": [ + "SQL", + "Windows" + ], + "type": "string", + "description": "The type used for authentication. Type: string." + }, "userName": { "type": "object", "x-ms-format": "dfe-string", @@ -385,10 +547,7 @@ "$ref": "#/definitions/SqlAlwaysEncryptedProperties", "description": "Sql always encrypted properties." } - }, - "required": [ - "connectionString" - ] + } }, "AzureSqlDatabaseLinkedService": { "x-ms-discriminator-value": "AzureSqlDatabase", @@ -413,12 +572,36 @@ "AzureSqlDatabaseLinkedServiceTypeProperties": { "description": "Azure SQL Database linked service properties.", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties" + } + ], "properties": { "connectionString": { "type": "object", "x-ms-format": "dfe-string", "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, + "authenticationType": { + "x-ms-enum": { + "name": "AzureSqlDatabaseAuthenticationType", + "modelAsString": true + }, + "enum": [ + "SQL", + "ServicePrincipal", + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity" + ], + "type": "string", + "description": "The type used for authentication. Type: string." + }, + "userName": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The user name to be used when connecting to server. Type: string (or Expression with resultType string)." + }, "password": { "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." @@ -432,6 +615,15 @@ "$ref": "../datafactory.json#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Azure SQL Database." }, + "servicePrincipalCredentialType": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." + }, + "servicePrincipalCredential": { + "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, "tenant": { "type": "object", "x-ms-format": "dfe-string", @@ -454,10 +646,7 @@ "$ref": "../datafactory.json#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } - }, - "required": [ - "connectionString" - ] + } }, "AzureSqlMILinkedService": { "x-ms-discriminator-value": "AzureSqlMI", @@ -482,12 +671,36 @@ "AzureSqlMILinkedServiceTypeProperties": { "description": "Azure SQL Managed Instance linked service properties.", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties" + } + ], "properties": { "connectionString": { "type": "object", "x-ms-format": "dfe-string", "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, + "authenticationType": { + "x-ms-enum": { + "name": "AzureSqlMIAuthenticationType", + "modelAsString": true + }, + "enum": [ + "SQL", + "ServicePrincipal", + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity" + ], + "type": "string", + "description": "The type used for authentication. Type: string." + }, + "userName": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The user name to be used when connecting to server. Type: string (or Expression with resultType string)." + }, "password": { "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." @@ -501,6 +714,15 @@ "$ref": "../datafactory.json#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Azure SQL Managed Instance." }, + "servicePrincipalCredentialType": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." + }, + "servicePrincipalCredential": { + "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, "tenant": { "type": "object", "x-ms-format": "dfe-string", @@ -523,10 +745,7 @@ "$ref": "../datafactory.json#/definitions/CredentialReference", "description": "The credential reference containing authentication information." } - }, - "required": [ - "connectionString" - ] + } }, "SqlAlwaysEncryptedProperties": { "description": "Sql always encrypted properties.", @@ -946,6 +1165,10 @@ "$ref": "../datafactory.json#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." + }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." @@ -1526,11 +1749,46 @@ "description": "MySQL linked service properties.", "type": "object", "properties": { + "driverVersion": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The version of the MySQL driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string." + }, "connectionString": { "type": "object", "x-ms-format": "dfe-string", "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." }, + "server": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Server name for connection. Type: string." + }, + "port": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The port for the connection. Type: integer." + }, + "username": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Username for authentication. Type: string." + }, + "database": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Database name for connection. Type: string." + }, + "sslMode": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "SSL mode for connection. Type: integer. 0: disable, 1: prefer, 2: require, 3: verify-ca, 4: verify-full." + }, + "useSystemTrustStore": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "Use system trust store for connection. Type: integer. 0: enable, 1: disable." + }, "password": { "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." @@ -1539,10 +1797,7 @@ "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." } - }, - "required": [ - "connectionString" - ] + } }, "PostgreSqlLinkedService": { "x-ms-discriminator-value": "PostgreSql", @@ -1586,9 +1841,9 @@ "connectionString" ] }, - "SybaseLinkedService": { - "x-ms-discriminator-value": "Sybase", - "description": "Linked service for Sybase data source.", + "PostgreSqlV2LinkedService": { + "x-ms-discriminator-value": "PostgreSqlV2", + "description": "Linked service for PostgreSQLV2 data source.", "type": "object", "allOf": [ { @@ -1597,28 +1852,153 @@ ], "properties": { "typeProperties": { - "description": "Sybase linked service properties.", + "description": "PostgreSQLV2 linked service properties.", "x-ms-client-flatten": true, - "$ref": "#/definitions/SybaseLinkedServiceTypeProperties" + "$ref": "#/definitions/PostgreSqlV2LinkedServiceTypeProperties" } }, "required": [ "typeProperties" ] }, - "SybaseLinkedServiceTypeProperties": { - "description": "Sybase linked service properties.", + "PostgreSqlV2LinkedServiceTypeProperties": { + "description": "PostgreSqlV2 linked service properties.", "type": "object", "properties": { "server": { "type": "object", "x-ms-format": "dfe-string", - "description": "Server name for connection. Type: string (or Expression with resultType string)." + "description": "Server name for connection. Type: string." + }, + "port": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The port for the connection. Type: integer." + }, + "username": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Username for authentication. Type: string." }, "database": { "type": "object", "x-ms-format": "dfe-string", - "description": "Database name for connection. Type: string (or Expression with resultType string)." + "description": "Database name for connection. Type: string." + }, + "sslMode": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer." + }, + "schema": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Sets the schema search path. Type: string." + }, + "pooling": { + "type": "object", + "x-ms-format": "dfe-bool", + "description": "Whether connection pooling should be used. Type: boolean." + }, + "connectionTimeout": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer." + }, + "commandTimeout": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Set to zero for infinity. Type: integer." + }, + "trustServerCertificate": { + "type": "object", + "x-ms-format": "dfe-bool", + "description": "Whether to trust the server certificate without validating it. Type: boolean." + }, + "sslCertificate": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Location of a client certificate to be sent to the server. Type: string." + }, + "sslKey": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Location of a client key for a client certificate to be sent to the server. Type: string." + }, + "sslPassword": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Password for a key for a client certificate. Type: string." + }, + "readBufferSize": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer." + }, + "logParameters": { + "type": "object", + "x-ms-format": "dfe-bool", + "description": "When enabled, parameter values are logged when commands are executed. Type: boolean." + }, + "timezone": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Gets or sets the session timezone. Type: string." + }, + "encoding": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string" + }, + "password": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string. Type: string." + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." + } + }, + "required": [ + "server", + "username", + "database", + "sslMode" + ] + }, + "SybaseLinkedService": { + "x-ms-discriminator-value": "Sybase", + "description": "Linked service for Sybase data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Sybase linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SybaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SybaseLinkedServiceTypeProperties": { + "description": "Sybase linked service properties.", + "type": "object", + "properties": { + "server": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Server name for connection. Type: string (or Expression with resultType string)." + }, + "database": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Database name for connection. Type: string (or Expression with resultType string)." }, "schema": { "type": "object", @@ -2203,8 +2583,8 @@ }, "authHeaders": { "type": "object", - "x-ms-format": "dfe-object", - "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object)." + "x-ms-format": "dfe-key-value-pairs", + "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type)." }, "tenant": { "type": "object", @@ -4003,8 +4383,8 @@ }, "authHeaders": { "type": "object", - "x-ms-format": "dfe-object", - "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object)." + "x-ms-format": "dfe-key-value-pairs", + "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type)." }, "embeddedCertData": { "type": "object", @@ -4732,6 +5112,74 @@ "authenticationType" ] }, + "GoogleBigQueryV2LinkedService": { + "x-ms-discriminator-value": "GoogleBigQueryV2", + "description": "Google BigQuery service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Google BigQuery service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GoogleBigQueryV2LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GoogleBigQueryV2LinkedServiceTypeProperties": { + "description": "Google BigQuery service linked service properties.", + "type": "object", + "properties": { + "projectId": { + "description": "The default BigQuery project id to query against. Type: string (or Expression with resultType string).", + "x-ms-format": "dfe-string", + "type": "object" + }, + "authenticationType": { + "description": "The OAuth 2.0 authentication mechanism used for authentication.", + "type": "string", + "enum": [ + "ServiceAuthentication", + "UserAuthentication" + ], + "x-ms-enum": { + "name": "GoogleBigQueryV2AuthenticationType", + "modelAsString": true + } + }, + "clientId": { + "x-ms-format": "dfe-string", + "description": "The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).", + "type": "object" + }, + "clientSecret": { + "description": "The client secret of the google application used to acquire the refresh token.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "refreshToken": { + "description": "The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "keyFileContent": { + "description": "The content of the .json key file that is used to authenticate the service account. Type: string (or Expression with resultType string).", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." + } + }, + "required": [ + "projectId", + "authenticationType" + ] + }, "GreenplumLinkedService": { "x-ms-discriminator-value": "Greenplum", "description": "Greenplum Database linked service.", @@ -5304,12 +5752,37 @@ "description": "MariaDB server linked service properties.", "type": "object", "properties": { + "driverVersion": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The version of the MariaDB driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string." + }, "connectionString": { "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object", "x-ms-format": "dfe-string" }, - "pwd": { + "server": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Server name for connection. Type: string." + }, + "port": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The port for the connection. Type: integer." + }, + "username": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Username for authentication. Type: string." + }, + "database": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Database name for connection. Type: string." + }, + "password": { "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, @@ -6369,8 +6842,8 @@ "properties": { "clusterSize": { "type": "object", - "x-ms-format": "dfe-string", - "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string)." + "x-ms-format": "dfe-int", + "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int)." }, "timeToLive": { "type": "object", @@ -7322,8 +7795,9 @@ "type": "object", "properties": { "functionAppUrl": { - "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net.", - "type": "object" + "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net. Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "functionKey": { "description": "Function or Host key for Azure Function App.", @@ -7338,8 +7812,9 @@ "description": "The credential reference containing authentication information." }, "resourceId": { - "description": "Allowed token audiences for azure function.", - "type": "object" + "description": "Allowed token audiences for azure function. Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "authentication": { "type": "object", @@ -7377,7 +7852,8 @@ "properties": { "connectionString": { "description": "The connection string of snowflake. Type: string, SecureString.", - "type": "object" + "type": "object", + "x-ms-format": "dfe-string" }, "password": { "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", @@ -7392,6 +7868,106 @@ "connectionString" ] }, + "SnowflakeV2LinkedService": { + "x-ms-discriminator-value": "SnowflakeV2", + "description": "Snowflake linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Snowflake linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnowflakeLinkedV2ServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SnowflakeLinkedV2ServiceTypeProperties": { + "description": "Snowflake linked service properties.", + "type": "object", + "properties": { + "accountIdentifier": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure" + }, + "user": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The name of the Snowflake user." + }, + "password": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "The Azure key vault secret reference of password in connection string." + }, + "database": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The name of the Snowflake database." + }, + "warehouse": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The name of the Snowflake warehouse." + }, + "authenticationType": { + "x-ms-enum": { + "name": "SnowflakeAuthenticationType", + "modelAsString": true + }, + "enum": [ + "Basic", + "KeyPair", + "AADServicePrincipal" + ], + "type": "string", + "default": "Basic", + "description": "The type used for authentication. Type: string." + }, + "clientId": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication." + }, + "clientSecret": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "The Azure key vault secret reference of client secret for AADServicePrincipal authentication." + }, + "tenantId": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication." + }, + "scope": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication." + }, + "privateKey": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "The Azure key vault secret reference of privateKey for KeyPair auth." + }, + "privateKeyPassphrase": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key." + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." + } + }, + "required": [ + "accountIdentifier", + "database", + "warehouse" + ] + }, "SharePointOnlineListLinkedService": { "x-ms-discriminator-value": "SharePointOnlineList", "description": "SharePoint Online List linked service.", @@ -7553,6 +8129,260 @@ "$ref": "../datafactory.json#/definitions/SecretBase" } } + }, + "SalesforceV2LinkedService": { + "x-ms-discriminator-value": "SalesforceV2", + "description": "Linked service for Salesforce V2.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce V2 linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceV2LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SalesforceV2LinkedServiceTypeProperties": { + "description": "Salesforce V2 linked service properties.", + "type": "object", + "properties": { + "environmentUrl": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The URL of Salesforce instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value" + }, + "clientId": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string)." + }, + "clientSecret": { + "description": "The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "apiVersion": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." + } + } + }, + "SalesforceServiceCloudV2LinkedService": { + "x-ms-discriminator-value": "SalesforceServiceCloudV2", + "description": "Linked service for Salesforce Service Cloud V2.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce Service Cloud V2 linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceServiceCloudV2LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SalesforceServiceCloudV2LinkedServiceTypeProperties": { + "description": "Salesforce Service Cloud V2 linked service properties.", + "type": "object", + "properties": { + "environmentUrl": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The URL of Salesforce Service Cloud instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value" + }, + "clientId": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string)." + }, + "clientSecret": { + "description": "The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "apiVersion": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." + } + } + }, + "WarehouseLinkedService": { + "x-ms-discriminator-value": "Warehouse", + "description": "Microsoft Fabric Warehouse linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Microsoft Fabric Warehouse linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WarehouseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WarehouseLinkedServiceTypeProperties": { + "description": "Microsoft Fabric Warehouse linked service properties.", + "type": "object", + "properties": { + "artifactId": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The ID of Microsoft Fabric Warehouse artifact. Type: string (or Expression with resultType string)." + }, + "endpoint": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The endpoint of Microsoft Fabric Warehouse server. Type: string (or Expression with resultType string)." + }, + "workspaceId": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The ID of the application used to authenticate against Microsoft Fabric Warehouse. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The Key of the application used to authenticate against Microsoft Fabric Warehouse.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." + }, + "servicePrincipalCredentialType": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." + }, + "servicePrincipalCredential": { + "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.", + "$ref": "../datafactory.json#/definitions/SecretBase" + } + }, + "required": [ + "artifactId", + "endpoint" + ] + }, + "ServiceNowV2LinkedService": { + "x-ms-discriminator-value": "ServiceNowV2", + "description": "ServiceNowV2 server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "ServiceNowV2 server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceNowV2LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ServiceNowV2LinkedServiceTypeProperties": { + "description": "ServiceNowV2 server linked service properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The endpoint of the ServiceNowV2 server. (i.e. .service-now.com)", + "type": "object", + "x-ms-format": "dfe-string" + }, + "authenticationType": { + "description": "The authentication type to use.", + "type": "string", + "enum": [ + "Basic", + "OAuth2" + ], + "x-ms-enum": { + "name": "ServiceNowV2AuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the ServiceNowV2 server for Basic and OAuth2 authentication.", + "type": "object", + "x-ms-format": "dfe-string" + }, + "password": { + "description": "The password corresponding to the user name for Basic and OAuth2 authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "clientId": { + "description": "The client id for OAuth2 authentication.", + "type": "object", + "x-ms-format": "dfe-string" + }, + "clientSecret": { + "description": "The client secret for OAuth2 authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "grantType": { + "description": "GrantType for OAuth2 authentication. Default value is password.", + "type": "object", + "x-ms-format": "dfe-string" + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." + } + }, + "required": [ + "endpoint", + "authenticationType" + ] } } } diff --git a/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 5376918c0..d094cd8aa 100644 --- a/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/swagger-specs/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -1171,6 +1171,16 @@ "description": "The type of copy behavior for copy sink.", "type": "object", "x-ms-format": "dfe-string" + }, + "metadata": { + "type": "array", + "description": "Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [ + "name" + ] } }, "additionalProperties": { @@ -2286,6 +2296,22 @@ } } }, + "PostgreSqlV2Source": { + "description": "A copy activity source for PostgreSQL databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, "SybaseSource": { "description": "A copy activity source for Sybase databases.", "type": "object", @@ -2640,8 +2666,8 @@ }, "additionalHeaders": { "type": "object", - "x-ms-format": "dfe-string", - "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + "x-ms-format": "dfe-key-value-pairs", + "description": "The additional HTTP headers in the request to the RESTful API. Type: key value pairs (value should be string type)." }, "httpRequestTimeout": { "type": "object", @@ -2654,7 +2680,8 @@ }, "httpCompressionType": { "type": "object", - "description": "Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. " + "x-ms-format": "dfe-string", + "description": "Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. Type: string (or Expression with resultType string)." } } }, @@ -2698,7 +2725,8 @@ }, "additionalColumns": { "type": "object", - "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." + "x-ms-format": "dfe-key-value-pairs", + "description": "Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type)." } } }, @@ -2731,8 +2759,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2773,8 +2802,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2857,8 +2887,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2899,8 +2930,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2937,8 +2969,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -3722,6 +3755,22 @@ } } }, + "GoogleBigQueryV2Source": { + "description": "A copy activity Google BigQuery service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "x-ms-format": "dfe-string", + "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", @@ -4276,6 +4325,29 @@ "exportSettings" ] }, + "SnowflakeV2Source": { + "description": "A copy activity snowflake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Snowflake Sql query. Type: string (or Expression with resultType string)." + }, + "exportSettings": { + "$ref": "#/definitions/SnowflakeExportCopyCommand", + "description": "Snowflake export settings." + } + }, + "required": [ + "exportSettings" + ] + }, "ExportSettings": { "description": "Export command settings.", "discriminator": "type", @@ -4402,6 +4474,79 @@ } } }, + "WarehouseSource": { + "description": "A copy activity Microsoft Fabric Warehouse source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Microsoft Fabric Warehouse reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Name of the stored procedure for a Microsoft Fabric 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." + }, + "isolationLevel": { + "x-ms-format": "dfe-string", + "description": "Specifies the transaction locking behavior for the Microsoft Fabric Warehouse source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "WarehouseSink": { + "description": "A copy activity Microsoft Fabric Warehouse sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "allowCopyCommand": { + "type": "object", + "x-ms-format": "dfe-bool", + "description": "Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean)." + }, + "copyCommandSettings": { + "description": "Specifies Copy Command related settings when allowCopyCommand is true.", + "$ref": "#/definitions/DWCopyCommandSettings" + }, + "tableOption": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + }, + "writeBehavior": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Write behavior when copying data into azure Microsoft Fabric Data Warehouse. Type: DWWriteBehaviorEnum (or Expression with resultType DWWriteBehaviorEnum)" + } + } + }, "StoredProcedureParameter": { "description": "SQL stored procedure parameter.", "type": "object", @@ -4754,7 +4899,8 @@ }, "writeBehavior": { "type": "object", - "description": "Write behavior when copying data into sql. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" + "x-ms-format": "dfe-string", + "description": "Write behavior when copying data into sql. Type: string (or Expression with resultType string)." }, "upsertSettings": { "description": "SQL upsert settings.", @@ -4808,7 +4954,8 @@ }, "writeBehavior": { "type": "object", - "description": "Write behavior when copying data into sql server. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" + "x-ms-format": "dfe-string", + "description": "Write behavior when copying data into sql server. Type: string (or Expression with resultType string)." }, "upsertSettings": { "description": "SQL upsert settings.", @@ -4916,7 +5063,8 @@ }, "writeBehavior": { "type": "object", - "description": "White behavior when copying data into azure SQL MI. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" + "x-ms-format": "dfe-string", + "description": "White behavior when copying data into azure SQL MI. Type: string (or Expression with resultType string)" }, "upsertSettings": { "description": "SQL upsert settings.", @@ -5140,6 +5288,26 @@ } } }, + "SnowflakeV2Sink": { + "description": "A copy activity snowflake sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "importSettings": { + "$ref": "#/definitions/SnowflakeImportCopyCommand", + "description": "Snowflake import settings." + } + } + }, "ImportSettings": { "description": "Import command settings.", "discriminator": "type", @@ -5966,6 +6134,7 @@ }, "arguments": { "type": "object", + "x-ms-format": "dfe-list-string", "description": "User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array)." }, "getDebugInfo": { @@ -6996,8 +7165,11 @@ }, "headers": { "type": "object", - "x-ms-format": "dfe-string", - "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)." + "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).", + "additionalProperties": { + "type": "object", + "x-ms-format": "dfe-string" + } }, "body": { "type": "object", @@ -7012,6 +7184,15 @@ "type": "boolean", "description": "When set to true, Certificate validation will be disabled." }, + "httpRequestTimeout": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Timeout for the HTTP request to get a response. Format is in TimeSpan (hh:mm:ss). This value is the timeout to get a response, not the activity timeout. The default value is 00:01:00 (1 minute). The range is from 1 to 10 minutes" + }, + "turnOffAsync": { + "type": "boolean", + "description": "Option to disable invoking HTTP GET on location given in response header of a HTTP 202 Response. If set true, it stops invoking HTTP GET on http location given in response header. If set false then continues to invoke HTTP GET call on location given in http response headers." + }, "datasets": { "type": "array", "description": "List of datasets passed to web endpoint.", @@ -7421,8 +7602,7 @@ "type": "object" }, "dataPathAssignments": { - "x-ms-format": "dfe-key-value-pairs", - "description": "Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).", + "description": "Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object (or Expression with resultType object).", "type": "object" }, "mlParentRunId": { @@ -8026,8 +8206,11 @@ }, "headers": { "type": "object", - "x-ms-format": "dfe-string", - "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)." + "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).", + "additionalProperties": { + "type": "object", + "x-ms-format": "dfe-string" + } }, "body": { "type": "object", @@ -8092,8 +8275,11 @@ }, "headers": { "type": "object", - "x-ms-format": "dfe-string", - "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)." + "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).", + "additionalProperties": { + "type": "object", + "x-ms-format": "dfe-string" + } }, "body": { "type": "object", @@ -8337,16 +8523,9 @@ "description": "The query text. Type: string (or Expression with resultType string)." }, "type": { - "x-ms-enum": { - "name": "ScriptType", - "modelAsString": true - }, - "enum": [ - "Query", - "NonQuery" - ], - "type": "string", - "description": "The type of the query. Type: string." + "type": "object", + "x-ms-format": "dfe-string", + "description": "The type of the query. Please refer to the ScriptType for valid options. Type: string (or Expression with resultType string)." }, "parameters": { "type": "array", @@ -8441,6 +8620,18 @@ } } }, + "ScriptType": { + "description": "The type of the ScriptActivityScriptBlock.", + "type": "string", + "enum": [ + "Query", + "NonQuery" + ], + "x-ms-enum": { + "name": "ScriptType", + "modelAsString": true + } + }, "SqlPartitionOption": { "description": "The partition mechanism that will be used for Sql read in parallel.", "type": "string", @@ -8862,6 +9053,7 @@ }, "referenceName": { "type": "object", + "x-ms-format": "dfe-string", "description": "Reference spark job name. Expression with resultType string." } }, @@ -8895,6 +9087,186 @@ "type", "referenceName" ] + }, + "SalesforceV2Source": { + "description": "A copy activity Salesforce V2 source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "SOQLQuery": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Deprecating, please use 'query' property instead. Type: string (or Expression with resultType string)." + }, + "query": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "You can only use Salesforce Object Query Language (SOQL) query with limitations. For SOQL limitations, see this article: https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm#SOQL%20Considerations. If query is not specified, all the data of the Salesforce object specified in ObjectApiName/reportId in dataset will be retrieved. Type: string (or Expression with resultType string)." + }, + "includeDeletedObjects": { + "description": "This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean).", + "type": "object", + "x-ms-format": "dfe-bool" + } + } + }, + "SalesforceServiceCloudV2Source": { + "description": "A copy activity Salesforce Service Cloud V2 source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "SOQLQuery": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Deprecating, please use 'query' property instead. Type: string (or Expression with resultType string)." + }, + "query": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "You can only use Salesforce Object Query Language (SOQL) query with limitations. For SOQL limitations, see this article: https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm#SOQL%20Considerations. If query is not specified, all the data of the Salesforce object specified in ObjectApiName/reportId in dataset will be retrieved. Type: string (or Expression with resultType string)." + }, + "includeDeletedObjects": { + "description": "This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean).", + "type": "object", + "x-ms-format": "dfe-bool" + }, + "additionalColumns": { + "type": "object", + "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." + } + } + }, + "SalesforceV2Sink": { + "description": "A copy activity Salesforce V2 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": "SalesforceV2SinkWriteBehavior", + "modelAsString": true + } + }, + "externalIdFieldName": { + "type": "object", + "x-ms-format": "dfe-string", + "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", + "x-ms-format": "dfe-bool", + "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)." + } + } + }, + "SalesforceServiceCloudV2Sink": { + "description": "A copy activity Salesforce Service Cloud V2 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": "SalesforceV2SinkWriteBehavior", + "modelAsString": true + } + }, + "externalIdFieldName": { + "type": "object", + "x-ms-format": "dfe-string", + "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", + "x-ms-format": "dfe-bool", + "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)." + } + } + }, + "ServiceNowV2Source": { + "description": "A copy activity ServiceNowV2 server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "expression": { + "type": "object", + "description": "Expression to filter data from source.", + "$ref": "#/definitions/ExpressionV2" + } + } + }, + "ExpressionV2": { + "description": "Nested representation of a complex expression.", + "type": "object", + "properties": { + "type": { + "x-ms-enum": { + "name": "ExpressionV2Type", + "modelAsString": true + }, + "enum": [ + "Constant", + "Field", + "Unary", + "Binary", + "NAry" + ], + "type": "string", + "description": "Type of expressions supported by the system. Type: string." + }, + "value": { + "description": "Value for Constant/Field Type: string.", + "type": "string" + }, + "operators": { + "description": "Expression operator value Type: list of strings.", + "type": "array", + "items": { + "type": "string", + "x-ms-format": "dfe-string", + "description": "Type: string." + } + }, + "operands": { + "description": "List of nested expressions.", + "type": "array", + "items": { + "$ref": "#/definitions/ExpressionV2", + "description": "Type: ExpressionV2." + } + } + } } } } diff --git a/swagger-specs/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/dataprotection.json b/swagger-specs/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/dataprotection.json similarity index 96% rename from swagger-specs/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/dataprotection.json rename to swagger-specs/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/dataprotection.json index d72c8de9a..95df18aea 100644 --- a/swagger-specs/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/dataprotection.json +++ b/swagger-specs/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/dataprotection.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-11-01", + "version": "2024-04-01", "title": "DataProtectionBackupClient", "x-ms-code-generation-settings": { "internalConstructors": false @@ -369,6 +369,9 @@ }, "Get BackupVault With MSI": { "$ref": "./examples/VaultCRUD/GetBackupVaultWithMSI.json" + }, + "Get BackupVault With CMK": { + "$ref": "./examples/VaultCRUD/GetBackupVaultWithCMK.json" } } }, @@ -405,6 +408,11 @@ "schema": { "$ref": "#/definitions/BackupVaultResource" } + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" } ], "responses": { @@ -433,6 +441,9 @@ }, "Create BackupVault With MSI": { "$ref": "./examples/VaultCRUD/PutBackupVaultWithMSI.json" + }, + "Create BackupVault With CMK": { + "$ref": "./examples/VaultCRUD/PutBackupVaultWithCMK.json" } }, "x-ms-long-running-operation": true @@ -514,6 +525,11 @@ "schema": { "$ref": "#/definitions/PatchResourceRequestInput" } + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" } ], "responses": { @@ -537,6 +553,9 @@ "x-ms-examples": { "Patch BackupVault": { "$ref": "./examples/VaultCRUD/PatchBackupVault.json" + }, + "Patch BackupVault with CMK": { + "$ref": "./examples/VaultCRUD/PatchBackupVaultWithCMK.json" } } } @@ -1094,6 +1113,11 @@ "schema": { "$ref": "#/definitions/BackupInstanceResource" } + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" } ], "responses": { @@ -1132,6 +1156,9 @@ "x-ms-examples": { "Create BackupInstance": { "$ref": "./examples/BackupInstanceOperations/PutBackupInstance.json" + }, + "Create BackupInstance to perform critical operation With MUA": { + "$ref": "./examples/BackupInstanceOperations/PutBackupInstance_ResourceGuardEnabled.json" } }, "x-ms-long-running-operation": true @@ -1160,6 +1187,11 @@ }, { "$ref": "#/parameters/BackupInstanceName" + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" } ], "responses": { @@ -1876,6 +1908,48 @@ } } }, + "/{resourceId}/providers/Microsoft.DataProtection/backupInstances": { + "get": { + "tags": [ + "BackupInstancesExtensionRouting" + ], + "description": "Gets a list of backup instances associated with a tracked resource", + "operationId": "BackupInstancesExtensionRouting_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupInstanceResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List BackupInstances associated with an azure resource": { + "$ref": "./examples/BackupInstanceOperations/ListBackupInstancesExtensionRouting.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate": { "post": { "description": "rehydrate recovery point for restore for a BackupInstance", @@ -1983,6 +2057,11 @@ "schema": { "$ref": "#/definitions/AzureBackupRestoreRequest" } + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" } ], "responses": { @@ -2187,6 +2266,20 @@ }, { "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": false, + "schema": { + "$ref": "#/definitions/StopProtectionRequest" + } + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" } ], "responses": { @@ -2222,6 +2315,9 @@ "x-ms-examples": { "StopProtection": { "$ref": "./examples/BackupInstanceOperations/StopProtection.json" + }, + "StopProtection with MUA": { + "$ref": "./examples/BackupInstanceOperations/StopProtection_ResourceGuardEnabled.json" } } } @@ -2251,6 +2347,20 @@ }, { "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": false, + "schema": { + "$ref": "#/definitions/SuspendBackupRequest" + } + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" } ], "responses": { @@ -2286,6 +2396,9 @@ "x-ms-examples": { "SuspendBackups": { "$ref": "./examples/BackupInstanceOperations/SuspendBackups.json" + }, + "SuspendBackups with MUA": { + "$ref": "./examples/BackupInstanceOperations/SuspendBackup_ResourceGuardEnabled.json" } } } @@ -4062,6 +4175,11 @@ "schema": { "$ref": "#/definitions/UnlockDeleteRequest" } + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" } ], "responses": { @@ -4712,6 +4830,13 @@ "description": "Fully qualified Azure Resource Manager ID of the datasource which is being recovered.", "type": "string" }, + "resourceGuardOperationRequests": { + "description": "ResourceGuardOperationRequests on which LAC check will be performed", + "type": "array", + "items": { + "type": "string" + } + }, "identityDetails": { "$ref": "#/definitions/IdentityDetails", "description": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned." @@ -5006,6 +5131,13 @@ "$ref": "#/definitions/PolicyInfo", "description": "Gets or sets the policy information." }, + "resourceGuardOperationRequests": { + "description": "ResourceGuardOperationRequests on which LAC check will be performed", + "type": "array", + "items": { + "type": "string" + } + }, "protectionStatus": { "$ref": "#/definitions/ProtectionStatusDetails", "description": "Specifies the protection status of the resource", @@ -5250,6 +5382,29 @@ "modelAsString": true } }, + "bcdrSecurityLevel": { + "description": "Security Level of Backup Vault", + "enum": [ + "Poor", + "Fair", + "Good", + "Excellent", + "NotSupported" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BCDRSecurityLevel", + "modelAsString": true + } + }, + "resourceGuardOperationRequests": { + "description": "ResourceGuardOperationRequests on which LAC check will be performed", + "type": "array", + "items": { + "type": "string" + } + }, "replicatedRegions": { "description": "List of replicated regions for Backup Vault", "items": { @@ -5570,6 +5725,38 @@ "title": "CloudError", "x-ms-external": true }, + "CmkKeyVaultProperties": { + "type": "object", + "description": "The properties of the Key Vault which hosts CMK", + "properties": { + "keyUri": { + "description": "The key uri of the Customer Managed Key", + "type": "string" + } + } + }, + "CmkKekIdentity": { + "type": "object", + "description": "The details of the managed identity used for CMK", + "properties": { + "identityType": { + "type": "string", + "description": "The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity.", + "enum": [ + "SystemAssigned", + "UserAssigned" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "identityId": { + "type": "string", + "description": "The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: 'UserAssigned' only." + } + } + }, "CopyOnExpiryOption": { "allOf": [ { @@ -6194,6 +6381,57 @@ } } }, + "encryptionSettings": { + "description": "Customer Managed Key details of the resource.", + "type": "object", + "properties": { + "state": { + "description": "Encryption state of the Backup Vault.", + "type": "string", + "enum": [ + "Enabled", + "Disabled", + "Inconsistent" + ], + "x-ms-enum": { + "name": "EncryptionState", + "modelAsString": true, + "values": [ + { + "description": "CMK encryption is enabled on the Backup Vault", + "value": "Enabled" + }, + { + "description": "CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State is 'Enabled'.", + "value": "Disabled" + }, + { + "description": "CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user needs to retry the encryption settings operation immediately to correct the state.", + "value": "Inconsistent" + } + ] + } + }, + "keyVaultProperties": { + "$ref": "#/definitions/CmkKeyVaultProperties" + }, + "kekIdentity": { + "$ref": "#/definitions/CmkKekIdentity" + }, + "infrastructureEncryption": { + "description": "Enabling/Disabling the Double Encryption state", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "InfrastructureEncryptionState", + "modelAsString": true + } + } + } + }, "Error": { "description": "The resource management error response.", "properties": { @@ -6732,6 +6970,13 @@ "featureSettings": { "$ref": "#/definitions/FeatureSettings", "description": "Feature Settings" + }, + "resourceGuardOperationRequests": { + "description": "ResourceGuardOperationRequests on which LAC check will be performed", + "type": "array", + "items": { + "type": "string" + } } } }, @@ -7009,6 +7254,10 @@ }, "x-ms-identifiers": [], "type": "array" + }, + "resourceModifierReference": { + "description": "Gets or sets the resource modifier reference. This property sets the reference for resource modifier during restore.", + "$ref": "#/definitions/NamespacedNameResource" } }, "x-ms-discriminator-value": "KubernetesClusterRestoreCriteria" @@ -7119,6 +7368,10 @@ } ] } + }, + "resourceModifierReference": { + "description": "Gets or sets the resource modifier reference. This property sets the reference for resource modifier during restore.", + "$ref": "#/definitions/NamespacedNameResource" } }, "x-ms-discriminator-value": "KubernetesClusterVaultTierRestoreCriteria" @@ -7546,6 +7799,9 @@ }, "immutabilitySettings": { "$ref": "#/definitions/ImmutabilitySettings" + }, + "encryptionSettings": { + "$ref": "#/definitions/encryptionSettings" } } }, @@ -7695,6 +7951,32 @@ } } }, + "StopProtectionRequest": { + "description": "Request body of Stop protection when MUA is Enabled", + "type": "object", + "properties": { + "resourceGuardOperationRequests": { + "description": "ResourceGuardOperationRequests on which LAC check will be performed", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SuspendBackupRequest": { + "description": "Request body of Suspend backup when MUA is Enabled", + "type": "object", + "properties": { + "resourceGuardOperationRequests": { + "description": "ResourceGuardOperationRequests on which LAC check will be performed", + "type": "array", + "items": { + "type": "string" + } + } + } + }, "TaggingCriteria": { "description": "Tagging criteria", "properties": { @@ -8074,6 +8356,7 @@ "type": "object", "properties": { "resourceGuardOperationRequests": { + "description": "ResourceGuardOperationRequests on which LAC check will be performed", "type": "array", "items": { "type": "string" @@ -8111,6 +8394,15 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" + }, + "ResourceId": { + "name": "resourceId", + "in": "path", + "description": "ARM path of the resource to be protected using Microsoft.DataProtection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true } }, "securityDefinitions": { diff --git a/swagger-specs/dataprotection/resource-manager/api-set.json b/swagger-specs/dataprotection/resource-manager/api-set.json index 775ea1cd8..630b43465 100644 --- a/swagger-specs/dataprotection/resource-manager/api-set.json +++ b/swagger-specs/dataprotection/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.DataProtection/stable/2023-11-01/dataprotection.json"], "name": "package-2023-11"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.DataProtection/stable/2024-04-01/dataprotection.json"], "name": "package-2024-04"} \ No newline at end of file diff --git a/swagger-specs/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/deploymentmanager.json b/swagger-specs/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/deploymentmanager.json deleted file mode 100644 index 2114072b8..000000000 --- a/swagger-specs/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/deploymentmanager.json +++ /dev/null @@ -1,2421 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2019-11-01-preview", - "title": "AzureDeploymentManager", - "description": "REST APIs for orchestrating deployments using the Azure Deployment Manager (ADM). See https://docs.microsoft.com/en-us/azure-resource-manager/deployment-manager-overview for more information." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}": { - "put": { - "tags": [ - "ServiceTopologies" - ], - "operationId": "ServiceTopologies_CreateOrUpdate", - "summary": "Creates or updates a service topology.", - "description": "Synchronously creates a new service topology or updates an existing service topology.", - "x-ms-examples": { - "Create a topology with Artifact Source": { - "$ref": "./examples/servicetopology_createorupdate.json" - }, - "Create a topology without Artifact Source": { - "$ref": "./examples/servicetopology_createorupdate_noartifactsource.json" - } - }, - "parameters": [ - { - "in": "body", - "name": "serviceTopologyInfo", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceTopologyResource" - }, - "description": "Source topology object defines the resource." - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "201": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceTopologyResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard Error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "ServiceTopologies" - ], - "operationId": "ServiceTopologies_Get", - "summary": "Gets the service topology.", - "x-ms-examples": { - "Get topology": { - "$ref": "./examples/servicetopology_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceTopologyResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "ServiceTopologies" - ], - "operationId": "ServiceTopologies_Delete", - "summary": "Deletes the service topology.", - "x-ms-examples": { - "Delete topology": { - "$ref": "./examples/servicetopology_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The topology was successfully deleted." - }, - "204": { - "description": "The topology was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies": { - "get": { - "tags": [ - "ServiceTopologies" - ], - "operationId": "ServiceTopologies_List", - "summary": "Lists the service topologies in the resource group.", - "x-ms-examples": { - "List topologies": { - "$ref": "./examples/servicetopologies_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceTopologiesListResult" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}": { - "put": { - "tags": [ - "Services" - ], - "operationId": "Services_CreateOrUpdate", - "summary": "Creates or updates a service in the service topology.", - "description": "Synchronously creates a new service or updates an existing service.", - "x-ms-examples": { - "Create service": { - "$ref": "./examples/service_createorupdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "serviceInfo", - "description": "The service object", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceResource" - } - } - ], - "responses": { - "201": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "Services" - ], - "operationId": "Services_Get", - "summary": "Gets the service.", - "x-ms-examples": { - "Get service": { - "$ref": "./examples/service_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Services" - ], - "operationId": "Services_Delete", - "summary": "Deletes the service.", - "x-ms-examples": { - "Delete service": { - "$ref": "./examples/service_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The service was successfully deleted." - }, - "204": { - "description": "The service was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services": { - "get": { - "tags": [ - "Services" - ], - "operationId": "Services_List", - "summary": "Lists the services in the service topology.", - "x-ms-examples": { - "List services": { - "$ref": "./examples/services_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceListResult" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}/serviceUnits/{serviceUnitName}": { - "put": { - "tags": [ - "ServiceUnits" - ], - "operationId": "ServiceUnits_CreateOrUpdate", - "x-ms-long-running-operation": true, - "summary": "Creates or updates a service unit under the service in the service topology.", - "description": "This is an asynchronous operation and can be polled to completion using the operation resource returned by this operation.", - "x-ms-examples": { - "Create service unit using relative paths into the artifact source": { - "$ref": "./examples/serviceunit_createorupdate.json" - }, - "Create service unit using SAS URIs": { - "$ref": "./examples/serviceunit_createorupdate_noartifactsource.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/serviceUnitName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "serviceUnitInfo", - "description": "The service unit resource object.", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceUnitResource" - } - } - ], - "responses": { - "201": { - "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.", - "headers": { - "Azure-AsyncOperation": { - "type": "string", - "description": "Contains the status URL on which clients are expected to poll the status of the operation." - } - }, - "schema": { - "$ref": "#/definitions/ServiceUnitResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "ServiceUnits" - ], - "operationId": "ServiceUnits_Get", - "summary": "Gets the service unit.", - "x-ms-examples": { - "Get service unit": { - "$ref": "./examples/serviceunit_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/serviceUnitName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceUnitResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "ServiceUnits" - ], - "operationId": "ServiceUnits_Delete", - "summary": "Deletes the service unit.", - "x-ms-examples": { - "Delete service unit": { - "$ref": "./examples/serviceunit_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/serviceUnitName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The service unit was successfully deleted." - }, - "204": { - "description": "The service unit was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/serviceTopologies/{serviceTopologyName}/services/{serviceName}/serviceUnits": { - "get": { - "tags": [ - "ServiceUnits" - ], - "operationId": "ServiceUnits_List", - "summary": "Lists the service units under a service in the service topology.", - "x-ms-examples": { - "List service units": { - "$ref": "./examples/serviceunits_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/serviceTopologyName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceUnitListResult" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/steps/{stepName}": { - "put": { - "tags": [ - "Steps" - ], - "operationId": "Steps_CreateOrUpdate", - "summary": "Creates or updates a rollout step with the given step properties.", - "description": "Synchronously creates a new step or updates an existing step.", - "x-ms-examples": { - "Create wait step": { - "$ref": "./examples/step_wait_createorupdate.json" - }, - "Create health check step": { - "$ref": "./examples/step_health_check_createorupdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/stepName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "stepInfo", - "description": "The step object.", - "schema": { - "$ref": "#/definitions/StepResource" - } - } - ], - "responses": { - "201": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StepResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "Steps" - ], - "operationId": "Steps_Get", - "summary": "Gets the step.", - "x-ms-examples": { - "Get deployment step": { - "$ref": "./examples/step_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/stepName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StepResource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Steps" - ], - "operationId": "Steps_Delete", - "summary": "Deletes the step.", - "x-ms-examples": { - "Delete deployment step": { - "$ref": "./examples/step_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/stepName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The step was successfully deleted." - }, - "204": { - "description": "The step was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/steps": { - "get": { - "tags": [ - "Steps" - ], - "operationId": "Steps_List", - "summary": "Lists the steps in a resource group.", - "x-ms-examples": { - "List steps": { - "$ref": "./examples/steps_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StepResourceListResult" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts/{rolloutName}": { - "put": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_CreateOrUpdate", - "x-ms-long-running-operation": true, - "summary": "Creates or updates a rollout.", - "description": "This is an asynchronous operation and can be polled to completion using the location header returned by this operation.", - "x-ms-examples": { - "Create or update rollout": { - "$ref": "./examples/rollout_createorupdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "rolloutRequest", - "description": "Source rollout request object that defines the rollout.", - "schema": { - "$ref": "#/definitions/RolloutRequest" - } - } - ], - "responses": { - "201": { - "description": "This is a long running operation. The operation returns a 201 if the request was successfully registered and basic validation is successful. The response includes an Azure-AsyncOperation header that contains the operation status URL. Clients are expected to poll the status URL for the status of the operation.", - "headers": { - "Azure-AsyncOperation": { - "type": "string", - "description": "Contains the status URL on which clients are expected to poll the status of the operation." - } - }, - "schema": { - "$ref": "#/definitions/RolloutRequest" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_Get", - "summary": "Gets detailed information of a rollout.", - "x-ms-examples": { - "Get rollout": { - "$ref": "./examples/rollout_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/retryAttempt" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Rollout" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_Delete", - "summary": "Deletes a rollout resource.", - "description": "Only rollouts in terminal state can be deleted.", - "x-ms-examples": { - "Delete rollout": { - "$ref": "./examples/rollout_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The rollout was successfully deleted." - }, - "204": { - "description": "The rollout was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts/{rolloutName}/cancel": { - "post": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_Cancel", - "summary": "Stops a running rollout.", - "description": "Only running rollouts can be canceled.", - "x-ms-examples": { - "Cancel rollout": { - "$ref": "./examples/rollout_post_cancel.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Rollout" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts/{rolloutName}/restart": { - "post": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_Restart", - "summary": "Restarts a failed rollout and optionally skips all succeeded steps.", - "description": "Only failed rollouts can be restarted.", - "x-ms-examples": { - "Restart rollout": { - "$ref": "./examples/rollout_post_restart.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/rolloutName" - }, - { - "name": "skipSucceeded", - "in": "query", - "required": false, - "type": "boolean", - "description": "If true, will skip all succeeded steps so far in the rollout. If false, will execute the entire rollout again regardless of the current state of individual resources. Defaults to false if not specified." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Rollout" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/rollouts": { - "get": { - "tags": [ - "Rollouts" - ], - "operationId": "Rollouts_List", - "summary": "Lists the rollouts in a resource group.", - "x-ms-examples": { - "List rollouts by resource group": { - "$ref": "./examples/rollouts_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RolloutListResult" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/artifactSources/{artifactSourceName}": { - "put": { - "tags": [ - "ArtifactSources" - ], - "operationId": "ArtifactSources_CreateOrUpdate", - "summary": "Creates or updates an artifact source.", - "description": "Synchronously creates a new artifact source or updates an existing artifact source.", - "x-ms-examples": { - "Create artifact source": { - "$ref": "./examples/artifactsource_createorupdate.json" - }, - "Create artifact source with artifact root, an offset into the storage container": { - "$ref": "./examples/artifactsource_createorupdate_artifactroot.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/artifactSourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "artifactSourceInfo", - "description": "Source object that defines the resource.", - "schema": { - "$ref": "#/definitions/ArtifactSource" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ArtifactSource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "ArtifactSources" - ], - "operationId": "ArtifactSources_Get", - "summary": "Gets an artifact source.", - "x-ms-examples": { - "Get artifact source": { - "$ref": "./examples/artifactsource_get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/artifactSourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ArtifactSource" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "ArtifactSources" - ], - "operationId": "ArtifactSources_Delete", - "summary": "Deletes an artifact source.", - "x-ms-examples": { - "Delete artifact source": { - "$ref": "./examples/artifactsource_delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/artifactSourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The artifact source was successfully deleted." - }, - "204": { - "description": "The artifact source was not found and the operation is considered success." - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/artifactSources": { - "get": { - "tags": [ - "ArtifactSources" - ], - "operationId": "ArtifactSources_List", - "summary": "Lists the artifact sources in a resource group.", - "x-ms-examples": { - "List steps": { - "$ref": "./examples/artifactsources_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ArtifactSourceListResult" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/providers/Microsoft.DeploymentManager/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "summary": "Lists the supported operations.", - "x-ms-examples": { - "Get operations": { - "$ref": "./examples/operations_list.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The operations are successfully returned. The response code does not determine if the request which this operation corresponds to is successful. Check the response content for the status and any error information on failures.", - "schema": { - "$ref": "#/definitions/OperationsList" - } - }, - "default": { - "description": "All non-success conditions are handled using the standard error contract.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "Identity": { - "description": "Identity for the resource.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The identity type.", - "example": "userAssigned" - }, - "identityIds": { - "type": "array", - "items": { - "type": "string", - "example": "/subscriptions/mySubId/resourcegroups/myRG/providers/Microsoft.ManagedIdentity/userassignedidentities/myIdentity" - }, - "description": "The list of identities." - } - }, - "required": [ - "type", - "identityIds" - ] - }, - "RolloutRequest": { - "description": "Defines the PUT rollout request body.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "identity": { - "description": "Identity for the resource.", - "$ref": "#/definitions/Identity" - }, - "properties": { - "description": "Defines the properties that make up a rollout request.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/RolloutRequestProperties" - } - }, - "required": [ - "identity", - "properties" - ] - }, - "RolloutRequestProperties": { - "description": "The properties for defining a rollout.", - "properties": { - "buildVersion": { - "type": "string", - "description": "The version of the build being deployed.", - "example": "1.0.0.1" - }, - "artifactSourceId": { - "type": "string", - "description": "The reference to the artifact source resource Id where the payload is located.", - "example": "Microsoft.DeploymentManager/artifactSources/payloadStore1" - }, - "targetServiceTopologyId": { - "type": "string", - "description": "The resource Id of the service topology from which service units are being referenced in step groups to be deployed.", - "example": "Microsoft.DeploymentManager/serviceTopologies/myServiceTopology" - }, - "stepGroups": { - "description": "The list of step groups that define the orchestration.", - "type": "array", - "items": { - "$ref": "#/definitions/StepGroup" - } - } - }, - "required": [ - "stepGroups", - "targetServiceTopologyId", - "buildVersion" - ] - }, - "StepGroup": { - "description": "The properties that define a Step group in a rollout.", - "properties": { - "name": { - "description": "The name of the step group.", - "type": "string" - }, - "dependsOnStepGroups": { - "description": "The list of step group names on which this step group depends on.", - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "stepGroup1", - "stepGroup2" - ] - }, - "preDeploymentSteps": { - "description": "The list of steps to be run before deploying the target.", - "type": "array", - "items": { - "$ref": "#/definitions/PrePostStep" - } - }, - "deploymentTargetId": { - "description": "The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId", - "type": "string", - "example": "Microsoft.DeploymentManager/serviceTopologies/myServiceTopology/services/myService/serviceUnits/database" - }, - "postDeploymentSteps": { - "description": "The list of steps to be run after deploying the target.", - "type": "array", - "items": { - "$ref": "#/definitions/PrePostStep" - } - } - }, - "required": [ - "deploymentTargetId", - "name" - ] - }, - "PrePostStep": { - "description": "The properties that define a step.", - "properties": { - "stepId": { - "type": "string", - "description": "The resource Id of the step to be run.", - "example": "Microsoft.DeploymentManager/steps/healthCheckStep1" - } - }, - "required": [ - "stepId" - ] - }, - "ArtifactSource": { - "description": "The resource that defines the source location where the artifacts are located.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "The properties that define the artifact source.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ArtifactSourceProperties" - } - ] - } - } - }, - "ArtifactSourceProperties": { - "description": "The properties that define the source location where the artifacts are located.", - "properties": { - "sourceType": { - "type": "string", - "description": "The type of artifact source used.", - "example": "AzureStorage" - }, - "artifactRoot": { - "type": "string", - "description": "The path from the location that the 'authentication' property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.", - "example": "binaries/2018.09.24" - }, - "authentication": { - "description": "The authentication method to use to access the artifact source.", - "$ref": "#/definitions/Authentication" - } - }, - "required": [ - "sourceType", - "authentication" - ] - }, - "Authentication": { - "description": "Defines the authentication method and properties to access the artifacts.", - "type": "object", - "discriminator": "type", - "properties": { - "type": { - "type": "string", - "description": "The authentication type" - } - }, - "required": [ - "type" - ] - }, - "SasAuthentication": { - "x-ms-discriminator-value": "Sas", - "type": "object", - "description": "Defines the properties to access the artifacts using an Azure Storage SAS URI.", - "allOf": [ - { - "$ref": "#/definitions/Authentication" - } - ], - "properties": { - "properties": { - "description": "The SAS properties", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SasProperties" - } - } - }, - "SasProperties": { - "description": "The properties that define SAS authentication.", - "properties": { - "sasUri": { - "type": "string", - "description": "The SAS URI to the Azure Storage blob container. Any offset from the root of the container to where the artifacts are located can be defined in the artifactRoot." - } - }, - "required": [ - "sasUri" - ] - }, - "Rollout": { - "description": "Defines the rollout.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "identity": { - "description": "Identity for the resource.", - "$ref": "#/definitions/Identity" - }, - "properties": { - "description": "The properties that define a rollout.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/RolloutRequestProperties" - }, - { - "$ref": "#/definitions/RolloutProperties" - } - ] - } - } - }, - "RolloutProperties": { - "description": "Defines the properties of a rollout.", - "properties": { - "status": { - "type": "string", - "readOnly": true, - "description": "The current status of the rollout." - }, - "totalRetryAttempts": { - "type": "integer", - "format": "int32", - "readOnly": true, - "description": "The cardinal count of total number of retries performed on the rollout at a given time." - }, - "operationInfo": { - "readOnly": true, - "$ref": "#/definitions/RolloutOperationInfo", - "description": "Operational information of the rollout." - }, - "services": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Service" - }, - "description": "The detailed information on the services being deployed." - } - } - }, - "RolloutOperationInfo": { - "description": "Detailed runtime information of the rollout.", - "properties": { - "retryAttempt": { - "type": "integer", - "format": "int32", - "readOnly": true, - "description": "The ordinal count of the number of retry attempts on a rollout. 0 if no retries of the rollout have been performed. If the rollout is updated with a PUT, this count is reset to 0." - }, - "skipSucceededOnRetry": { - "type": "boolean", - "readOnly": true, - "description": "True, if all steps that succeeded on the previous run/attempt were chosen to be skipped in this retry attempt. False, otherwise." - }, - "startTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The start time of the rollout in UTC." - }, - "endTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The start time of the rollout in UTC. This property will not be set if the rollout has not completed yet." - }, - "error": { - "description": "The detailed error information for any failure.", - "readOnly": true, - "$ref": "#/definitions/CloudErrorBody" - } - } - }, - "ServiceTopologyResource": { - "description": "The resource representation of a service topology.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "The properties that define the service topology.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ServiceTopologyProperties" - } - ] - } - }, - "required": [ - "properties" - ] - }, - "ServiceTopologyProperties": { - "description": "The properties of a service topology.", - "properties": { - "artifactSourceId": { - "type": "string", - "description": "The resource Id of the artifact source that contains the artifacts that can be referenced in the service units." - } - } - }, - "ServiceResource": { - "description": "The resource representation of a service in a service topology.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "The properties that define a service in a service topology.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ServiceProperties" - } - ] - } - }, - "required": [ - "properties" - ] - }, - "Service": { - "description": "Defines a service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceProperties" - } - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the service." - }, - "serviceUnits": { - "description": "The detailed information about the units that make up the service.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceUnit" - } - } - } - }, - "ServiceProperties": { - "description": "The properties of a service.", - "properties": { - "targetLocation": { - "type": "string", - "description": "The Azure location to which the resources in the service belong to or should be deployed to." - }, - "targetSubscriptionId": { - "type": "string", - "description": "The subscription to which the resources in the service belong to or should be deployed to." - } - }, - "required": [ - "targetLocation", - "targetSubscriptionId" - ] - }, - "ServiceUnitResource": { - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "description": "Represents the response of a service unit resource.", - "properties": { - "properties": { - "description": "The properties that define the service unit.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ServiceUnitProperties" - } - ] - } - }, - "required": [ - "properties" - ] - }, - "ServiceUnit": { - "description": "Defines a service unit.", - "allOf": [ - { - "$ref": "#/definitions/ServiceUnitProperties" - } - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the service unit." - }, - "steps": { - "type": "array", - "items": { - "$ref": "#/definitions/RolloutStep" - }, - "description": "Detailed step information, if present." - } - } - }, - "ServiceUnitProperties": { - "description": "Defines the properties of a service unit.", - "properties": { - "targetResourceGroup": { - "type": "string", - "description": "The Azure Resource Group to which the resources in the service unit belong to or should be deployed to." - }, - "deploymentMode": { - "type": "string", - "enum": [ - "Incremental", - "Complete" - ], - "x-ms-enum": { - "name": "DeploymentMode", - "modelAsString": false - }, - "description": "Describes the type of ARM deployment to be performed on the resource." - }, - "artifacts": { - "type": "object", - "description": "The artifacts for the service unit.", - "$ref": "#/definitions/ServiceUnitArtifacts" - } - }, - "required": [ - "targetResourceGroup", - "deploymentMode" - ] - }, - "ServiceUnitArtifacts": { - "description": "Defines the artifacts of a service unit.", - "properties": { - "templateUri": { - "type": "string", - "description": "The full URI of the ARM template file with the SAS token.", - "example": "https://teststore.blob.core.windows.net/payloadcontainer/template.json?sasUri" - }, - "parametersUri": { - "type": "string", - "description": "The full URI of the ARM parameters file with the SAS token.", - "example": "https://teststore.blob.core.windows.net/payloadcontainer/parameters.json?sasUri" - }, - "templateArtifactSourceRelativePath": { - "type": "string", - "description": "The path to the ARM template file relative to the artifact source.", - "example": "/templates/resource1.template.json" - }, - "parametersArtifactSourceRelativePath": { - "type": "string", - "description": "The path to the ARM parameters file relative to the artifact source.", - "example": "/parameters/resource1.parameters.json" - } - } - }, - "RolloutStep": { - "description": "Defines a specific step on a target service unit.", - "properties": { - "name": { - "type": "string", - "description": "Name of the step." - }, - "status": { - "type": "string", - "readOnly": true, - "description": "Current state of the step." - }, - "stepGroup": { - "type": "string", - "description": "The step group the current step is part of." - }, - "operationInfo": { - "readOnly": true, - "$ref": "#/definitions/StepOperationInfo", - "description": "Detailed information of specific action execution." - }, - "resourceOperations": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ResourceOperation" - }, - "description": "Set of resource operations that were performed, if any, on an Azure resource." - }, - "messages": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Message" - }, - "description": "Supplementary informative messages during rollout." - } - }, - "required": [ - "name" - ] - }, - "StepOperationInfo": { - "description": "Detailed information of a specific step run.", - "properties": { - "deploymentName": { - "type": "string", - "readOnly": true, - "description": "The name of the ARM deployment initiated as part of the step." - }, - "correlationId": { - "type": "string", - "readOnly": true, - "description": "Unique identifier to track the request for ARM-based resources." - }, - "startTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Start time of the action in UTC." - }, - "endTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "End time of the action in UTC." - }, - "lastUpdatedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Last time in UTC this operation was updated." - }, - "error": { - "description": "The errors, if any, for the action.", - "$ref": "#/definitions/CloudErrorBody" - } - } - }, - "ResourceOperation": { - "description": "Individual resource operation information.", - "properties": { - "resourceName": { - "type": "string", - "description": "Name of the resource as specified in the artifacts. For ARM resources, this is the name of the resource specified in the template." - }, - "operationId": { - "type": "string", - "readOnly": true, - "description": "Unique identifier of the operation. For ARM resources, this is the operationId obtained from ARM service." - }, - "resourceType": { - "type": "string", - "description": "Type of the resource as specified in the artifacts. For ARM resources, this is the type of the resource specified in the template." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "State of the resource deployment. For ARM resources, this is the current provisioning state of the resource." - }, - "statusMessage": { - "type": "string", - "readOnly": true, - "description": "Descriptive information of the resource operation." - }, - "statusCode": { - "type": "string", - "readOnly": true, - "description": "Http status code of the operation." - } - } - }, - "Message": { - "description": "Supplementary contextual messages during a rollout.", - "properties": { - "timeStamp": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Time in UTC this message was provided." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "The actual message text." - } - } - }, - "CloudError": { - "description": "The error information object.", - "x-ms-external": true, - "properties": { - "error": { - "description": "The properties that define the error.", - "$ref": "#/definitions/CloudErrorBody" - } - } - }, - "CloudErrorBody": { - "description": "Detailed error information of any failure.", - "properties": { - "code": { - "type": "string", - "readOnly": true, - "description": "Error code string." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "Descriptive error information." - }, - "target": { - "type": "string", - "description": "Error target" - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/CloudErrorBody" - }, - "description": "More detailed error information." - } - } - }, - "OperationsList": { - "description": "The operations response.", - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "The list of supported operations", - "$ref": "#/definitions/Operation" - } - } - }, - "Operation": { - "description": "Represents an operation that can be performed on the service.", - "properties": { - "name": { - "type": "string", - "description": "The name of the operation." - }, - "display": { - "description": "The display name of the operation.", - "$ref": "#/definitions/OperationDetail" - }, - "origin": { - "type": "string", - "description": "The origin of the operation." - }, - "properties": { - "description": "The properties of the operation.", - "type": "object", - "x-ms-client-flatten": true - } - } - }, - "OperationDetail": { - "description": "The detail about an operation.", - "properties": { - "provider": { - "type": "string", - "description": "The name of the provider that supports the operation." - }, - "resource": { - "type": "string", - "description": "The resource type on which this operation can be performed." - }, - "operation": { - "type": "string", - "description": "The name of the operation." - }, - "description": { - "type": "string", - "description": "The description of the operation." - } - } - }, - "StepResource": { - "description": "The resource representation of a rollout step.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "The properties that define the step.", - "$ref": "#/definitions/StepProperties" - } - }, - "required": [ - "properties" - ] - }, - "StepProperties": { - "description": "The properties of a step resource.", - "type": "object", - "discriminator": "stepType", - "properties": { - "stepType": { - "type": "string", - "description": "The type of step.", - "enum": [ - "Wait", - "HealthCheck" - ], - "x-ms-enum": { - "name": "StepType", - "modelAsString": false - } - } - }, - "required": [ - "stepType" - ] - }, - "HealthCheckStepProperties": { - "x-ms-discriminator-value": "HealthCheck", - "type": "object", - "description": "Defines the properties of a health check step.", - "allOf": [ - { - "$ref": "#/definitions/StepProperties" - } - ], - "properties": { - "attributes": { - "description": "The health check step attributes", - "$ref": "#/definitions/HealthCheckStepAttributes" - } - }, - "required": [ - "attributes" - ] - }, - "HealthCheckStepAttributes": { - "type": "object", - "description": "The attributes for the health check step.", - "discriminator": "type", - "properties": { - "type": { - "type": "string", - "description": "The type of health check.", - "example": "REST" - }, - "waitDuration": { - "type": "string", - "description": "The duration in ISO 8601 format for which health check waits idly without any checks.", - "example": "PT15M" - }, - "maxElasticDuration": { - "type": "string", - "description": "The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy.", - "example": "PT30M" - }, - "healthyStateDuration": { - "type": "string", - "description": "The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal.", - "example": "PT60M" - } - }, - "required": [ - "type", - "healthyStateDuration" - ] - }, - "RestHealthCheckStepAttributes": { - "x-ms-discriminator-value": "REST", - "type": "object", - "description": "Defines the REST health check step properties.", - "allOf": [ - { - "$ref": "#/definitions/HealthCheckStepAttributes" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "The REST health check parameters.", - "$ref": "#/definitions/RestParameters" - } - } - }, - "RestParameters": { - "type": "object", - "description": "The parameters for the REST health check.", - "properties": { - "healthChecks": { - "type": "array", - "items": { - "$ref": "#/definitions/RestHealthCheck" - }, - "description": "The list of checks that form the health check step." - } - }, - "required": [ - "healthChecks" - ] - }, - "RestHealthCheck": { - "type": "object", - "description": "A REST based health check", - "properties": { - "name": { - "type": "string", - "description": "A unique name for this check." - }, - "request": { - "description": "The request to the health provider.", - "$ref": "#/definitions/RestRequest" - }, - "response": { - "description": "The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.", - "$ref": "#/definitions/RestResponse" - } - }, - "required": [ - "name", - "request" - ] - }, - "RestRequest": { - "type": "object", - "description": "The properties that make up a REST request", - "properties": { - "method": { - "type": "string", - "description": "The HTTP method to use for the request.", - "enum": [ - "GET", - "POST" - ], - "x-ms-enum": { - "name": "RestRequestMethod", - "modelAsString": false - } - }, - "uri": { - "type": "string", - "description": "The HTTP URI to use for the request." - }, - "authentication": { - "description": "The authentication information required in the request to the health provider.", - "$ref": "#/definitions/RestRequestAuthentication" - } - }, - "required": [ - "method", - "uri", - "authentication" - ] - }, - "RestRequestAuthentication": { - "type": "object", - "description": "The authentication information required in the REST health check request to the health provider.", - "discriminator": "type", - "properties": { - "type": { - "type": "string", - "description": "The authentication type.", - "example": "ApiKey", - "enum": [ - "ApiKey", - "RolloutIdentity" - ], - "x-ms-enum": { - "name": "RestAuthType", - "modelAsString": false - } - } - }, - "required": [ - "type" - ] - }, - "RolloutIdentityAuthentication": { - "x-ms-discriminator-value": "RolloutIdentity", - "description": "RolloutIdentity uses the user-assigned managed identity authentication context specified in the Identity property during rollout creation.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/RestRequestAuthentication" - } - ] - }, - "ApiKeyAuthentication": { - "x-ms-discriminator-value": "ApiKey", - "description": "ApiKey authentication gives a name and a value that can be included in either the request header or query parameters.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/RestRequestAuthentication" - } - ], - "properties": { - "name": { - "type": "string", - "description": "The key name of the authentication key/value pair." - }, - "in": { - "type": "string", - "description": "The location of the authentication key/value pair in the request.", - "enum": [ - "Query", - "Header" - ], - "x-ms-enum": { - "name": "RestAuthLocation", - "modelAsString": false - } - }, - "value": { - "type": "string", - "description": "The value of the authentication key/value pair." - } - }, - "required": [ - "name", - "in", - "value" - ] - }, - "RestResponse": { - "type": "object", - "description": "The properties that make up the expected REST response", - "properties": { - "successStatusCodes": { - "type": "array", - "description": "The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.", - "items": { - "type": "string" - }, - "example": [ - "Ok", - "No Content" - ] - }, - "regex": { - "type": "object", - "description": "The regular expressions to match the response content with.", - "properties": { - "matches": { - "type": "array", - "description": "The list of regular expressions.", - "items": { - "type": "string" - }, - "example": [ - "Contoso-Service-EndToEnd", - "(?i)\"health_status\":((.|\n)*)\"(green|yellow)\"", - "(?mi)^(\"application_host\": 94781052)$" - ] - }, - "matchQuantifier": { - "type": "string", - "description": "Indicates whether any or all of the expressions should match with the response content.", - "enum": [ - "All", - "Any" - ], - "x-ms-enum": { - "name": "RestMatchQuantifier", - "modelAsString": false - } - } - } - } - } - }, - "WaitStepProperties": { - "x-ms-discriminator-value": "Wait", - "type": "object", - "description": "Defines the properties of a Wait step.", - "allOf": [ - { - "$ref": "#/definitions/StepProperties" - } - ], - "properties": { - "attributes": { - "description": "The Wait attributes", - "$ref": "#/definitions/WaitStepAttributes" - } - }, - "required": [ - "attributes" - ] - }, - "WaitStepAttributes": { - "type": "object", - "description": "The parameters for the wait step.", - "properties": { - "duration": { - "type": "string", - "description": "The duration in ISO 8601 format of how long the wait should be.", - "example": "PT30M" - } - }, - "required": [ - "duration" - ] - }, - "ServiceTopologiesListResult": { - "description": "The list of service topologies.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceTopologyResource" - } - }, - "ServiceListResult": { - "description": "The list of services.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceResource" - } - }, - "ServiceUnitListResult": { - "description": "The list of service units.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceUnitResource" - } - }, - "StepResourceListResult": { - "description": "The list of steps.", - "type": "array", - "items": { - "$ref": "#/definitions/StepResource" - } - }, - "ArtifactSourceListResult": { - "description": "The list of artifact sources.", - "type": "array", - "items": { - "$ref": "#/definitions/ArtifactSource" - } - }, - "RolloutListResult": { - "description": "The list of rollouts.", - "type": "array", - "items": { - "$ref": "#/definitions/Rollout" - } - } - }, - "parameters": { - "artifactSourceName": { - "description": "The name of the artifact source.", - "name": "artifactSourceName", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "serviceTopologyName": { - "name": "serviceTopologyName", - "in": "path", - "description": "The name of the service topology .", - "type": "string", - "required": true, - "x-ms-parameter-location": "method" - }, - "serviceName": { - "name": "serviceName", - "in": "path", - "description": "The name of the service resource.", - "type": "string", - "required": true, - "x-ms-parameter-location": "method" - }, - "serviceUnitName": { - "name": "serviceUnitName", - "in": "path", - "description": "The name of the service unit resource.", - "type": "string", - "required": true, - "x-ms-parameter-location": "method" - }, - "stepName": { - "name": "stepName", - "in": "path", - "description": "The name of the deployment step.", - "type": "string", - "required": true, - "x-ms-parameter-location": "method" - }, - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "type": "string", - "required": true, - "x-ms-parameter-location": "client" - }, - "resourceGroupName": { - "description": "The name of the resource group. The name is case insensitive.", - "name": "resourceGroupName", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90 - }, - "rolloutName": { - "description": "The rollout name.", - "name": "rolloutName", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "retryAttempt": { - "name": "retryAttempt", - "in": "query", - "required": false, - "type": "integer", - "description": "Rollout retry attempt ordinal to get the result of. If not specified, result of the latest attempt will be returned.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for this operation.", - "x-ms-parameter-location": "client" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } -} diff --git a/swagger-specs/deploymentmanager/resource-manager/api-set.json b/swagger-specs/deploymentmanager/resource-manager/api-set.json deleted file mode 100644 index b06820fa6..000000000 --- a/swagger-specs/deploymentmanager/resource-manager/api-set.json +++ /dev/null @@ -1 +0,0 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.DeploymentManager/preview/2019-11-01-preview/deploymentmanager.json"], "name": "package-2019-11-01-preview"} \ No newline at end of file diff --git a/swagger-specs/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2023-09-05/desktopvirtualization.json b/swagger-specs/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/desktopvirtualization.json similarity index 85% rename from swagger-specs/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2023-09-05/desktopvirtualization.json rename to swagger-specs/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/desktopvirtualization.json index 888bf3d49..638205c7c 100644 --- a/swagger-specs/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2023-09-05/desktopvirtualization.json +++ b/swagger-specs/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/desktopvirtualization.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-09-05", + "version": "2024-04-03", "title": "Desktop Virtualization API Client" }, "schemes": [ @@ -40,7 +40,7 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -76,13 +76,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/WorkspaceNameParameter" @@ -116,13 +116,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/WorkspaceNameParameter" @@ -171,13 +171,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/WorkspaceNameParameter" @@ -211,13 +211,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/WorkspaceNameParameter" @@ -262,13 +262,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/WorkspaceNameParameter" @@ -308,19 +308,19 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/parameters/PrivateEndpointConnectionName" + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { @@ -352,19 +352,19 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { @@ -396,19 +396,19 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" }, { "name": "connection", @@ -416,7 +416,7 @@ "in": "body", "required": true, "schema": { - "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" } } ], @@ -451,13 +451,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/WorkspaceNameParameter" @@ -520,13 +520,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "pageSize", @@ -585,10 +585,10 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -624,13 +624,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -664,13 +664,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -719,13 +719,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -759,13 +759,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -810,13 +810,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "pageSize", @@ -875,13 +875,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -918,13 +918,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -976,13 +976,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -1019,13 +1019,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -1073,13 +1073,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -1141,13 +1141,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -1184,13 +1184,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -1242,13 +1242,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -1285,13 +1285,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -1339,13 +1339,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ScalingPlanNameParameter" @@ -1407,10 +1407,10 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "pageSize", @@ -1469,13 +1469,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" @@ -1509,13 +1509,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" @@ -1564,13 +1564,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" @@ -1604,13 +1604,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" @@ -1655,13 +1655,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "$filter", @@ -1727,10 +1727,10 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "$filter", @@ -1773,13 +1773,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" @@ -1841,13 +1841,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" @@ -1884,13 +1884,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" @@ -1942,13 +1942,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" @@ -1985,13 +1985,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" @@ -2039,13 +2039,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" @@ -2107,13 +2107,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" @@ -2150,13 +2150,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" @@ -2204,13 +2204,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" @@ -2272,13 +2272,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -2312,13 +2312,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -2367,13 +2367,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -2414,13 +2414,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -2465,13 +2465,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "pageSize", @@ -2530,10 +2530,10 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "pageSize", @@ -2592,13 +2592,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -2661,13 +2661,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -2703,13 +2703,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -2778,13 +2778,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -2821,13 +2821,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -2871,13 +2871,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -2932,13 +2932,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3000,13 +3000,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3043,13 +3043,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3101,13 +3101,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3144,13 +3144,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3198,13 +3198,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3252,6 +3252,60 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/importAppAttachPackageInfo": { + "post": { + "tags": [ + "AppAttachPackageInfo" + ], + "operationId": "AppAttachPackageInfo_Import", + "description": "Gets information from a package given the path to the package.", + "x-ms-examples": { + "AppAttachPackageInfo_Import": { + "$ref": "./examples/AppAttachPackageInfo_Import_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "importPackageInfoRequest", + "description": "Object containing URI to package image and other optional properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImportPackageInfoRequest" + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved packages in specified Image Path.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/expandMsixImage": { "post": { "tags": [ @@ -3266,13 +3320,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3306,6 +3360,287 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}": { + "get": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_Get", + "description": "Get an app attach package.", + "x-ms-examples": { + "AppAttachPackage_Get": { + "$ref": "./examples/AppAttachPackage_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_CreateOrUpdate", + "description": "Create or update an App Attach package.", + "x-ms-examples": { + "AppAttachPackage_Create": { + "$ref": "./examples/AppAttachPackage_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + }, + { + "name": "appAttachPackage", + "description": "Object containing App Attach Package definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "201": { + "description": "Successfully created App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_Delete", + "description": "Remove an App Attach Package.", + "x-ms-examples": { + "AppAttachPackage_Delete": { + "$ref": "./examples/AppAttachPackage_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted App Attach Package." + }, + "204": { + "description": "App Attach Package does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_Update", + "description": "Update an App Attach Package", + "x-ms-examples": { + "AppAttachPackage_Update": { + "$ref": "./examples/AppAttachPackage_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + }, + { + "name": "appAttachPackagePatch", + "description": "Object containing App Attach Package definition.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/AppAttachPackagePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages": { + "get": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_ListByResourceGroup", + "description": "List App Attach packages in resource group.", + "x-ms-examples": { + "AppAttachPackage_ListByResourceGroup": { + "$ref": "./examples/AppAttachPackage_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are package name and host pool." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved App Attach Packages in resource group.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/appAttachPackages": { + "get": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_ListBySubscription", + "description": "List App Attach packages in subscription.", + "x-ms-examples": { + "AppAttachPackage_ListBySubscription": { + "$ref": "./examples/AppAttachPackage_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are package name, host pool, and resource group." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved App Attach Packages in subscription.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { "get": { "tags": [ @@ -3320,13 +3655,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3366,13 +3701,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3421,13 +3756,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3492,13 +3827,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3537,13 +3872,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3591,13 +3926,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3659,13 +3994,13 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" @@ -3728,19 +4063,19 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName" + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { @@ -3772,19 +4107,19 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { @@ -3816,19 +4151,19 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" }, { "name": "connection", @@ -3836,7 +4171,7 @@ "in": "body", "required": true, "schema": { - "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" } } ], @@ -3988,12 +4323,12 @@ "description": "Represents a Workspace definition.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ResourceModelWithAllowedPropertySet" } ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." }, "properties": { @@ -4025,12 +4360,14 @@ "description": "List of applicationGroup resource Ids.", "items": { "type": "string" - } + }, + "x-nullable": true }, "cloudPcResource": { "type": "boolean", "description": "Is cloud pc resource.", - "readOnly": true + "readOnly": true, + "x-nullable": true }, "publicNetworkAccess": { "enum": [ @@ -4043,15 +4380,16 @@ }, "type": "string", "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints", - "x-nullable": false + "x-nullable": true }, "privateEndpointConnections": { "readOnly": true, "type": "array", "items": { - "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" }, - "description": "List of private endpoint connection associated with the specified resource" + "description": "List of private endpoint connection associated with the specified resource", + "x-nullable": true } } }, @@ -4083,7 +4421,8 @@ "additionalProperties": { "type": "string" }, - "description": "tags to be updated" + "description": "tags to be updated", + "x-nullable": true }, "properties": { "description": "Detailed properties for Workspace", @@ -4109,7 +4448,8 @@ "description": "List of applicationGroup links.", "items": { "type": "string" - } + }, + "x-nullable": true }, "publicNetworkAccess": { "enum": [ @@ -4121,7 +4461,8 @@ "modelAsString": true }, "type": "string", - "description": "Enabled to allow this resource to be access from the public network" + "description": "Enabled to allow this resource to be access from the public network", + "x-nullable": true } } }, @@ -4130,7 +4471,7 @@ "description": "Represents a ApplicationGroup definition.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ResourceModelWithAllowedPropertySet" } ], "required": [ @@ -4138,7 +4479,7 @@ ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." }, "properties": { @@ -4196,7 +4537,8 @@ "cloudPcResource": { "type": "boolean", "description": "Is cloud pc resource.", - "readOnly": true + "readOnly": true, + "x-nullable": true }, "showInFeed": { "type": "boolean", @@ -4209,7 +4551,7 @@ "description": "ApplicationGroup properties that can be patched.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "properties": { @@ -4218,7 +4560,8 @@ "additionalProperties": { "type": "string" }, - "description": "tags to be updated" + "description": "tags to be updated", + "x-nullable": true }, "properties": { "description": "ApplicationGroup properties that can be patched.", @@ -4269,7 +4612,7 @@ "description": "Represents a HostPool definition.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ResourceModelWithAllowedPropertySet" } ], "required": [ @@ -4277,7 +4620,7 @@ ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." }, "properties": { @@ -4348,7 +4691,8 @@ "modelAsString": true }, "type": "string", - "description": "PersonalDesktopAssignment type for HostPool." + "description": "PersonalDesktopAssignment type for HostPool.", + "x-nullable": true }, "customRdpProperty": { "type": "string", @@ -4357,7 +4701,8 @@ "maxSessionLimit": { "type": "integer", "format": "int32", - "description": "The max session limit of HostPool." + "description": "The max session limit of HostPool.", + "x-nullable": true }, "loadBalancerType": { "enum": [ @@ -4376,15 +4721,18 @@ "ring": { "type": "integer", "format": "int32", - "description": "The ring number of HostPool." + "description": "The ring number of HostPool.", + "x-nullable": true }, "validationEnvironment": { "type": "boolean", - "description": "Is validation environment." + "description": "Is validation environment.", + "x-nullable": true }, "registrationInfo": { "$ref": "#/definitions/RegistrationInfo", - "description": "The registration info of HostPool." + "description": "The registration info of HostPool.", + "x-nullable": true }, "vmTemplate": { "type": "string", @@ -4394,6 +4742,15 @@ "readOnly": true, "type": "array", "description": "List of applicationGroup links.", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "appAttachPackageReferences": { + "readOnly": true, + "type": "array", + "description": "List of App Attach Package links.", "items": { "type": "string" } @@ -4422,7 +4779,8 @@ "modelAsString": true }, "type": "string", - "description": "The type of single sign on Secret Type." + "description": "The type of single sign on Secret Type.", + "x-nullable": true }, "preferredAppGroupType": { "enum": [ @@ -4440,12 +4798,14 @@ }, "startVMOnConnect": { "type": "boolean", - "description": "The flag to turn on/off StartVMOnConnect feature." + "description": "The flag to turn on/off StartVMOnConnect feature.", + "x-nullable": true }, "cloudPcResource": { "type": "boolean", "description": "Is cloud pc resource.", - "readOnly": true + "readOnly": true, + "x-nullable": true }, "publicNetworkAccess": { "enum": [ @@ -4460,19 +4820,21 @@ }, "type": "string", "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints", - "x-nullable": false + "x-nullable": true }, "agentUpdate": { "$ref": "#/definitions/AgentUpdateProperties", - "description": "The session host configuration for updating agent, monitoring agent, and stack component." + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "x-nullable": true }, "privateEndpointConnections": { "readOnly": true, "type": "array", "items": { - "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" }, - "description": "List of private endpoint connection associated with the specified resource" + "description": "List of private endpoint connection associated with the specified resource", + "x-nullable": true } } }, @@ -4481,7 +4843,7 @@ "description": "HostPool properties that can be patched.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "properties": { @@ -4490,7 +4852,8 @@ "additionalProperties": { "type": "string" }, - "description": "tags to be updated" + "description": "tags to be updated", + "x-nullable": true }, "properties": { "description": "HostPool properties that can be patched.", @@ -4518,7 +4881,8 @@ "maxSessionLimit": { "type": "integer", "format": "int32", - "description": "The max session limit of HostPool." + "description": "The max session limit of HostPool.", + "x-nullable": true }, "personalDesktopAssignmentType": { "enum": [ @@ -4530,7 +4894,8 @@ "modelAsString": true }, "type": "string", - "description": "PersonalDesktopAssignment type for HostPool." + "description": "PersonalDesktopAssignment type for HostPool.", + "x-nullable": true }, "loadBalancerType": { "enum": [ @@ -4548,15 +4913,18 @@ "ring": { "type": "integer", "format": "int32", - "description": "The ring number of HostPool." + "description": "The ring number of HostPool.", + "x-nullable": true }, "validationEnvironment": { "type": "boolean", - "description": "Is validation environment." + "description": "Is validation environment.", + "x-nullable": true }, "registrationInfo": { "$ref": "#/definitions/RegistrationInfoPatch", - "description": "The registration info of HostPool." + "description": "The registration info of HostPool.", + "x-nullable": true }, "vmTemplate": { "type": "string", @@ -4586,7 +4954,8 @@ "modelAsString": true }, "type": "string", - "description": "The type of single sign on Secret Type." + "description": "The type of single sign on Secret Type.", + "x-nullable": true }, "preferredAppGroupType": { "enum": [ @@ -4603,7 +4972,8 @@ }, "startVMOnConnect": { "type": "boolean", - "description": "The flag to turn on/off StartVMOnConnect feature." + "description": "The flag to turn on/off StartVMOnConnect feature.", + "x-nullable": true }, "publicNetworkAccess": { "enum": [ @@ -4617,11 +4987,13 @@ "modelAsString": true }, "type": "string", - "description": "Enabled to allow this resource to be access from the public network" + "description": "Enabled to allow this resource to be access from the public network", + "x-nullable": true }, "agentUpdate": { "$ref": "#/definitions/AgentUpdatePatchProperties", - "description": "The session host configuration for updating agent, monitoring agent, and stack component." + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "x-nullable": true } } }, @@ -4632,7 +5004,8 @@ "expirationTime": { "format": "date-time", "type": "string", - "description": "Expiration time of registration token." + "description": "Expiration time of registration token.", + "x-nullable": true }, "token": { "type": "string", @@ -4661,7 +5034,8 @@ "expirationTime": { "format": "date-time", "type": "string", - "description": "Expiration time of registration token." + "description": "Expiration time of registration token.", + "x-nullable": true }, "registrationTokenOperation": { "enum": [ @@ -4718,7 +5092,8 @@ "items": { "$ref": "#/definitions/MaintenanceWindowProperties" }, - "x-ms-identifiers": [] + "x-ms-identifiers": [], + "x-nullable": true } } }, @@ -4790,7 +5165,8 @@ "items": { "$ref": "#/definitions/MaintenanceWindowPatchProperties" }, - "x-ms-identifiers": [] + "x-ms-identifiers": [], + "x-nullable": true } } }, @@ -4860,7 +5236,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "required": [ @@ -4868,7 +5244,7 @@ ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." }, "properties": { @@ -4927,7 +5303,7 @@ }, "version": { "type": "string", - "description": "Package Version found in the appxmanifest.xml. ", + "description": "Package version found in the appxmanifest.xml. ", "x-nullable": false }, "lastUpdated": { @@ -4951,7 +5327,7 @@ "description": "MSIX Package properties that can be patched.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "properties": { @@ -5061,12 +5437,284 @@ } } }, + "AppAttachPackage": { + "description": "Schema for App Attach Package properties.", + "type": "object", + "x-ms-client-flatten": false, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackageProperties", + "x-nullable": false + } + } + }, + "AppAttachPackagePatch": { + "description": "Schema for updatable App Attach Package properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackagePatchProperties", + "x-ms-client-flatten": false, + "x-nullable": false + } + } + }, + "AppAttachPackageList": { + "type": "object", + "title": "AppAttachPackageList", + "description": "List of App Attach Package definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of App Attach Package definitions.", + "items": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "AppAttachPackageProperties": { + "description": "Schema for App Attach Package properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the App Attach Package." + }, + "image": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackageInfoProperties", + "x-nullable": false + }, + "hostPoolReferences": { + "type": "array", + "description": "List of Hostpool resource Ids.", + "items": { + "type": "string" + } + }, + "keyVaultURL": { + "type": "string", + "description": "URL path to certificate name located in keyVault" + }, + "failHealthCheckOnStagingFailure": { + "$ref": "#/definitions/FailHealthCheckOnStagingFailureEnum", + "description": "Parameter indicating how the health check should behave if this package fails staging" + } + } + }, + "AppAttachPackagePatchProperties": { + "description": "Schema for patchable fields on an App Attach Package.", + "type": "object", + "properties": { + "image": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackageInfoProperties" + }, + "hostPoolReferences": { + "type": "array", + "description": "List of Hostpool resource Ids.", + "items": { + "type": "string", + "format": "arm-id" + } + }, + "keyVaultURL": { + "type": "string", + "description": "URL path to certificate name located in keyVault" + }, + "failHealthCheckOnStagingFailure": { + "$ref": "#/definitions/FailHealthCheckOnStagingFailureEnum", + "description": "Parameter indicating how the health check should behave if this package fails staging" + } + } + }, + "AppAttachPackageInfoProperties": { + "description": "Schema for Import Package Information properties.", + "type": "object", + "properties": { + "packageAlias": { + "type": "string", + "description": "Alias of App Attach Package. Assigned at import time" + }, + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share.", + "x-nullable": false + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml. ", + "x-nullable": false + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ", + "x-nullable": false + }, + "packageFullName": { + "type": "string", + "description": "Package Full Name from appxmanifest.xml. ", + "x-nullable": false + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal. ", + "x-nullable": true + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image. ", + "x-nullable": false + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed.", + "x-nullable": false + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool. ", + "x-nullable": false + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies. ", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + }, + "x-ms-identifiers": [], + "x-nullable": true + }, + "version": { + "type": "string", + "description": "Package version found in the appxmanifest.xml. ", + "x-nullable": false + }, + "lastUpdated": { + "format": "date-time", + "type": "string", + "description": "Date Package was last updated, found in the appxmanifest.xml. ", + "x-nullable": false + }, + "packageApplications": { + "type": "array", + "description": "List of package applications. ", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-ms-identifiers": [], + "x-nullable": false + }, + "certificateName": { + "type": "string", + "description": "Certificate name found in the appxmanifest.xml. ", + "x-nullable": true + }, + "certificateExpiry": { + "format": "date-time", + "type": "string", + "description": "Date certificate expires, found in the appxmanifest.xml. ", + "x-nullable": true + }, + "isPackageTimestamped": { + "enum": [ + "Timestamped", + "NotTimestamped" + ], + "x-ms-enum": { + "name": "packageTimestamped", + "modelAsString": true + }, + "type": "string", + "description": "Is package timestamped so it can ignore the certificate expiry date", + "x-nullable": true + } + } + }, + "ImportPackageInfoRequest": { + "description": "Information to import app attach package", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "URI to Image" + }, + "packageArchitecture": { + "enum": [ + "ARM", + "ARM64", + "x86", + "x64", + "Neutral", + "x86a64", + "ALL" + ], + "x-ms-enum": { + "name": "AppAttachPackageArchitectures", + "modelAsString": true + }, + "type": "string", + "description": "Possible device architectures that an app attach package can be configured for", + "x-nullable": true + } + } + }, + "FailHealthCheckOnStagingFailureEnum": { + "enum": [ + "Unhealthy", + "NeedsAssistance", + "DoNotFail" + ], + "x-ms-enum": { + "name": "failHealthCheckOnStagingFailure", + "modelAsString": true + }, + "type": "string", + "description": "Parameter indicating how the health check should behave if this package fails staging" + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Provisioning", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, "Application": { "description": "Schema for Application properties.", "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "required": [ @@ -5074,7 +5722,7 @@ ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." }, "properties": { @@ -5215,7 +5863,8 @@ "additionalProperties": { "type": "string" }, - "description": "tags to be updated" + "description": "tags to be updated", + "x-nullable": true }, "properties": { "description": "Detailed properties for Application", @@ -5299,12 +5948,12 @@ "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." }, "properties": { @@ -5372,7 +6021,8 @@ "additionalProperties": { "type": "string" }, - "description": "tags to be updated" + "description": "tags to be updated", + "x-nullable": true }, "properties": { "description": "Detailed properties for Desktop", @@ -5427,7 +6077,7 @@ "description": "Represents a StartMenuItem definition.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "properties": { @@ -5515,7 +6165,7 @@ }, "version": { "type": "string", - "description": "Package Version found in the appxmanifest.xml. ", + "description": "Package version found in the appxmanifest.xml. ", "x-nullable": false }, "lastUpdated": { @@ -5531,6 +6181,17 @@ "$ref": "#/definitions/MsixPackageApplications" }, "x-nullable": false + }, + "certificateName": { + "type": "string", + "description": "Certificate name found in the appxmanifest.xml. ", + "x-nullable": true + }, + "certificateExpiry": { + "format": "date-time", + "type": "string", + "description": "Date certificate expires, found in the appxmanifest.xml. ", + "x-nullable": true } } }, @@ -5539,7 +6200,7 @@ "description": "Represents the definition of contents retrieved after expanding the MSIX Image. ", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "properties": { @@ -5584,12 +6245,12 @@ "description": "Represents a SessionHost definition.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." }, "properties": { @@ -5905,7 +6566,7 @@ "description": "SessionHost properties that can be patched.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "properties": { @@ -5958,12 +6619,12 @@ "description": "Represents a UserSession definition.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." }, "properties": { @@ -6053,12 +6714,12 @@ ], "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ResourceModelWithAllowedPropertySet" } ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." }, "properties": { @@ -6280,7 +6941,7 @@ "description": "ScalingPlanPooledSchedule properties that can be patched.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "properties": { @@ -6318,12 +6979,12 @@ ], "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." }, "properties": { @@ -6543,7 +7204,8 @@ "additionalProperties": { "type": "string" }, - "description": "tags to be updated" + "description": "tags to be updated", + "x-nullable": true }, "properties": { "description": "Detailed properties for scaling plan", @@ -6592,12 +7254,12 @@ "type": "object", "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" } }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" } ], "description": "The Private Endpoint Connection resource." @@ -6631,7 +7293,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "description": "A private link resource" @@ -6718,12 +7380,12 @@ ], "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." }, "properties": { @@ -7008,6 +7670,7 @@ "name": "hostPoolName", "in": "path", "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", "type": "string", "description": "The name of the host pool within the specified resource group", "maxLength": 64, @@ -7018,16 +7681,29 @@ "name": "msixPackageFullName", "in": "path", "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", "type": "string", "description": "The version specific package full name of the MSIX package within specified hostpool", "maxLength": 100, "minLength": 3, "x-ms-parameter-location": "method" }, + "AppAttachPackageNameParameter": { + "name": "appAttachPackageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the App Attach package", + "maxLength": 100, + "minLength": 3, + "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$", + "x-ms-parameter-location": "method" + }, "ApplicationGroupNameParameter": { "name": "applicationGroupName", "in": "path", "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", "type": "string", "description": "The name of the application group", "maxLength": 64, @@ -7038,6 +7714,7 @@ "name": "applicationName", "in": "path", "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", "type": "string", "description": "The name of the application within the specified application group", "maxLength": 24, @@ -7048,6 +7725,7 @@ "name": "desktopName", "in": "path", "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", "type": "string", "description": "The name of the desktop within the specified desktop group", "maxLength": 24, @@ -7058,6 +7736,7 @@ "name": "workspaceName", "in": "path", "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", "type": "string", "description": "The name of the workspace", "maxLength": 64, @@ -7068,6 +7747,7 @@ "name": "sessionHostName", "in": "path", "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", "type": "string", "description": "The name of the session host within the specified host pool", "maxLength": 48, @@ -7108,6 +7788,7 @@ "name": "scalingPlanName", "in": "path", "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", "type": "string", "description": "The name of the scaling plan.", "maxLength": 64, @@ -7118,6 +7799,7 @@ "name": "scalingPlanScheduleName", "in": "path", "required": true, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$", "type": "string", "description": "The name of the ScalingPlanSchedule", "maxLength": 64, diff --git a/swagger-specs/desktopvirtualization/resource-manager/api-set.json b/swagger-specs/desktopvirtualization/resource-manager/api-set.json index b09d49b29..82d805617 100644 --- a/swagger-specs/desktopvirtualization/resource-manager/api-set.json +++ b/swagger-specs/desktopvirtualization/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.DesktopVirtualization/stable/2023-09-05/desktopvirtualization.json"], "name": "package-2023-09"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.DesktopVirtualization/stable/2024-04-03/desktopvirtualization.json"], "name": "package-2024-04"} \ No newline at end of file diff --git a/swagger-specs/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json b/swagger-specs/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/azure.developer.signing.json similarity index 77% rename from swagger-specs/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json rename to swagger-specs/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/azure.developer.signing.json index 4be8817cb..167577681 100644 --- a/swagger-specs/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json +++ b/swagger-specs/developersigning/data-plane/Azure.Developer.Signing/preview/2023-06-15-preview/azure.developer.signing.json @@ -1,9 +1,9 @@ { "swagger": "2.0", "info": { - "title": "Azure CodeSigning", + "title": "Azure Developer Signing", "version": "2023-06-15-preview", - "description": "Azure CodeSigning is a service that provides managed code signing for all.", + "description": "Azure Developer Signing is a service that provides managed artifact signing for all.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" @@ -51,35 +51,51 @@ }, "tags": [], "paths": { - "/codesigningaccounts/{codeSigningAccountName}/certificateprofiles/{certificateProfileName}:sign": { + "/codesigningaccounts/{accountName}/certificateprofiles/{certificateProfile}:sign": { "post": { "operationId": "CertificateProfileOperations_Sign", - "summary": "Submit a codesign operation.", - "description": "Submit a codesign operation under the created codesign account and profile name provided.", + "summary": "Submit a sign operation.", + "description": "Submit a sign operation under the created account and profile name provided.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "codeSigningAccountName", + "name": "accountName", "in": "path", - "description": "Azure CodeSigning account name.", + "description": "Azure Developer Signing account name.", "required": true, "type": "string" }, { - "name": "certificateProfileName", + "name": "certificateProfile", "in": "path", - "description": "Azure Codesigning certificate profile name under a codesign account.", + "description": "Azure Developer Signing certificate profile name under an account.", "required": true, "type": "string" }, + { + "name": "client-version", + "in": "header", + "description": "An optional client version.", + "required": false, + "type": "string", + "x-ms-client-name": "clientVersion" + }, + { + "name": "x-correlation-id", + "in": "header", + "description": "An identifier used to batch multiple requests.", + "required": false, + "type": "string", + "x-ms-client-name": "xCorrelationId" + }, { "name": "body", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CodeSigningSubmissionOptions" + "$ref": "#/definitions/SigningPayloadOptions" } } ], @@ -99,11 +115,11 @@ "description": "The status of the operation" }, "error": { - "$ref": "#/definitions/Azure.Core.Foundations.Error", + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse", "description": "Error object that describes the error when status is \"Failed\"." }, "result": { - "$ref": "#/definitions/CodeSignOperationStatus", + "$ref": "#/definitions/SignResult", "description": "The result of the operation." } }, @@ -117,6 +133,10 @@ "type": "string", "format": "uri", "description": "The location for monitoring the operation state." + }, + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." } } }, @@ -141,20 +161,20 @@ "x-ms-long-running-operation": true } }, - "/codesigningaccounts/{codeSigningAccountName}/certificateprofiles/{certificateProfileName}/sign/{operationId}": { + "/codesigningaccounts/{accountName}/certificateprofiles/{certificateProfile}/sign/{operationId}": { "get": { - "operationId": "CertificateProfileOperations_GetCodeSigningStatus", - "summary": "Gets the status of a codesigning operation.", + "operationId": "CertificateProfileOperations_GetSigningStatus", + "summary": "Gets the status of a signing operation.", "description": "This status operation requires that a Sign request has been submitted and the operationId is known.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/CodeSigningOptions.codeSigningAccountName" + "$ref": "#/parameters/SigningOptions.accountName" }, { - "$ref": "#/parameters/CodeSigningOptions.certificateProfileName" + "$ref": "#/parameters/SigningOptions.certificateProfile" }, { "name": "operationId", @@ -184,7 +204,7 @@ "description": "Error object that describes the error when status is \"Failed\"." }, "result": { - "$ref": "#/definitions/CodeSignResult", + "$ref": "#/definitions/SignResult", "description": "The result of the operation." } }, @@ -209,31 +229,31 @@ }, "x-ms-examples": { "Gets the status of a codesign operation.": { - "$ref": "./examples/CertificateProfileOperations_GetCodeSigningStatus.json" + "$ref": "./examples/CertificateProfileOperations_GetSigningStatus.json" } } } }, - "/codesigningaccounts/{codeSigningAccountName}/certificateprofiles/{certificateProfileName}/sign/eku": { + "/codesigningaccounts/{accountName}/certificateprofiles/{certificateProfile}/sign/eku": { "get": { - "operationId": "CertificateProfileOperations_ListSignEkus", + "operationId": "CertificateProfileOperations_ListExtendedKeyUsages", "summary": "Gets a list of extended key usage object identifiers that are allowed for this account and profile combination.", - "description": "The list of extended key usages are used to determine the purpose of the certificate usage as part of the codesigning operation.", + "description": "The list of extended key usages are used to determine the purpose of the certificate usage as part of the signing operation.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "codeSigningAccountName", + "name": "accountName", "in": "path", - "description": "Azure CodeSigning account name.", + "description": "Azure Developer Signing account name.", "required": true, "type": "string" }, { - "name": "certificateProfileName", + "name": "certificateProfile", "in": "path", - "description": "Azure Codesigning certificate profile name under a codesign account.", + "description": "Azure Developer Signing certificate profile name under an account.", "required": true, "type": "string" } @@ -260,7 +280,7 @@ }, "x-ms-examples": { "Gets a list of extended key usage object identifiers that are allowed.": { - "$ref": "./examples/CertificateProfileOperations_ListSignEkus.json" + "$ref": "./examples/CertificateProfileOperations_ListExtendedKeyUsages.json" } }, "x-ms-pageable": { @@ -268,10 +288,10 @@ } } }, - "/codesigningaccounts/{codeSigningAccountName}/certificateprofiles/{certificateProfileName}/sign/rootcert": { + "/codesigningaccounts/{accountName}/certificateprofiles/{certificateProfile}/sign/rootcert": { "get": { "operationId": "CertificateProfileOperations_GetSignRootCertificate", - "summary": "Gets the codesigning root certificate on the certificate chain for that account and profile name.", + "summary": "Gets the signing root certificate on the certificate chain for that account and profile name.", "description": "The root certificate is generated as part of the initial account creation and it is used to sign the bits for the profile provided.", "produces": [ "application/x-x509-ca-cert", @@ -282,10 +302,10 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/CodeSigningOptions.codeSigningAccountName" + "$ref": "#/parameters/SigningOptions.accountName" }, { - "$ref": "#/parameters/CodeSigningOptions.certificateProfileName" + "$ref": "#/parameters/SigningOptions.certificateProfile" } ], "responses": { @@ -420,133 +440,18 @@ ] } }, - "CertificateProfile": { - "type": "object", - "description": "Azure CodeSigning certificate profile configured on a codesign account.", - "properties": { - "certificateProfileName": { - "type": "string", - "description": "Azure Codesigning certificate profile name under a codesign account.", - "x-ms-mutability": [ - "read", - "update" - ] - } - }, - "required": [ - "certificateProfileName" - ] - }, - "CodeSignOperationStatus": { - "type": "object", - "description": "The codesign operation status response.", - "properties": { - "id": { - "type": "string", - "description": "Unique Id of the operation." - }, - "signResult": { - "$ref": "#/definitions/CodeSignResult", - "description": "The result of the codesign operation including the signature and signing certificate." - } - }, - "required": [ - "id" - ] - }, - "CodeSignResult": { - "type": "object", - "description": "The sign status model.", - "properties": { - "operationId": { - "type": "string", - "description": "Response Id of the codesign operation." - }, - "signature": { - "type": "string", - "format": "byte", - "description": "Digital signature of the requested content digest." - }, - "signingCertificate": { - "type": "string", - "format": "byte", - "description": "Signing certificate corresponding to the private key used to codesign the requested\ndigest." - } - }, - "required": [ - "operationId" - ] - }, - "CodeSigningAccount": { - "type": "object", - "description": "Azure CodeSigning customer account created upon registration on the service.", - "properties": { - "codeSigningAccountName": { - "type": "string", - "description": "Azure CodeSigning account name.", - "x-ms-mutability": [ - "read", - "update" - ] - } - }, - "required": [ - "codeSigningAccountName" - ] - }, - "CodeSigningSubmissionOptions": { - "type": "object", - "description": "The codesign request information to be signed by the service.", - "properties": { - "signatureAlgorithm": { - "$ref": "#/definitions/SignatureAlgorithm", - "description": "The supported signature algorithm identifiers." - }, - "digest": { - "type": "string", - "format": "byte", - "description": "Content digest to codesign." - }, - "fileHashList": { - "type": "array", - "description": "List of full file digital signatures.", - "items": { - "type": "string", - "format": "byte" - } - }, - "authenticodeHashList": { - "type": "array", - "description": "List of authenticode digital signatures.", - "items": { - "type": "string", - "format": "byte" - } - } - }, - "required": [ - "signatureAlgorithm", - "digest" - ] - }, "ExtendedKeyUsage": { "type": "object", - "description": "Extended key usage object identifier that are allowed.", + "description": "Extended key usage object identifier that are allowable.", "properties": { - "ekus": { - "type": "array", - "description": "An element of ekus.", - "items": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "update" - ] + "eku": { + "type": "string", + "description": "An oid string that represents an eku.", + "readOnly": true } }, "required": [ - "ekus" + "eku" ] }, "PagedExtendedKeyUsage": { @@ -571,6 +476,22 @@ "value" ] }, + "SignResult": { + "type": "object", + "description": "The sign status model.", + "properties": { + "signature": { + "type": "string", + "format": "byte", + "description": "Digital signature of the requested content digest." + }, + "signingCertificate": { + "type": "string", + "format": "byte", + "description": "Signing certificate corresponding to the private key used to sign the requested \ndigest." + } + } + }, "SignatureAlgorithm": { "type": "string", "description": "Algorithms supported for signing.", @@ -643,23 +564,40 @@ ] } }, - "Versions": { - "type": "string", - "description": "Versions info.", - "enum": [ - "2023-06-15-preview" - ], - "x-ms-enum": { - "name": "Versions", - "modelAsString": true, - "values": [ - { - "name": "v2023_06_15_preview", - "value": "2023-06-15-preview", - "description": "The 2023-06-15-preview version." + "SigningPayloadOptions": { + "type": "object", + "description": "The artifact request information to be signed by the service.", + "properties": { + "signatureAlgorithm": { + "$ref": "#/definitions/SignatureAlgorithm", + "description": "The supported signature algorithm identifiers." + }, + "digest": { + "type": "string", + "format": "byte", + "description": "Content digest to sign." + }, + "fileHashList": { + "type": "array", + "description": "List of full file digital signatures.", + "items": { + "type": "string", + "format": "byte" } - ] - } + }, + "authenticodeHashList": { + "type": "array", + "description": "List of authenticode digital signatures.", + "items": { + "type": "string", + "format": "byte" + } + } + }, + "required": [ + "signatureAlgorithm", + "digest" + ] } }, "parameters": { @@ -673,18 +611,18 @@ "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" }, - "CodeSigningOptions.certificateProfileName": { - "name": "certificateProfileName", + "SigningOptions.accountName": { + "name": "accountName", "in": "path", - "description": "Certificate profile name.", + "description": "Signing account name.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, - "CodeSigningOptions.codeSigningAccountName": { - "name": "codeSigningAccountName", + "SigningOptions.certificateProfile": { + "name": "certificateProfile", "in": "path", - "description": "CodeSigning account name.", + "description": "Signing Certificate profile name.", "required": true, "type": "string", "x-ms-parameter-location": "method" diff --git a/swagger-specs/developersigning/data-plane/api-set.json b/swagger-specs/developersigning/data-plane/api-set.json new file mode 100644 index 000000000..323c5dd43 --- /dev/null +++ b/swagger-specs/developersigning/data-plane/api-set.json @@ -0,0 +1 @@ +{"addition_input_file_paths": [], "input_files": ["Azure.Developer.Signing/preview/2023-06-15-preview/azure.developer.signing.json"], "name": "2023-06-15-preview"} \ No newline at end of file diff --git a/swagger-specs/deviceupdate/data-plane/Microsoft.DeviceUpdate/preview/2020-09-01/deviceupdate.json b/swagger-specs/deviceupdate/data-plane/Microsoft.DeviceUpdate/preview/2020-09-01/deviceupdate.json new file mode 100644 index 000000000..8e4ff3aed --- /dev/null +++ b/swagger-specs/deviceupdate/data-plane/Microsoft.DeviceUpdate/preview/2020-09-01/deviceupdate.json @@ -0,0 +1,2681 @@ +{ + "swagger": "2.0", + "info": { + "title": "DeviceUpdateClient", + "description": "Device Update for IoT Hub is an Azure service that enables customers to publish update for their IoT devices to the cloud, and then deploy that update to their devices (approve updates to groups of devices managed and provisioned in IoT Hub). It leverages the proven security and reliability of the Windows Update platform, optimized for IoT devices. It works globally and knows when and how to update devices, enabling customers to focus on their business goals and let Device Update for IoT Hub handle the updates.", + "version": "2020-09-01" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{accountEndpoint}", + "useSchemePrefix": true, + "parameters": [ + { + "$ref": "#/parameters/AccountEndpointParameter" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth_implicit": [ + "user_impersonation" + ] + }, + { + "azure_auth_code": [ + "user_impersonation" + ] + }, + { + "azure_auth_application": [ + ".default" + ] + }, + { + "azure_auth_password": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth_implicit": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Implicit Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + }, + "azure_auth_code": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/token", + "flow": "accessCode", + "description": "Azure Active Directory OAuth2 AccessCode Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + }, + "azure_auth_application": { + "type": "oauth2", + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/token", + "flow": "application", + "description": "Azure Active Directory OAuth2 Application Flow", + "scopes": { + ".default": "client credential scope" + } + }, + "azure_auth_password": { + "type": "oauth2", + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/token", + "flow": "password", + "description": "Azure Active Directory OAuth2 Password Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/deviceupdate/{instanceId}/v2/updates": { + "post": { + "tags": [ + "Update management" + ], + "operationId": "Updates_ImportUpdate", + "x-ms-examples": { + "Updates_ImportUpdate": { + "$ref": "./examples/Updates_ImportUpdate.json" + } + }, + "description": "Import new update version.", + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/ImportActionParameter" + }, + { + "name": "updateToImport", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImportUpdateInput" + }, + "description": "The update to be imported." + } + ], + "responses": { + "202": { + "description": "Accepted update import request; background operation location to track status is specified in Operation-Location response header.", + "headers": { + "Location": { + "type": "string", + "description": "Url to retrieve the import operation status." + }, + "Operation-Location": { + "type": "string", + "description": "Url to retrieve the import operation status." + } + } + }, + "429": { + "description": "Too many requests; there is a rate limit on how many operations can be executed within a time period and there is also a limit on how many concurrent import and delete background operations can be executed.", + "x-ms-error-response": true + } + } + } + }, + "/deviceupdate/{instanceId}/v2/updates/providers/{provider}/names/{name}/versions/{version}": { + "get": { + "tags": [ + "Update management" + ], + "description": "Get a specific update version.", + "operationId": "Updates_GetUpdate", + "x-ms-examples": { + "Updates_GetUpdate": { + "$ref": "./examples/Updates_GetUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/UpdateProviderParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateVersionParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "200": { + "description": "The requested update version.", + "schema": { + "$ref": "#/definitions/Update" + } + }, + "304": { + "description": "Not modified." + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests; there is a rate limit on how many operations can be executed within a time period.", + "x-ms-error-response": true + } + } + }, + "delete": { + "tags": [ + "Update management" + ], + "description": "Delete a specific update version.", + "operationId": "Updates_DeleteUpdate", + "x-ms-examples": { + "Updates_DeleteUpdate": { + "$ref": "./examples/Updates_DeleteUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/UpdateProviderParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted update deletion request; background operation location to track status is specified in Operation-Location response header.", + "headers": { + "Location": { + "type": "string", + "description": "Url to retrieve the operation status" + }, + "Operation-Location": { + "type": "string", + "description": "Url to retrieve the operation status" + } + } + }, + "429": { + "description": "Too many requests; there is a rate limit on how many operations can be executed within a time period and there is also a limit on how many concurrent import and delete background operations can be executed.", + "x-ms-error-response": true + } + } + } + }, + "/deviceupdate/{instanceId}/v2/updates/providers": { + "get": { + "tags": [ + "Update management" + ], + "description": "Get a list of all update providers that have been imported to Device Update for IoT Hub.", + "operationId": "Updates_GetProviders", + "x-ms-examples": { + "Updates_GetProviders": { + "$ref": "./examples/Updates_GetProviders.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + } + ], + "responses": { + "200": { + "description": "All imported update providers, or empty list if there is none.", + "schema": { + "$ref": "#/definitions/PageableListOfStrings" + } + }, + "429": { + "description": "Too many requests; there is a rate limit on how many operations can be executed within a time period.", + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deviceupdate/{instanceId}/v2/updates/providers/{provider}/names": { + "get": { + "tags": [ + "Update management" + ], + "description": "Get a list of all update names that match the specified provider.", + "operationId": "Updates_GetNames", + "x-ms-examples": { + "Updates_GetNames": { + "$ref": "./examples/Updates_GetNames.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/UpdateProviderParameter" + } + ], + "responses": { + "200": { + "description": "All update names that match the specified provider, or empty list if there is none.", + "schema": { + "$ref": "#/definitions/PageableListOfStrings" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests; there is a rate limit on how many operations can be executed within a time period.", + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deviceupdate/{instanceId}/v2/updates/providers/{provider}/names/{name}/versions": { + "get": { + "tags": [ + "Update management" + ], + "description": "Get a list of all update versions that match the specified provider and name.", + "operationId": "Updates_GetVersions", + "x-ms-examples": { + "Updates_GetVersions": { + "$ref": "./examples/Updates_GetVersions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/UpdateProviderParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + } + ], + "responses": { + "200": { + "description": "All update versions that match the specified provider and name, or empty list if there is none.", + "schema": { + "$ref": "#/definitions/PageableListOfStrings" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests; there is a rate limit on how many operations can be executed within a time period.", + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deviceupdate/{instanceId}/v2/updates/providers/{provider}/names/{name}/versions/{version}/files": { + "get": { + "tags": [ + "Update management" + ], + "description": "Get a list of all update file identifiers for the specified version.", + "operationId": "Updates_GetFiles", + "x-ms-examples": { + "Updates_GetFiles": { + "$ref": "./examples/Updates_GetFiles.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/UpdateProviderParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateVersionParameter" + } + ], + "responses": { + "200": { + "description": "All update file identifiers for the specified version.", + "schema": { + "$ref": "#/definitions/PageableListOfStrings" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests; there is a rate limit on how many operations can be executed within a time period.", + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deviceupdate/{instanceId}/v2/updates/providers/{provider}/names/{name}/versions/{version}/files/{fileId}": { + "get": { + "tags": [ + "Update management" + ], + "description": "Get a specific update file from the version.", + "operationId": "Updates_GetFile", + "x-ms-examples": { + "Updates_GetFile": { + "$ref": "./examples/Updates_GetFile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/UpdateProviderParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateVersionParameter" + }, + { + "$ref": "#/parameters/FileIdParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "200": { + "description": "The requested file entity.", + "schema": { + "$ref": "#/definitions/File" + } + }, + "304": { + "description": "Not modified." + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests; there is a rate limit on how many operations can be executed within a time period.", + "x-ms-error-response": true + } + } + } + }, + "/deviceupdate/{instanceId}/v2/updates/operations": { + "get": { + "tags": [ + "Update management" + ], + "operationId": "Updates_GetOperations", + "description": "Get a list of all import update operations. Completed operations are kept for 7 days before auto-deleted. Delete operations are not returned by this API version.", + "x-ms-examples": { + "Updates_GetOperations": { + "$ref": "./examples/Updates_GetOperations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of operations returned. Only one specific filter is supported: \"status eq 'NotStarted' or status eq 'Running'\"" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + } + ], + "responses": { + "200": { + "description": "Operation details.", + "schema": { + "$ref": "#/definitions/PageableListOfOperations" + } + }, + "429": { + "description": "Too many requests; there is a rate limit on how many operations can be executed within a time period.", + "x-ms-error-response": true + } + }, + "x-ms-odata": "#/definitions/OperationFilter", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deviceupdate/{instanceId}/v2/updates/operations/{operationId}": { + "get": { + "tags": [ + "Update management" + ], + "operationId": "Updates_GetOperation", + "description": "Retrieve operation status.", + "x-ms-examples": { + "Updates_GetOperation": { + "$ref": "./examples/Updates_GetOperation.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "200": { + "description": "Operation status.", + "headers": { + "Retry-After": { + "type": "string", + "description": "Number of seconds to wait before checking the operation status again." + } + }, + "schema": { + "$ref": "#/definitions/Operation" + } + }, + "304": { + "description": "Not modified." + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests; there is a rate limit on how many operations can be executed within a time period.", + "x-ms-error-response": true + } + } + } + }, + "/deviceupdate/{instanceId}/v2/management/deviceclasses": { + "get": { + "tags": [ + "Device management" + ], + "description": "Gets a list of all device classes (unique combinations of device manufacturer and model) for all devices connected to Device Update for IoT Hub.", + "operationId": "Devices_GetAllDeviceClasses", + "x-ms-examples": { + "Devices_GetAllDeviceClasses": { + "$ref": "./examples/Devices_GetAllDeviceClasses.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + } + ], + "responses": { + "200": { + "description": "All device classes.", + "schema": { + "$ref": "#/definitions/PageableListOfDeviceClasses" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deviceupdate/{instanceId}/v2/management/deviceclasses/{deviceClassId}": { + "get": { + "tags": [ + "Device management" + ], + "description": "Gets the properties of a device class.", + "operationId": "Devices_GetDeviceClass", + "x-ms-examples": { + "Devices_GetDeviceClass": { + "$ref": "./examples/Devices_GetDeviceClass.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/DeviceClassIdParameter" + } + ], + "responses": { + "200": { + "description": "The device class properties.", + "schema": { + "$ref": "#/definitions/DeviceClass" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + } + } + }, + "/deviceupdate/{instanceId}/v2/management/deviceclasses/{deviceClassId}/deviceids": { + "get": { + "tags": [ + "Device management" + ], + "description": "Gets a list of device identifiers in a device class.", + "operationId": "Devices_GetDeviceClassDeviceIds", + "x-ms-examples": { + "Devices_GetDeviceClassDeviceIds": { + "$ref": "./examples/Devices_GetDeviceClassDeviceIds.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/DeviceClassIdParameter" + } + ], + "responses": { + "200": { + "description": "All device identifiers in the specified device class.", + "schema": { + "$ref": "#/definitions/PageableListOfStrings" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deviceupdate/{instanceId}/v2/management/deviceclasses/{deviceClassId}/installableupdates": { + "get": { + "tags": [ + "Device management" + ], + "description": "Gets a list of installable updates for a device class.", + "operationId": "Devices_GetDeviceClassInstallableUpdates", + "x-ms-examples": { + "Devices_GetDeviceClassInstallableUpdates": { + "$ref": "./examples/Devices_GetDeviceClassInstallableUpdates.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/DeviceClassIdParameter" + } + ], + "responses": { + "200": { + "description": "The installable update identifiers. Returns empty list in case of no installable updates", + "schema": { + "$ref": "#/definitions/PageableListOfUpdateIds" + } + }, + "404": { + "description": "Not found. Only returned when the deviceClassId does not exist", + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deviceupdate/{instanceId}/v2/management/devices": { + "get": { + "tags": [ + "Device management" + ], + "description": "Gets a list of devices connected to Device Update for IoT Hub.", + "operationId": "Devices_GetAllDevices", + "x-ms-examples": { + "Devices_GetAllDevices": { + "$ref": "./examples/Devices_GetAllDevices.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of devices returned. You can only filter on device GroupId." + } + ], + "responses": { + "200": { + "description": "All devices connected to Device Update for IoT Hub.", + "schema": { + "$ref": "#/definitions/PageableListOfDevices" + } + } + }, + "x-ms-odata": "#/definitions/DeviceFilter", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deviceupdate/{instanceId}/v2/management/devices/{deviceId}": { + "get": { + "tags": [ + "Device management" + ], + "description": "Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub.", + "operationId": "Devices_GetDevice", + "x-ms-examples": { + "Devices_GetDevice": { + "$ref": "./examples/Devices_GetDevice.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/DeviceIdParameter" + } + ], + "responses": { + "200": { + "description": "The device properties and latest deployment status.", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + } + } + }, + "/deviceupdate/{instanceId}/v2/management/updatecompliance": { + "get": { + "tags": [ + "Device management" + ], + "description": "Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates.", + "operationId": "Devices_GetUpdateCompliance", + "x-ms-examples": { + "Devices_GetUpdateCompliance": { + "$ref": "./examples/Devices_GetUpdateCompliance.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + } + ], + "responses": { + "200": { + "description": "The count of devices that have the latest update, have updates available, or are in progress receiving new updates.", + "schema": { + "$ref": "#/definitions/UpdateCompliance" + } + } + } + } + }, + "/deviceupdate/{instanceId}/v2/management/devicetags": { + "get": { + "tags": [ + "Device management" + ], + "description": "Gets a list of available group device tags for all devices connected to Device Update for IoT Hub.", + "operationId": "Devices_GetAllDeviceTags", + "x-ms-examples": { + "Devices_GetAllDeviceTags": { + "$ref": "./examples/Devices_GetAllDeviceTags.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + } + ], + "responses": { + "200": { + "description": "Available group device tags for all devices connected to Device Update for IoT Hub.", + "schema": { + "$ref": "#/definitions/PageableListOfDeviceTags" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deviceupdate/{instanceId}/v2/management/devicetags/{tagName}": { + "get": { + "tags": [ + "Device management" + ], + "description": "Gets a count of how many devices have a device tag.", + "operationId": "Devices_GetDeviceTag", + "x-ms-examples": { + "Devices_GetDeviceTag": { + "$ref": "./examples/Devices_GetDeviceTag.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/TagNameParameter" + } + ], + "responses": { + "200": { + "description": "The count of devices with this device tag.", + "schema": { + "$ref": "#/definitions/DeviceTag" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + } + } + }, + "/deviceupdate/{instanceId}/v2/management/groups": { + "get": { + "tags": [ + "Device management" + ], + "description": "Gets a list of all device groups.", + "operationId": "Devices_GetAllGroups", + "x-ms-examples": { + "Devices_GetAllGroups": { + "$ref": "./examples/Devices_GetAllGroups.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + } + ], + "responses": { + "200": { + "description": "The device groups.", + "schema": { + "$ref": "#/definitions/PageableListOfGroups" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deviceupdate/{instanceId}/v2/management/groups/{groupId}": { + "get": { + "tags": [ + "Device management" + ], + "description": "Gets the properties of a group.", + "operationId": "Devices_GetGroup", + "x-ms-examples": { + "Devices_GetGroup": { + "$ref": "./examples/Devices_GetGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + } + ], + "responses": { + "200": { + "description": "The group properties.", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + } + }, + "put": { + "tags": [ + "Device management" + ], + "description": "Create or update a device group.", + "operationId": "Devices_CreateOrUpdateGroup", + "x-ms-examples": { + "Devices_CreateOrUpdateGroup": { + "$ref": "./examples/Devices_CreateOrUpdateGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "name": "group", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Group" + }, + "description": "The group properties." + } + ], + "responses": { + "200": { + "description": "The group properties.", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "400": { + "description": "GroupId in query parameter and request body don't match.", + "x-ms-error-response": true + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + } + }, + "delete": { + "tags": [ + "Device management" + ], + "description": "Deletes a device group.", + "operationId": "Devices_DeleteGroup", + "x-ms-examples": { + "Devices_DeleteGroup": { + "$ref": "./examples/Devices_DeleteGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "204": { + "description": "Not found." + } + } + } + }, + "/deviceupdate/{instanceId}/v2/management/groups/{groupId}/updateCompliance": { + "get": { + "tags": [ + "Device management" + ], + "description": "Get group update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update.", + "operationId": "Devices_GetGroupUpdateCompliance", + "x-ms-examples": { + "Devices_GetGroupUpdateCompliance": { + "$ref": "./examples/Devices_GetGroupUpdateCompliance.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + } + ], + "responses": { + "200": { + "description": "The group update compliance information.", + "schema": { + "$ref": "#/definitions/UpdateCompliance" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + } + } + }, + "/deviceupdate/{instanceId}/v2/management/groups/{groupId}/bestUpdates": { + "get": { + "tags": [ + "Device management" + ], + "description": "Get the best available updates for a group and a count of how many devices need each update.", + "operationId": "Devices_GetGroupBestUpdates", + "x-ms-examples": { + "Devices_GetGroupBestUpdates": { + "$ref": "./examples/Devices_GetGroupBestUpdates.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of bestUpdates returned. You can filter on update Provider, Name and Version property." + } + ], + "responses": { + "200": { + "description": "The best available updates for a group and a count of how many devices need each update.", + "schema": { + "$ref": "#/definitions/PageableListOfUpdatableDevices" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + }, + "x-ms-odata": "#/definitions/GroupBestUpdatesFilter", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deviceupdate/{instanceId}/v2/management/deployments": { + "get": { + "tags": [ + "Deployment management" + ], + "description": "Gets a list of deployments.", + "operationId": "Deployments_GetAllDeployments", + "x-ms-examples": { + "Deployments_GetAllDeployments": { + "$ref": "./examples/Deployments_GetAllDeployments.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of deployments returned. You can filter on update Provider, Name and Version property." + } + ], + "responses": { + "200": { + "description": "The deployments.", + "schema": { + "$ref": "#/definitions/PageableListOfDeployments" + } + } + }, + "x-ms-odata": "#/definitions/DeploymentFilter", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}": { + "get": { + "tags": [ + "Deployment management" + ], + "description": "Gets the properties of a deployment.", + "operationId": "Deployments_GetDeployment", + "x-ms-examples": { + "Deployments_GetDeployment": { + "$ref": "./examples/Deployments_GetDeployment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/DeploymentIdParameter" + } + ], + "responses": { + "200": { + "description": "The deployment properties.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + } + }, + "put": { + "tags": [ + "Deployment management" + ], + "description": "Creates or updates a deployment.", + "operationId": "Deployments_CreateOrUpdateDeployment", + "x-ms-examples": { + "Deployments_CreateOrUpdateDeployment": { + "$ref": "./examples/Deployments_CreateOrUpdateDeployment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/DeploymentIdParameter" + }, + { + "name": "deployment", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "The deployment properties." + } + ], + "responses": { + "200": { + "description": "The deployment properties.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + } + }, + "delete": { + "tags": [ + "Deployment management" + ], + "description": "Deletes a deployment.", + "operationId": "Deployments_DeleteDeployment", + "x-ms-examples": { + "Deployments_DeleteDeployment": { + "$ref": "./examples/Deployments_DeleteDeployment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/DeploymentIdParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + } + } + }, + "/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}/status": { + "get": { + "tags": [ + "Deployment management" + ], + "description": "Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.", + "operationId": "Deployments_GetDeploymentStatus", + "x-ms-examples": { + "Deployments_GetDeploymentStatus": { + "$ref": "./examples/Deployments_GetDeploymentStatus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/DeploymentIdParameter" + } + ], + "responses": { + "200": { + "description": "The status of the deployment.", + "schema": { + "$ref": "#/definitions/DeploymentStatus" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + } + } + }, + "/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}/devicestates": { + "get": { + "tags": [ + "Deployment management" + ], + "description": "Gets a list of devices in a deployment along with their state. Useful for getting a list of failed devices.", + "operationId": "Deployments_GetDeploymentDevices", + "x-ms-examples": { + "Deployments_GetDeploymentDevices": { + "$ref": "./examples/Deployments_GetDeploymentDevices.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/DeploymentIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of deployment device states returned. You can filter on deviceId and/or deviceState." + } + ], + "responses": { + "200": { + "description": "The devices in the deployment along with their states.", + "schema": { + "$ref": "#/definitions/PageableListOfDeploymentDeviceStates" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + }, + "x-ms-odata": "#/definitions/DeploymentDeviceStatesFilter", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "x-ms-paths": { + "/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}?action=cancel": { + "post": { + "tags": [ + "Deployment management" + ], + "description": "Cancels a deployment.", + "operationId": "Deployments_CancelDeployment", + "x-ms-examples": { + "Deployments_CancelOrRetryDeployment": { + "$ref": "./examples/Deployments_CancelDeployment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/DeploymentIdParameter" + }, + { + "$ref": "#/parameters/DeploymentCancelActionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The deployment properties.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + } + } + }, + "/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}?action=retry": { + "post": { + "tags": [ + "Deployment management" + ], + "description": "Retries a deployment with failed devices.", + "operationId": "Deployments_RetryDeployment", + "x-ms-examples": { + "Deployments_CancelOrRetryDeployment": { + "$ref": "./examples/Deployments_RetryDeployment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/InstanceIdParameter" + }, + { + "$ref": "#/parameters/DeploymentIdParameter" + }, + { + "$ref": "#/parameters/DeploymentRetryActionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The deployment properties.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + } + } + } + } + }, + "definitions": { + "ArrayOfStrings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of strings." + }, + "PageableListOfStrings": { + "description": "The list of strings with server paging support.", + "type": "object", + "properties": { + "value": { + "description": "The collection of pageable items.", + "type": "array", + "items": { + "type": "string" + } + }, + "nextLink": { + "description": "The link to the next page of items.", + "type": "string" + } + } + }, + "ImportUpdateInput": { + "type": "object", + "properties": { + "importManifest": { + "$ref": "#/definitions/ImportManifestMetadata", + "description": "Import manifest metadata like source URL, file size/hashes, etc." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/definitions/FileImportMetadata" + }, + "minItems": 1, + "description": "One or more update file properties like filename and source URL." + } + }, + "required": [ + "importManifest", + "files" + ], + "description": "Import update input metadata." + }, + "ImportManifestMetadata": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "Azure Blob location from which the import manifest can be downloaded by Device Update for IoT Hub. This is typically a read-only SAS-protected blob URL with an expiration set to at least 4 hours." + }, + "sizeInBytes": { + "type": "integer", + "description": "File size in number of bytes.", + "format": "int64" + }, + "hashes": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A JSON object containing the hash(es) of the file. At least SHA256 hash is required. This object can be thought of as a set of key-value pairs where the key is the hash algorithm, and the value is the hash of the file calculated using that algorithm." + } + }, + "required": [ + "url", + "sizeInBytes", + "hashes" + ], + "description": "Metadata describing the import manifest, a document which describes the files and other metadata about an update version." + }, + "FileImportMetadata": { + "type": "object", + "properties": { + "filename": { + "type": "string", + "description": "Update file name as specified inside import manifest." + }, + "url": { + "type": "string", + "description": "Azure Blob location from which the update file can be downloaded by Device Update for IoT Hub. This is typically a read-only SAS-protected blob URL with an expiration set to at least 4 hours." + } + }, + "required": [ + "filename", + "url" + ], + "description": "Metadata describing an update file." + }, + "Update": { + "type": "object", + "properties": { + "updateId": { + "$ref": "#/definitions/UpdateId", + "description": "Update identity." + }, + "updateType": { + "type": "string", + "description": "Update type." + }, + "installedCriteria": { + "type": "string", + "description": "String interpreted by Device Update client to determine if the update is installed on the device." + }, + "compatibility": { + "type": "array", + "items": { + "$ref": "#/definitions/Compatibility" + }, + "minItems": 1, + "description": "List of update compatibility information." + }, + "manifestVersion": { + "type": "string", + "description": "Schema version of manifest used to import the update." + }, + "importedDateTime": { + "type": "string", + "description": "Date and time in UTC when the update was imported.", + "format": "date-time" + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time in UTC when the update was created." + }, + "etag": { + "type": "string", + "description": "Update ETag." + } + }, + "required": [ + "updateId", + "updateType", + "installedCriteria", + "compatibility", + "manifestVersion", + "importedDateTime", + "createdDateTime" + ], + "description": "Update metadata." + }, + "UpdateId": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "Update provider." + }, + "name": { + "type": "string", + "description": "Update name." + }, + "version": { + "type": "string", + "description": "Update version." + } + }, + "required": [ + "provider", + "name", + "version" + ], + "description": "Update identifier." + }, + "PageableListOfUpdateIds": { + "description": "The list of update identities.", + "type": "object", + "properties": { + "value": { + "description": "The collection of pageable items.", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateId" + } + }, + "nextLink": { + "description": "The link to the next page of items.", + "type": "string" + } + } + }, + "Compatibility": { + "type": "object", + "properties": { + "deviceManufacturer": { + "type": "string", + "description": "The manufacturer of device the update is compatible with." + }, + "deviceModel": { + "type": "string", + "description": "The model of device the update is compatible with." + } + }, + "required": [ + "deviceManufacturer", + "deviceModel" + ], + "description": "Update compatibility information." + }, + "File": { + "type": "object", + "properties": { + "fileId": { + "type": "string", + "description": "File identity, generated by server at import time." + }, + "fileName": { + "type": "string", + "description": "File name." + }, + "sizeInBytes": { + "type": "integer", + "description": "File size in number of bytes.", + "format": "int64" + }, + "hashes": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Mapping of hashing algorithm to base64 encoded hash values." + }, + "mimeType": { + "type": "string", + "description": "File MIME type." + }, + "etag": { + "type": "string", + "description": "File ETag." + } + }, + "required": [ + "fileId", + "fileName", + "sizeInBytes", + "hashes" + ], + "description": "Update file metadata." + }, + "Operation": { + "type": "object", + "properties": { + "operationId": { + "type": "string", + "description": "Operation Id." + }, + "status": { + "$ref": "#/definitions/OperationStatus", + "description": "Operation status." + }, + "updateId": { + "$ref": "#/definitions/UpdateId", + "description": "The identity of update being imported or deleted. For import, this property will only be populated after import manifest is processed successfully." + }, + "resourceLocation": { + "type": "string", + "description": "Location of the imported update when operation is successful." + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Operation error encountered, if any." + }, + "traceId": { + "type": "string", + "description": "Operation correlation identity that can used by Microsoft Support for troubleshooting." + }, + "lastActionDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time in UTC when the operation status was last updated." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time in UTC when the operation was created." + }, + "etag": { + "type": "string", + "description": "Operation ETag." + } + }, + "required": [ + "operationId", + "status", + "lastActionDateTime", + "createdDateTime" + ], + "description": "Operation metadata." + }, + "OperationStatus": { + "type": "string", + "enum": [ + "Undefined", + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": true, + "values": [ + { + "value": "Undefined", + "name": "Undefined", + "description": "Undefined operation status." + }, + { + "value": "NotStarted", + "name": "NotStarted", + "description": "Background operation created but not started yet." + }, + { + "value": "Running", + "name": "Running", + "description": "Background operation is currently running." + }, + { + "value": "Succeeded", + "name": "Succeeded", + "description": "Background operation finished with success." + }, + { + "value": "Failed", + "name": "Failed", + "description": "Background operation finished with failure." + } + ] + }, + "description": "Operation status." + }, + "Error": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Server defined error code." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/Error" + }, + "description": "An array of errors that led to the reported error." + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "An object containing more specific information than the current object about the error." + }, + "occurredDateTime": { + "type": "string", + "description": "Date and time in UTC when the error occurred.", + "format": "date-time" + } + }, + "required": [ + "code", + "message" + ], + "description": "Error details." + }, + "InnerError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "A more specific error code than what was provided by the containing error." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "errorDetail": { + "type": "string", + "description": "The internal error or exception message." + }, + "innerError": { + "$ref": "#/definitions/InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code" + ], + "description": "An object containing more specific information than the current object about the error." + }, + "PageableListOfOperations": { + "description": "The list of operations with server paging support.", + "type": "object", + "properties": { + "value": { + "description": "The collection of pageable items.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "The link to the next page of items.", + "type": "string" + } + } + }, + "DeviceClass": { + "type": "object", + "properties": { + "deviceClassId": { + "type": "string", + "description": "The device class identifier." + }, + "manufacturer": { + "type": "string", + "description": "Device manufacturer" + }, + "model": { + "type": "string", + "description": "Device model." + }, + "bestCompatibleUpdateId": { + "$ref": "#/definitions/UpdateId", + "x-nullable": true, + "description": "Update identity." + } + }, + "required": [ + "deviceClassId", + "manufacturer", + "model", + "bestCompatibleUpdateId" + ], + "description": "Device class metadata." + }, + "PageableListOfDeviceClasses": { + "description": "The list of device classes.", + "type": "object", + "properties": { + "value": { + "description": "The collection of pageable items.", + "type": "array", + "items": { + "$ref": "#/definitions/DeviceClass" + } + }, + "nextLink": { + "description": "The link to the next page of items.", + "type": "string" + } + } + }, + "Device": { + "type": "object", + "properties": { + "deviceId": { + "type": "string", + "description": "Device identity." + }, + "deviceClassId": { + "type": "string", + "description": "Device class identity." + }, + "manufacturer": { + "type": "string", + "description": "Device manufacturer." + }, + "model": { + "type": "string", + "description": "Device model." + }, + "groupId": { + "type": "string", + "description": "Device group identity." + }, + "lastAttemptedUpdateId": { + "$ref": "#/definitions/UpdateId", + "x-nullable": true, + "description": "Update identity." + }, + "deploymentStatus": { + "$ref": "#/definitions/DeviceDeploymentState", + "description": "State of the device in its last deployment." + }, + "installedUpdateId": { + "$ref": "#/definitions/UpdateId", + "x-nullable": true, + "description": "Update identity." + }, + "onLatestUpdate": { + "type": "boolean", + "description": "Boolean flag indicating whether the latest update is installed on the device" + }, + "lastDeploymentId": { + "type": "string", + "description": "The deployment identifier for the last deployment to the device" + } + }, + "required": [ + "deviceId", + "deviceClassId", + "manufacturer", + "model", + "onLatestUpdate" + ], + "description": "Device metadata." + }, + "DeviceDeploymentState": { + "type": "string", + "enum": [ + "Succeeded", + "InProgress", + "Failed", + "Canceled", + "Incompatible" + ], + "x-ms-enum": { + "name": "DeviceDeploymentState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded", + "name": "Succeeded", + "description": "Deployment has completed with success." + }, + { + "value": "InProgress", + "name": "InProgress", + "description": "Deployment is in progress." + }, + { + "value": "Failed", + "name": "Failed", + "description": "Deployment has completed with failure." + }, + { + "value": "Canceled", + "name": "Canceled", + "description": "Deployment was canceled." + }, + { + "value": "Incompatible", + "name": "Incompatible", + "description": "Deployment is not compatible with the device." + } + ] + }, + "description": "Deployment state." + }, + "DeviceFilter": { + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "Device group identifier." + } + }, + "description": "Operation status filter." + }, + "PageableListOfDevices": { + "description": "The list of devices.", + "type": "object", + "properties": { + "value": { + "description": "The collection of pageable items.", + "type": "array", + "items": { + "$ref": "#/definitions/Device" + } + }, + "nextLink": { + "description": "The link to the next page of items.", + "type": "string" + } + } + }, + "UpdateCompliance": { + "type": "object", + "properties": { + "totalDeviceCount": { + "type": "integer", + "description": "Total number of devices." + }, + "onLatestUpdateDeviceCount": { + "type": "integer", + "description": "Number of devices on the latest update." + }, + "newUpdatesAvailableDeviceCount": { + "type": "integer", + "description": "Number of devices with a newer update available." + }, + "updatesInProgressDeviceCount": { + "type": "integer", + "description": "Number of devices with update in-progress." + } + }, + "required": [ + "totalDeviceCount", + "onLatestUpdateDeviceCount", + "newUpdatesAvailableDeviceCount", + "updatesInProgressDeviceCount" + ], + "description": "Update compliance information." + }, + "UpdatableDevices": { + "type": "object", + "properties": { + "updateId": { + "$ref": "#/definitions/UpdateId", + "description": "Update identity." + }, + "deviceCount": { + "type": "integer", + "description": "Total number of devices for which the update is applicable." + } + }, + "required": [ + "updateId", + "deviceCount" + ], + "description": "Update identifier and the number of devices for which the update is applicable." + }, + "PageableListOfUpdatableDevices": { + "description": "The list of updatable devices.", + "type": "object", + "properties": { + "value": { + "description": "The collection of pageable items.", + "type": "array", + "items": { + "$ref": "#/definitions/UpdatableDevices" + } + }, + "nextLink": { + "description": "The link to the next page of items.", + "type": "string" + } + } + }, + "DeviceTag": { + "type": "object", + "properties": { + "tagName": { + "type": "string", + "description": "Tag name." + }, + "deviceCount": { + "type": "integer", + "description": "Number of devices with this tag." + } + }, + "required": [ + "tagName", + "deviceCount" + ], + "description": "Device tag properties." + }, + "PageableListOfDeviceTags": { + "description": "The list of device tags.", + "type": "object", + "properties": { + "value": { + "description": "The collection of pageable items.", + "type": "array", + "items": { + "$ref": "#/definitions/DeviceTag" + } + }, + "nextLink": { + "description": "The link to the next page of items.", + "type": "string" + } + } + }, + "Group": { + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "Group identity." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Group type." + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "IoT Hub tags." + }, + "createdDateTime": { + "type": "string", + "description": "Date and time when the update was created." + }, + "deviceCount": { + "type": "integer", + "description": "The number of devices in the group." + } + }, + "required": [ + "groupId", + "groupType", + "tags", + "createdDateTime" + ], + "description": "Group details." + }, + "GroupType": { + "type": "string", + "enum": [ + "IoTHubTag" + ], + "x-ms-enum": { + "name": "GroupType", + "modelAsString": true, + "values": [ + { + "value": "IoTHubTag", + "name": "IoTHubTag", + "description": "IoT Hub tag based group." + } + ] + }, + "description": "Supported group types." + }, + "PageableListOfGroups": { + "description": "The list of groups.", + "type": "object", + "properties": { + "value": { + "description": "The collection of pageable items.", + "type": "array", + "items": { + "$ref": "#/definitions/Group" + } + }, + "nextLink": { + "description": "The link to the next page of items.", + "type": "string" + } + } + }, + "Deployment": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Gets or sets the deployment identifier." + }, + "deploymentType": { + "$ref": "#/definitions/DeploymentType", + "description": "Gets or sets the deployment type." + }, + "deviceClassId": { + "type": "string", + "description": "Gets or sets the device class identifier." + }, + "startDateTime": { + "type": "string", + "description": "Gets or sets the Deployment start datetime.", + "format": "date-time" + }, + "deviceGroupType": { + "$ref": "#/definitions/DeviceGroupType", + "description": "Gets or sets the device group type." + }, + "deviceGroupDefinition": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the device group definition." + }, + "updateId": { + "$ref": "#/definitions/UpdateId", + "description": "Update identity." + }, + "isCanceled": { + "type": "boolean", + "description": "Boolean flag indicating whether the deployment was canceled." + }, + "isRetried": { + "type": "boolean", + "description": "Boolean flag indicating whether the deployment has been retried." + }, + "isCompleted": { + "type": "boolean", + "description": "Boolean flag indicating whether the deployment was completed." + } + }, + "required": [ + "deploymentId", + "deploymentType", + "startDateTime", + "deviceGroupType", + "deviceGroupDefinition", + "updateId" + ], + "description": "Deployment metadata." + }, + "DeploymentType": { + "type": "string", + "enum": [ + "Complete", + "Download", + "Install" + ], + "x-ms-enum": { + "name": "DeploymentType", + "modelAsString": true, + "values": [ + { + "value": "Complete", + "name": "Complete", + "description": "A complete deployment including download, install, and apply actions." + }, + { + "value": "Download", + "name": "Download", + "description": "A download-only deployment that does not include any install or apply actions. Not currently supported." + }, + { + "value": "Install", + "name": "Install", + "description": "An install-only rollout that does not include any download actions, only install and complete. Not currently supported." + } + ] + }, + "description": "Supported deployment types." + }, + "DeviceGroupType": { + "type": "string", + "enum": [ + "All", + "Devices", + "DeviceGroupDefinitions" + ], + "x-ms-enum": { + "name": "DeviceGroupType", + "modelAsString": true, + "values": [ + { + "value": "All", + "name": "All", + "description": "The deployment should be sent to all devices in the device class." + }, + { + "value": "Devices", + "name": "Devices", + "description": "The deployment should be sent to the list of devices in the device group definition." + }, + { + "value": "DeviceGroupDefinitions", + "name": "DeviceGroupDefinitions", + "description": "The deployment should be sent to the list of devices returned by the union of all the device group definition queries." + } + ] + }, + "description": "Supported deployment group types." + }, + "PageableListOfDeployments": { + "description": "The list of deployments.", + "type": "object", + "properties": { + "value": { + "description": "The collection of pageable items.", + "type": "array", + "items": { + "$ref": "#/definitions/Deployment" + } + }, + "nextLink": { + "description": "The link to the next page of items.", + "type": "string" + } + } + }, + "DeploymentStatus": { + "type": "object", + "properties": { + "deploymentState": { + "$ref": "#/definitions/DeploymentState", + "description": "Gets or sets the state of the deployment." + }, + "totalDevices": { + "type": "integer", + "description": "Gets or sets the total number of devices in the deployment.", + "format": "int32" + }, + "devicesIncompatibleCount": { + "type": "integer", + "description": "Gets or sets the number of incompatible devices in the deployment.", + "format": "int32" + }, + "devicesInProgressCount": { + "type": "integer", + "description": "Gets or sets the number of devices that are currently in deployment.", + "format": "int32" + }, + "devicesCompletedFailedCount": { + "type": "integer", + "description": "Gets or sets the number of devices that have completed deployment with a failure.", + "format": "int32" + }, + "devicesCompletedSucceededCount": { + "type": "integer", + "description": "Gets or sets the number of devices which have successfully completed deployment.", + "format": "int32" + }, + "devicesCanceledCount": { + "type": "integer", + "description": "Gets or sets the number of devices which have had their deployment canceled.", + "format": "int32" + } + }, + "required": [ + "deploymentState" + ], + "description": "Deployment status metadata." + }, + "DeploymentState": { + "type": "string", + "enum": [ + "Active", + "Superseded", + "Canceled" + ], + "x-ms-enum": { + "name": "DeploymentState", + "modelAsString": true, + "values": [ + { + "value": "Active", + "name": "Active", + "description": "The deployment can be sent to devices targeted in the deployment." + }, + { + "value": "Superseded", + "name": "Superseded", + "description": "A newer deployment with the same targeting exists and no devices will receive this deployment." + }, + { + "value": "Canceled", + "name": "Canceled", + "description": "The deployment has been canceled and no devices will receive it." + } + ] + }, + "description": "Deployment state." + }, + "DeploymentDeviceState": { + "type": "object", + "properties": { + "deviceId": { + "type": "string", + "description": "Device identity." + }, + "retryCount": { + "type": "integer", + "description": "The number of times this deployment has been retried on this device.", + "format": "int32" + }, + "movedOnToNewDeployment": { + "type": "boolean", + "description": "Boolean flag indicating whether this device is in a newer deployment and can no longer retry this deployment." + }, + "deviceState": { + "$ref": "#/definitions/DeviceDeploymentState", + "description": "Deployment device state." + } + }, + "required": [ + "deviceId", + "retryCount", + "movedOnToNewDeployment", + "deviceState" + ], + "description": "Deployment device status." + }, + "PageableListOfDeploymentDeviceStates": { + "description": "The list of deployment device states.", + "type": "object", + "properties": { + "value": { + "description": "The collection of pageable items.", + "type": "array", + "items": { + "$ref": "#/definitions/DeploymentDeviceState" + } + }, + "nextLink": { + "description": "The link to the next page of items.", + "type": "string" + } + } + }, + "OperationFilterStatus": { + "type": "string", + "enum": [ + "Running", + "NotStarted" + ], + "x-ms-enum": { + "name": "OperationFilterStatus", + "modelAsString": true + }, + "description": "Operation status filter." + }, + "OperationFilter": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/OperationFilterStatus", + "description": "Operation status filter." + } + }, + "description": "Operation status filter." + }, + "DeploymentFilter": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "Update provider." + }, + "name": { + "type": "string", + "description": "Update name." + }, + "version": { + "type": "string", + "description": "Update version." + } + }, + "description": "Deployment filter." + }, + "GroupBestUpdatesFilter": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "Update provider." + }, + "name": { + "type": "string", + "description": "Update name." + }, + "version": { + "type": "string", + "description": "Update version." + } + }, + "description": "Group best updates filter." + }, + "DeploymentDeviceStatesFilter": { + "type": "object", + "properties": { + "deviceId": { + "type": "string", + "description": "Device Identifier." + }, + "deviceState": { + "$ref": "#/definitions/DeviceState", + "description": "The deployment device state." + } + }, + "description": "Deployment device state filter." + }, + "DeviceState": { + "type": "string", + "description": "The deployment device state.", + "enum": [ + "NotStarted", + "Incompatible", + "AlreadyInDeployment", + "Canceled", + "InProgress", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "DeviceState", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "name": "NotStarted", + "description": "Not started (or uninitialized)" + }, + { + "value": "Incompatible", + "name": "Incompatible", + "description": "Deployment incompatible for this device." + }, + { + "value": "AlreadyInDeployment", + "name": "AlreadyInDeployment", + "description": "Another Deployment is underway for this device." + }, + { + "value": "Canceled", + "name": "Canceled", + "description": "Deployment has been canceled for this device." + }, + { + "value": "InProgress", + "name": "InProgress", + "description": "Deployment underway." + }, + { + "value": "Failed", + "name": "Failed", + "description": "Deployment failed." + }, + { + "value": "Succeeded", + "name": "Succeeded", + "description": "Deployment completed successfully." + } + ] + } + } + }, + "parameters": { + "AccountEndpointParameter": { + "name": "accountEndpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "Account endpoint.", + "x-ms-parameter-location": "client", + "x-ms-parameter-grouping": { + "name": "account-options" + } + }, + "InstanceIdParameter": { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "Account instance identifier.", + "x-ms-parameter-location": "client", + "x-ms-parameter-grouping": { + "name": "account-options" + } + }, + "UpdateProviderParameter": { + "name": "provider", + "in": "path", + "required": true, + "type": "string", + "description": "Update provider.", + "x-ms-parameter-location": "method" + }, + "UpdateNameParameter": { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Update name.", + "x-ms-parameter-location": "method" + }, + "UpdateVersionParameter": { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "Update version.", + "x-ms-parameter-location": "method" + }, + "FileIdParameter": { + "name": "fileId", + "in": "path", + "required": true, + "type": "string", + "description": "File identifier.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "description": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "type": "string", + "x-ms-parameter-grouping": { + "name": "access-condition" + }, + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "description": "Operation identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ImportActionParameter": { + "name": "action", + "in": "query", + "required": true, + "description": "Import update action.", + "type": "string", + "enum": [ + "import" + ], + "x-ms-enum": { + "name": "ImportAction", + "values": [ + { + "value": "import", + "name": "import", + "description": "Import action." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "DeviceIdParameter": { + "name": "deviceId", + "in": "path", + "description": "Device identifier in Azure IOT Hub.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DeviceClassIdParameter": { + "name": "deviceClassId", + "in": "path", + "description": "Device class identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "TagNameParameter": { + "name": "tagName", + "in": "path", + "description": "Tag name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "GroupIdParameter": { + "name": "groupId", + "in": "path", + "description": "Group identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DeploymentIdParameter": { + "name": "deploymentId", + "in": "path", + "description": "Deployment identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DeploymentCancelActionQueryParameter": { + "name": "action", + "in": "query", + "required": true, + "description": "Cancel deployment action.", + "type": "string", + "enum": [ + "cancel" + ], + "x-ms-enum": { + "name": "DeploymentCancelAction", + "values": [ + { + "value": "cancel", + "name": "cancel", + "description": "Cancel action." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "DeploymentRetryActionQueryParameter": { + "name": "action", + "in": "query", + "required": true, + "description": "Retry deployment action.", + "type": "string", + "enum": [ + "retry" + ], + "x-ms-enum": { + "name": "DeploymentRetryAction", + "values": [ + { + "value": "retry", + "name": "retry", + "description": "Retry action." + } + ] + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/deviceupdate/data-plane/Microsoft.DeviceUpdate/stable/2022-10-01/deviceupdate.json b/swagger-specs/deviceupdate/data-plane/Microsoft.DeviceUpdate/stable/2022-10-01/deviceupdate.json deleted file mode 100644 index 5368b0f21..000000000 --- a/swagger-specs/deviceupdate/data-plane/Microsoft.DeviceUpdate/stable/2022-10-01/deviceupdate.json +++ /dev/null @@ -1,4458 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "DeviceUpdateClient", - "description": "Device Update for IoT Hub is an Azure service that enables customers to publish updates for their IoT devices to the cloud, and then deploy that update to their devices (approve updates to groups of devices managed and provisioned in IoT Hub). It leverages the proven security and reliability of the Windows Update platform, optimized for IoT devices. It works globally and knows when and how to update devices, enabling customers to focus on their business goals and let Device Update for IoT Hub handle the updates.", - "version": "2022-10-01" - }, - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": true, - "parameters": [ - { - "$ref": "#/parameters/EndpointParameter" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "https://api.adu.microsoft.com/.default" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "https://api.adu.microsoft.com/.default": "Default authorization scope." - } - } - }, - "paths": { - "/deviceUpdate/{instanceId}/updates": { - "get": { - "tags": [ - "Update management" - ], - "description": "Get a list of all updates that have been imported to Device Update for IoT Hub.", - "operationId": "DeviceUpdate_ListUpdates", - "x-ms-examples": { - "DeviceUpdate_ListUpdates": { - "$ref": "./examples/DeviceUpdate_ListUpdates.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "search", - "in": "query", - "required": false, - "type": "string", - "description": "Request updates matching a free-text search expression." - }, - { - "name": "filter", - "in": "query", - "required": false, - "type": "string", - "description": "Optional to filter updates by isDeployable property." - } - ], - "responses": { - "200": { - "description": "All imported updates, or empty list if there is none.", - "schema": { - "$ref": "#/definitions/UpdateList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-odata": "#/definitions/UpdateFilter", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/updates:import": { - "post": { - "tags": [ - "Update management" - ], - "operationId": "DeviceUpdate_ImportUpdate", - "x-ms-long-running-operation": true, - "x-ms-examples": { - "DeviceUpdate_ImportUpdate": { - "$ref": "./examples/DeviceUpdate_ImportUpdate.json" - } - }, - "description": "Import new update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.", - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "updateToImport", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ImportUpdateInput" - }, - "description": "The update to be imported (see schema https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json for details)." - } - ], - "responses": { - "202": { - "description": "Accepted update import request; background operation location to track status is specified in Operation-Location response header.", - "headers": { - "Operation-Location": { - "type": "string", - "description": "Url to retrieve the import operation status." - } - } - }, - "200": { - "description": "The requested update version.", - "schema": { - "$ref": "#/definitions/Update" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}": { - "get": { - "tags": [ - "Update management" - ], - "description": "Get a specific update version.", - "operationId": "DeviceUpdate_GetUpdate", - "x-ms-examples": { - "DeviceUpdate_GetUpdate": { - "$ref": "./examples/DeviceUpdate_GetUpdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/UpdateProviderParameter" - }, - { - "$ref": "#/parameters/UpdateNameParameter" - }, - { - "$ref": "#/parameters/UpdateVersionParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/IfNoneMatchParameter" - } - ], - "responses": { - "200": { - "description": "The requested update version.", - "schema": { - "$ref": "#/definitions/Update" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Update management" - ], - "description": "Delete a specific update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.", - "operationId": "DeviceUpdate_DeleteUpdate", - "x-ms-long-running-operation": true, - "x-ms-examples": { - "DeviceUpdate_DeleteUpdate": { - "$ref": "./examples/DeviceUpdate_DeleteUpdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/UpdateProviderParameter" - }, - { - "$ref": "#/parameters/UpdateNameParameter" - }, - { - "$ref": "#/parameters/UpdateVersionParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Accepted update deletion request; background operation location to track status is specified in Operation-Location response header.", - "headers": { - "Operation-Location": { - "type": "string", - "description": "Url to retrieve the operation status" - } - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/updates/providers": { - "get": { - "tags": [ - "Update management" - ], - "description": "Get a list of all update providers that have been imported to Device Update for IoT Hub.", - "operationId": "DeviceUpdate_ListProviders", - "x-ms-examples": { - "DeviceUpdate_ListProviders": { - "$ref": "./examples/DeviceUpdate_ListProviders.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "All imported update providers, or empty list if there is none.", - "schema": { - "$ref": "#/definitions/StringsList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/updates/providers/{provider}/names": { - "get": { - "tags": [ - "Update management" - ], - "description": "Get a list of all update names that match the specified provider.", - "operationId": "DeviceUpdate_ListNames", - "x-ms-examples": { - "DeviceUpdate_ListNames": { - "$ref": "./examples/DeviceUpdate_ListNames.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/UpdateProviderParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "All update names that match the specified provider, or empty list if there is none.", - "schema": { - "$ref": "#/definitions/StringsList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions": { - "get": { - "tags": [ - "Update management" - ], - "description": "Get a list of all update versions that match the specified provider and name.", - "operationId": "DeviceUpdate_ListVersions", - "x-ms-examples": { - "DeviceUpdate_ListVersions": { - "$ref": "./examples/DeviceUpdate_ListVersions.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/UpdateProviderParameter" - }, - { - "$ref": "#/parameters/UpdateNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "filter", - "in": "query", - "required": false, - "type": "string", - "description": "Optional to filter updates by isDeployable property." - } - ], - "responses": { - "200": { - "description": "All update versions that match the specified provider and name, or empty list if there is none.", - "schema": { - "$ref": "#/definitions/StringsList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-odata": "#/definitions/UpdateFilter", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}/files": { - "get": { - "tags": [ - "Update management" - ], - "description": "Get a list of all update file identifiers for the specified version.", - "operationId": "DeviceUpdate_ListFiles", - "x-ms-examples": { - "DeviceUpdate_ListFiles": { - "$ref": "./examples/DeviceUpdate_ListFiles.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/UpdateProviderParameter" - }, - { - "$ref": "#/parameters/UpdateNameParameter" - }, - { - "$ref": "#/parameters/UpdateVersionParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "All update file identifiers for the specified version.", - "schema": { - "$ref": "#/definitions/StringsList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}/files/{fileId}": { - "get": { - "tags": [ - "Update management" - ], - "description": "Get a specific update file from the version.", - "operationId": "DeviceUpdate_GetFile", - "x-ms-examples": { - "DeviceUpdate_GetFile": { - "$ref": "./examples/DeviceUpdate_GetFile.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/UpdateProviderParameter" - }, - { - "$ref": "#/parameters/UpdateNameParameter" - }, - { - "$ref": "#/parameters/UpdateVersionParameter" - }, - { - "$ref": "#/parameters/FileIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/IfNoneMatchParameter" - } - ], - "responses": { - "200": { - "description": "The requested file entity.", - "schema": { - "$ref": "#/definitions/UpdateFile" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/updates/operations": { - "get": { - "tags": [ - "Update management" - ], - "operationId": "DeviceUpdate_ListOperationStatuses", - "description": "Get a list of all import update operations. Completed operations are kept for 7 days before auto-deleted. Delete operations are not returned by this API version.", - "x-ms-examples": { - "DeviceUpdate_ListOperationStatuses": { - "$ref": "./examples/DeviceUpdate_ListOperationStatuses.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "name": "filter", - "in": "query", - "required": false, - "type": "string", - "description": "Optional to filter operations by status property. Only one specific filter is supported: \"status eq 'NotStarted' or status eq 'Running'\"" - }, - { - "name": "top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Operation details.", - "schema": { - "$ref": "#/definitions/UpdateOperationsList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-odata": "#/definitions/OperationFilter", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/updates/operations/{operationId}": { - "get": { - "tags": [ - "Update management" - ], - "operationId": "DeviceUpdate_GetOperationStatus", - "description": "Retrieve operation status.", - "x-ms-examples": { - "DeviceUpdate_GetOperationStatus": { - "$ref": "./examples/DeviceUpdate_GetOperationStatus.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/OperationIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/IfNoneMatchParameter" - } - ], - "responses": { - "200": { - "description": "Operation status.", - "headers": { - "Retry-After": { - "type": "string", - "description": "Number of seconds to wait before checking the operation status again." - } - }, - "schema": { - "$ref": "#/definitions/UpdateOperation" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/deviceClasses": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets a list of all device classes (sets of devices compatible with the same updates based on the model Id and compat properties reported in the Device Update PnP interface in IoT Hub) for all devices connected to Device Update for IoT Hub.", - "operationId": "DeviceManagement_ListDeviceClasses", - "x-ms-examples": { - "DeviceManagement_ListDeviceClasses": { - "$ref": "./examples/DeviceManagement_ListDeviceClasses.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "filter", - "in": "query", - "required": false, - "type": "string", - "description": "Restricts the set of device classes returned. You can filter on friendly name." - } - ], - "responses": { - "200": { - "description": "All device classes.", - "schema": { - "$ref": "#/definitions/DeviceClassesList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-odata": "#/definitions/DeviceClassFilter", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/management/deviceClasses/{deviceClassId}": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets the properties of a device class.", - "operationId": "DeviceManagement_GetDeviceClass", - "x-ms-examples": { - "DeviceManagement_GetDeviceClass": { - "$ref": "./examples/DeviceManagement_GetDeviceClass.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The device class properties.", - "schema": { - "$ref": "#/definitions/DeviceClass" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Device and deployment management" - ], - "description": "Update device class details.", - "operationId": "DeviceManagement_UpdateDeviceClass", - "consumes": [ - "application/merge-patch+json" - ], - "x-ms-examples": { - "DeviceManagement_UpdateDeviceClass": { - "$ref": "./examples/DeviceManagement_UpdateDeviceClass.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "deviceClassPatch", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PatchBody" - }, - "description": "The device class json merge patch body. Currently only supports patching friendlyName." - } - ], - "responses": { - "200": { - "description": "The updated device class subgroup details.", - "schema": { - "$ref": "#/definitions/DeviceClass" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Device and deployment management" - ], - "description": "Deletes a device class. Device classes are created automatically when Device Update-enabled devices are connected to the hub but are not automatically cleaned up since they are referenced by DeviceClassSubgroups. If the user has deleted all DeviceClassSubgroups for a device class they can also delete the device class to remove the records from the system and to stop checking the compatibility of this device class with new updates. If a device is ever reconnected for this device class it will be re-created.", - "operationId": "DeviceManagement_DeleteDeviceClass", - "x-ms-examples": { - "DeviceManagement_DeleteDeviceClass": { - "$ref": "./examples/DeviceManagement_DeleteDeviceClass.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/deviceClasses/{deviceClassId}/installableUpdates": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets a list of installable updates for a device class.", - "operationId": "DeviceManagement_ListInstallableUpdatesForDeviceClass", - "x-ms-examples": { - "DeviceManagement_ListInstallableUpdatesForDeviceClass": { - "$ref": "./examples/DeviceManagement_ListInstallableUpdatesForDeviceClass.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The installable update information for the device class. Returns empty list in case of no installable updates", - "schema": { - "$ref": "#/definitions/UpdateInfoList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/management/devices": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets a list of devices connected to Device Update for IoT Hub.", - "operationId": "DeviceManagement_ListDevices", - "x-ms-examples": { - "DeviceManagement_ListDevices": { - "$ref": "./examples/DeviceManagement_ListDevices.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "name": "filter", - "in": "query", - "required": false, - "type": "string", - "description": "Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus. Use DeploymentStatus eq null to query for devices with no deployment status (that have never been deployed to)." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "All devices connected to Device Update for IoT Hub.", - "schema": { - "$ref": "#/definitions/DevicesList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-odata": "#/definitions/DeviceFilter", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/management/devices:import": { - "post": { - "tags": [ - "Device and deployment management" - ], - "operationId": "DeviceManagement_ImportDevices", - "x-ms-long-running-operation": true, - "x-ms-examples": { - "DeviceManagement_ImportDevices": { - "$ref": "./examples/DeviceManagement_ImportDevices.json" - } - }, - "description": "Import existing devices from IoT Hub. This is a long-running-operation; use Operation-Location response header value to check for operation status.", - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "importType", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ImportType" - }, - "description": "The types of devices to import." - } - ], - "responses": { - "202": { - "description": "Accepted device import request; background operation location to track status is specified in Operation-Location response header.", - "headers": { - "Operation-Location": { - "type": "string", - "description": "Url to retrieve the device import operation status." - } - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/devices/{deviceId}": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub.", - "operationId": "DeviceManagement_GetDevice", - "x-ms-examples": { - "DeviceManagement_GetDevice": { - "$ref": "./examples/DeviceManagement_GetDevice.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/DeviceIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The device properties and latest deployment status.", - "schema": { - "$ref": "#/definitions/Device" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/devices/{deviceId}/modules/{moduleId}": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets the device module properties and latest deployment status for a device module connected to Device Update for IoT Hub.", - "operationId": "DeviceManagement_GetDeviceModule", - "x-ms-examples": { - "DeviceManagement_GetDevice": { - "$ref": "./examples/DeviceManagement_GetDeviceModule.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/DeviceIdParameter" - }, - { - "$ref": "#/parameters/ModuleIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The device properties and latest deployment status.", - "schema": { - "$ref": "#/definitions/Device" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/updateCompliance": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates.", - "operationId": "DeviceManagement_GetUpdateCompliance", - "x-ms-examples": { - "DeviceManagement_GetUpdateCompliance": { - "$ref": "./examples/DeviceManagement_GetUpdateCompliance.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The count of devices that have the latest update, have updates available, or are in progress receiving new updates.", - "schema": { - "$ref": "#/definitions/UpdateCompliance" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/groups": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets a list of all device groups. The $default group will always be returned first.", - "operationId": "DeviceManagement_ListGroups", - "x-ms-examples": { - "DeviceManagement_ListGroups": { - "$ref": "./examples/DeviceManagement_ListGroups.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "name": "orderby", - "in": "query", - "required": false, - "type": "string", - "x-ms-client-name": "orderBy", - "description": "Orders the set of groups returned. You can order by groupId, deviceCount, createdDate, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The device groups.", - "schema": { - "$ref": "#/definitions/GroupsList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-odata": "#/definitions/GroupOrderBy", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets the device group properties.", - "operationId": "DeviceManagement_GetGroup", - "x-ms-examples": { - "DeviceManagement_GetGroup": { - "$ref": "./examples/DeviceManagement_GetGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The device group properties.", - "schema": { - "$ref": "#/definitions/Group" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Device and deployment management" - ], - "description": "Deletes a device group. This group is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a group if they do not need to retain any of the history of the group and no longer need it. If a device is ever connected again for this group after the group was deleted it will be automatically re-created but there will be no history.", - "operationId": "DeviceManagement_DeleteGroup", - "x-ms-examples": { - "DeviceManagement_DeleteGroup": { - "$ref": "./examples/DeviceManagement_DeleteGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/updateCompliance": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Get device group update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update.", - "operationId": "DeviceManagement_GetUpdateComplianceForGroup", - "x-ms-examples": { - "DeviceManagement_GetUpdateComplianceForGroup": { - "$ref": "./examples/DeviceManagement_GetUpdateComplianceForGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The device group update compliance information.", - "schema": { - "$ref": "#/definitions/UpdateCompliance" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/bestUpdates": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Get the best available updates for a device group and a count of how many devices need each update.", - "operationId": "DeviceManagement_ListBestUpdatesForGroup", - "x-ms-examples": { - "DeviceManagement_ListBestUpdatesForGroup": { - "$ref": "./examples/DeviceManagement_ListBestUpdatesForGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The best available updates for a device group, the device class subgroup, and a count of how many devices need each update.", - "schema": { - "$ref": "#/definitions/DeviceClassSubgroupUpdatableDevicesList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets a list of deployments for a device group.", - "operationId": "DeviceManagement_ListDeploymentsForGroup", - "x-ms-examples": { - "DeviceManagement_ListDeploymentsForGroup": { - "$ref": "./examples/DeviceManagement_ListDeploymentsForGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "orderby", - "in": "query", - "required": false, - "type": "string", - "x-ms-client-name": "orderBy", - "description": "Orders the set of deployments returned. You can order by start date." - } - ], - "responses": { - "200": { - "description": "All deployments for the group.", - "schema": { - "$ref": "#/definitions/DeploymentsList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-odata": "#/definitions/DeploymentOrderBy", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets the deployment properties.", - "operationId": "DeviceManagement_GetDeployment", - "x-ms-examples": { - "DeviceManagement_GetDeployment": { - "$ref": "./examples/DeviceManagement_GetDeployment.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeploymentIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The deployment properties.", - "schema": { - "$ref": "#/definitions/Deployment" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Device and deployment management" - ], - "description": "Creates or updates a deployment.", - "operationId": "DeviceManagement_CreateOrUpdateDeployment", - "x-ms-examples": { - "DeviceManagement_CreateOrUpdateDeployment": { - "$ref": "./examples/DeviceManagement_CreateOrUpdateDeployment.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeploymentIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "deployment", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - }, - "description": "The deployment properties." - } - ], - "responses": { - "200": { - "description": "The deployment properties.", - "schema": { - "$ref": "#/definitions/Deployment" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Deployment management" - ], - "description": "Deletes a deployment.", - "operationId": "DeviceManagement_DeleteDeployment", - "x-ms-examples": { - "DeviceManagement_DeleteDeployment": { - "$ref": "./examples/DeviceManagement_DeleteDeployment.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeploymentIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}/status": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.", - "operationId": "DeviceManagement_GetDeploymentStatus", - "x-ms-examples": { - "DeviceManagement_GetDeploymentStatus": { - "$ref": "./examples/DeviceManagement_GetDeploymentStatus.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeploymentIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The status of the deployment.", - "schema": { - "$ref": "#/definitions/DeploymentStatus" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Get the device class subgroups for the group. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates.", - "operationId": "DeviceManagement_ListDeviceClassSubgroupsForGroup", - "x-ms-examples": { - "DeviceManagement_ListDeviceClassSubgroupsForGroup": { - "$ref": "./examples/DeviceManagement_ListDeviceClassSubgroupsForGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "name": "filter", - "in": "query", - "required": false, - "type": "string", - "description": "Restricts the set of device class subgroups returned. You can filter on compat properties by name and value. (i.e. filter=compatProperties/propertyName1 eq 'value1' and compatProperties/propertyName2 eq 'value2')" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The device class subgroup details.", - "schema": { - "$ref": "#/definitions/DeviceClassSubgroupsList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-odata": "#/definitions/DeviceClassSubgroupFilter", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets device class subgroup details. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates.", - "operationId": "DeviceManagement_GetDeviceClassSubgroup", - "x-ms-examples": { - "DeviceManagement_GetGroupUpdateCompliance": { - "$ref": "./examples/DeviceManagement_GetDeviceClassSubgroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The device class subgroup details.", - "schema": { - "$ref": "#/definitions/DeviceClassSubgroup" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Device and deployment management" - ], - "description": "Deletes a device class subgroup. This subgroup is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a subgroup if they do not need to retain any of the history of the subgroup and no longer need it. If a device is ever connected again for this subgroup after the subgroup was deleted it will be automatically re-created but there will be no history.", - "operationId": "DeviceManagement_DeleteDeviceClassSubgroup", - "x-ms-examples": { - "DeviceManagement_DeleteDeviceClassSubgroup": { - "$ref": "./examples/DeviceManagement_DeleteDeviceClassSubgroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/updateCompliance": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Get device class subgroup update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update.", - "operationId": "DeviceManagement_GetDeviceClassSubgroupUpdateCompliance", - "x-ms-examples": { - "DeviceManagement_GetDeviceClassSubgroupUpdateCompliance": { - "$ref": "./examples/DeviceManagement_GetDeviceClassSubgroupUpdateCompliance.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The device class subgroup update compliance information.", - "schema": { - "$ref": "#/definitions/UpdateCompliance" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/bestUpdates": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Get the best available update for a device class subgroup and a count of how many devices need this update.", - "operationId": "DeviceManagement_GetBestUpdatesForDeviceClassSubgroup", - "x-ms-examples": { - "DeviceManagement_ListBestUpdatesForDeviceClassSubgroup": { - "$ref": "./examples/DeviceManagement_GetBestUpdatesForDeviceClassSubgroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The best available update for a device class subgroup and a count of how many devices need this update.", - "schema": { - "$ref": "#/definitions/DeviceClassSubgroupUpdatableDevices" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets a list of deployments for a device class subgroup.", - "operationId": "DeviceManagement_ListDeploymentsForDeviceClassSubgroup", - "x-ms-examples": { - "DeviceManagement_ListDeploymentsForDeviceClassSubgroup": { - "$ref": "./examples/DeviceManagement_ListDeploymentsForDeviceClassSubgroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "orderby", - "in": "query", - "required": false, - "type": "string", - "x-ms-client-name": "orderBy", - "description": "Orders the set of deployments returned. You can order by start date." - } - ], - "responses": { - "200": { - "description": "All deployments for the device class subgroup.", - "schema": { - "$ref": "#/definitions/DeploymentsList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-odata": "#/definitions/DeploymentOrderBy", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets the deployment properties.", - "operationId": "DeviceManagement_GetDeploymentForDeviceClassSubgroup", - "x-ms-examples": { - "DeviceManagement_GetDeploymentForDeviceClassSubgroup": { - "$ref": "./examples/DeviceManagement_GetDeploymentForDeviceClassSubgroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/DeploymentIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The deployment properties.", - "schema": { - "$ref": "#/definitions/Deployment" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Deployment management" - ], - "description": "Deletes a device class subgroup deployment.", - "operationId": "DeviceManagement_DeleteDeploymentForDeviceClassSubgroup", - "x-ms-examples": { - "DeviceManagement_DeleteDeploymentForDeviceClassSubgroup": { - "$ref": "./examples/DeviceManagement_DeleteDeploymentForDeviceClassSubgroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/DeploymentIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}:cancel": { - "post": { - "tags": [ - "Device and deployment management" - ], - "description": "Stops a deployment.", - "operationId": "DeviceManagement_StopDeployment", - "x-ms-examples": { - "DeviceManagement_CancelOrRetryDeployment": { - "$ref": "./examples/DeviceManagement_StopDeployment.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/DeploymentIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The deployment properties.", - "schema": { - "$ref": "#/definitions/Deployment" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}:retry": { - "post": { - "tags": [ - "Device and deployment management" - ], - "description": "Retries a deployment with failed devices.", - "operationId": "DeviceManagement_RetryDeployment", - "x-ms-examples": { - "DeviceManagement_CancelOrRetryDeployment": { - "$ref": "./examples/DeviceManagement_RetryDeployment.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/DeploymentIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The deployment properties.", - "schema": { - "$ref": "#/definitions/Deployment" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}/status": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.", - "operationId": "DeviceManagement_GetDeviceClassSubgroupDeploymentStatus", - "x-ms-examples": { - "DeviceManagement_GetDeviceClassSubgroupDeploymentStatus": { - "$ref": "./examples/DeviceManagement_GetDeviceClassSubgroupDeploymentStatus.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/DeploymentIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The status of the device class subgroup deployment.", - "schema": { - "$ref": "#/definitions/DeviceClassSubgroupDeploymentStatus" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}/devicestates": { - "get": { - "tags": [ - "Device and deployment management" - ], - "description": "Gets a list of devices in a deployment along with their state. Useful for getting a list of failed devices.", - "operationId": "DeviceManagement_ListDeviceStatesForDeviceClassSubgroupDeployment", - "x-ms-examples": { - "DeviceManagement_ListDeviceStatesForDeviceClassSubgroupDeployment": { - "$ref": "./examples/DeviceManagement_ListDeviceStatesForDeviceClassSubgroupDeployment.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/GroupIdParameter" - }, - { - "$ref": "#/parameters/DeviceClassIdParameter" - }, - { - "$ref": "#/parameters/DeploymentIdParameter" - }, - { - "name": "filter", - "in": "query", - "required": false, - "type": "string", - "description": "Restricts the set of deployment device states returned. You can filter on deviceId and moduleId and/or deviceState." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The devices in the deployment along with their states.", - "schema": { - "$ref": "#/definitions/DeploymentDeviceStatesList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-odata": "#/definitions/DeploymentDeviceStatesFilter", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/management/operations/{operationId}": { - "get": { - "tags": [ - "Device and deployment management" - ], - "operationId": "DeviceManagement_GetOperationStatus", - "description": "Retrieve operation status.", - "x-ms-examples": { - "DeviceManagement_GetOperationStatus": { - "$ref": "./examples/DeviceManagement_GetOperationStatus.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/OperationIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/IfNoneMatchParameter" - } - ], - "responses": { - "200": { - "description": "Operation status.", - "headers": { - "Retry-After": { - "type": "string", - "description": "Number of seconds to wait before checking the operation status again." - } - }, - "schema": { - "$ref": "#/definitions/DeviceOperation" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/operations": { - "get": { - "tags": [ - "Device and deployment management" - ], - "operationId": "DeviceManagement_ListOperationStatuses", - "description": "Get a list of all device import operations. Completed operations are kept for 7 days before auto-deleted.", - "x-ms-examples": { - "DeviceManagement_ListOperationStatuses": { - "$ref": "./examples/DeviceManagement_ListOperationStatuses.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "name": "filter", - "in": "query", - "required": false, - "type": "string", - "description": "Restricts the set of operations returned. Only one specific filter is supported: \"status eq 'NotStarted' or status eq 'Running'\"" - }, - { - "name": "top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Operation details.", - "schema": { - "$ref": "#/definitions/DeviceOperationsList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-odata": "#/definitions/OperationFilter", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/management/deviceDiagnostics/logCollections/{operationId}": { - "put": { - "tags": [ - "Device and deployment management" - ], - "operationId": "DeviceManagement_StartLogCollection", - "description": "Start the device diagnostics log collection on specified devices.", - "x-ms-examples": { - "DeviceManagement_StartLogCollection": { - "$ref": "./examples/DeviceManagement_StartLogCollection.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/LogCollectionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "logCollection", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/LogCollection" - }, - "description": "The log collection properties." - } - ], - "responses": { - "201": { - "description": "Log collection created.", - "schema": { - "$ref": "#/definitions/LogCollection" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Device and deployment management" - ], - "operationId": "DeviceManagement_GetLogCollection", - "description": "Get the device diagnostics log collection", - "x-ms-examples": { - "DeviceManagement_GetLogCollection": { - "$ref": "./examples/DeviceManagement_GetLogCollection.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/LogCollectionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Operation resource", - "schema": { - "$ref": "#/definitions/LogCollection" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/deviceDiagnostics/logCollections": { - "get": { - "tags": [ - "Device and deployment management" - ], - "operationId": "DeviceManagement_ListLogCollections", - "description": "Get all device diagnostics log collections", - "x-ms-examples": { - "DeviceManagement_ListLogCollections": { - "$ref": "./examples/DeviceManagement_ListLogCollections.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "List of all log collections", - "schema": { - "$ref": "#/definitions/LogCollectionList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/deviceUpdate/{instanceId}/management/deviceDiagnostics/logCollections/{operationId}/detailedStatus": { - "get": { - "tags": [ - "Device and deployment management" - ], - "operationId": "DeviceManagement_GetLogCollectionDetailedStatus", - "description": "Get log collection with detailed status", - "x-ms-examples": { - "DeviceManagement_GetLogCollectionDetailedStatus": { - "$ref": "./examples/DeviceManagement_GetLogCollectionDetailedStatus.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/LogCollectionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Device diagnostics operation with detailed status", - "schema": { - "$ref": "#/definitions/LogCollectionOperationDetailedStatus" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/deviceUpdate/{instanceId}/management/deviceDiagnostics/deviceHealth": { - "get": { - "tags": [ - "Device and deployment management" - ], - "operationId": "DeviceManagement_ListHealthOfDevices", - "description": "Get list of device health", - "x-ms-examples": { - "DeviceManagement_ListHealthOfDevices": { - "$ref": "./examples/DeviceManagement_ListHealthOfDevices.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/InstanceIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "filter", - "in": "query", - "required": true, - "type": "string", - "description": "Restricts the set of devices for which device health is returned. You can filter on status, device id and module id." - } - ], - "responses": { - "200": { - "description": "Agent check response list", - "schema": { - "$ref": "#/definitions/DeviceHealthList" - } - }, - "default": { - "description": "Default response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-odata": "#/definitions/DeviceHealthFilter", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "ArrayOfStrings": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of strings." - }, - "StringsList": { - "description": "The list of strings with server paging support.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "type": "string" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "ImportUpdateInput": { - "type": "array", - "items": { - "$ref": "#/definitions/ImportUpdateInputItem" - }, - "minItems": 1, - "maxItems": 11, - "description": "Import update input metadata." - }, - "ImportUpdateInputItem": { - "type": "object", - "properties": { - "importManifest": { - "$ref": "#/definitions/ImportManifestMetadata", - "description": "Import manifest metadata like source URL, file size/hashes, etc." - }, - "friendlyName": { - "type": "string", - "minLength": 1, - "maxLength": 512, - "description": "Friendly update name." - }, - "files": { - "type": "array", - "items": { - "$ref": "#/definitions/FileImportMetadata" - }, - "minItems": 1, - "maxItems": 5, - "description": "One or more update file properties like filename and source URL." - } - }, - "required": [ - "importManifest" - ], - "description": "Import update input item metadata." - }, - "ImportManifestMetadata": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "Azure Blob location from which the import manifest can be downloaded by Device Update for IoT Hub. This is typically a read-only SAS-protected blob URL with an expiration set to at least 4 hours." - }, - "sizeInBytes": { - "type": "integer", - "description": "File size in number of bytes.", - "format": "int64" - }, - "hashes": { - "type": "object", - "additionalProperties": { - "type": "string", - "minItems": 1 - }, - "description": "A JSON object containing the hash(es) of the file. At least SHA256 hash is required. This object can be thought of as a set of key-value pairs where the key is the hash algorithm, and the value is the hash of the file calculated using that algorithm." - } - }, - "required": [ - "url", - "sizeInBytes", - "hashes" - ], - "description": "Metadata describing the import manifest, a document which describes the files and other metadata about an update version." - }, - "FileImportMetadata": { - "type": "object", - "properties": { - "filename": { - "type": "string", - "description": "Update file name as specified inside import manifest." - }, - "url": { - "type": "string", - "description": "Azure Blob location from which the update file can be downloaded by Device Update for IoT Hub. This is typically a read-only SAS-protected blob URL with an expiration set to at least 4 hours." - } - }, - "required": [ - "filename", - "url" - ], - "description": "Metadata describing an update file." - }, - "Update": { - "type": "object", - "properties": { - "updateId": { - "$ref": "#/definitions/UpdateId", - "description": "Update identity." - }, - "description": { - "type": "string", - "description": "Update description specified by creator.", - "minLength": 1, - "maxLength": 512 - }, - "friendlyName": { - "type": "string", - "description": "Friendly update name specified by importer.", - "minLength": 1, - "maxLength": 512 - }, - "isDeployable": { - "type": "boolean", - "description": "Whether the update can be deployed to a device on its own.", - "default": true - }, - "updateType": { - "type": "string", - "description": "Update type. Deprecated in latest import manifest schema." - }, - "installedCriteria": { - "type": "string", - "description": "String interpreted by Device Update client to determine if the update is installed on the device. Deprecated in latest import manifest schema." - }, - "compatibility": { - "type": "array", - "items": { - "$ref": "#/definitions/Compatibility" - }, - "minItems": 1, - "maxItems": 10, - "description": "List of update compatibility information." - }, - "instructions": { - "$ref": "#/definitions/Instructions", - "description": "Update install instructions." - }, - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/definitions/UpdateId" - }, - "minItems": 1, - "description": "List of update identities that reference this update." - }, - "scanResult": { - "type": "string", - "description": "Update aggregate scan result (calculated from payload file scan results)." - }, - "manifestVersion": { - "type": "string", - "description": "Schema version of manifest used to import the update." - }, - "importedDateTime": { - "type": "string", - "description": "Date and time in UTC when the update was imported.", - "format": "date-time" - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "Date and time in UTC when the update was created." - }, - "etag": { - "type": "string", - "description": "Update ETag." - } - }, - "required": [ - "updateId", - "compatibility", - "manifestVersion", - "importedDateTime", - "createdDateTime" - ], - "description": "Update metadata." - }, - "UpdateList": { - "description": "The list of updates.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/Update" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "UpdateId": { - "type": "object", - "properties": { - "provider": { - "type": "string", - "description": "Update provider." - }, - "name": { - "type": "string", - "description": "Update name." - }, - "version": { - "type": "string", - "description": "Update version." - } - }, - "required": [ - "provider", - "name", - "version" - ], - "description": "Update identifier." - }, - "UpdateInfo": { - "type": "object", - "properties": { - "updateId": { - "$ref": "#/definitions/UpdateId", - "description": "Update identifier." - }, - "description": { - "type": "string", - "description": "Update description.", - "readOnly": true - }, - "friendlyName": { - "type": "string", - "description": "Friendly update name.", - "readOnly": true - } - }, - "required": [ - "updateId" - ], - "description": "Update information." - }, - "UpdateInfoList": { - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/UpdateInfo" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ], - "description": "List of update information." - }, - "Compatibility": { - "type": "object", - "additionalProperties": { - "type": "string", - "minItems": 1, - "maxItems": 5 - }, - "description": "Key-value pairs representing update compatibility information." - }, - "Instructions": { - "type": "object", - "properties": { - "steps": { - "description": "Collection of installation steps.", - "type": "array", - "items": { - "$ref": "#/definitions/Step" - }, - "minItems": 1, - "maxItems": 10 - } - }, - "required": [ - "steps" - ] - }, - "Step": { - "description": "Update install instruction step.", - "type": "object", - "properties": { - "type": { - "description": "Step type.", - "type": "string", - "enum": [ - "inline", - "reference" - ], - "default": "inline", - "x-ms-enum": { - "name": "StepType", - "modelAsString": true, - "values": [ - { - "value": "Inline", - "name": "Inline", - "description": "Step type that performs code execution." - }, - { - "value": "Reference", - "name": "Reference", - "description": "Step type that installs another update." - } - ] - } - }, - "description": { - "description": "Step description.", - "type": "string", - "minLength": 1, - "maxLength": 64 - }, - "handler": { - "description": "Identity of handler that will execute this step. Required if step type is inline.", - "type": "string", - "minLength": 1, - "maxLength": 32 - }, - "handlerProperties": { - "description": "Parameters to be passed to handler during execution.", - "type": "object" - }, - "files": { - "description": "Collection of file names to be passed to handler during execution. Required if step type is inline.", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1, - "maxItems": 5 - }, - "updateId": { - "description": "Referenced child update identity. Required if step type is reference.", - "$ref": "#/definitions/UpdateId" - } - }, - "minProperties": 2 - }, - "UpdateFileBase": { - "type": "object", - "properties": { - "fileName": { - "type": "string", - "description": "File name." - }, - "sizeInBytes": { - "type": "integer", - "description": "File size in number of bytes.", - "format": "int64" - }, - "hashes": { - "type": "object", - "additionalProperties": { - "type": "string", - "minItems": 1 - }, - "description": "Mapping of hashing algorithm to base64 encoded hash values." - }, - "mimeType": { - "type": "string", - "description": "File MIME type." - }, - "scanResult": { - "type": "string", - "description": "Anti-malware scan result." - }, - "scanDetails": { - "type": "string", - "description": "Anti-malware scan details." - }, - "properties": { - "type": "object", - "additionalProperties": { - "type": "string", - "minItems": 0 - }, - "description": "Optional file properties (not consumed by service but pass-through to device)." - } - }, - "required": [ - "fileName", - "sizeInBytes", - "hashes" - ], - "description": "Update file basic metadata." - }, - "UpdateFile": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/UpdateFileBase" - } - ], - "properties": { - "fileId": { - "type": "string", - "description": "File identity, generated by server at import time." - }, - "relatedFiles": { - "type": "array", - "items": { - "$ref": "#/definitions/UpdateFileBase" - }, - "description": "Optional related files metadata used together DownloadHandler metadata to download payload file." - }, - "downloadHandler": { - "$ref": "#/definitions/UpdateFileDownloadHandler", - "description": "Optional download handler for utilizing related files to download payload file." - }, - "etag": { - "type": "string", - "description": "File ETag." - } - }, - "required": [ - "fileId" - ], - "description": "Update file metadata." - }, - "UpdateFileDownloadHandler": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Download handler identifier." - } - }, - "required": [ - "id" - ], - "description": "Download handler for utilizing related files to download payload file." - }, - "UpdateOperation": { - "type": "object", - "properties": { - "operationId": { - "type": "string", - "description": "Operation Id." - }, - "status": { - "$ref": "#/definitions/OperationStatus", - "description": "Operation status." - }, - "update": { - "$ref": "#/definitions/UpdateInfo", - "description": "The update being imported or deleted. For import, this property will only be populated after import manifest is processed successfully." - }, - "resourceLocation": { - "type": "string", - "description": "Location of the imported update when operation is successful." - }, - "error": { - "$ref": "#/definitions/Error", - "description": "Operation error encountered, if any." - }, - "traceId": { - "type": "string", - "description": "Operation correlation identity that can used by Microsoft Support for troubleshooting." - }, - "lastActionDateTime": { - "type": "string", - "format": "date-time", - "description": "Date and time in UTC when the operation status was last updated." - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "Date and time in UTC when the operation was created." - }, - "etag": { - "type": "string", - "description": "Operation ETag." - } - }, - "required": [ - "operationId", - "status", - "lastActionDateTime", - "createdDateTime" - ], - "description": "Operation metadata." - }, - "DeviceOperation": { - "type": "object", - "properties": { - "operationId": { - "type": "string", - "description": "Operation Id." - }, - "status": { - "$ref": "#/definitions/OperationStatus", - "description": "Operation status." - }, - "error": { - "$ref": "#/definitions/Error", - "description": "Operation error encountered, if any." - }, - "traceId": { - "type": "string", - "description": "Operation correlation identity that can used by Microsoft Support for troubleshooting." - }, - "lastActionDateTime": { - "type": "string", - "format": "date-time", - "description": "Date and time in UTC when the operation status was last updated." - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "Date and time in UTC when the operation was created." - }, - "etag": { - "type": "string", - "description": "Operation ETag." - } - }, - "required": [ - "operationId", - "status", - "lastActionDateTime", - "createdDateTime" - ], - "description": "Operation metadata." - }, - "OperationStatus": { - "type": "string", - "enum": [ - "NotStarted", - "Running", - "Succeeded", - "Failed" - ], - "x-ms-enum": { - "name": "OperationStatus", - "modelAsString": true, - "values": [ - { - "value": "NotStarted", - "name": "NotStarted", - "description": "Background operation created but not started yet." - }, - { - "value": "Running", - "name": "Running", - "description": "Background operation is currently running." - }, - { - "value": "Succeeded", - "name": "Succeeded", - "description": "Background operation finished with success." - }, - { - "value": "Failed", - "name": "Failed", - "description": "Background operation finished with failure." - } - ] - }, - "description": "Operation status." - }, - "OperationStatusWithoutUndefinedOption": { - "type": "string", - "enum": [ - "NotStarted", - "Running", - "Succeeded", - "Failed" - ], - "x-ms-enum": { - "name": "OperationStatus", - "modelAsString": true, - "values": [ - { - "value": "NotStarted", - "name": "NotStarted", - "description": "Background operation created but not started yet." - }, - { - "value": "Running", - "name": "Running", - "description": "Background operation is currently running." - }, - { - "value": "Succeeded", - "name": "Succeeded", - "description": "Background operation finished with success." - }, - { - "value": "Failed", - "name": "Failed", - "description": "Background operation finished with failure." - } - ] - }, - "description": "Operation status." - }, - "ErrorResponse": { - "description": "Common error response.", - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/Error", - "description": "The error details." - } - }, - "required": [ - "error" - ] - }, - "Error": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Server defined error code." - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/Error" - }, - "description": "An array of errors that led to the reported error." - }, - "innererror": { - "$ref": "#/definitions/InnerError", - "description": "An object containing more specific information than the current object about the error." - }, - "occurredDateTime": { - "type": "string", - "description": "Date and time in UTC when the error occurred.", - "format": "date-time" - } - }, - "required": [ - "code", - "message" - ], - "description": "Error details." - }, - "InnerError": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "A more specific error code than what was provided by the containing error." - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "errorDetail": { - "type": "string", - "description": "The internal error or exception message." - }, - "innerError": { - "$ref": "#/definitions/InnerError", - "description": "An object containing more specific information than the current object about the error." - } - }, - "required": [ - "code" - ], - "description": "An object containing more specific information than the current object about the error." - }, - "UpdateOperationsList": { - "description": "The list of operations with server paging support.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/UpdateOperation" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "DeviceOperationsList": { - "description": "The list of device operations with server paging support.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/DeviceOperation" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "DeviceClass": { - "type": "object", - "properties": { - "deviceClassId": { - "type": "string", - "description": "The device class identifier. This is generated from the model Id and the compat properties reported by the device update agent in the Device Update PnP interface in IoT Hub. It is a hex-encoded SHA1 hash." - }, - "friendlyName": { - "type": "string", - "description": "The device class friendly name. This can be updated by callers after the device class has been automatically created." - }, - "deviceClassProperties": { - "$ref": "#/definitions/DeviceClassProperties", - "description": "The device class properties that are used to calculate the device class Id" - }, - "bestCompatibleUpdate": { - "$ref": "#/definitions/UpdateInfo", - "description": "Update that is the highest version compatible with this device class." - } - }, - "required": [ - "deviceClassId", - "deviceClassProperties" - ], - "description": "Device class metadata." - }, - "DeviceClassProperties": { - "type": "object", - "description": "The device class properties that are used to calculate the device class Id", - "properties": { - "contractModel": { - "$ref": "#/definitions/ContractModel", - "description": "The Device Update agent contract model." - }, - "compatProperties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The compat properties of the device class. This object can be thought of as a set of key-value pairs where the key is the name of the compatibility property and the value is the value of the compatibility property. There will always be at least 1 compat property" - } - }, - "required": [ - "compatProperties" - ] - }, - "ContractModel": { - "type": "object", - "description": "The Device Update agent contract model.", - "properties": { - "id": { - "type": "string", - "description": "The Device Update agent contract model Id of the device class. This is also used to calculate the device class Id." - }, - "name": { - "type": "string", - "description": "The Device Update agent contract model name of the device class. Intended to be a more readable form of the contract model Id." - } - }, - "required": [ - "id", - "name" - ] - }, - "DeviceClassesList": { - "description": "The list of device classes.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/DeviceClass" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "PatchBody": { - "type": "object", - "properties": { - "friendlyName": { - "type": "string", - "description": "The device class friendly name. Friendly name can be 1-100 characters, alphanumeric, dot, and dash." - } - }, - "required": [ - "friendlyName" - ], - "description": "Device Class JSON Merge Patch request body" - }, - "Device": { - "type": "object", - "properties": { - "deviceId": { - "type": "string", - "description": "Device identity." - }, - "moduleId": { - "type": "string", - "description": "Device module identity." - }, - "deviceClassId": { - "type": "string", - "description": "Device class identity." - }, - "groupId": { - "type": "string", - "description": "Device group identity." - }, - "lastAttemptedUpdate": { - "$ref": "#/definitions/UpdateInfo", - "description": "The update that device last attempted to install." - }, - "deploymentStatus": { - "$ref": "#/definitions/DeviceDeploymentState", - "description": "State of the device in its last deployment." - }, - "installedUpdate": { - "$ref": "#/definitions/UpdateInfo", - "description": "Currently installed update on device." - }, - "onLatestUpdate": { - "type": "boolean", - "description": "Boolean flag indicating whether the latest update (the best compatible update for the device's device class and group) is installed on the device" - }, - "lastDeploymentId": { - "type": "string", - "description": "The deployment identifier for the last deployment to the device" - }, - "lastInstallResult": { - "$ref": "#/definitions/InstallResult", - "description": "Last install result." - } - }, - "required": [ - "deviceId", - "deviceClassId", - "onLatestUpdate" - ], - "description": "Device metadata." - }, - "DeviceDeploymentState": { - "type": "string", - "enum": [ - "Succeeded", - "InProgress", - "Canceled", - "Failed" - ], - "x-ms-enum": { - "name": "DeviceDeploymentState", - "modelAsString": true, - "values": [ - { - "value": "Succeeded", - "name": "Succeeded", - "description": "Deployment has completed with success." - }, - { - "value": "InProgress", - "name": "InProgress", - "description": "Deployment is in progress." - }, - { - "value": "Canceled", - "name": "Canceled", - "description": "Deployment was canceled." - }, - { - "value": "Failed", - "name": "Failed", - "description": "Deployment has completed with failure." - } - ] - }, - "description": "Deployment state." - }, - "DeviceFilter": { - "type": "object", - "properties": { - "groupId": { - "type": "string", - "description": "Device group identity." - }, - "deviceClassId": { - "type": "string", - "description": "Device class identity." - }, - "deploymentStatus": { - "$ref": "#/definitions/DeviceDeploymentState", - "description": "State of the device in its last deployment." - } - }, - "description": "Device filter." - }, - "DeviceClassSubgroupFilter": { - "type": "object", - "properties": { - "compatPropertyName": { - "type": "string", - "description": "The name of the compat property to use in the filter. E.g. compatProperties/manufacturer" - }, - "compatPropertyValue": { - "type": "string", - "description": "The value the compat property to use in the filter. E.g. Contoso" - } - }, - "description": "Device class subgroups filter. Filters device class subgroups based on device class compat property names and values" - }, - "DeviceClassFilter": { - "type": "object", - "properties": { - "friendlyName": { - "type": "string", - "description": "The friendly name of the device class to use in the filter" - } - }, - "description": "Device class filter. Filters device classes based on device class friendly name" - }, - "DevicesList": { - "description": "The list of devices.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/Device" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "UpdateCompliance": { - "type": "object", - "properties": { - "totalDeviceCount": { - "type": "integer", - "description": "Total number of devices." - }, - "onLatestUpdateDeviceCount": { - "type": "integer", - "description": "Number of devices on the latest update." - }, - "newUpdatesAvailableDeviceCount": { - "type": "integer", - "description": "Number of devices with a newer update available." - }, - "updatesInProgressDeviceCount": { - "type": "integer", - "description": "Number of devices with update in-progress." - } - }, - "required": [ - "totalDeviceCount", - "onLatestUpdateDeviceCount", - "newUpdatesAvailableDeviceCount", - "updatesInProgressDeviceCount" - ], - "description": "Update compliance information." - }, - "DeviceClassSubgroupUpdatableDevices": { - "type": "object", - "properties": { - "groupId": { - "type": "string", - "description": "The group Id" - }, - "deviceClassId": { - "type": "string", - "description": "The device class subgroup's device class Id" - }, - "update": { - "$ref": "#/definitions/UpdateInfo", - "description": "Update information." - }, - "deviceCount": { - "type": "integer", - "description": "Total number of devices for which the update is applicable." - } - }, - "required": [ - "groupId", - "deviceClassId", - "update", - "deviceCount" - ], - "description": "Device class subgroup, update information, and the number of devices for which the update is applicable." - }, - "DeviceClassSubgroupUpdatableDevicesList": { - "description": "The list of updatable devices for a device class subgroup.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/DeviceClassSubgroupUpdatableDevices" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "Group": { - "type": "object", - "properties": { - "groupId": { - "type": "string", - "description": "Group identity. This is created from the value of the ADUGroup tag in the Iot Hub's device/module twin or $default for devices with no tag." - }, - "groupType": { - "$ref": "#/definitions/GroupType", - "description": "Group type." - }, - "createdDateTime": { - "type": "string", - "description": "Date and time when the update was created." - }, - "deviceCount": { - "type": "integer", - "description": "The number of devices in the group." - }, - "subgroupsWithNewUpdatesAvailableCount": { - "type": "integer", - "description": "The count of subgroups with new updates available." - }, - "subgroupsWithUpdatesInProgressCount": { - "type": "integer", - "description": "The count of subgroups with updates in progress." - }, - "subgroupsWithOnLatestUpdateCount": { - "type": "integer", - "description": "The count of subgroups with devices on the latest update." - }, - "deployments": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The active deployment Ids for the group" - } - }, - "required": [ - "groupId", - "groupType", - "createdDateTime" - ], - "description": "Group details." - }, - "GroupType": { - "type": "string", - "enum": [ - "IoTHubTag", - "DefaultNoTag" - ], - "x-ms-enum": { - "name": "GroupType", - "modelAsString": true, - "values": [ - { - "value": "IoTHubTag", - "name": "IoTHubTag", - "description": "IoT Hub tag based group, all devices in the group share an ADUGroup tag value." - }, - { - "value": "DefaultNoTag", - "name": "DefaultNoTag", - "description": "Default group for untagged devices." - } - ] - }, - "description": "Supported group types." - }, - "GroupsList": { - "description": "The list of groups.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/Group" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "DeviceClassSubgroup": { - "type": "object", - "properties": { - "deviceClassId": { - "type": "string", - "description": "Device class subgroup identity. This is generated from the model Id and the compat properties reported by the device update agent in the Device Update PnP interface in IoT Hub. It is a hex-encoded SHA1 hash." - }, - "groupId": { - "type": "string", - "description": "Group identity." - }, - "createdDateTime": { - "type": "string", - "description": "Date and time when the device class subgroup was created." - }, - "deviceCount": { - "type": "integer", - "description": "The number of devices in the device class subgroup." - }, - "deploymentId": { - "type": "string", - "description": "The active deployment Id for the device class subgroup." - } - }, - "required": [ - "deviceClassId", - "groupId", - "createdDateTime" - ], - "description": "Device class subgroup details. A device class subgroup is a subset of devices in a group that share the same device class id." - }, - "DeviceClassSubgroupsList": { - "description": "The list of device class subgroups within a group.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/DeviceClassSubgroup" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "Deployment": { - "type": "object", - "properties": { - "deploymentId": { - "type": "string", - "description": "The caller-provided deployment identifier. This cannot be longer than 73 characters, must be all lower-case, and cannot contain '&', '^', '[', ']', '{', '}', '|', '<', '>', forward slash, backslash, or double quote. The Updates view in the Azure Portal IoT Hub resource generates a GUID for deploymentId when you create a deployment." - }, - "startDateTime": { - "type": "string", - "description": "The deployment start datetime.", - "format": "date-time" - }, - "update": { - "$ref": "#/definitions/UpdateInfo", - "description": "Update information for the update in the deployment." - }, - "groupId": { - "type": "string", - "description": "The group identity for the devices the deployment is intended to update." - }, - "deviceClassSubgroups": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The device class subgroups the deployment is compatible with and subgroup deployments have been created for. This is not provided by the caller during CreateOrUpdateDeployment but is automatically determined by Device Update" - }, - "isCanceled": { - "type": "boolean", - "description": "Boolean flag indicating whether the deployment was canceled." - }, - "isRetried": { - "type": "boolean", - "description": "Boolean flag indicating whether the deployment has been retried." - }, - "rollbackPolicy": { - "$ref": "#/definitions/CloudInitiatedRollbackPolicy", - "description": "The rollback policy for the deployment." - }, - "isCloudInitiatedRollback": { - "type": "boolean", - "description": "Boolean flag indicating whether the deployment is a rollback deployment." - } - }, - "required": [ - "deploymentId", - "startDateTime", - "update", - "groupId" - ], - "description": "Deployment metadata." - }, - "DeploymentsList": { - "description": "The list of deployments.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/Deployment" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "DeploymentStatus": { - "type": "object", - "properties": { - "groupId": { - "type": "string", - "description": "The group identity" - }, - "deploymentState": { - "$ref": "#/definitions/DeploymentState", - "description": "The state of the deployment." - }, - "error": { - "$ref": "#/definitions/Error", - "description": "The error details of the Failed state. This is not present if the deployment state is not Failed." - }, - "subgroupStatus": { - "type": "array", - "description": "The collection of device class subgroup status objects", - "items": { - "$ref": "#/definitions/DeviceClassSubgroupDeploymentStatus" - } - } - }, - "required": [ - "groupId", - "deploymentState", - "subgroupStatus" - ], - "description": "Deployment status metadata." - }, - "DeploymentState": { - "type": "string", - "enum": [ - "Active", - "ActiveWithSubgroupFailures", - "Failed", - "Inactive", - "Canceled" - ], - "x-ms-enum": { - "name": "DeploymentState", - "modelAsString": true, - "values": [ - { - "value": "Active", - "name": "Active", - "description": "The deployment can be sent to devices targeted in the deployment." - }, - { - "value": "ActiveWithSubgroupFailures", - "name": "ActiveWithSubgroupFailures", - "description": "The deployment can be sent to some devices targeted in the deployment but at least 1 subgroup is in a failed state." - }, - { - "value": "Failed", - "name": "Failed", - "description": "The deployment will not be sent to any devices. Consult error for more details about what failed." - }, - { - "value": "Inactive", - "name": "Inactive", - "description": "A newer deployment for this group has been created and no devices in the group will receive this deployment." - }, - { - "value": "Canceled", - "name": "Canceled", - "description": "The deployment has been canceled and no devices will receive it." - } - ] - }, - "description": "Deployment state." - }, - "DeviceClassSubgroupDeploymentStatus": { - "type": "object", - "properties": { - "groupId": { - "type": "string", - "description": "The group identity" - }, - "deviceClassId": { - "type": "string", - "description": "The device class subgroup identity" - }, - "deploymentState": { - "$ref": "#/definitions/DeviceClassSubgroupDeploymentState", - "description": "The state of the subgroup deployment." - }, - "error": { - "$ref": "#/definitions/Error", - "description": "The error details of the Failed state. This is not present if the deployment state is not Failed." - }, - "totalDevices": { - "type": "integer", - "description": "The total number of devices in the deployment.", - "format": "int32" - }, - "devicesInProgressCount": { - "type": "integer", - "description": "The number of devices that are currently in deployment.", - "format": "int32" - }, - "devicesCompletedFailedCount": { - "type": "integer", - "description": "The number of devices that have completed deployment with a failure.", - "format": "int32" - }, - "devicesCompletedSucceededCount": { - "type": "integer", - "description": "The number of devices which have successfully completed deployment.", - "format": "int32" - }, - "devicesCanceledCount": { - "type": "integer", - "description": "The number of devices which have had their deployment canceled.", - "format": "int32" - } - }, - "required": [ - "groupId", - "deviceClassId", - "deploymentState" - ], - "description": "Device class subgroup deployment status metadata." - }, - "DeviceClassSubgroupDeploymentState": { - "type": "string", - "enum": [ - "Active", - "Failed", - "Inactive", - "Canceled" - ], - "x-ms-enum": { - "name": "DeviceClassSubgroupDeploymentState", - "modelAsString": true, - "values": [ - { - "value": "Active", - "name": "Active", - "description": "The subgroup deployment can be sent to devices targeted in the deployment." - }, - { - "value": "Failed", - "name": "Failed", - "description": "The subgroup deployment failed and will not be sent to any devices." - }, - { - "value": "Inactive", - "name": "Inactive", - "description": "A newer deployment for this subgroup has been created and no devices in the subgroup will receive this deployment." - }, - { - "value": "Canceled", - "name": "Canceled", - "description": "The subgroup deployment has been canceled and no devices will receive it." - } - ] - }, - "description": "Device class subgroup deployment state." - }, - "DeploymentDeviceState": { - "type": "object", - "properties": { - "deviceId": { - "type": "string", - "description": "Device identity." - }, - "moduleId": { - "type": "string", - "description": "Device module identity." - }, - "retryCount": { - "type": "integer", - "description": "The number of times this deployment has been retried on this device.", - "format": "int32" - }, - "movedOnToNewDeployment": { - "type": "boolean", - "description": "Boolean flag indicating whether this device is in a newer deployment and can no longer retry this deployment." - }, - "deviceState": { - "$ref": "#/definitions/DeviceDeploymentState", - "description": "Deployment device state." - } - }, - "required": [ - "deviceId", - "retryCount", - "movedOnToNewDeployment", - "deviceState" - ], - "description": "Deployment device status." - }, - "DeploymentDeviceStatesList": { - "description": "The list of deployment device states.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/DeploymentDeviceState" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "CloudInitiatedRollbackPolicyFailure": { - "type": "object", - "properties": { - "devicesFailedPercentage": { - "type": "integer", - "description": "Percentage of devices that failed." - }, - "devicesFailedCount": { - "type": "integer", - "description": "Number of devices that failed." - } - }, - "required": [ - "devicesFailedPercentage", - "devicesFailedCount" - ], - "description": "Failure conditions to initiate rollback policy" - }, - "CloudInitiatedRollbackPolicy": { - "type": "object", - "properties": { - "update": { - "$ref": "#/definitions/UpdateInfo", - "description": "Update to rollback to." - }, - "failure": { - "$ref": "#/definitions/CloudInitiatedRollbackPolicyFailure", - "description": "Failure conditions to initiate rollback policy." - } - }, - "required": [ - "update", - "failure" - ], - "description": "Rollback policy for deployment" - }, - "UpdateFilter": { - "type": "object", - "properties": { - "isDeployable": { - "type": "boolean", - "description": "Update isDeployable property." - } - }, - "description": "Update filter." - }, - "OperationFilterStatus": { - "type": "string", - "enum": [ - "Running", - "NotStarted" - ], - "x-ms-enum": { - "name": "OperationFilterStatus", - "modelAsString": true - }, - "description": "Operation status filter." - }, - "OperationFilter": { - "type": "object", - "properties": { - "status": { - "$ref": "#/definitions/OperationFilterStatus", - "description": "Operation status filter." - } - }, - "description": "Operation status filter." - }, - "GroupOrderBy": { - "type": "object", - "properties": { - "groupId": { - "type": "string", - "description": "The group Id." - }, - "deviceCount": { - "type": "string", - "description": "The group device count." - }, - "createdDate": { - "type": "string", - "description": "The group created date." - }, - "subgroupsWithNewUpdatesAvailableCount": { - "type": "string", - "description": "The number of subgroups with new updates available" - }, - "subgroupsWithUpdatesInProgressCount": { - "type": "string", - "description": "The number of subgroups with updates in progress" - }, - "subgroupsOnLatestUpdateCount": { - "type": "string", - "description": "The number of subgroups with devices on the latest update" - } - }, - "description": "Groups order by." - }, - "DeploymentOrderBy": { - "type": "object", - "properties": { - "startDateTime": { - "type": "string", - "description": "The deployment start datetime.", - "format": "date-time" - } - }, - "description": "Deployment order by." - }, - "DeploymentDeviceStatesFilter": { - "type": "object", - "properties": { - "deviceId": { - "type": "string", - "description": "Device Identifier." - }, - "moduleId": { - "type": "string", - "description": "Device module Identifier." - }, - "deviceState": { - "$ref": "#/definitions/DeviceDeploymentState", - "description": "The deployment device state." - } - }, - "description": "Deployment device state filter." - }, - "ImportType": { - "type": "string", - "description": "The device import type.", - "enum": [ - "Devices", - "Modules", - "All" - ], - "x-ms-enum": { - "name": "ImportType", - "modelAsString": true, - "values": [ - { - "value": "Devices", - "name": "Devices", - "description": "Import only devices but not modules." - }, - { - "value": "Modules", - "name": "Modules", - "description": "Import only modules but not devices." - }, - { - "value": "All", - "name": "All", - "description": "Import both devices and modules." - } - ] - } - }, - "StepResult": { - "type": "object", - "properties": { - "update": { - "$ref": "#/definitions/UpdateInfo", - "description": "The update that this step installs if it is of reference type." - }, - "description": { - "type": "string", - "description": "Step description." - }, - "resultCode": { - "type": "integer", - "description": "Install result code." - }, - "extendedResultCode": { - "type": "integer", - "description": "Install extended result code" - }, - "resultDetails": { - "type": "string", - "description": "A string containing further details about the install result" - } - }, - "required": [ - "resultCode", - "extendedResultCode" - ], - "description": "The step result under an update." - }, - "InstallResult": { - "type": "object", - "properties": { - "resultCode": { - "type": "integer", - "description": "Install result code." - }, - "extendedResultCode": { - "type": "integer", - "description": "Install extended result code" - }, - "resultDetails": { - "type": "string", - "description": "A string containing further details about the install result" - }, - "stepResults": { - "type": "array", - "items": { - "$ref": "#/definitions/StepResult", - "description": "Step results" - }, - "description": "Array of step results" - } - }, - "required": [ - "resultCode", - "extendedResultCode" - ], - "description": "The install result of an update and any step results under it." - }, - "DeviceUpdateAgentId": { - "type": "object", - "properties": { - "deviceId": { - "type": "string", - "description": "Device Id" - }, - "moduleId": { - "type": "string", - "description": "Module Id" - } - }, - "required": [ - "deviceId" - ], - "description": "Device Update agent id" - }, - "LogCollection": { - "type": "object", - "properties": { - "operationId": { - "type": "string", - "description": "The log collection id.", - "x-ms-client-name": "logCollectionId" - }, - "deviceList": { - "type": "array", - "description": "Array of Device Update agent ids", - "items": { - "$ref": "#/definitions/DeviceUpdateAgentId" - } - }, - "description": { - "type": "string", - "maxLength": 512, - "description": "Description of the diagnostics operation." - }, - "createdDateTime": { - "type": "string", - "description": "The timestamp when the operation was created.", - "readOnly": true - }, - "lastActionDateTime": { - "type": "string", - "description": "A timestamp for when the current state was entered.", - "readOnly": true - }, - "status": { - "$ref": "#/definitions/OperationStatusWithoutUndefinedOption", - "description": "Operation status.", - "readOnly": true - } - }, - "required": [ - "deviceList" - ], - "description": "Diagnostics request body" - }, - "LogCollectionOperationDetailedStatus": { - "type": "object", - "properties": { - "operationId": { - "type": "string", - "description": "The device diagnostics operation id.", - "x-ms-client-name": "logCollectionId" - }, - "createdDateTime": { - "type": "string", - "description": "The timestamp when the operation was created." - }, - "lastActionDateTime": { - "type": "string", - "description": "A timestamp for when the current state was entered." - }, - "status": { - "$ref": "#/definitions/OperationStatusWithoutUndefinedOption", - "description": "Operation status." - }, - "deviceStatus": { - "type": "array", - "items": { - "$ref": "#/definitions/LogCollectionOperationDeviceStatus" - }, - "description": "Status of the devices in the operation" - }, - "description": { - "type": "string", - "description": "Device diagnostics operation description." - } - }, - "description": "Device diagnostics operation detailed status" - }, - "LogCollectionList": { - "description": "The list of log collections with server paging support.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/LogCollection" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "LogCollectionDetailedStatusList": { - "description": "The list of log collections with detailed status, with server paging support.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/LogCollectionOperationDetailedStatus" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "LogCollectionOperationDeviceStatus": { - "type": "object", - "properties": { - "deviceId": { - "type": "string", - "description": "Device id" - }, - "moduleId": { - "type": "string", - "description": "Module id." - }, - "status": { - "$ref": "#/definitions/OperationStatusWithoutUndefinedOption", - "description": "Log upload status" - }, - "resultCode": { - "type": "string", - "description": "Log upload result code" - }, - "extendedResultCode": { - "type": "string", - "description": "Log upload extended result code" - }, - "logLocation": { - "type": "string", - "description": "Log upload location" - } - }, - "required": [ - "deviceId", - "status" - ], - "description": "Diagnostics operation device status" - }, - "HealthCheckResult": { - "type": "string", - "enum": [ - "success", - "userError" - ], - "x-ms-enum": { - "name": "HealthCheckResult", - "modelAsString": true, - "values": [ - { - "value": "success", - "name": "success", - "description": "Health check succeeded" - }, - { - "value": "userError", - "name": "userError", - "description": "Health check failed due to user error" - } - ] - }, - "description": "Health check result" - }, - "DeviceHealth": { - "description": "Device Health", - "type": "object", - "properties": { - "deviceId": { - "type": "string", - "description": "Device id" - }, - "moduleId": { - "type": "string", - "description": "Module id" - }, - "state": { - "$ref": "#/definitions/DeviceHealthState", - "description": "Aggregate device health state" - }, - "digitalTwinModelId": { - "type": "string", - "description": "Digital twin model Id" - }, - "healthChecks": { - "type": "array", - "description": "Array of health checks and their results", - "items": { - "$ref": "#/definitions/HealthCheck" - } - } - }, - "required": [ - "deviceId", - "state", - "healthChecks" - ] - }, - "DeviceHealthState": { - "description": "Device health states", - "type": "string", - "enum": [ - "healthy", - "unhealthy" - ], - "x-ms-enum": { - "name": "DeviceHealthState", - "modelAsString": true, - "values": [ - { - "value": "healthy", - "name": "healthy", - "description": "Agent is healthy" - }, - { - "value": "unhealthy", - "name": "unhealthy", - "description": "Agent is in an unhealthy state" - } - ] - } - }, - "DeviceHealthList": { - "description": "Array of Device Health, with server paging support.", - "type": "object", - "properties": { - "value": { - "description": "The collection of pageable items.", - "type": "array", - "items": { - "$ref": "#/definitions/DeviceHealth" - } - }, - "nextLink": { - "description": "The link to the next page of items.", - "type": "string" - } - }, - "required": [ - "value" - ] - }, - "HealthCheck": { - "description": "Health check", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Health check name" - }, - "result": { - "$ref": "#/definitions/HealthCheckResult", - "description": "Health check result" - } - } - }, - "DeviceHealthFilter": { - "type": "object", - "properties": { - "state": { - "$ref": "#/definitions/DeviceHealthState", - "description": "Device health state" - }, - "deviceId": { - "type": "string", - "description": "Device Id" - }, - "moduleId": { - "type": "string", - "description": "Module Id" - } - }, - "description": "Device health filter." - } - }, - "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Version of the API to be used with the client request." - }, - "EndpointParameter": { - "name": "endpoint", - "in": "path", - "required": true, - "format": "url", - "type": "string", - "x-ms-skip-url-encoding": true, - "description": "The Device Update for IoT Hub account endpoint (hostname only, no protocol).", - "x-ms-parameter-location": "client", - "x-ms-parameter-grouping": { - "name": "account-options" - } - }, - "InstanceIdParameter": { - "name": "instanceId", - "in": "path", - "required": true, - "type": "string", - "x-ms-skip-url-encoding": true, - "description": "The Device Update for IoT Hub account instance identifier.", - "x-ms-parameter-location": "client", - "x-ms-parameter-grouping": { - "name": "account-options" - } - }, - "UpdateProviderParameter": { - "name": "provider", - "in": "path", - "required": true, - "type": "string", - "description": "Update provider.", - "x-ms-parameter-location": "method" - }, - "UpdateNameParameter": { - "name": "name", - "in": "path", - "required": true, - "type": "string", - "description": "Update name.", - "x-ms-parameter-location": "method" - }, - "UpdateVersionParameter": { - "name": "version", - "in": "path", - "required": true, - "type": "string", - "description": "Update version.", - "x-ms-parameter-location": "method" - }, - "FileIdParameter": { - "name": "fileId", - "in": "path", - "required": true, - "type": "string", - "description": "File identifier.", - "x-ms-parameter-location": "method" - }, - "IfNoneMatchParameter": { - "name": "If-None-Match", - "in": "header", - "required": false, - "description": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", - "type": "string", - "x-ms-parameter-grouping": { - "name": "access-condition" - }, - "x-ms-parameter-location": "method" - }, - "OperationIdParameter": { - "name": "operationId", - "in": "path", - "description": "Operation identifier.", - "minLength": 1, - "maxLength": 256, - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "LogCollectionIdParameter": { - "name": "operationId", - "in": "path", - "description": "Log collection identifier.", - "minLength": 1, - "maxLength": 256, - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-client-name": "logCollectionId" - }, - "DeviceIdParameter": { - "name": "deviceId", - "in": "path", - "description": "Device identifier in Azure IoT Hub.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ModuleIdParameter": { - "name": "moduleId", - "in": "path", - "description": "Device module identifier in Azure IoT Hub.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DeviceClassIdParameter": { - "name": "deviceClassId", - "in": "path", - "description": "Device class identifier.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "GroupIdParameter": { - "name": "groupId", - "in": "path", - "description": "Group identifier.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DeploymentIdParameter": { - "name": "deploymentId", - "in": "path", - "description": "Deployment identifier.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DevicesImportActionParameter": { - "name": "action", - "in": "query", - "required": true, - "description": "Devices action.", - "type": "string", - "enum": [ - "import" - ], - "x-ms-enum": { - "name": "ImportAction", - "modelAsString": true, - "values": [ - { - "value": "import", - "name": "import", - "description": "Import action." - } - ] - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/deviceupdate/data-plane/api-set.json b/swagger-specs/deviceupdate/data-plane/api-set.json index f02af0fc4..0c5b9b8d8 100644 --- a/swagger-specs/deviceupdate/data-plane/api-set.json +++ b/swagger-specs/deviceupdate/data-plane/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.DeviceUpdate/stable/2022-10-01/deviceupdate.json"], "name": "package-2022-10-01"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.DeviceUpdate/preview/2020-09-01/deviceupdate.json"], "name": "package-2020-09-01"} \ No newline at end of file diff --git a/swagger-specs/dns/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dns.json b/swagger-specs/dns/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dns.json index 9f690ff19..2870bd357 100644 --- a/swagger-specs/dns/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dns.json +++ b/swagger-specs/dns/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dns.json @@ -413,6 +413,9 @@ "Create A recordset with alias target resource": { "$ref": "./examples/CreateOrUpdateARecordsetAlias.json" }, + "Create A recordset with traffic management profile": { + "$ref": "./examples/CreateOrUpdateARecordSetTrafficManagementProfile.json" + }, "Create AAAA recordset": { "$ref": "./examples/CreateOrUpdateAAAARecordset.json" }, @@ -1500,6 +1503,10 @@ "$ref": "#/definitions/SubResource", "description": "A reference to an azure resource from where the dns resource value is taken." }, + "trafficManagementProfile": { + "$ref": "#/definitions/SubResource", + "description": "A reference to an azure traffic manager profile resource from where the dns resource value is taken." + }, "ARecords": { "type": "array", "x-ms-identifiers": [], diff --git a/swagger-specs/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/edgeorder.json b/swagger-specs/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/edgeorder.json similarity index 86% rename from swagger-specs/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/edgeorder.json rename to swagger-specs/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/edgeorder.json index e2b57d2af..e8f0fd931 100644 --- a/swagger-specs/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2022-05-01-preview/edgeorder.json +++ b/swagger-specs/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2024-02-01/edgeorder.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2022-05-01-preview", + "version": "2024-02-01", "title": "Edge Ordering Service-Customer" }, "host": "management.azure.com", @@ -30,20 +30,20 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The supported operations list.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -72,10 +72,10 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$filter", @@ -110,7 +110,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -139,10 +139,10 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$skipToken", @@ -171,7 +171,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -200,10 +200,10 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$expand", @@ -239,7 +239,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -268,15 +268,15 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$filter", "in": "query", - "description": "$filter is supported to filter based on order id. Filter supports only equals operation.", + "description": "$filter is supported to filter based on order id and order Item Type. Filter supports only equals operation.", "required": false, "type": "string" }, @@ -313,7 +313,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -342,10 +342,10 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$skipToken", @@ -373,7 +373,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -402,10 +402,10 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$skipToken", @@ -425,7 +425,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -454,13 +454,13 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$filter", @@ -495,7 +495,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -524,16 +524,16 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/addressNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -546,7 +546,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -570,16 +570,16 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/addressNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "addressResource", @@ -599,12 +599,18 @@ } }, "202": { - "description": "Accepted request for create Address." + "description": "Accepted request for create Address.", + "headers": { + "Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -629,22 +635,19 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/addressNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Address deleted." - }, "202": { "description": "Accepted request for delete address.", "headers": { @@ -660,7 +663,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -685,16 +688,16 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/addressNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "If-Match", @@ -732,7 +735,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -759,19 +762,19 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" }, { "$ref": "#/parameters/orderNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -784,7 +787,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -810,18 +813,18 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$filter", "in": "query", - "description": "$filter is supported to filter based on order id. Filter supports only equals operation.", + "description": "$filter is supported to filter based on order id and order Item Type. Filter supports only equals operation.", "required": false, "type": "string" }, @@ -858,7 +861,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -887,16 +890,16 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/orderItemNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$expand", @@ -916,7 +919,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -940,16 +943,16 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/orderItemNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "orderItemResource", @@ -969,12 +972,18 @@ } }, "202": { - "description": "Accepted request to create order item." + "description": "Accepted request to create order item.", + "headers": { + "Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } }, "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -999,22 +1008,19 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/orderItemNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Order item deleted." - }, "202": { "description": "Accepted delete request for an order item.", "headers": { @@ -1030,7 +1036,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1055,16 +1061,16 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/orderItemNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "If-Match", @@ -1102,7 +1108,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1129,16 +1135,16 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/orderItemNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "cancellationReason", @@ -1160,7 +1166,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1186,16 +1192,16 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/orderItemNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "returnOrderItemDetails", @@ -1223,7 +1229,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1250,13 +1256,13 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$skipToken", @@ -1284,7 +1290,7 @@ "default": { "description": "Error response describing reason for operation failure.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1316,9 +1322,40 @@ "format": "int32", "description": "Quantity of the product.", "type": "integer" + }, + "provisioningDetails": { + "description": "List Provisioning Details for Devices in Additional Config.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ProvisioningDetails" + }, + "x-ms-identifiers": [] } } }, + "AddressClassification": { + "description": "Type of address based on its usage context.", + "enum": [ + "Shipping", + "Site" + ], + "type": "string", + "x-ms-enum": { + "name": "AddressClassification", + "modelAsString": true, + "values": [ + { + "value": "Shipping", + "description": "Shipping address for the order." + }, + { + "value": "Site", + "description": "Site Address." + } + ] + } + }, "AddressDetails": { "description": "Address details for an order item.", "required": [ @@ -1339,11 +1376,12 @@ }, "AddressProperties": { "description": "Address Properties.", - "required": [ - "contactDetails" - ], "type": "object", "properties": { + "addressClassification": { + "$ref": "#/definitions/AddressClassification", + "description": "Type of address based on its usage context." + }, "shippingAddress": { "$ref": "#/definitions/ShippingAddress", "description": "Shipping details for the address." @@ -1379,6 +1417,10 @@ } ] } + }, + "provisioningState": { + "description": "Provisioning state", + "$ref": "#/definitions/ProvisioningState" } } }, @@ -1390,7 +1432,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "properties": { @@ -1398,11 +1440,6 @@ "$ref": "#/definitions/AddressProperties", "description": "Properties of an address.", "x-ms-client-flatten": true - }, - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "Represents resource creation and update time.", - "readOnly": true } } }, @@ -1457,6 +1494,28 @@ } } }, + "AutoProvisioningStatus": { + "description": "Auto Provisioning Details.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProvisioningStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Provisioning Enabled. Will act as pre-approved, and arc extension will be enabled as soon as the device is verified to be at the right edge location." + }, + { + "value": "Disabled", + "description": "Provisioning Disabled." + } + ] + } + }, "AvailabilityInformation": { "description": "Availability information of a product system.", "type": "object", @@ -1679,6 +1738,11 @@ "description": "Frequency of recurrence.", "type": "string", "readOnly": true + }, + "termTypeDetails": { + "description": "Represent Term Type details.", + "$ref": "#/definitions/TermTypeDetails", + "readOnly": true } } }, @@ -1834,6 +1898,11 @@ "description": "Dimensions of the configuration.", "readOnly": true }, + "provisioningSupport": { + "description": "Determining nature of provisioning that the configuration supports.", + "$ref": "#/definitions/ProvisioningSupport", + "readOnly": true + }, "childConfigurationTypes": { "description": "Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter.", "uniqueItems": false, @@ -1871,6 +1940,15 @@ "readOnly": true, "x-ms-identifiers": [] }, + "supportedTermCommitmentDurations": { + "description": "The Term Commitment Durations that are supported for a configuration.", + "type": "array", + "items": { + "type": "string", + "format": "duration" + }, + "readOnly": true + }, "filterableProperties": { "description": "List of filters supported for a product.", "uniqueItems": false, @@ -2025,6 +2103,11 @@ }, "readOnly": true, "x-ms-identifiers": [] + }, + "termCommitmentInformation": { + "description": "Term Commitment Information of the Device.", + "$ref": "#/definitions/TermCommitmentInformation", + "readOnly": true } } }, @@ -2078,6 +2161,11 @@ "description": "Dimensions of the configuration.", "readOnly": true }, + "provisioningSupport": { + "description": "Determining nature of provisioning that the configuration supports.", + "$ref": "#/definitions/ProvisioningSupport", + "readOnly": true + }, "childConfigurationTypes": { "description": "Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter.", "uniqueItems": false, @@ -2114,6 +2202,15 @@ }, "readOnly": true, "x-ms-identifiers": [] + }, + "supportedTermCommitmentDurations": { + "description": "The Term Commitment Durations that are supported for a configuration.", + "type": "array", + "items": { + "type": "string", + "format": "duration" + }, + "readOnly": true } } }, @@ -2153,11 +2250,6 @@ }, "ContactDetails": { "description": "Contact Details.", - "required": [ - "contactName", - "phone", - "emailList" - ], "type": "object", "properties": { "contactName": { @@ -2318,6 +2410,11 @@ "type": "string", "readOnly": true }, + "displaySerialNumber": { + "description": "Device serial number to be displayed.", + "type": "string", + "readOnly": true + }, "managementResourceId": { "description": "Management Resource Id.", "type": "string", @@ -2327,9 +2424,57 @@ "description": "Management Resource Tenant ID.", "type": "string", "readOnly": true + }, + "provisioningSupport": { + "description": "Determining nature of provisioning that the configuration supports.", + "$ref": "#/definitions/ProvisioningSupport", + "readOnly": true + }, + "provisioningDetails": { + "$ref": "#/definitions/ProvisioningDetails", + "description": "Provisioning Details for the device.", + "readOnly": true + } + } + }, + "DevicePresenceVerificationDetails": { + "description": "Proof of possession details.", + "type": "object", + "properties": { + "status": { + "description": "Proof of possession status.", + "$ref": "#/definitions/DevicePresenceVerificationStatus", + "readOnly": true + }, + "message": { + "description": "Insights on current status.", + "type": "string", + "readOnly": true } } }, + "DevicePresenceVerificationStatus": { + "description": "Proof of possession status.", + "enum": [ + "NotInitiated", + "Completed" + ], + "type": "string", + "x-ms-enum": { + "name": "DevicePresenceVerificationStatus", + "modelAsString": true, + "values": [ + { + "value": "NotInitiated", + "description": "The device has not yet been verified to be with the right edge operator or at the right location." + }, + { + "value": "Completed", + "description": "Confirms that the device is verified to be with the right edge operator or at the right location." + } + ] + } + }, "Dimensions": { "description": "Dimensions of a configuration.", "type": "object", @@ -2562,6 +2707,10 @@ "configurationName": { "description": "Represents configuration name that uniquely identifies configuration.", "type": "string" + }, + "configurationIdDisplayName": { + "description": "Represents Model Display Name.", + "type": "string" } } }, @@ -2780,13 +2929,14 @@ "properties": { "productDetails": { "$ref": "#/definitions/ProductDetails", - "description": "Unique identifier for configuration." + "description": "Represents product details." }, "orderItemType": { "description": "Order item type.", "enum": [ "Purchase", - "Rental" + "Rental", + "External" ], "type": "string", "x-ms-enum": { @@ -2800,6 +2950,10 @@ { "value": "Rental", "description": "Rental OrderItem." + }, + { + "value": "External", + "description": "Orders placed outside of azure." } ] } @@ -2826,6 +2980,10 @@ ] } }, + "siteDetails": { + "$ref": "#/definitions/SiteDetails", + "description": "Site Related Details." + }, "currentStage": { "$ref": "#/definitions/StageDetails", "description": "Current Order item Status.", @@ -2963,17 +3121,30 @@ "x-ms-identifiers": [] }, "error": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", "description": "Top level error for the job.", "readOnly": true } } }, + "OrderItemDetailsUpdateParameter": { + "description": "Order item details Patchable Properties.", + "type": "object", + "properties": { + "productDetails": { + "$ref": "#/definitions/ProductDetailsUpdateParameter", + "description": "Represents product details." + }, + "siteDetails": { + "$ref": "#/definitions/SiteDetails", + "description": "Site Related Details." + } + } + }, "OrderItemProperties": { "description": "Represents order item properties.", "required": [ "orderItemDetails", - "addressDetails", "orderId" ], "type": "object", @@ -2995,6 +3166,11 @@ "orderId": { "description": "Id of the order to which order item belongs to.", "type": "string" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state", + "readOnly": true } } }, @@ -3006,7 +3182,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "properties": { @@ -3015,10 +3191,9 @@ "description": "Order item properties.", "x-ms-client-flatten": true }, - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "Represents resource creation and update time.", - "readOnly": true + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "Msi identity of the resource" } } }, @@ -3056,6 +3231,10 @@ "additionalProperties": { "type": "string" } + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "Msi identity of the resource" } } }, @@ -3078,6 +3257,10 @@ "items": { "type": "string" } + }, + "orderItemDetails": { + "$ref": "#/definitions/OrderItemDetailsUpdateParameter", + "description": "Represents order item details." } } }, @@ -3142,7 +3325,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ], "properties": { @@ -3150,11 +3333,6 @@ "$ref": "#/definitions/OrderProperties", "description": "Order properties.", "x-ms-client-flatten": true - }, - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "Represents resource creation and update time.", - "readOnly": true } } }, @@ -3221,6 +3399,10 @@ "managementResourcePreferences": { "$ref": "#/definitions/ManagementResourcePreferences", "description": "Preferences related to the Management resource." + }, + "termCommitmentPreferences": { + "$ref": "#/definitions/TermCommitmentPreferences", + "description": "Preferences related to the Term commitment." } } }, @@ -3302,6 +3484,10 @@ "description": "Device details of the parent configuration.", "readOnly": true }, + "parentProvisioningDetails": { + "$ref": "#/definitions/ProvisioningDetails", + "description": "Device Provisioning Details for Parent." + }, "optInAdditionalConfigurations": { "description": "List of additional configurations customer wants in the order item apart from the ones included in the base configuration.", "uniqueItems": false, @@ -3320,6 +3506,87 @@ }, "readOnly": true, "x-ms-identifiers": [] + }, + "termCommitmentInformation": { + "description": "Term Commitment Information of the Device.", + "$ref": "#/definitions/TermCommitmentInformation", + "readOnly": true + } + } + }, + "ProductDetailsUpdateParameter": { + "description": "Represents product details patchable properties.", + "type": "object", + "properties": { + "parentProvisioningDetails": { + "$ref": "#/definitions/ProvisioningDetails", + "description": "Device Provisioning Details for Parent." + } + } + }, + "ProvisioningDetails": { + "description": "Details Related To Provision Resource.", + "type": "object", + "properties": { + "quantity": { + "format": "int32", + "description": "Quantity of the devices.", + "type": "integer", + "minimum": 0, + "default": 0 + }, + "provisioningArmId": { + "description": "Provisioning Resource Arm ID.", + "type": "string", + "format": "arm-id" + }, + "provisioningEndPoint": { + "description": "Provisioning End Point.", + "type": "string" + }, + "serialNumber": { + "description": "Serial Number for the Device.", + "type": "string" + }, + "vendorName": { + "description": "Vendor Name for the Device , (for 1P devices - Microsoft).", + "type": "string" + }, + "readyToConnectArmId": { + "description": "Arc Enabled Resource Arm id.", + "type": "string", + "format": "arm-id" + }, + "managementResourceArmId": { + "description": "Management Resource ArmId.", + "type": "string", + "format": "arm-id" + }, + "uniqueDeviceIdentifier": { + "description": "Unique Identity for a Device.", + "type": "string", + "readOnly": true + }, + "autoProvisioningStatus": { + "description": "Auto Provisioning Details.", + "$ref": "#/definitions/AutoProvisioningStatus" + }, + "devicePresenceVerification": { + "description": "Proof of possession details.", + "$ref": "#/definitions/DevicePresenceVerificationDetails" + } + } + }, + "SiteDetails": { + "description": "Represents Site Related Details.", + "required": [ + "siteId" + ], + "type": "object", + "properties": { + "siteId": { + "description": "Unique Id, Identifying A Site.", + "type": "string" } } }, @@ -3497,6 +3764,61 @@ } } }, + "ProvisioningState": { + "description": "Provisioning state", + "type": "string", + "enum": [ + "Creating", + "Succeeded", + "Failed", + "Canceled" + ], + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating", + "description": "Creating state." + }, + { + "value": "Succeeded", + "description": "Succeeded state." + }, + { + "value": "Failed", + "description": "Failed state." + }, + { + "value": "Canceled", + "description": "Canceled state." + } + ] + } + }, + "ProvisioningSupport": { + "description": "Determining nature of provisioning that the configuration supports.", + "enum": [ + "CloudBased", + "Manual" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningSupport", + "modelAsString": true, + "values": [ + { + "value": "CloudBased", + "description": "The configuration can be provisioned from the cloud." + }, + { + "value": "Manual", + "description": "The configuration need to be provisioned manually by the end user." + } + ] + } + }, "PurchaseMeterDetails": { "description": "Billing type Purchase meter details.", "required": [ @@ -3527,7 +3849,33 @@ }, "x-ms-discriminator-value": "Purchase" }, + "ResourceIdentity": { + "description": "Msi identity details of the resource", + "type": "object", + "properties": { + "type": { + "description": "Identity type", + "type": "string", + "default": "None" + }, + "principalId": { + "description": "Service Principal Id backing the Msi", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Home Tenant Id", + "type": "string", + "readOnly": true + }, + "userAssignedIdentities": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentities", + "description": "User Assigned Identities" + } + } + }, "ResourceMoveRequest": { + "description": "Resource move request body.", "type": "object", "properties": { "targetResourceGroup": { @@ -3613,7 +3961,6 @@ "ShippingAddress": { "description": "Shipping address where customer wishes to receive the device.", "required": [ - "streetAddress1", "country" ], "type": "object", @@ -3755,6 +4102,7 @@ "ReadyToShip", "Shipped", "Delivered", + "ReadyToSetup", "InUse", "ReturnInitiated", "ReturnPickedUp", @@ -3792,6 +4140,10 @@ "value": "Delivered", "description": "Order is delivered to customer." }, + { + "value": "ReadyToSetup", + "description": "Order is ready to get cloud connected." + }, { "value": "InUse", "description": "Order is in use at customer site." @@ -3832,6 +4184,97 @@ } } }, + "TermCommitmentInformation": { + "description": "Term Commitment Information.", + "required": [ + "termCommitmentType" + ], + "type": "object", + "properties": { + "termCommitmentType": { + "description": "Term Commitment Type", + "$ref": "#/definitions/TermCommitmentType" + }, + "termCommitmentTypeDuration": { + "description": "Term Commitment Duration. Currently Supporting P365D, P1095D", + "type": "string", + "format": "duration", + "readOnly": true + }, + "pendingDaysForTerm": { + "format": "int32", + "description": "Number of Days Pending for Term Commitment", + "type": "integer", + "minimum": 0, + "default": 0, + "readOnly": true + } + } + }, + "TermCommitmentPreferences": { + "description": "Term Commitment preference received from customer.", + "required": [ + "preferredTermCommitmentType" + ], + "type": "object", + "properties": { + "preferredTermCommitmentType": { + "description": "Term Commitment Type", + "$ref": "#/definitions/TermCommitmentType" + }, + "preferredTermCommitmentDuration": { + "description": "Customer preferred Term Duration.", + "type": "string", + "format": "duration" + } + } + }, + "TermCommitmentType": { + "description": "Term Commitment Type", + "enum": [ + "None", + "Trial", + "Timed" + ], + "type": "string", + "x-ms-enum": { + "name": "TermCommitmentType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Pay as you go Term Commitment Model." + }, + { + "value": "Trial", + "description": "Trial Term Commitment Model." + }, + { + "value": "Timed", + "description": "Time based Term Commitment Model." + } + ] + } + }, + "TermTypeDetails": { + "description": "Holds details about term type and duration.", + "required": [ + "termType", + "termTypeDuration" + ], + "type": "object", + "properties": { + "termType": { + "description": "Term Commitment Type", + "$ref": "#/definitions/TermCommitmentType" + }, + "termTypeDuration": { + "description": "Duration for the term type.", + "type": "string", + "format": "duration" + } + } + }, "TransportPreferences": { "description": "Preferences related to the shipment logistics of the sku.", "required": [ @@ -3876,20 +4319,15 @@ "pattern": "^[-\\w\\.]+$", "x-ms-parameter-location": "method" }, - "locationParameter": { - "name": "location", - "in": "path", - "description": "The location of the resource.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "orderItemNameParameter": { "name": "orderItemName", "in": "path", "description": "The name of the order item.", "required": true, "type": "string", + "maxLength": 63, + "minLength": 3, + "pattern": "^[A-Za-z0-9][-A-Za-z0-9]*[A-Za-z0-9]$|^[A-Za-z0-9]$", "x-ms-parameter-location": "method" }, "orderNameParameter": { diff --git a/swagger-specs/edgeorder/resource-manager/api-set.json b/swagger-specs/edgeorder/resource-manager/api-set.json index 7c3977bfe..47aeac70f 100644 --- a/swagger-specs/edgeorder/resource-manager/api-set.json +++ b/swagger-specs/edgeorder/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.EdgeOrder/preview/2022-05-01-preview/edgeorder.json"], "name": "package-2022-05-preview"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.EdgeOrder/stable/2024-02-01/edgeorder.json"], "name": "package-2024-02"} \ No newline at end of file diff --git a/swagger-specs/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2023-01-01/elasticsan.json b/swagger-specs/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json similarity index 96% rename from swagger-specs/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2023-01-01/elasticsan.json rename to swagger-specs/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json index ca56e0fe8..2504c483f 100644 --- a/swagger-specs/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2023-01-01/elasticsan.json +++ b/swagger-specs/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2024-05-01", "title": "ElasticSanManagement" }, "host": "management.azure.com", @@ -283,9 +283,6 @@ "x-ms-examples": { "ElasticSans_Create_MaximumSet_Gen": { "$ref": "./examples/ElasticSans_Create_MaximumSet_Gen.json" - }, - "ElasticSans_Create_MinimumSet_Gen": { - "$ref": "./examples/ElasticSans_Create_MinimumSet_Gen.json" } } }, @@ -347,9 +344,6 @@ "x-ms-examples": { "ElasticSans_Update_MaximumSet_Gen": { "$ref": "./examples/ElasticSans_Update_MaximumSet_Gen.json" - }, - "ElasticSans_Update_MinimumSet_Gen": { - "$ref": "./examples/ElasticSans_Update_MinimumSet_Gen.json" } } }, @@ -402,9 +396,6 @@ "x-ms-examples": { "ElasticSans_Delete_MaximumSet_Gen": { "$ref": "./examples/ElasticSans_Delete_MaximumSet_Gen.json" - }, - "ElasticSans_Delete_MinimumSet_Gen": { - "$ref": "./examples/ElasticSans_Delete_MinimumSet_Gen.json" } } }, @@ -445,9 +436,6 @@ "x-ms-examples": { "ElasticSans_Get_MaximumSet_Gen": { "$ref": "./examples/ElasticSans_Get_MaximumSet_Gen.json" - }, - "ElasticSans_Get_MinimumSet_Gen": { - "$ref": "./examples/ElasticSans_Get_MinimumSet_Gen.json" } } } @@ -493,9 +481,6 @@ "x-ms-examples": { "VolumeGroups_ListByElasticSan_MaximumSet_Gen": { "$ref": "./examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json" - }, - "VolumeGroups_ListByElasticSan_MinimumSet_Gen": { - "$ref": "./examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json" } } } @@ -560,9 +545,6 @@ "x-ms-examples": { "VolumeGroups_Create_MaximumSet_Gen": { "$ref": "./examples/VolumeGroups_Create_MaximumSet_Gen.json" - }, - "VolumeGroups_Create_MinimumSet_Gen": { - "$ref": "./examples/VolumeGroups_Create_MinimumSet_Gen.json" } } }, @@ -627,9 +609,6 @@ "x-ms-examples": { "VolumeGroups_Update_MaximumSet_Gen": { "$ref": "./examples/VolumeGroups_Update_MaximumSet_Gen.json" - }, - "VolumeGroups_Update_MinimumSet_Gen": { - "$ref": "./examples/VolumeGroups_Update_MinimumSet_Gen.json" } } }, @@ -685,9 +664,6 @@ "x-ms-examples": { "VolumeGroups_Delete_MaximumSet_Gen": { "$ref": "./examples/VolumeGroups_Delete_MaximumSet_Gen.json" - }, - "VolumeGroups_Delete_MinimumSet_Gen": { - "$ref": "./examples/VolumeGroups_Delete_MinimumSet_Gen.json" } } }, @@ -731,9 +707,6 @@ "x-ms-examples": { "VolumeGroups_Get_MaximumSet_Gen": { "$ref": "./examples/VolumeGroups_Get_MaximumSet_Gen.json" - }, - "VolumeGroups_Get_MinimumSet_Gen": { - "$ref": "./examples/VolumeGroups_Get_MinimumSet_Gen.json" } } } @@ -801,9 +774,6 @@ "x-ms-examples": { "Volumes_Create_MaximumSet_Gen": { "$ref": "./examples/Volumes_Create_MaximumSet_Gen.json" - }, - "Volumes_Create_MinimumSet_Gen": { - "$ref": "./examples/Volumes_Create_MinimumSet_Gen.json" } } }, @@ -871,9 +841,6 @@ "x-ms-examples": { "Volumes_Update_MaximumSet_Gen": { "$ref": "./examples/Volumes_Update_MaximumSet_Gen.json" - }, - "Volumes_Update_MinimumSet_Gen": { - "$ref": "./examples/Volumes_Update_MinimumSet_Gen.json" } } }, @@ -962,9 +929,6 @@ "x-ms-examples": { "Volumes_Delete_MaximumSet_Gen": { "$ref": "./examples/Volumes_Delete_MaximumSet_Gen.json" - }, - "Volumes_Delete_MinimumSet_Gen": { - "$ref": "./examples/Volumes_Delete_MinimumSet_Gen.json" } } }, @@ -1011,9 +975,6 @@ "x-ms-examples": { "Volumes_Get_MaximumSet_Gen": { "$ref": "./examples/Volumes_Get_MaximumSet_Gen.json" - }, - "Volumes_Get_MinimumSet_Gen": { - "$ref": "./examples/Volumes_Get_MinimumSet_Gen.json" } } } @@ -1062,9 +1023,6 @@ "x-ms-examples": { "Volumes_ListByVolumeGroup_MaximumSet_Gen": { "$ref": "./examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json" - }, - "Volumes_ListByVolumeGroup_MinimumSet_Gen": { - "$ref": "./examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json" } } } @@ -1129,9 +1087,6 @@ "x-ms-examples": { "PrivateEndpointConnections_Create_MaximumSet_Gen": { "$ref": "./examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json" - }, - "PrivateEndpointConnections_Create_MinimumSet_Gen": { - "$ref": "./examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json" } } }, @@ -1175,9 +1130,6 @@ "x-ms-examples": { "PrivateEndpointConnections_Get_MaximumSet_Gen": { "$ref": "./examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json" - }, - "PrivateEndpointConnections_Get_MinimumSet_Gen": { - "$ref": "./examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json" } } }, @@ -1233,9 +1185,6 @@ "x-ms-examples": { "PrivateEndpointConnections_Delete_MaximumSet_Gen": { "$ref": "./examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json" - }, - "PrivateEndpointConnections_Delete_MinimumSet_Gen": { - "$ref": "./examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json" } } } @@ -1281,9 +1230,6 @@ "x-ms-examples": { "PrivateEndpointConnections_List_MaximumSet_Gen": { "$ref": "./examples/PrivateEndpointConnections_List_MaximumSet_Gen.json" - }, - "PrivateEndpointConnections_List_MinimumSet_Gen": { - "$ref": "./examples/PrivateEndpointConnections_List_MinimumSet_Gen.json" } } } @@ -1326,9 +1272,6 @@ "x-ms-examples": { "PrivateLinkResources_ListByElasticSan_MaximumSet_Gen": { "$ref": "./examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json" - }, - "PrivateLinkResources_ListByElasticSan_MinimumSet_Gen": { - "$ref": "./examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json" } } } @@ -1384,9 +1327,6 @@ "x-ms-examples": { "VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen": { "$ref": "./examples/VolumeSnapshots_ListByVolumeGroup_MaximumSet_Gen.json" - }, - "VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_ListByVolumeGroup_MinimumSet_Gen.json" } } } @@ -1454,9 +1394,6 @@ "x-ms-examples": { "VolumeSnapshots_Create_MaximumSet_Gen": { "$ref": "./examples/VolumeSnapshots_Create_MaximumSet_Gen.json" - }, - "VolumeSnapshots_Create_MinimumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_Create_MinimumSet_Gen.json" } } }, @@ -1515,9 +1452,6 @@ "x-ms-examples": { "VolumeSnapshots_Delete_MaximumSet_Gen": { "$ref": "./examples/VolumeSnapshots_Delete_MaximumSet_Gen.json" - }, - "VolumeSnapshots_Delete_MinimumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_Delete_MinimumSet_Gen.json" } } }, @@ -1564,9 +1498,6 @@ "x-ms-examples": { "VolumeSnapshots_Get_MaximumSet_Gen": { "$ref": "./examples/VolumeSnapshots_Get_MaximumSet_Gen.json" - }, - "VolumeSnapshots_Get_MinimumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_Get_MinimumSet_Gen.json" } } } @@ -2121,6 +2052,10 @@ "$ref": "#/definitions/PrivateEndpointConnection" }, "description": "The list of Private Endpoint Connections." + }, + "enforceDataIntegrityCheckForIscsi": { + "type": "boolean", + "description": "A boolean indicating whether or not Data Integrity Check is enabled" } } }, @@ -2246,6 +2181,10 @@ "x-ms-mutability": [ "update" ] + }, + "enforceDataIntegrityCheckForIscsi": { + "type": "boolean", + "description": "A boolean indicating whether or not Data Integrity Check is enabled" } } }, diff --git a/swagger-specs/elasticsan/resource-manager/api-set.json b/swagger-specs/elasticsan/resource-manager/api-set.json index 36c68abbe..8d095ad2c 100644 --- a/swagger-specs/elasticsan/resource-manager/api-set.json +++ b/swagger-specs/elasticsan/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.ElasticSan/stable/2023-01-01/elasticsan.json"], "name": "package-2023-01"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json"], "name": "package-2024-05"} \ No newline at end of file diff --git a/swagger-specs/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/PrivateCloud.json b/swagger-specs/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/PrivateCloud.json new file mode 100644 index 000000000..e756614f0 --- /dev/null +++ b/swagger-specs/eventgrid/data-plane/Microsoft.AVS/stable/2018-01-01/PrivateCloud.json @@ -0,0 +1,216 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-01-01", + "title": "Schema of Azure VMware Solution events published to Azure Event Grid", + "description": "Describes the schema of the Azure VMware Solution events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent." + }, + "paths": {}, + "definitions": { + "AvsPrivateCloudUpdatingEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdating event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsPrivateCloudEventData" + } + ], + "properties": {} + }, + "AvsPrivateCloudUpdatedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdated event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsPrivateCloudEventData" + } + ], + "properties": {} + }, + "AvsPrivateCloudFailedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudFailed event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsPrivateCloudEventData" + } + ], + "properties": { + "failureMessage": { + "description": "Failure reason of an event.", + "type": "string" + } + } + }, + "AvsClusterCreatedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterCreated event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ], + "properties": {} + }, + "AvsClusterDeletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterDeleted event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ], + "properties": {} + }, + "AvsClusterUpdatingEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdating event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ], + "properties": {} + }, + "AvsClusterUpdatedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdated event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ], + "properties": {} + }, + "AvsClusterFailedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterFailed event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsClusterEventData" + } + ], + "properties": { + "failureMessage": { + "description": "Failure reason of an event.", + "type": "string" + } + } + }, + "AvsScriptExecutionStartedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionStarted event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ], + "properties": {} + }, + "AvsScriptExecutionFinishedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFinished event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ], + "properties": { + "namedOutputs": { + "description": "Named outputs of completed execution, if any.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AvsScriptExecutionCancelledEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionCancelled event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ], + "properties": {} + }, + "AvsScriptExecutionFailedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFailed event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AvsScriptExecutionEventData" + } + ], + "properties": { + "failureMessage": { + "description": "Failure reason of an event.", + "type": "string" + } + } + }, + "AvsPrivateCloudEventData": { + "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/privateClouds events.", + "type": "object", + "properties": { + "operationId": { + "description": "Id of the operation that caused this event.", + "type": "string" + } + } + }, + "AvsClusterEventData": { + "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/clusters events.", + "type": "object", + "properties": { + "operationId": { + "description": "Id of the operation that caused this event.", + "type": "string" + }, + "addedHostNames": { + "description": "Hosts added to the cluster in this event, if any.", + "type": "array", + "items": { + "type": "string" + } + }, + "removedHostNames": { + "description": "Hosts removed to the cluster in this event, if any.", + "type": "array", + "items": { + "type": "string" + } + }, + "inMaintenanceHostNames": { + "description": "Hosts in Maintenance mode in the cluster, if any.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AvsScriptExecutionEventData": { + "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/scriptExecutions events.", + "type": "object", + "properties": { + "operationId": { + "description": "Id of the operation that caused this event.", + "type": "string" + }, + "cmdletId": { + "description": "Cmdlet referenced in the execution that caused this event.", + "type": "string" + }, + "output": { + "description": "Stdout outputs from the execution, if any.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } +} diff --git a/swagger-specs/eventgrid/data-plane/Microsoft.ApiCenter/stable/2018-01-01/ApiCenter.json b/swagger-specs/eventgrid/data-plane/Microsoft.ApiCenter/stable/2018-01-01/ApiCenter.json new file mode 100644 index 000000000..228b383e3 --- /dev/null +++ b/swagger-specs/eventgrid/data-plane/Microsoft.ApiCenter/stable/2018-01-01/ApiCenter.json @@ -0,0 +1,75 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-01-01", + "title": "Schema of Azure API Center service events published to Azure Event Grid", + "description": "Describes the schema of the Azure API Center service events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent." + }, + "paths": {}, + "definitions": { + "ApiCenterApiDefinitionAddedEventData": { + "description": "Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionAdded event.", + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "API definition title." + }, + "description": { + "type": "string", + "description": "API definition description." + }, + "specification": { + "$ref": "#/definitions/ApiCenterApiSpecification" + } + }, + "x-ms-examples": { + "userCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/api_definition_added.json" + }, + "userCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/api_definition_added.json" + } + } + }, + "ApiCenterApiDefinitionUpdatedEventData": { + "description": "Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionUpdated event.", + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "API definition title." + }, + "description": { + "type": "string", + "description": "API definition description." + }, + "specification": { + "$ref": "#/definitions/ApiCenterApiSpecification" + } + }, + "x-ms-examples": { + "userCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/api_definition_updated.json" + }, + "userCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/api_definition_updated.json" + } + } + }, + "ApiCenterApiSpecification": { + "type": "object", + "description": "API specification details.", + "properties": { + "name": { + "type": "string", + "description": "Specification name." + }, + "version": { + "type": "string", + "description": "Specification version." + } + } + } + } +} diff --git a/swagger-specs/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/swagger-specs/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json index f9c27dc6c..8cbf69a50 100644 --- a/swagger-specs/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json +++ b/swagger-specs/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -13,12 +13,12 @@ "properties": { "to": { "description": "The communication identifier of the target user.", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel", + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel", "x-ms-client-name": "toCommunicationIdentifier" }, "from": { "description": "The communication identifier of the user who initiated the call.", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel", + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel", "x-ms-client-name": "fromCommunicationIdentifier" }, "serverCallId": { @@ -49,7 +49,7 @@ "properties": { "userCommunicationIdentifier": { "description": "The communication identifier of the user who was disconnected", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" } } }, @@ -814,6 +814,77 @@ } } }, + "AcsRouterWorkerUpdatedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerUpdated event", + "type": "object", + "properties": { + "workerId": { + "description": "Router Worker Updated Worker Id", + "type": "string" + }, + "queueAssignments": { + "description": "Router Worker Updated Queue Info", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterQueueDetails" + } + }, + "channelConfigurations": { + "description": "Router Worker Updated Channel Configuration", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterChannelConfiguration" + } + }, + "totalCapacity": { + "description": "Router Worker Updated Total Capacity", + "type": "integer", + "format": "int32" + }, + "labels": { + "type": "object", + "description": "Router Worker Updated Labels", + "additionalProperties": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Router Worker Updated Tags", + "additionalProperties": { + "type": "string" + } + }, + "updatedWorkerProperties": { + "description": "Router Worker Properties Updated", + "type": "array", + "items": { + "type": "string", + "description": "An individual property updated in the Router Worker", + "enum": [ + "AvailableForOffers", + "TotalCapacity", + "QueueAssignments", + "Labels", + "Tags", + "ChannelConfigurations" + ], + "x-ms-enum": { + "name": "AcsRouterUpdatedWorkerProperty", + "modelAsString": true + } + } + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_worker_updated.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_worker_updated.json" + } + } + }, "AcsChatMessageReceivedEventData": { "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceived event.", "allOf": [ @@ -955,7 +1026,7 @@ "properties": { "createdByCommunicationIdentifier": { "description": "The communication identifier of the user who created the thread", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "properties": { "description": "The thread properties", @@ -991,7 +1062,7 @@ "properties": { "createdByCommunicationIdentifier": { "description": "The communication identifier of the user who created the thread", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "properties": { "description": "The thread properties", @@ -1000,6 +1071,13 @@ "type": "object" } }, + "metadata": { + "description": "The chat thread created metadata", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, "participants": { "description": "The list of properties of participants who are part of the thread", "type": "array", @@ -1020,7 +1098,7 @@ "properties": { "deletedByCommunicationIdentifier": { "description": "The communication identifier of the user who deleted the thread", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "deleteTime": { "description": "The deletion time of the thread", @@ -1040,7 +1118,7 @@ "properties": { "deletedByCommunicationIdentifier": { "description": "The communication identifier of the user who deleted the thread", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "deleteTime": { "description": "The deletion time of the thread", @@ -1060,7 +1138,7 @@ "properties": { "editedByCommunicationIdentifier": { "description": "The communication identifier of the user who updated the thread properties", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "editTime": { "description": "The time at which the properties of the thread were updated", @@ -1094,7 +1172,7 @@ "properties": { "editedByCommunicationIdentifier": { "description": "The communication identifier of the user who updated the thread properties", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "editTime": { "description": "The time at which the properties of the thread were updated", @@ -1133,7 +1211,7 @@ }, "addedByCommunicationIdentifier": { "description": "The communication identifier of the user who added the user", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "participantAdded": { "description": "The details of the user who was added", @@ -1157,7 +1235,7 @@ }, "removedByCommunicationIdentifier": { "description": "The communication identifier of the user who removed the user", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "participantRemoved": { "description": "The details of the user who was removed", @@ -1181,7 +1259,7 @@ }, "addedByCommunicationIdentifier": { "description": "The communication identifier of the user who added the user", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "participantAdded": { "description": "The details of the user who was added", @@ -1210,7 +1288,7 @@ }, "removedByCommunicationIdentifier": { "description": "The communication identifier of the user who removed the user", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "participantRemoved": { "description": "The details of the user who was removed", @@ -1455,6 +1533,170 @@ } } }, + "AcsMessageReceivedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageReceived event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsMessageEventData" + } + ], + "properties": { + "content": { + "description": "The received message content", + "type": "string" + }, + "channelType": { + "description": "The received message channel Kind", + "type": "string", + "x-ms-client-name": "channelKind", + "enum": [ + "whatsapp" + ], + "x-ms-enum": { + "name": "AcsMessageChannelKind", + "modelAsString": true, + "values": [ + { + "value": "whatsapp", + "description": "Updated message channel type is Whatsapp" + } + ] + } + }, + "media": { + "description": "The received message media content", + "$ref": "#/definitions/AcsMessageMediaContent", + "type": "object", + "x-ms-client-name": "mediaContent" + }, + "context": { + "description": "The received message context", + "$ref": "#/definitions/AcsMessageContext", + "type": "object" + }, + "button": { + "description": "The received message button content", + "$ref": "#/definitions/AcsMessageButtonContent", + "type": "object" + }, + "interactive": { + "description": "The received message interactive content", + "$ref": "#/definitions/AcsMessageInteractiveContent", + "type": "object", + "x-ms-client-name": "interactiveContent" + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/advanced_message_received.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/advanced_message_received.json" + } + } + }, + "AcsMessageDeliveryStatusUpdatedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsMessageEventData" + } + ], + "properties": { + "messageId": { + "description": "The message id", + "type": "string" + }, + "status": { + "description": "The updated message status", + "type": "string", + "enum": [ + "Read", + "Delivered", + "Failed", + "Sent", + "Warning", + "Unknown" + ], + "x-ms-enum": { + "name": "AcsMessageDeliveryStatus", + "modelAsString": true, + "values": [ + { + "value": "read" + }, + { + "value": "delivered" + }, + { + "value": "failed" + }, + { + "value": "sent" + }, + { + "value": "warning" + }, + { + "value": "unknown" + } + ] + } + }, + "channelType": { + "description": "The updated message channel type", + "x-ms-client-name": "channelKind", + "type": "string", + "enum": [ + "whatsapp" + ], + "x-ms-enum": { + "name": "AcsMessageChannelKind", + "modelAsString": true, + "values": [ + { + "value": "whatsapp", + "description": "Updated message channel type is Whatsapp" + } + ] + } + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/advanced_message_delivery_status_updated.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/advanced_message_delivery_status_updated.json" + } + } + }, + "AcsMessageEventData": { + "description": "Schema of common properties of all chat thread events", + "type": "object", + "properties": { + "from": { + "description": "The message sender", + "type": "string" + }, + "to": { + "description": "The message recipient", + "type": "string" + }, + "receivedTimestamp": { + "description": "The time message was received", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "The channel event error", + "$ref": "#/definitions/AcsMessageChannelEventError", + "type": "object" + } + } + }, "AcsChatThreadEventBaseProperties": { "description": "Schema of common properties of all chat thread events", "allOf": [ @@ -1512,7 +1754,7 @@ }, "senderCommunicationIdentifier": { "description": "The communication identifier of the sender", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "senderDisplayName": { "description": "The display name of the sender", @@ -1549,7 +1791,7 @@ }, "senderCommunicationIdentifier": { "description": "The communication identifier of the sender", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "senderDisplayName": { "description": "The display name of the sender", @@ -1653,7 +1895,7 @@ "properties": { "recipientCommunicationIdentifier": { "description": "The communication identifier of the target user", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "transactionId": { "description": "The transaction id will be used as co-relation vector", @@ -1675,7 +1917,7 @@ }, "participantCommunicationIdentifier": { "description": "The communication identifier of the user", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" }, "metadata": { "description": "The metadata of the user", @@ -1917,8 +2159,9 @@ ] } }, - "labelValue": { + "value": { "description": "Router Job Worker Selector Value", + "x-ms-client-name": "labelValue", "type": "object" }, "ttlSeconds": { @@ -1953,6 +2196,150 @@ "format": "date-time" } } + }, + "AcsMessageChannelEventError": { + "description": "Message Channel Event Error", + "type": "object", + "properties": { + "channelCode": { + "description": "The channel error code", + "type": "string" + }, + "channelMessage": { + "description": "The channel error message", + "type": "string" + } + } + }, + "AcsMessageMediaContent": { + "description": "Message Media Content", + "type": "object", + "properties": { + "mimeType": { + "description": "The MIME type of the file this media represents", + "type": "string" + }, + "id": { + "x-ms-client-name": "mediaId", + "description": "The media identifier", + "type": "string" + }, + "fileName": { + "description": "The filename of the underlying media file as specified when uploaded", + "type": "string" + }, + "caption": { + "description": "The caption for the media object, if supported and provided", + "type": "string" + } + } + }, + "AcsMessageContext": { + "description": "Message Context", + "type": "object", + "properties": { + "from": { + "description": "The WhatsApp ID for the customer who replied to an inbound message.", + "type": "string" + }, + "id": { + "x-ms-client-name": "messageId", + "description": "The message ID for the sent message for an inbound reply", + "type": "string" + } + } + }, + "AcsMessageButtonContent": { + "description": "Message Button Content", + "type": "object", + "properties": { + "text": { + "description": "The Text of the button", + "type": "string" + }, + "payload": { + "description": "The Payload of the button which was clicked by the user, setup by the business", + "type": "string" + } + } + }, + "AcsMessageInteractiveContent": { + "description": "Message Interactive Content", + "type": "object", + "properties": { + "type": { + "x-ms-client-name": "replyKind", + "description": "The Message interactive reply type", + "type": "string", + "enum": [ + "buttonReply", + "listReply", + "unknown" + ], + "x-ms-enum": { + "name": "AcsInteractiveReplyKind", + "modelAsString": true, + "values": [ + { + "value": "buttonReply", + "description": "Messaged interactive reply type is ButtonReply" + }, + { + "value": "listReply", + "description": "Messaged interactive reply type is ListReply" + }, + { + "value": "unknown", + "description": "Messaged interactive reply type is Unknown" + } + ] + } + }, + "buttonReply": { + "description": "The Message Sent when a customer clicks a button", + "$ref": "#/definitions/AcsMessageInteractiveButtonReplyContent", + "type": "object" + }, + "listReply": { + "description": "The Message Sent when a customer selects an item from a list", + "$ref": "#/definitions/AcsMessageInteractiveListReplyContent", + "type": "object" + } + } + }, + "AcsMessageInteractiveButtonReplyContent": { + "description": "Message Interactive button reply content for a user to business message", + "type": "object", + "properties": { + "id": { + "x-ms-client-name": "buttonId", + "description": "The ID of the button", + "type": "string" + }, + "title": { + "description": "The title of the button", + "type": "string" + } + } + }, + "AcsMessageInteractiveListReplyContent": { + "description": "Message Interactive list reply content for a user to business message", + "type": "object", + "properties": { + "id": { + "x-ms-client-name": "listItemId", + "description": "The ID of the selected list item", + "type": "string" + }, + "title": { + "description": "The title of the selected list item", + "type": "string" + }, + "description": { + "description": "The sescription of the selected row", + "type": "string" + } + } } } } diff --git a/swagger-specs/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json b/swagger-specs/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json index 12f99a19a..2e4f9a09a 100644 --- a/swagger-specs/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json +++ b/swagger-specs/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json @@ -491,6 +491,76 @@ "$ref": "./examples/event-grid-schema/storage_task_completed.json" } } + }, + "StorageTaskAssignmentQueuedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentQueued event.", + "type": "object", + "properties": { + "queuedDateTime": { + "description": "The time at which a storage task was queued.", + "format": "date-time", + "type": "string", + "x-ms-client-name": "queuedOn" + }, + "taskExecutionId": { + "description": "The execution id for a storage task.", + "type": "string" + } + }, + "x-ms-examples": { + "StorageTaskAssignmentQueuedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/storage_task_assignment_queued.json" + }, + "StorageTaskAssignmentQueuedEventGridSchema": { + "$ref": "./examples/event-grid-schema/storage_task_assignment_queued.json" + } + } + }, + "StorageTaskAssignmentCompletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentCompleted event.", + "type": "object", + "properties": { + "status": { + "description": "The status for a storage task.", + "type": "string", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "StorageTaskAssignmentCompletedStatus", + "modelAsString": true + } + }, + "completedDateTime": { + "description": "The time at which a storage task was completed.", + "format": "date-time", + "type": "string", + "x-ms-client-name": "completedOn" + }, + "taskExecutionId": { + "description": "The execution id for a storage task.", + "type": "string" + }, + "taskName": { + "description": "The task name for a storage task.", + "type": "string" + }, + "summaryReportBlobUrl": { + "description": "The summary report blob url for a storage task", + "format": "url", + "type": "string", + "x-ms-client-name": "summaryReportBlobUri" + } + }, + "x-ms-examples": { + "StorageTaskAssignmentCompletedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/storage_task_assignment_completed.json" + }, + "StorageTaskAssignmentCompletedEventGridSchema": { + "$ref": "./examples/event-grid-schema/storage_task_assignment_completed.json" + } + } } } } diff --git a/swagger-specs/eventgrid/data-plane/api-set.json b/swagger-specs/eventgrid/data-plane/api-set.json index 9cd18b3d6..6f5c4120c 100644 --- a/swagger-specs/eventgrid/data-plane/api-set.json +++ b/swagger-specs/eventgrid/data-plane/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Storage/stable/2018-01-01/Storage.json", "Microsoft.EventHub/stable/2018-01-01/EventHub.json", "Microsoft.Resources/stable/2018-01-01/Resources.json", "Microsoft.EventGrid/stable/2018-01-01/EventGrid.json", "Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json", "Microsoft.DataBox/stable/2018-01-01/DataBox.json", "Microsoft.Devices/stable/2018-01-01/IotHub.json", "Microsoft.ContainerRegistry/stable/2018-01-01/ContainerRegistry.json", "Microsoft.ServiceBus/stable/2018-01-01/ServiceBus.json", "Microsoft.Media/stable/2018-01-01/MediaServices.json", "Microsoft.Maps/stable/2018-01-01/Maps.json", "Microsoft.AppConfiguration/stable/2018-01-01/AppConfiguration.json", "Microsoft.SignalRService/stable/2018-01-01/SignalRService.json", "Microsoft.KeyVault/stable/2018-01-01/KeyVault.json", "Microsoft.MachineLearningServices/stable/2018-01-01/MachineLearningServices.json", "Microsoft.Cache/stable/2018-01-01/RedisCache.json", "Microsoft.Web/stable/2018-01-01/Web.json", "Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json", "Microsoft.PolicyInsights/stable/2018-01-01/PolicyInsights.json", "Microsoft.ContainerService/stable/2018-01-01/ContainerService.json", "Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json", "Microsoft.HealthcareApis/stable/2018-01-01/HealthcareApis.json", "Microsoft.ResourceNotifications/stable/2018-01-01/common.json", "Microsoft.ResourceNotifications/stable/2018-01-01/HealthResources.json", "Microsoft.ResourceNotifications/stable/2018-01-01/Resources.json"], "name": "package-2018-01"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.Storage/stable/2018-01-01/Storage.json", "Microsoft.EventHub/stable/2018-01-01/EventHub.json", "Microsoft.Resources/stable/2018-01-01/Resources.json", "Microsoft.EventGrid/stable/2018-01-01/EventGrid.json", "Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json", "Microsoft.DataBox/stable/2018-01-01/DataBox.json", "Microsoft.Devices/stable/2018-01-01/IotHub.json", "Microsoft.ContainerRegistry/stable/2018-01-01/ContainerRegistry.json", "Microsoft.ServiceBus/stable/2018-01-01/ServiceBus.json", "Microsoft.Media/stable/2018-01-01/MediaServices.json", "Microsoft.Maps/stable/2018-01-01/Maps.json", "Microsoft.AppConfiguration/stable/2018-01-01/AppConfiguration.json", "Microsoft.SignalRService/stable/2018-01-01/SignalRService.json", "Microsoft.KeyVault/stable/2018-01-01/KeyVault.json", "Microsoft.MachineLearningServices/stable/2018-01-01/MachineLearningServices.json", "Microsoft.Cache/stable/2018-01-01/RedisCache.json", "Microsoft.Web/stable/2018-01-01/Web.json", "Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json", "Microsoft.PolicyInsights/stable/2018-01-01/PolicyInsights.json", "Microsoft.ContainerService/stable/2018-01-01/ContainerService.json", "Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json", "Microsoft.HealthcareApis/stable/2018-01-01/HealthcareApis.json", "Microsoft.ResourceNotifications/stable/2018-01-01/common.json", "Microsoft.ResourceNotifications/stable/2018-01-01/HealthResources.json", "Microsoft.ResourceNotifications/stable/2018-01-01/Resources.json", "Microsoft.AVS/stable/2018-01-01/PrivateCloud.json", "Microsoft.ApiCenter/stable/2018-01-01/ApiCenter.json"], "name": "package-2018-01"} \ No newline at end of file diff --git a/swagger-specs/eventgrid/resource-manager/Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json b/swagger-specs/eventgrid/resource-manager/Microsoft.EventGrid/preview/2024-06-01-preview/EventGrid.json similarity index 96% rename from swagger-specs/eventgrid/resource-manager/Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json rename to swagger-specs/eventgrid/resource-manager/Microsoft.EventGrid/preview/2024-06-01-preview/EventGrid.json index 2b7b70df2..25778df63 100644 --- a/swagger-specs/eventgrid/resource-manager/Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json +++ b/swagger-specs/eventgrid/resource-manager/Microsoft.EventGrid/preview/2024-06-01-preview/EventGrid.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-12-15-preview", + "version": "2024-06-01-preview", "title": "EventGridManagementClient", "description": "Azure EventGrid Management Client" }, @@ -73,7 +73,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -156,7 +156,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -234,7 +234,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -302,7 +302,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -757,7 +757,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -840,7 +840,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -918,7 +918,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -986,7 +986,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1057,7 +1057,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1140,7 +1140,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1218,7 +1218,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1286,7 +1286,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2265,7 +2265,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription.", "required": true, "type": "string" }, @@ -2337,7 +2337,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be found.", "required": true, "type": "string", "maxLength": 50, @@ -2358,7 +2358,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2415,7 +2415,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 50 characters in length and use alphanumeric letters only.", "required": true, "type": "string", "maxLength": 50, @@ -2451,7 +2451,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2510,7 +2510,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be deleted.", "required": true, "type": "string", "maxLength": 50, @@ -2539,7 +2539,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2600,7 +2600,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be updated.", "required": true, "type": "string", "maxLength": 50, @@ -2641,7 +2641,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2719,7 +2719,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2779,7 +2779,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription.", "required": true, "type": "string", "maxLength": 50, @@ -2800,7 +2800,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2835,7 +2835,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription.", + "description": "Name of the event subscription to be found.", "required": true, "type": "string" }, @@ -2915,7 +2915,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.", "required": true, "type": "string" }, @@ -3003,7 +3003,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription.", + "description": "Name of the event subscription to be deleted.", "required": true, "type": "string" }, @@ -3177,7 +3177,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription.", + "description": "Name of the event subscription to be found.", "required": true, "type": "string" }, @@ -3243,7 +3243,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only.", "required": true, "type": "string" }, @@ -3323,7 +3323,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be deleted.", "required": true, "type": "string" }, @@ -3467,7 +3467,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be found.", "required": true, "type": "string" }, @@ -3526,7 +3526,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only.", "required": true, "type": "string" }, @@ -3599,7 +3599,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be deleted.", "required": true, "type": "string" }, @@ -3736,7 +3736,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be found.", "required": true, "type": "string" }, @@ -3795,7 +3795,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only.", "required": true, "type": "string" }, @@ -3868,7 +3868,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be deleted.", "required": true, "type": "string" }, @@ -4005,7 +4005,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be found.", "required": true, "type": "string" }, @@ -4064,7 +4064,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only.", "required": true, "type": "string" }, @@ -4131,7 +4131,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be deleted.", "required": true, "type": "string" }, @@ -4199,7 +4199,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be updated.", "required": true, "type": "string" }, @@ -4240,7 +4240,7 @@ "tags": [ "EventSubscriptions" ], - "summary": "Get full URL of an event subscription of a system topic", + "summary": "Get full URL of an event subscription of a system topic.", "description": "Get the full endpoint URL for an event subscription of a system topic.", "operationId": "SystemTopicEventSubscriptions_GetFullUrl", "consumes": [], @@ -4268,7 +4268,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription.", "required": true, "type": "string" }, @@ -4447,7 +4447,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be found.", "required": true, "type": "string" }, @@ -4506,7 +4506,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only.", "required": true, "type": "string" }, @@ -4579,7 +4579,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be deleted.", "required": true, "type": "string" }, @@ -4647,7 +4647,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription to be updated.", "required": true, "type": "string" }, @@ -4716,7 +4716,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription.", "required": true, "type": "string" }, @@ -5813,7 +5813,7 @@ { "name": "eventSubscriptionName", "in": "path", - "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "description": "Name of the event subscription.", "required": true, "type": "string" }, @@ -5886,7 +5886,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5959,7 +5959,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6027,7 +6027,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6109,7 +6109,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6160,7 +6160,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6217,7 +6217,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6278,7 +6278,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6355,7 +6355,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6427,7 +6427,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6510,7 +6510,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6588,7 +6588,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6680,7 +6680,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6748,7 +6748,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6819,7 +6819,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6906,7 +6906,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -7432,7 +7432,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -7505,7 +7505,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -7573,7 +7573,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -7661,7 +7661,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -7712,7 +7712,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -7769,7 +7769,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -7830,7 +7830,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -7885,7 +7885,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -7949,7 +7949,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -8011,7 +8011,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -8079,7 +8079,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -8127,7 +8127,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -8184,7 +8184,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -8242,7 +8242,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -8308,7 +8308,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -9192,7 +9192,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -9287,7 +9287,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -9364,7 +9364,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -9435,7 +9435,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -9518,7 +9518,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -9596,7 +9596,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -9664,7 +9664,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -11117,7 +11117,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -11200,7 +11200,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -11278,7 +11278,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -11346,7 +11346,7 @@ "default": { "description": "Error response returned if request was unsuccessful.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -11570,6 +11570,154 @@ "nextLinkName": "nextLink" } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/validateCustomDomainOwnership": { + "post": { + "tags": [ + "Namespaces" + ], + "summary": "Validate ownership for all custom domains in a namespace.", + "description": "Performs ownership validation via checking TXT records for all custom domains in a namespace.", + "operationId": "Namespaces_ValidateCustomDomainOwnership", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "Name of the Namespace.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 3, + "pattern": "^[a-zA-Z0-9-]*$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomDomainOwnershipValidationResult" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response returned if request was unsuccessful.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Namespaces_ValidateCustomDomainOwnership": { + "$ref": "./examples/Namespaces_ValidateCustomDomainOwnership.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl": { + "post": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get full URL of an event subscription of a namespace topic.", + "description": "Get the full endpoint URL for an event subscription of a namespace topic.", + "operationId": "NamespaceTopicEventSubscriptions_GetFullUrl", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "Name of the namespace.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 3, + "pattern": "^[a-zA-Z0-9-]*$" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the namespace topic.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 3, + "pattern": "^[a-zA-Z0-9-]*$" + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 3, + "pattern": "^[a-zA-Z0-9-]*$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionFullUrl" + } + }, + "default": { + "description": "Error response returned if request was unsuccessful.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NamespaceTopicEventSubscriptions_GetFullUrl": { + "$ref": "./examples/NamespaceTopicEventSubscriptions_GetFullUrl.json" + } + } + } } }, "definitions": { @@ -11632,7 +11780,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to the CaCertificate resource.", "type": "object", "readOnly": true @@ -11968,7 +12116,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to Channel resource.", "type": "object", "readOnly": true @@ -12117,7 +12265,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to the ClientGroup resource.", "type": "object", "readOnly": true @@ -12239,7 +12387,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to the Client resource.", "type": "object", "readOnly": true @@ -12268,6 +12416,7 @@ "type": "object", "properties": { "privateEndpointConnections": { + "description": "List of private endpoint connections.", "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" @@ -12731,7 +12880,7 @@ "description": "Identity information for the Event Grid Domain resource." }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to the Event Grid Domain resource.", "type": "object", "readOnly": true @@ -12917,7 +13066,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to Domain Topic resource.", "type": "object", "readOnly": true @@ -13084,6 +13233,11 @@ "filtersConfiguration": { "$ref": "#/definitions/FiltersConfiguration", "description": "Information about the filter for the event subscription." + }, + "expirationTimeUtc": { + "format": "date-time", + "description": "Expiration time of the event subscription.", + "type": "string" } } }, @@ -13169,7 +13323,7 @@ }, "deadLetterDestination": { "$ref": "#/definitions/DeadLetterDestination", - "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering." + "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering." } } }, @@ -13178,7 +13332,7 @@ "type": "object", "properties": { "type": { - "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.", + "description": "The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'.", "enum": [ "SystemAssigned", "UserAssigned" @@ -13657,7 +13811,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to Event Subscription resource.", "type": "object", "readOnly": true @@ -13696,6 +13850,11 @@ "filtersConfiguration": { "$ref": "#/definitions/FiltersConfiguration", "description": "Information about the filter for the event subscription." + }, + "expirationTimeUtc": { + "format": "date-time", + "description": "Expiration time of the event subscription.", + "type": "string" } } }, @@ -13805,7 +13964,7 @@ }, "destination": { "$ref": "#/definitions/EventSubscriptionDestination", - "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering." + "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery." } } }, @@ -13936,11 +14095,15 @@ }, "deadLetterDestinationWithResourceIdentity": { "$ref": "#/definitions/DeadLetterWithResourceIdentity", - "description": "The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.\r\nUses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens being used during delivery / dead-lettering." + "description": "The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.\r\nUses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens being used during dead-lettering." }, "deliveryWithResourceIdentity": { "$ref": "#/definitions/DeliveryWithResourceIdentity", - "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering." + "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery." + }, + "destination": { + "$ref": "#/definitions/EventSubscriptionDestination", + "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses Azure Event Grid's identity to acquire the authentication tokens being used during delivery." } } }, @@ -14762,7 +14925,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to Event Subscription resource.", "type": "object", "readOnly": true @@ -14825,7 +14988,7 @@ } }, "EventSubscriptionFullUrl": { - "description": "Full endpoint url of an event subscription", + "description": "Full endpoint URL of an event subscription", "type": "object", "properties": { "endpointUrl": { @@ -14856,6 +15019,7 @@ "type": "object", "properties": { "privateEndpointConnections": { + "description": "List of private endpoint connections.", "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" @@ -14960,6 +15124,14 @@ "description": "The hostname for the topics configuration. This is a read-only property.", "type": "string", "readOnly": true + }, + "customDomains": { + "description": "List of custom domain configurations for the namespace.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomainConfiguration" + }, + "x-ms-identifiers": [] } } }, @@ -15010,6 +15182,56 @@ "routingIdentityInfo": { "$ref": "#/definitions/RoutingIdentityInfo", "description": "Routing identity info for topic spaces configuration." + }, + "customDomains": { + "description": "List of custom domain configurations for the namespace.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomainConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "CustomDomainConfiguration": { + "description": "A custom domain configuration that allows users to publish to their own domain name.", + "required": [ + "fullyQualifiedDomainName" + ], + "type": "object", + "properties": { + "fullyQualifiedDomainName": { + "description": "Fully Qualified Domain Name (FQDN) for the custom domain.", + "type": "string" + }, + "validationState": { + "description": "Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated.", + "enum": [ + "Pending", + "Approved", + "ErrorRetrievingDnsRecord" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomDomainValidationState", + "modelAsString": true + } + }, + "identity": { + "$ref": "#/definitions/CustomDomainIdentity", + "description": "Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace." + }, + "certificateUrl": { + "description": "The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either\r\nversioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g.,\r\nhttps://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert)", + "type": "string" + }, + "expectedTxtRecordName": { + "description": "Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain.\r\nThe values under this TXT record must contain the expected TXT record value.", + "type": "string" + }, + "expectedTxtRecordValue": { + "description": "Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain.", + "type": "string" } } }, @@ -15040,6 +15262,7 @@ "description": "Alternative authentication name sources related to client authentication settings for namespace resource.", "type": "array", "items": { + "description": "Alternative authentication name sources related to client authentication settings for namespace resource.", "enum": [ "ClientCertificateSubject", "ClientCertificateDns", @@ -15053,6 +15276,10 @@ "modelAsString": true } } + }, + "customJwtAuthentication": { + "$ref": "#/definitions/CustomJwtAuthenticationSettings", + "description": "Custom JWT authentication settings for namespace resource." } } }, @@ -15061,6 +15288,7 @@ "type": "object", "properties": { "type": { + "description": "Routing identity type for topic spaces configuration.", "enum": [ "None", "SystemAssigned", @@ -15077,6 +15305,28 @@ } } }, + "CustomDomainIdentity": { + "description": "The identity information for retrieving the certificate for the custom domain.", + "type": "object", + "properties": { + "type": { + "description": "The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'.", + "enum": [ + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomDomainIdentityType", + "modelAsString": true + } + }, + "userAssignedIdentity": { + "description": "The user identity associated with the resource.", + "type": "string" + } + } + }, "DynamicRoutingEnrichment": { "type": "object", "properties": { @@ -15157,7 +15407,7 @@ "description": "Identity information for the Namespace resource." }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to the namespace resource.", "type": "object", "readOnly": true @@ -15198,6 +15448,10 @@ "$ref": "#/definitions/UpdateTopicSpacesConfigurationInfo", "description": "Topic spaces configuration properties that can be updated." }, + "topicsConfiguration": { + "$ref": "#/definitions/UpdateTopicsConfigurationInfo", + "description": "Topics configuration properties that can be updated." + }, "publicNetworkAccess": { "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ", "enum": [ @@ -15262,6 +15516,14 @@ "routingIdentityInfo": { "$ref": "#/definitions/RoutingIdentityInfo", "description": "Routing identity info for topic spaces configuration." + }, + "customDomains": { + "description": "Custom domain info for topic spaces configuration.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomainConfiguration" + }, + "x-ms-identifiers": [] } } }, @@ -15381,7 +15643,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to namespace topic resource.", "type": "object", "readOnly": true @@ -15569,7 +15831,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to partner configuration resource.", "type": "object", "readOnly": true @@ -15706,7 +15968,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to Partner Destination resource.", "type": "object", "readOnly": true @@ -15748,6 +16010,7 @@ "type": "object", "properties": { "privateEndpointConnections": { + "description": "List of private endpoint connections.", "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" @@ -15850,7 +16113,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to Partner Namespace resource.", "type": "object", "readOnly": true @@ -16007,7 +16270,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to Partner Registration resource.", "type": "object", "readOnly": true @@ -16122,7 +16385,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to Partner Topic resource.", "type": "object", "readOnly": true @@ -16400,7 +16663,7 @@ "description": "List of subscriptions.", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/NetworkSecurityPerimeterSubscription" } }, "networkSecurityPerimeters": { @@ -16433,6 +16696,16 @@ } } }, + "NetworkSecurityPerimeterSubscription": { + "description": "Network security perimeter subscription inbound access rule.", + "type": "object", + "properties": { + "id": { + "description": "Subscription id.", + "type": "string" + } + } + }, "NetworkSecurityPerimeterConfiguration": { "description": "Network security perimeter configuration.", "type": "object", @@ -16529,7 +16802,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to the PermissionBinding resource.", "type": "object", "readOnly": true @@ -16684,7 +16957,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to System Topic resource.", "type": "object", "readOnly": true @@ -16734,6 +17007,7 @@ "type": "object", "properties": { "privateEndpointConnections": { + "description": "List of private endpoint connections.", "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" @@ -16897,7 +17171,7 @@ "description": "Extended location of the resource." }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to Topic resource.", "type": "object", "readOnly": true @@ -17115,7 +17389,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to Extension Topic resource.", "type": "object", "readOnly": true @@ -17172,7 +17446,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to the TopicSpace resource.", "type": "object", "readOnly": true @@ -17398,7 +17672,7 @@ "x-ms-client-flatten": true }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "The system metadata relating to Verified Partner resource.", "type": "object", "readOnly": true @@ -17421,6 +17695,112 @@ "type": "string" } } + }, + "CustomDomainOwnershipValidationResult": { + "description": "Namespace custom domain ownership validation result.", + "type": "object", + "properties": { + "customDomainsForTopicsConfiguration": { + "description": "List of custom domain configurations for the namespace under topics configuration.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomainConfiguration" + }, + "x-ms-identifiers": [] + }, + "customDomainsForTopicSpacesConfiguration": { + "description": "List of custom domain configurations for the namespace under topic spaces configuration.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomainConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "CustomJwtAuthenticationManagedIdentity": { + "description": "The identity information for retrieving the certificate for custom JWT authentication.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "description": "The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'.", + "enum": [ + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomJwtAuthenticationManagedIdentityType", + "modelAsString": true + } + }, + "userAssignedIdentity": { + "description": "The user identity associated with the resource.", + "type": "string" + } + } + }, + "CustomJwtAuthenticationSettings": { + "description": "Custom JWT authentication settings for namespace resource.", + "type": "object", + "properties": { + "tokenIssuer": { + "description": "Expected JWT token issuer.", + "type": "string" + }, + "issuerCertificates": { + "description": "Information about the certificate that is used for token validation. We currently support maximum 2 certificates.", + "type": "array", + "items": { + "$ref": "#/definitions/IssuerCertificateInfo" + }, + "x-ms-identifiers": [] + } + } + }, + "IssuerCertificateInfo": { + "description": "Information about the certificate that is used for token validation.", + "required": [ + "certificateUrl" + ], + "type": "object", + "properties": { + "certificateUrl": { + "description": "Keyvault certificate URL in https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion format.", + "type": "string" + }, + "identity": { + "$ref": "#/definitions/CustomJwtAuthenticationManagedIdentity", + "description": "The identity that will be used to access the certificate." + } + } + }, + "SubscriptionFullUrl": { + "description": "Full endpoint URL of an event subscription", + "type": "object", + "properties": { + "endpointUrl": { + "description": "The URL that represents the endpoint of the destination of an event subscription.", + "type": "string" + } + } + }, + "UpdateTopicsConfigurationInfo": { + "description": "Properties of the topics configuration info of a namespace.", + "type": "object", + "properties": { + "customDomains": { + "description": "Custom domain info for topics configuration.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomainConfiguration" + }, + "x-ms-identifiers": [] + } + } } }, "parameters": { diff --git a/swagger-specs/eventgrid/resource-manager/api-set.json b/swagger-specs/eventgrid/resource-manager/api-set.json index 678e39fb8..a99543c22 100644 --- a/swagger-specs/eventgrid/resource-manager/api-set.json +++ b/swagger-specs/eventgrid/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.EventGrid/preview/2023-12-15-preview/EventGrid.json"], "name": "package-2023-12-preview"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.EventGrid/preview/2024-06-01-preview/EventGrid.json"], "name": "package-2024-06-preview"} \ No newline at end of file diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/AuthorizationRules.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json similarity index 96% rename from swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/AuthorizationRules.json rename to swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json index d091f4ddd..b738f5d8b 100644 --- a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/AuthorizationRules.json +++ b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json @@ -3,7 +3,7 @@ "info": { "title": "EventHubManagementClient", "description": "Azure Event Hubs client", - "version": "2024-01-01" + "version": "2017-04-01" }, "host": "management.azure.com", "schemes": [ @@ -70,7 +70,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -127,7 +127,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -170,7 +170,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -213,7 +213,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -258,7 +258,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -312,7 +312,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -357,7 +357,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -408,7 +408,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -456,7 +456,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -501,7 +501,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -561,7 +561,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -607,7 +607,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -653,7 +653,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -701,7 +701,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -758,7 +758,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -808,16 +808,11 @@ "rights" ], "description": "Properties supplied to create or update AuthorizationRule" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../common/v1/definitions.json#/definitions/systemData" } }, "allOf": [ { - "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" } ], "description": "Single item in a List or Get AuthorizationRule operation" @@ -873,7 +868,7 @@ ], "x-ms-enum": { "name": "KeyType", - "modelAsString": true + "modelAsString": false } }, "key": { diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/CheckNameAvailability.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json similarity index 97% rename from swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/CheckNameAvailability.json rename to swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json index 23562d05c..6ca247347 100644 --- a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/CheckNameAvailability.json +++ b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json @@ -3,7 +3,7 @@ "info": { "title": "EventHubManagementClient", "description": "Azure Event Hubs client", - "version": "2024-01-01" + "version": "2017-04-01" }, "host": "management.azure.com", "schemes": [ @@ -73,7 +73,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/consumergroups.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/consumergroups.json similarity index 94% rename from swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/consumergroups.json rename to swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/consumergroups.json index f4b09ea41..b74f5c4d0 100644 --- a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/consumergroups.json +++ b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/consumergroups.json @@ -3,7 +3,7 @@ "info": { "title": "EventHubManagementClient", "description": "Azure Event Hubs client", - "version": "2024-01-01" + "version": "2017-04-01" }, "host": "management.azure.com", "schemes": [ @@ -85,7 +85,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -131,7 +131,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -177,7 +177,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -228,7 +228,7 @@ "default": { "description": "Eventhub error response describing why the operation failed", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -262,16 +262,11 @@ } }, "description": "Single item in List or Get Consumer group operation" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../common/v1/definitions.json#/definitions/systemData" } }, "allOf": [ { - "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" } ], "description": "Single item in List or Get Consumer group operation" diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/disasterRecoveryConfigs.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json similarity index 94% rename from swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/disasterRecoveryConfigs.json rename to swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json index 45a76d288..9b32c93c8 100644 --- a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/disasterRecoveryConfigs.json +++ b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json @@ -3,7 +3,7 @@ "info": { "title": "EventHubManagementClient", "description": "Azure Event Hubs client", - "version": "2024-01-01" + "version": "2017-04-01" }, "host": "management.azure.com", "schemes": [ @@ -79,7 +79,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -121,7 +121,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -176,15 +176,12 @@ } }, "201": { - "description": "Alias(Disaster Recovery configuration) creation request received", - "schema": { - "$ref": "#/definitions/ArmDisasterRecovery" - } + "description": "Alias(Disaster Recovery configuration) creation request received" }, "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -221,13 +218,10 @@ "200": { "description": "Delete Alias(Disaster Recovery configuration) request accepted" }, - "204": { - "description": "No content." - }, "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -270,7 +264,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -312,7 +306,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -354,7 +348,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -457,16 +451,11 @@ } }, "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../common/v1/definitions.json#/definitions/systemData" } }, "allOf": [ { - "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" } ], "description": "Single item in List or Get Alias(Disaster Recovery configuration) operation" diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/eventhubs.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/eventhubs.json similarity index 78% rename from swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/eventhubs.json rename to swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/eventhubs.json index f7123e06c..6a0c933a2 100644 --- a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/eventhubs.json +++ b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/eventhubs.json @@ -3,7 +3,7 @@ "info": { "title": "EventHubManagementClient", "description": "Azure Event Hubs client", - "version": "2024-01-01" + "version": "2017-04-01" }, "host": "management.azure.com", "schemes": [ @@ -76,7 +76,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -133,7 +133,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -176,7 +176,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -219,7 +219,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -248,11 +248,15 @@ "intervalInSeconds": { "format": "int32", "type": "integer", + "maximum": 900, + "minimum": 60, "description": "The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds" }, "sizeLimitInBytes": { "format": "int32", "type": "integer", + "maximum": 524288000, + "minimum": 10485760, "description": "The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes" }, "destination": { @@ -266,34 +270,6 @@ }, "description": "Properties to configure capture description for eventhub" }, - "RetentionDescription": { - "type": "object", - "properties": { - "cleanupPolicy": { - "type": "string", - "description": "Enumerates the possible values for cleanup policy", - "enum": [ - "Delete", - "Compact" - ], - "x-ms-enum": { - "name": "CleanupPolicyRetentionDescription", - "modelAsString": true - } - }, - "retentionTimeInHours": { - "format": "int64", - "type": "integer", - "description": "Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue " - }, - "tombstoneRetentionTimeInHours": { - "format": "int32", - "type": "integer", - "description": "Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub" - } - }, - "description": "Properties to configure retention settings for the eventhub" - }, "Eventhub": { "properties": { "properties": { @@ -353,23 +329,14 @@ "captureDescription": { "$ref": "#/definitions/CaptureDescription", "description": "Properties of capture description" - }, - "retentionDescription": { - "$ref": "#/definitions/RetentionDescription", - "description": "Event Hub retention settings" } }, "description": "Properties supplied to the Create Or Update Event Hub operation." - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../common/v1/definitions.json#/definitions/systemData" } }, "allOf": [ { - "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" } ], "description": "Single item in List or Get Event Hub operation" @@ -390,37 +357,12 @@ }, "description": "The result of the List EventHubs operation." }, - "CaptureIdentity": { - "type": "object", - "description": "A value that indicates whether capture description is enabled.", - "properties": { - "type": { - "type": "string", - "description": "Type of Azure Active Directory Managed Identity.", - "enum": [ - "SystemAssigned", - "UserAssigned" - ], - "x-ms-enum": { - "name": "CaptureIdentityType", - "modelAsString": false - } - }, - "userAssignedIdentity": { - "type": "string", - "description": "ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used." - } - } - }, "Destination": { "properties": { "name": { "type": "string", "description": "Name for capture destination" }, - "identity": { - "$ref": "#/definitions/CaptureIdentity" - }, "properties": { "x-ms-client-flatten": true, "properties": { @@ -435,19 +377,6 @@ "archiveNameFormat": { "type": "string", "description": "Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order" - }, - "dataLakeSubscriptionId": { - "type": "string", - "format": "uuid", - "description": "Subscription Id of Azure Data Lake Store" - }, - "dataLakeAccountName": { - "type": "string", - "description": "The Azure Data Lake Store name for the captured events" - }, - "dataLakeFolderPath": { - "type": "string", - "description": "The destination folder path for the captured events" } }, "description": "Properties describing the storage account, blob container and archive name format for capture destination" diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/namespaces.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/namespaces.json new file mode 100644 index 000000000..455dbbeea --- /dev/null +++ b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/namespaces.json @@ -0,0 +1,533 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client", + "version": "2017-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_List", + "x-ms-examples": { + "NamespacesListBySubscription": { + "$ref": "./examples/NameSpaces/EHNameSpaceList.json" + } + }, + "description": "Lists all the available Namespaces within a subscription, irrespective of the resource groups.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespaceListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListByResourceGroup", + "x-ms-examples": { + "NamespaceListByResourceGroup": { + "$ref": "./examples/NameSpaces/EHNameSpaceListByResourceGroup.json" + } + }, + "description": "Lists the available Namespaces within a resource group.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespaceListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdate", + "x-ms-examples": { + "NamespaceCreate": { + "$ref": "./examples/NameSpaces/EHNameSpaceCreate.json" + } + }, + "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EHNamespace", + "required": [ + "location" + ] + }, + "description": "Parameters for creating a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully created.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "201": { + "description": "Namespace create request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Delete", + "x-ms-examples": { + "NameSpaceDelete": { + "$ref": "./examples/NameSpaces/EHNameSpaceDelete.json" + } + }, + "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully deleted." + }, + "202": { + "description": "Namespace delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Get", + "x-ms-examples": { + "NameSpaceGet": { + "$ref": "./examples/NameSpaces/EHNameSpaceGet.json" + } + }, + "description": "Gets the description of the specified namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Update", + "x-ms-examples": { + "NamespacesUpdate": { + "$ref": "./examples/NameSpaces/EHNameSpaceUpdate.json" + } + }, + "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EHNamespace" + }, + "description": "Parameters for updating a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully updated.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/messagingplan": { + "get": { + "tags": [ + "MessagingPlan" + ], + "operationId": "Namespaces_GetMessagingPlan", + "x-ms-examples": { + "GetNamespaceMessagingPlan": { + "$ref": "./examples/NameSpaces/EHNameSpaceGetMessagingPlan.json" + } + }, + "description": "Gets messaging plan for specified namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Messaging Plan successfully returned.", + "schema": { + "$ref": "#/definitions/MessagingPlan" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "The billing tier of this particular SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + }, + "capacity": { + "format": "int32", + "maximum": 20, + "minimum": 0, + "type": "integer", + "description": "The Event Hubs throughput units, value should be 0 to 20 throughput units." + } + }, + "required": [ + "name" + ], + "description": "SKU parameters supplied to the create namespace operation" + }, + "EHNamespaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EHNamespace" + }, + "description": "Result of the List Namespace operation" + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of namespaces." + } + }, + "description": "The response of the List Namespace operation" + }, + "EHNamespace": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Properties of sku resource" + }, + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the Namespace." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the Namespace was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the Namespace was updated." + }, + "serviceBusEndpoint": { + "readOnly": true, + "type": "string", + "description": "Endpoint you can use to perform Service Bus operations." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "Identifier for Azure Insights metrics." + }, + "isAutoInflateEnabled": { + "type": "boolean", + "description": "Value that indicates whether AutoInflate is enabled for eventhub namespace." + }, + "maximumThroughputUnits": { + "format": "int32", + "type": "integer", + "maximum": 20, + "minimum": 0, + "description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" + }, + "kafkaEnabled": { + "type": "boolean", + "description": "Value that indicates whether Kafka is enabled for eventhub namespace." + } + }, + "description": "Namespace properties supplied for create namespace operation." + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Single Namespace item in List or Get Operation" + }, + "MessagingPlan": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "sku": { + "format": "int32", + "readOnly": true, + "type": "integer", + "description": "Sku type" + }, + "selectedEventHubUnit": { + "format": "int32", + "readOnly": true, + "type": "integer", + "description": "Selected event hub unit" + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The exact time the messaging plan was updated." + }, + "revision": { + "format": "int64", + "readOnly": true, + "type": "integer", + "description": "revision number" + } + } + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Messaging Plan for the namespace" + } + }, + "parameters": {} +} diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/networkrulessets.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/networkRuleSets.json similarity index 77% rename from swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/networkrulessets.json rename to swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/networkRuleSets.json index 0d51a0e00..ce564ce00 100644 --- a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/networkrulessets.json +++ b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/networkRuleSets.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "EventHubManagementClient", - "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", - "version": "2024-01-01" + "description": "Azure Event Hubs client", + "version": "2017-04-01" }, "host": "management.azure.com", "schemes": [ @@ -77,9 +77,9 @@ } }, "default": { - "description": "ServiceBus error response describing why the operation failed.", + "description": "EventHub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -117,9 +117,9 @@ } }, "default": { - "description": "ServiceBus error response describing why the operation failed.", + "description": "EventHub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -128,15 +128,15 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets": { "get": { "tags": [ - "NetworkRuleSets" + "NetWorkRuleSets" ], "x-ms-examples": { "NameSpaceNetworkRuleSetList": { "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetList.json" } }, - "operationId": "Namespaces_ListNetworkRuleSet", - "description": "Gets NetworkRuleSet for a Namespace.", + "operationId": "Namespaces_ListNetworkRuleSets", + "description": "Gets list of NetworkRuleSet for a Namespace.", "parameters": [ { "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" @@ -153,17 +153,20 @@ ], "responses": { "200": { - "description": "Namespace NetworkRuleSet successfully returned.", + "description": "List of NetworkRuleSets for Namespace successfully returned.", "schema": { "$ref": "#/definitions/NetworkRuleSetListResult" } }, "default": { - "description": "ServiceBus error response describing why the operation failed.", + "description": "EventHub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } } @@ -176,6 +179,9 @@ "description": "Resource ID of Virtual Network Subnet" } }, + "required": [ + "id" + ], "description": "Properties supplied for Subnet" }, "NWRuleSetIpRules": { @@ -194,10 +200,11 @@ "x-ms-enum": { "name": "NetworkRuleIPAction", "modelAsString": true - } + }, + "default": "Allow" } }, - "description": "The response from the List namespace operation." + "description": "Description of NetWorkRuleSet - IpRules resource." }, "NWRuleSetVirtualNetworkRules": { "x-ms-client-flatten": true, @@ -208,10 +215,10 @@ }, "ignoreMissingVnetServiceEndpoint": { "type": "boolean", - "description": "Value that indicates whether to ignore missing Vnet Service Endpoint" + "description": "Value that indicates whether to ignore missing VNet Service Endpoint" } }, - "description": "The response from the List namespace operation." + "description": "Description of VirtualNetworkRules - NetworkRules resource." }, "NetworkRuleSet": { "properties": { @@ -219,10 +226,6 @@ "description": "NetworkRuleSet properties", "x-ms-client-flatten": true, "properties": { - "trustedServiceAccessEnabled": { - "type": "boolean", - "description": "Value that indicates whether Trusted Service Access is Enabled or not." - }, "defaultAction": { "type": "string", "description": "Default Action for Network Rule Set", @@ -248,45 +251,25 @@ "$ref": "#/definitions/NWRuleSetIpRules" }, "description": "List of IpRules" - }, - "publicNetworkAccess": { - "description": "This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. ", - "enum": [ - "Enabled", - "Disabled", - "SecuredByPerimeter" - ], - "type": "string", - "x-ms-enum": { - "name": "PublicNetworkAccessFlag", - "modelAsString": true - }, - "default": "Enabled" } } - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../common/v1/definitions.json#/definitions/systemData" } }, "allOf": [ { - "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" } ], - "description": "Description of topic resource." + "description": "Description of NetworkRuleSet resource." }, "NetworkRuleSetListResult": { - "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/NetworkRuleSet" }, - "description": "Result of the List NetworkRuleSet operation" + "description": "Result of the List NetworkRuleSet operation." }, "nextLink": { "type": "string", diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/operations.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/operations.json similarity index 67% rename from swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/operations.json rename to swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/operations.json index 3b2b48d4f..3766fecc4 100644 --- a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/operations.json +++ b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/operations.json @@ -3,7 +3,7 @@ "info": { "title": "EventHubManagementClient", "description": "Azure Event Hubs client", - "version": "2024-01-01" + "version": "2017-04-01" }, "host": "management.azure.com", "schemes": [ @@ -61,7 +61,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -99,48 +99,25 @@ "type": "string", "description": "Operation name: {provider}/{resource}/{operation}" }, - "isDataAction": { - "description": "Indicates whether the operation is a data action", - "type": "boolean" - }, "display": { - "$ref": "#/definitions/OperationDisplay", - "description": "Display of the operation" - }, - "origin": { - "description": "Origin of the operation", - "type": "string" - }, - "properties": { - "description": "Properties of the operation", - "type": "object", - "x-ms-client-flatten": true - } - } - }, - "OperationDisplay": { - "description": "Operation display payload", - "type": "object", - "properties": { - "provider": { - "description": "Resource provider of the operation", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "Resource of the operation", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "Localized friendly name for the operation", - "type": "string", - "readOnly": true - }, - "description": { - "description": "Localized friendly description for the operation", - "type": "string", - "readOnly": true + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.EventHub" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource on which the operation is performed: Invoice, etc." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Operation type: Read, write, delete, etc." + } + } } } } diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/sku.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/sku.json new file mode 100644 index 000000000..28e64afd1 --- /dev/null +++ b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/sku.json @@ -0,0 +1,128 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client", + "version": "2017-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/sku/{sku}/regions": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Regions_ListBySku", + "x-ms-examples": { + "RegionsListBySkuBasic": { + "$ref": "./examples/EHRegionsListBySkuBasic.json" + }, + "RegionsListBySkuStandard": { + "$ref": "./examples/EHRegionsListBySkuStandard.json" + } + }, + "description": "Gets the available Regions for a given sku", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkuNameParameter" + } + ], + "responses": { + "200": { + "description": "Regions successfully returned.", + "schema": { + "$ref": "#/definitions/MessagingRegionsListResult" + } + }, + "default": { + "description": "EventHub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "MessagingRegions": { + "properties": { + "properties": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "Region code" + }, + "fullName": { + "readOnly": true, + "type": "string", + "description": "Full name of the region" + } + }, + "description": "Properties of Messaging Region" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Messaging Region" + }, + "MessagingRegionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MessagingRegions" + }, + "description": "Result of the List MessagingRegions type." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of MessagingRegions." + } + }, + "description": "The response of the List MessagingRegions operation." + } + }, + "parameters": {} +} diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/ApplicationGroups.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/ApplicationGroups.json deleted file mode 100644 index d4ad9c811..000000000 --- a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/ApplicationGroups.json +++ /dev/null @@ -1,347 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "EventHubManagementClient", - "description": "Azure Event Hubs client", - "version": "2024-01-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups": { - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroup_ListByNamespace", - "x-ms-examples": { - "ListApplicationGroups": { - "$ref": "./examples/ApplicationGroup/ApplicationGroupListByNamespace.json" - } - }, - "description": "Gets a list of application groups for a Namespace.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace ApplicationGroups successfully returned.", - "schema": { - "$ref": "#/definitions/ApplicationGroupListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups/{applicationGroupName}": { - "put": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroup_CreateOrUpdateApplicationGroup", - "x-ms-azure-resource": true, - "x-ms-examples": { - "ApplicationGroupCreate": { - "$ref": "./examples/ApplicationGroup/ApplicationGroupCreate.json" - } - }, - "description": "Creates or updates an ApplicationGroup for a Namespace.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v2/definitions.json#/parameters/ApplicationGroupNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationGroup" - }, - "description": "The ApplicationGroup." - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "ApplicationGroup successfully created.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroup_Delete", - "x-ms-examples": { - "ApplicationGroupDelete": { - "$ref": "./examples/ApplicationGroup/ApplicationGroupDelete.json" - } - }, - "description": "Deletes an ApplicationGroup for a Namespace.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v2/definitions.json#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "ApplicationGroup successfully deleted." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroup_Get", - "x-ms-examples": { - "ApplicationGroupGet": { - "$ref": "./examples/ApplicationGroup/ApplicationGroupGet.json" - } - }, - "description": "Gets an ApplicationGroup for a Namespace.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v2/definitions.json#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace ApplicationGroup returned successfully.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "ApplicationGroupListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGroup" - }, - "description": "Result of the List Application Groups operation." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules" - } - }, - "description": "The response from the List Application Groups operation." - }, - "ApplicationGroup": { - "type": "object", - "properties": { - "properties": { - "type": "object", - "x-ms-client-flatten": true, - "properties": { - "isEnabled": { - "type": "boolean", - "description": "Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed" - }, - "clientAppGroupIdentifier": { - "type": "string", - "description": "The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)" - }, - "policies": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGroupPolicy" - }, - "x-ms-identifiers": [], - "description": "List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic." - } - }, - "required": [ - "clientAppGroupIdentifier" - ] - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../common/v1/definitions.json#/definitions/systemData" - } - }, - "allOf": [ - { - "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" - } - ], - "description": "The Application Group object" - }, - "ApplicationGroupPolicy": { - "type": "object", - "discriminator": "type", - "description": "Properties of the Application Group policy", - "properties": { - "name": { - "type": "string", - "description": "The Name of this policy" - }, - "type": { - "type": "string", - "enum": [ - "ThrottlingPolicy" - ], - "x-ms-enum": { - "name": "ApplicationGroupPolicyType", - "modelAsString": true - }, - "description": "Application Group Policy types" - } - }, - "required": [ - "name", - "type" - ] - }, - "ThrottlingPolicy": { - "type": "object", - "x-ms-discriminator-value": "ThrottlingPolicy", - "description": "Properties of the throttling policy", - "properties": { - "rateLimitThreshold": { - "format": "int64", - "type": "integer", - "description": "The Threshold limit above which the application group will be throttled.Rate limit is always per second." - }, - "metricId": { - "type": "string", - "description": "Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal", - "enum": [ - "IncomingBytes", - "OutgoingBytes", - "IncomingMessages", - "OutgoingMessages" - ], - "x-ms-enum": { - "name": "MetricId", - "modelAsString": true - } - } - }, - "required": [ - "rateLimitThreshold", - "metricId" - ], - "allOf": [ - { - "$ref": "#/definitions/ApplicationGroupPolicy" - } - ] - } - }, - "parameters": {} -} diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/AvailableClusterRegions.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/AvailableClusterRegions.json deleted file mode 100644 index 34371728b..000000000 --- a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/AvailableClusterRegions.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "EventHubManagementClient", - "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", - "version": "2024-01-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/availableClusterRegions": { - "get": { - "tags": [ - "Event Hubs Clusters AvailableClusterRegions" - ], - "operationId": "Clusters_ListAvailableClusterRegion", - "x-ms-examples": { - "ListAvailableClusters": { - "$ref": "./examples/Clusters/ListAvailableClustersGet.json" - } - }, - "description": "List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Available clusters listed successfully.", - "schema": { - "$ref": "#/definitions/AvailableClustersList" - } - }, - "default": { - "description": "Error response describing why available clusters could not be successfully listed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "AvailableClustersList": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AvailableCluster" - }, - "description": "The count of readily available and pre-provisioned Event Hubs Clusters per region." - } - }, - "description": "The response of the List Available Clusters operation." - }, - "AvailableCluster": { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "Location fo the Available Cluster" - } - }, - "description": "Pre-provisioned and readily available Event Hubs Cluster count per region." - } - }, - "parameters": {} -} diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/Clusters.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/Clusters.json deleted file mode 100644 index 289b51dc2..000000000 --- a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/Clusters.json +++ /dev/null @@ -1,581 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "EventHubManagementClient", - "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", - "version": "2024-01-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/clusters": { - "get": { - "tags": [ - "EventHubs Clusters" - ], - "operationId": "Clusters_ListBySubscription", - "x-ms-examples": { - "ClustersListBySubscription": { - "$ref": "./examples/Clusters/ClustersListBySubscription.json" - } - }, - "description": "Lists the available Event Hubs Clusters within an ARM resource group", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Clusters returned successfully.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Event Hub Cluster error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters": { - "get": { - "tags": [ - "EventHubs Clusters" - ], - "operationId": "Clusters_ListByResourceGroup", - "x-ms-examples": { - "ClustersListByResourceGroup": { - "$ref": "./examples/Clusters/ClustersListByResourceGroup.json" - } - }, - "description": "Lists the available Event Hubs Clusters within an ARM resource group", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Clusters returned successfully.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Event Hub Cluster error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}": { - "get": { - "tags": [ - "EventHubs Clusters" - ], - "operationId": "Clusters_Get", - "x-ms-examples": { - "ClusterGet": { - "$ref": "./examples/Clusters/ClusterGet.json" - } - }, - "description": "Gets the resource description of the specified Event Hubs Cluster.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Event Hubs Cluster resource description returned successfully.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Event Hubs Cluster error response describing why the cluster description get operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "EventHubs Clusters" - ], - "operationId": "Clusters_CreateOrUpdate", - "x-ms-examples": { - "ClusterPut": { - "$ref": "./examples/Clusters/ClusterPut.json" - } - }, - "description": "Creates or updates an instance of an Event Hubs Cluster.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Cluster", - "required": [ - "location" - ] - }, - "description": "Parameters for creating a eventhub cluster resource." - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Event Hubs Cluster successfully created or updated.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "201": { - "description": "Event Hubs Cluster create or update request accepted.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Event Hubs Cluster create or update request accepted." - }, - "default": { - "description": "Event Hubs error response detailing why the Event Hubs Cluster create or update operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "EventHubs Clusters" - ], - "operationId": "Clusters_Update", - "x-ms-examples": { - "ClusterPatch": { - "$ref": "./examples/Clusters/ClusterPatch.json" - } - }, - "description": "Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Cluster" - }, - "description": "The properties of the Event Hubs Cluster which should be updated." - } - ], - "responses": { - "200": { - "description": "Event Hubs Cluster successfully created.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "201": { - "description": "Event Hubs Cluster update request accepted.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Event Hubs Cluster update request accepted." - }, - "default": { - "description": "Event Hubs error response detailing why the Event Hubs Cluster update operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "EventHubs Clusters" - ], - "operationId": "Clusters_Delete", - "x-ms-examples": { - "ClusterDelete": { - "$ref": "./examples/Clusters/ClusterDelete.json" - } - }, - "description": "Deletes an existing Event Hubs Cluster. This operation is idempotent.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Event Hubs Cluster successfully deleted." - }, - "202": { - "description": "Event Hubs Cluster delete request accepted." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Event Hubs error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/namespaces": { - "get": { - "tags": [ - "EventHubs Clusters Namespace" - ], - "operationId": "Clusters_ListNamespaces", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - } - ], - "description": "List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.", - "x-ms-examples": { - "ListNamespacesInCluster": { - "$ref": "./examples/Clusters/ListNamespacesInClusterGet.json" - } - }, - "responses": { - "200": { - "description": "List of Namespace IDs in Cluster successfully delivered.", - "schema": { - "$ref": "#/definitions/EHNamespaceIdListResult" - } - }, - "default": { - "description": "Event Hubs Cluster error response detailing why this operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/triggerUpgrade": { - "post": { - "tags": [ - "EventHubs Clusters Upgrade" - ], - "operationId": "Clusters_TriggerUpgradePost", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - } - ], - "description": "Trigger pending cluster upgrades if any. Bypasses any upgrade preferences set by customer.", - "x-ms-examples": { - "TriggerUpgradeInCluster": { - "$ref": "./examples/Clusters/TriggerUpgradeInCluster.json" - } - }, - "responses": { - "204": { - "description": "Successfully started applying pending cluster upgrades" - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "Cluster": { - "type": "object", - "properties": { - "sku": { - "$ref": "#/definitions/ClusterSku", - "description": "Properties of the cluster SKU." - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../common/v1/definitions.json#/definitions/systemData" - }, - "properties": { - "type": "object", - "x-ms-client-flatten": true, - "properties": { - "createdAt": { - "readOnly": true, - "type": "string", - "description": "The UTC time when the Event Hubs Cluster was created." - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "enum": [ - "Unknown", - "Creating", - "Deleting", - "Scaling", - "Active", - "Failed", - "Succeeded", - "Canceled" - ], - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true - }, - "description": "Provisioning state of the Cluster." - }, - "updatedAt": { - "readOnly": true, - "type": "string", - "description": "The UTC time when the Event Hubs Cluster was last updated." - }, - "metricId": { - "readOnly": true, - "type": "string", - "description": "The metric ID of the cluster resource. Provided by the service and not modifiable by the user." - }, - "status": { - "readOnly": true, - "type": "string", - "description": "Status of the Cluster resource" - }, - "supportsScaling": { - "type": "boolean", - "description": "A value that indicates whether Scaling is Supported." - }, - "upgradePreferences": { - "$ref": "#/definitions/UpgradePreferences", - "description": "Properties of the cluster upgrade preferences." - } - }, - "description": "Event Hubs Cluster properties supplied in responses in List or Get operations." - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" - } - ], - "description": "Single Event Hubs Cluster resource in List or Get operations." - }, - "ClusterSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of this SKU.", - "enum": [ - "Dedicated" - ], - "x-ms-enum": { - "name": "ClusterSkuName", - "modelAsString": true - } - }, - "capacity": { - "format": "int32", - "minimum": 1, - "type": "integer", - "description": "The quantity of Event Hubs Cluster Capacity Units contained in this cluster." - } - }, - "required": [ - "name" - ], - "description": "SKU parameters particular to a cluster instance." - }, - "ClusterListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - }, - "description": "The Event Hubs Clusters present in the List Event Hubs operation results." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters." - } - }, - "description": "The response of the List Event Hubs Clusters operation." - }, - "EHNamespaceIdListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/EHNamespaceIdContainer" - }, - "description": "Result of the List Namespace IDs operation" - } - }, - "description": "The response of the List Namespace IDs operation" - }, - "EHNamespaceIdContainer": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "id parameter" - } - }, - "description": "The full ARM ID of an Event Hubs Namespace" - }, - "UpgradePreferences": { - "type": "object", - "properties": { - "startDayOfWeek": { - "type": "string", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Any" - ], - "description": "Preferred day of the week in UTC time to begin an upgrade. If 'Any' is selected, upgrade will proceed at any given weekday", - "x-ms-enum": { - "name": "startDayOfWeek", - "modelAsString": true - } - }, - "startHourOfDay": { - "format": "int32", - "type": "integer", - "minimum": 0, - "maximum": 23, - "description": "Preferred hour of the day in UTC time to begin an upgrade" - } - }, - "description": "Contains all settings for the cluster upgrade window." - } - }, - "parameters": {} -} diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/SchemaRegistry.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/SchemaRegistry.json deleted file mode 100644 index cff253870..000000000 --- a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/SchemaRegistry.json +++ /dev/null @@ -1,321 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "EventHubManagementClient", - "description": "Azure Event Hubs client", - "version": "2024-01-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups": { - "get": { - "tags": [ - "SchemaRegistry" - ], - "operationId": "SchemaRegistry_ListByNamespace", - "x-ms-examples": { - "SchemaRegistryListAll": { - "$ref": "./examples/SchemaRegistry/SchemaRegistryListByNamespace.json" - } - }, - "description": "Gets all the Schema Groups in a Namespace.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of SchemaGroups.", - "schema": { - "$ref": "#/definitions/SchemaGroupListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups/{schemaGroupName}": { - "put": { - "tags": [ - "SchemaRegistry" - ], - "operationId": "SchemaRegistry_CreateOrUpdate", - "x-ms-examples": { - "SchemaRegistryCreate": { - "$ref": "./examples/SchemaRegistry/SchemaRegistryCreate.json" - } - }, - "description": "Creates or Updates an EventHub schema group.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v2/definitions.json#/parameters/SchemaGroupNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SchemaGroup" - }, - "description": "Parameters supplied to create an Event Hub resource." - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "SchemaGroup successfully created.", - "schema": { - "$ref": "#/definitions/SchemaGroup" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "SchemaRegistry" - ], - "operationId": "SchemaRegistry_Delete", - "x-ms-examples": { - "SchemaRegistryDelete": { - "$ref": "./examples/SchemaRegistry/SchemaRegistryDelete.json" - } - }, - "description": "Deletes an EventHub schema group.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v2/definitions.json#/parameters/SchemaGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "SchemaGroup successfully deleted." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "SchemaRegistry" - ], - "operationId": "SchemaRegistry_Get", - "x-ms-examples": { - "SchemaRegistryGet": { - "$ref": "./examples/SchemaRegistry/SchemaRegistryGet.json" - } - }, - "description": "Gets the details of an EventHub schema group.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v2/definitions.json#/parameters/SchemaGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the Schema Group description.", - "schema": { - "$ref": "#/definitions/SchemaGroup" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "SchemaGroup": { - "type": "object", - "properties": { - "properties": { - "type": "object", - "x-ms-client-flatten": true, - "properties": { - "updatedAtUtc": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "Exact time the Schema Group was updated" - }, - "createdAtUtc": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "Exact time the Schema Group was created." - }, - "eTag": { - "readOnly": true, - "format": "uuid", - "type": "string", - "description": "The ETag value." - }, - "groupProperties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "dictionary object for SchemaGroup group properties" - }, - "schemaCompatibility": { - "type": "string", - "description": "", - "enum": [ - "None", - "Backward", - "Forward" - ], - "x-ms-enum": { - "name": "SchemaCompatibility", - "modelAsString": true - } - }, - "schemaType": { - "type": "string", - "description": "", - "enum": [ - "Unknown", - "Avro" - ], - "x-ms-enum": { - "name": "SchemaType", - "modelAsString": true - } - } - }, - "description": "" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../common/v1/definitions.json#/definitions/systemData" - } - }, - "allOf": [ - { - "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" - } - ], - "description": "Single item in List or Get Schema Group operation" - }, - "SchemaGroupListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SchemaGroup" - }, - "description": "Result of the List SchemaGroups operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of Schema Groups." - } - }, - "description": "The result of the List SchemaGroup operation." - } - } -} diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/namespaces.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/namespaces.json deleted file mode 100644 index da1fe5907..000000000 --- a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/namespaces.json +++ /dev/null @@ -1,1402 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "EventHubManagementClient", - "description": "Azure Event Hubs client for managing namespaces.", - "version": "2024-01-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_List", - "x-ms-examples": { - "NamespacesListBySubscription": { - "$ref": "./examples/NameSpaces/EHNameSpaceList.json" - } - }, - "description": "Lists all the available Namespaces within a subscription, irrespective of the resource groups.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespaces returned successfully.", - "schema": { - "$ref": "#/definitions/EHNamespaceListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListByResourceGroup", - "x-ms-examples": { - "NamespaceListByResourceGroup": { - "$ref": "./examples/NameSpaces/EHNameSpaceListByResourceGroup.json" - } - }, - "description": "Lists the available Namespaces within a resource group.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespaces returned successfully.", - "schema": { - "$ref": "#/definitions/EHNamespaceListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdate", - "x-ms-examples": { - "NamespaceCreate": { - "$ref": "./examples/NameSpaces/EHNameSpaceCreate.json" - } - }, - "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/EHNamespace", - "required": [ - "location" - ] - }, - "description": "Parameters for creating a namespace resource." - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace successfully created.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "201": { - "description": "Namespace create request accepted.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "202": { - "description": "Namespace create or update request accepted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Delete", - "x-ms-examples": { - "NameSpaceDelete": { - "$ref": "./examples/NameSpaces/EHNameSpaceDelete.json" - } - }, - "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace successfully deleted." - }, - "202": { - "description": "Namespace delete request accepted." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Get", - "x-ms-examples": { - "NameSpaceGet": { - "$ref": "./examples/NameSpaces/EHNameSpaceGet.json" - } - }, - "description": "Gets the description of the specified namespace.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace returned successfully.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Update", - "x-ms-examples": { - "NamespacesUpdate": { - "$ref": "./examples/NameSpaces/EHNameSpaceUpdate.json" - } - }, - "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/EHNamespace" - }, - "description": "Parameters for updating a namespace resource." - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace successfully updated.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "201": { - "description": "Namespace update request accepted.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "202": { - "description": "Namespace create or update request accepted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections": { - "get": { - "tags": [ - "Namespaces PrivateEndpointConnections" - ], - "operationId": "PrivateEndpointConnections_List", - "x-ms-examples": { - "PrivateEndPointConnectionList": { - "$ref": "./examples/NameSpaces/PrivateEndPointConnectionList.json" - } - }, - "description": "Gets the available PrivateEndpointConnections within a namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" - }, - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "PrivateEndpointConnections successfully returned.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnectionListResult" - } - }, - "default": { - "description": "EventHub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { - "put": { - "tags": [ - "Namespaces PrivateEndpointConnections" - ], - "operationId": "PrivateEndpointConnections_CreateOrUpdate", - "x-ms-examples": { - "NameSpacePrivateEndPointConnectionCreate": { - "$ref": "./examples/NameSpaces/PrivateEndPointConnectionCreate.json" - } - }, - "description": "Creates or updates PrivateEndpointConnections of service namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" - }, - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - }, - "description": "Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource." - } - ], - "responses": { - "200": { - "description": "Status of PrivateEndPoint Connection Created successfully.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - }, - "201": { - "description": "Request to update Status of PrivateEndPoint Connection accepted.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - }, - "202": { - "description": "Request to update Status of PrivateEndPoint Connection accepted.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Namespaces PrivateEndpointConnections" - ], - "operationId": "PrivateEndpointConnections_Delete", - "x-ms-examples": { - "NameSpacePrivateEndPointConnectionDelete": { - "$ref": "./examples/NameSpaces/PrivateEndPointConnectionDelete.json" - } - }, - "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" - }, - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" - } - ], - "responses": { - "200": { - "description": "Private Endpoint Connection successfully deleted." - }, - "202": { - "description": "Private Endpoint Connection delete request accepted." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Namespaces PrivateEndpointConnections" - ], - "operationId": "PrivateEndpointConnections_Get", - "x-ms-examples": { - "NameSpacePrivateEndPointConnectionGet": { - "$ref": "./examples/NameSpaces/PrivateEndPointConnectionGet.json" - } - }, - "description": "Gets a description for the specified Private Endpoint Connection name.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" - }, - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Private Endpoint Connection successfully returned.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateLinkResources": { - "get": { - "tags": [ - "Namespaces PrivateLinkResources" - ], - "operationId": "PrivateLinkResources_Get", - "x-ms-examples": { - "NameSpacePrivateLinkResourcesGet": { - "$ref": "./examples/NameSpaces/PrivateLinkResourcesGet.json" - } - }, - "description": "Gets lists of resources that supports Privatelinks.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" - }, - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Private Link resource List", - "schema": { - "$ref": "#/definitions/PrivateLinkResourcesListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkSecurityPerimeterConfigurations": { - "get": { - "tags": [ - "Namespaces NetworkSecurityPerimeterConfigurations" - ], - "operationId": "NetworkSecurityPerimeterConfiguration_List", - "x-ms-examples": { - "NamspaceNetworkSecurityPerimeterConfigurationList": { - "$ref": "./examples/NameSpaces/NetworkSecurityPerimeterConfigurationList.json" - } - }, - "description": "Gets list of current NetworkSecurityPerimeterConfiguration for Namespace", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Network Security Perimeter Configuration List", - "schema": { - "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationList" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkSecurityPerimeterConfigurations/{resourceAssociationName}/reconcile": { - "post": { - "tags": [ - "Namespaces NetworkSecurityPerimeterConfigurations" - ], - "operationId": "NetworkSecurityPerimeterConfigurations_CreateOrUpdate", - "description": "Refreshes any information about the association.", - "x-ms-examples": { - "NetworkSecurityPerimeterConfigurationList": { - "$ref": "./examples/NameSpaces/NetworkSecurityPerimeterConfigurationReconcile.json" - } - }, - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceAssociationNameParameter" - } - ], - "responses": { - "200": { - "description": "Association reconciled" - }, - "202": { - "description": "Request to reconcile the association accepted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "EHNamespaceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/EHNamespace" - }, - "description": "Result of the List Namespace operation" - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of namespaces." - } - }, - "description": "The response of the List Namespace operation" - }, - "EHNamespace": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Properties of sku resource" - }, - "identity": { - "$ref": "#/definitions/Identity", - "description": "Properties of BYOK Identity description" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../common/v1/definitions.json#/definitions/systemData" - }, - "properties": { - "x-ms-client-flatten": true, - "properties": { - "minimumTlsVersion": { - "type": "string", - "description": "The minimum TLS version for the cluster to support, e.g. '1.2'", - "enum": [ - "1.0", - "1.1", - "1.2" - ], - "x-ms-enum": { - "name": "TlsVersion", - "modelAsString": true - } - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Provisioning state of the Namespace." - }, - "status": { - "readOnly": true, - "type": "string", - "description": "Status of the Namespace." - }, - "createdAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "The time the Namespace was created." - }, - "updatedAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "The time the Namespace was updated." - }, - "serviceBusEndpoint": { - "readOnly": true, - "type": "string", - "description": "Endpoint you can use to perform Service Bus operations." - }, - "clusterArmId": { - "type": "string", - "description": "Cluster ARM ID of the Namespace." - }, - "metricId": { - "readOnly": true, - "type": "string", - "description": "Identifier for Azure Insights metrics." - }, - "isAutoInflateEnabled": { - "type": "boolean", - "description": "Value that indicates whether AutoInflate is enabled for eventhub namespace." - }, - "publicNetworkAccess": { - "description": "This determines if traffic is allowed over public network. By default it is enabled.", - "enum": [ - "Enabled", - "Disabled", - "SecuredByPerimeter" - ], - "type": "string", - "x-ms-enum": { - "name": "PublicNetworkAccess", - "modelAsString": true - }, - "default": "Enabled" - }, - "maximumThroughputUnits": { - "format": "int32", - "type": "integer", - "minimum": 0, - "description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" - }, - "kafkaEnabled": { - "type": "boolean", - "description": "Value that indicates whether Kafka is enabled for eventhub namespace." - }, - "zoneRedundant": { - "type": "boolean", - "description": "Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones." - }, - "encryption": { - "$ref": "#/definitions/Encryption", - "description": "Properties of BYOK Encryption description" - }, - "privateEndpointConnections": { - "description": "List of private endpoint connections.", - "type": "array", - "items": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - }, - "disableLocalAuth": { - "type": "boolean", - "description": "This property disables SAS authentication for the Event Hubs namespace." - }, - "alternateName": { - "type": "string", - "description": "Alternate name specified when alias and namespace names are same." - } - }, - "description": "Namespace properties supplied for create namespace operation." - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" - } - ], - "description": "Single Namespace item in List or Get Operation" - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of this SKU.", - "enum": [ - "Basic", - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": true - } - }, - "tier": { - "type": "string", - "description": "The billing tier of this particular SKU.", - "enum": [ - "Basic", - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "SkuTier", - "modelAsString": true - } - }, - "capacity": { - "format": "int32", - "minimum": 0, - "type": "integer", - "description": "The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units." - } - }, - "required": [ - "name" - ], - "description": "SKU parameters supplied to the create namespace operation" - }, - "Identity": { - "x-ms-client-flatten": true, - "properties": { - "principalId": { - "type": "string", - "description": "ObjectId from the KeyVault", - "readOnly": true - }, - "tenantId": { - "type": "string", - "description": "TenantId from the KeyVault", - "readOnly": true - }, - "type": { - "type": "string", - "description": "Type of managed service identity.", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" - ], - "x-ms-enum": { - "name": "ManagedServiceIdentityType", - "modelAsString": false - } - }, - "userAssignedIdentities": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/UserAssignedIdentity" - }, - "description": "Properties for User Assigned Identities" - } - }, - "description": "Properties to configure Identity for Bring your Own Keys" - }, - "UserAssignedIdentity": { - "description": "Recognized Dictionary value.", - "type": "object", - "properties": { - "principalId": { - "description": "Principal Id of user assigned identity", - "type": "string", - "x-ms-client-name": "PrincipalId", - "readOnly": true - }, - "clientId": { - "description": "Client Id of user assigned identity", - "type": "string", - "x-ms-client-name": "ClientId", - "readOnly": true - } - } - }, - "Encryption": { - "x-ms-client-flatten": true, - "properties": { - "keyVaultProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/KeyVaultProperties" - }, - "x-ms-client-name": "KeyVaultProperties", - "description": "Properties of KeyVault" - }, - "keySource": { - "type": "string", - "description": "Enumerates the possible value of keySource for Encryption", - "default": "Microsoft.KeyVault", - "enum": [ - "Microsoft.KeyVault" - ], - "x-ms-enum": { - "name": "keySource", - "modelAsString": false - } - }, - "requireInfrastructureEncryption": { - "type": "boolean", - "description": "Enable Infrastructure Encryption (Double Encryption)" - } - }, - "description": "Properties to configure Encryption" - }, - "KeyVaultProperties": { - "properties": { - "keyName": { - "type": "string", - "description": "Name of the Key from KeyVault", - "x-ms-client-name": "KeyName" - }, - "keyVaultUri": { - "type": "string", - "description": "Uri of KeyVault", - "x-ms-client-name": "KeyVaultUri" - }, - "keyVersion": { - "type": "string", - "description": "Key Version", - "x-ms-client-name": "KeyVersion" - }, - "identity": { - "$ref": "#/definitions/userAssignedIdentityProperties" - } - }, - "description": "Properties to configure keyVault Properties" - }, - "PrivateEndpointConnection": { - "description": "Properties of the PrivateEndpointConnection.", - "allOf": [ - { - "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/PrivateEndpointConnectionProperties", - "description": "Properties of the PrivateEndpointConnection.", - "x-ms-client-flatten": true - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../common/v1/definitions.json#/definitions/systemData" - } - } - }, - "PrivateEndpointConnectionProperties": { - "description": "Properties of the private endpoint connection resource.", - "properties": { - "privateEndpoint": { - "$ref": "#/definitions/PrivateEndpoint", - "description": "The Private Endpoint resource for this Connection." - }, - "privateLinkServiceConnectionState": { - "$ref": "#/definitions/ConnectionState", - "description": "Details about the state of the connection." - }, - "provisioningState": { - "description": "Provisioning state of the Private Endpoint Connection.", - "enum": [ - "Creating", - "Updating", - "Deleting", - "Succeeded", - "Canceled", - "Failed" - ], - "type": "string", - "x-ms-enum": { - "name": "EndPointProvisioningState", - "modelAsString": true - } - } - } - }, - "PrivateEndpoint": { - "description": "PrivateEndpoint information.", - "properties": { - "id": { - "description": "The ARM identifier for Private Endpoint.", - "type": "string" - } - } - }, - "ConnectionState": { - "description": "ConnectionState information.", - "properties": { - "status": { - "description": "Status of the connection.", - "enum": [ - "Pending", - "Approved", - "Rejected", - "Disconnected" - ], - "type": "string", - "x-ms-enum": { - "name": "PrivateLinkConnectionStatus", - "modelAsString": true - } - }, - "description": { - "description": "Description of the connection state.", - "type": "string" - } - } - }, - "PrivateEndpointConnectionListResult": { - "description": "Result of the list of all private endpoint connections operation.", - "properties": { - "value": { - "description": "A collection of private endpoint connection resources.", - "type": "array", - "items": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - }, - "nextLink": { - "description": "A link for the next page of private endpoint connection resources.", - "type": "string" - } - } - }, - "PrivateLinkResource": { - "description": "Information of the private link resource.", - "properties": { - "properties": { - "$ref": "#/definitions/PrivateLinkResourceProperties", - "description": "Properties of the private link resource.", - "x-ms-client-flatten": true - }, - "id": { - "description": "Fully qualified identifier of the resource.", - "type": "string" - }, - "name": { - "description": "Name of the resource", - "type": "string" - }, - "type": { - "description": "Type of the resource", - "type": "string" - } - } - }, - "PrivateLinkResourceProperties": { - "description": "Properties of PrivateLinkResource", - "properties": { - "groupId": { - "description": "The private link resource group id.", - "type": "string" - }, - "requiredMembers": { - "type": "array", - "description": "The private link resource required member names.", - "items": { - "type": "string" - } - }, - "requiredZoneNames": { - "type": "array", - "description": "The private link resource Private link DNS zone name.", - "items": { - "type": "string" - } - } - } - }, - "PrivateLinkResourcesListResult": { - "description": "Result of the List private link resources operation.", - "properties": { - "value": { - "description": "A collection of private link resources", - "type": "array", - "items": { - "$ref": "#/definitions/PrivateLinkResource" - } - }, - "nextLink": { - "description": "A link for the next page of private link resources.", - "type": "string" - } - } - }, - "userAssignedIdentityProperties": { - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "userAssignedIdentity": { - "type": "string", - "description": "ARM ID of user Identity selected for encryption" - } - } - }, - "NetworkSecurityPerimeterConfigurationList": { - "description": "Result of the List NetworkSecurityPerimeterConfiguration operation.", - "type": "object", - "properties": { - "value": { - "description": "A collection of NetworkSecurityPerimeterConfigurations", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" - } - } - } - }, - "NetworkSecurityPerimeterConfiguration": { - "description": "Network Security Perimeter related configurations of a given namespace", - "type": "object", - "readOnly": true, - "properties": { - "properties": { - "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationProperties", - "description": "Properties of the Network Security Perimeter Configuration", - "x-ms-client-flatten": true - } - }, - "allOf": [ - { - "$ref": "../../../common/v2/definitions.json#/definitions/ProxyResource" - } - ] - }, - "NetworkSecurityPerimeterConfigurationProperties": { - "description": "Properties of NetworkSecurityPerimeterConfiguration", - "type": "object", - "readOnly": true, - "properties": { - "provisioningState": { - "description": "Provisioning state of NetworkSecurityPerimeter configuration propagation", - "enum": [ - "Unknown", - "Creating", - "Updating", - "Accepted", - "InvalidResponse", - "Succeeded", - "SucceededWithIssues", - "Failed", - "Deleting", - "Deleted", - "Canceled" - ], - "type": "string", - "x-ms-enum": { - "name": "NetworkSecurityPerimeterConfigurationProvisioningState", - "modelAsString": true - } - }, - "provisioningIssues": { - "description": "List of Provisioning Issues if any", - "type": "array", - "items": { - "$ref": "#/definitions/ProvisioningIssue" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "networkSecurityPerimeter": { - "$ref": "#/definitions/NetworkSecurityPerimeter" - }, - "resourceAssociation": { - "description": "Information about resource association", - "readOnly": true, - "type": "object", - "properties": { - "name": { - "description": "Name of the resource association", - "type": "string" - }, - "accessMode": { - "description": "Access Mode of the resource association", - "enum": [ - "NoAssociationMode", - "EnforcedMode", - "LearningMode", - "AuditMode", - "UnspecifiedMode" - ], - "type": "string", - "x-ms-enum": { - "name": "ResourceAssociationAccessMode", - "modelAsString": true - } - } - } - }, - "profile": { - "description": "Information about current network profile", - "readOnly": true, - "type": "object", - "properties": { - "name": { - "description": "Name of the resource", - "type": "string" - }, - "accessRulesVersion": { - "description": "Current access rules version", - "type": "string" - }, - "accessRules": { - "description": "List of Access Rules", - "type": "array", - "items": { - "$ref": "#/definitions/NspAccessRule" - } - } - } - }, - "isBackingResource": { - "readOnly": true, - "type": "boolean", - "description": "True if the EventHub namespace is backed by another Azure resource and not visible to end users." - }, - "applicableFeatures": { - "readOnly": true, - "type": "array", - "description": "Indicates that the NSP controls related to backing association are only applicable to a specific feature in backing resource's data plane.", - "items": { - "type": "string" - } - }, - "parentAssociationName": { - "readOnly": true, - "type": "string", - "description": "Source Resource Association name" - }, - "sourceResourceId": { - "readOnly": true, - "type": "string", - "description": "ARM Id of source resource" - } - } - }, - "ProvisioningIssue": { - "description": "Describes Provisioning issue for given NetworkSecurityPerimeterConfiguration", - "type": "object", - "readOnly": true, - "properties": { - "name": { - "description": "Name of the issue", - "type": "string" - }, - "properties": { - "description": "Properties of Provisioning Issue", - "type": "object", - "readOnly": true, - "properties": { - "issueType": { - "description": "Type of Issue", - "type": "string" - }, - "description": { - "description": "Description of the issue", - "type": "string" - } - } - } - } - }, - "NspAccessRule": { - "description": "Information of Access Rule in Network Profile", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "description": "Fully qualified identifier of the resource", - "type": "string" - }, - "name": { - "description": "Name of the resource", - "type": "string" - }, - "type": { - "description": "Type of the resource", - "type": "string" - }, - "properties": { - "description": "Properties of Access Rule", - "readOnly": true, - "type": "object", - "properties": { - "direction": { - "description": "Direction of Access Rule", - "enum": [ - "Inbound", - "Outbound" - ], - "type": "string", - "x-ms-enum": { - "name": "NspAccessRuleDirection", - "modelAsString": true - } - }, - "addressPrefixes": { - "description": "Address prefixes in the CIDR format for inbound rules", - "type": "array", - "items": { - "description": "IP Address", - "type": "string" - } - }, - "subscriptions": { - "description": "Subscriptions for inbound rules", - "type": "array", - "items": { - "description": "Subscription for inbound rule", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "description": "Fully qualified identifier of subscription", - "type": "string" - } - } - } - }, - "networkSecurityPerimeters": { - "description": "NetworkSecurityPerimeters for inbound rules", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/NetworkSecurityPerimeter" - } - }, - "fullyQualifiedDomainNames": { - "description": "FQDN for outbound rules", - "type": "array", - "readOnly": true, - "items": { - "description": "Fully qualified domain name", - "type": "string" - } - } - } - } - } - }, - "NetworkSecurityPerimeter": { - "description": "NetworkSecurityPerimeter related information", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "description": "Fully qualified identifier of the resource", - "type": "string" - }, - "perimeterGuid": { - "description": "Guid of the resource", - "type": "string" - }, - "location": { - "description": "Location of the resource", - "type": "string" - } - } - } - }, - "parameters": {} -} diff --git a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/quotaConfiguration.json b/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/quotaConfiguration.json deleted file mode 100644 index b27184636..000000000 --- a/swagger-specs/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/quotaConfiguration.json +++ /dev/null @@ -1,157 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "EventHubManagementClient", - "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", - "version": "2024-01-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default": { - "patch": { - "tags": [ - "Event Hubs Clusters Configuration" - ], - "operationId": "Configuration_Patch", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties", - "required": [ - "settings" - ] - }, - "description": "Parameters for creating an Event Hubs Cluster resource." - } - ], - "x-ms-examples": { - "ClustersQuotasConfigurationPatch": { - "$ref": "./examples/Clusters/ClusterQuotaConfigurationPatch.json" - } - }, - "description": "Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.", - "responses": { - "200": { - "description": "Event Hubs Cluster settings configuration returned.", - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties" - } - }, - "201": { - "description": "Event Hubs Cluster setting configuration request successfully accepted.", - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties" - } - }, - "202": { - "description": "Event Hubs Cluster update request accepted." - }, - "default": { - "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Event Hubs Clusters Configuration" - ], - "operationId": "Configuration_Get", - "parameters": [ - { - "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" - }, - { - "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" - } - ], - "x-ms-examples": { - "ClustersQuotasConfigurationGet": { - "$ref": "./examples/Clusters/ClusterQuotaConfigurationGet.json" - } - }, - "description": "Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.", - "responses": { - "200": { - "description": "Event Hubs Cluster settings configuration returned.", - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties" - } - }, - "default": { - "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", - "schema": { - "$ref": "../../../common/v2/definitions.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "ClusterQuotaConfigurationProperties": { - "type": "object", - "properties": { - "settings": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster." - } - }, - "description": "Contains all settings for the cluster." - } - }, - "parameters": {} -} diff --git a/swagger-specs/eventhub/resource-manager/api-set.json b/swagger-specs/eventhub/resource-manager/api-set.json index 8d7cdd167..88454fb55 100644 --- a/swagger-specs/eventhub/resource-manager/api-set.json +++ b/swagger-specs/eventhub/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.EventHub/stable/2024-01-01/AvailableClusterRegions.json", "Microsoft.EventHub/stable/2024-01-01/Clusters.json", "Microsoft.EventHub/stable/2024-01-01/namespaces.json", "Microsoft.EventHub/stable/2024-01-01/quotaConfiguration.json", "Microsoft.EventHub/stable/2024-01-01/networkrulessets.json", "Microsoft.EventHub/stable/2024-01-01/AuthorizationRules.json", "Microsoft.EventHub/stable/2024-01-01/CheckNameAvailability.json", "Microsoft.EventHub/stable/2024-01-01/consumergroups.json", "Microsoft.EventHub/stable/2024-01-01/disasterRecoveryConfigs.json", "Microsoft.EventHub/stable/2024-01-01/operations.json", "Microsoft.EventHub/stable/2024-01-01/eventhubs.json", "Microsoft.EventHub/stable/2024-01-01/SchemaRegistry.json", "Microsoft.EventHub/stable/2024-01-01/ApplicationGroups.json"], "name": "package-2024-01"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json", "Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json", "Microsoft.EventHub/stable/2017-04-01/consumergroups.json", "Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json", "Microsoft.EventHub/stable/2017-04-01/eventhubs.json", "Microsoft.EventHub/stable/2017-04-01/namespaces.json", "Microsoft.EventHub/stable/2017-04-01/networkRuleSets.json", "Microsoft.EventHub/stable/2017-04-01/operations.json", "Microsoft.EventHub/stable/2017-04-01/sku.json"], "name": "package-2017-04"} \ No newline at end of file diff --git a/swagger-specs/frontdoor/resource-manager/Microsoft.Network/stable/2022-05-01/network.json b/swagger-specs/frontdoor/resource-manager/Microsoft.Network/stable/2024-02-01/network.json similarity index 99% rename from swagger-specs/frontdoor/resource-manager/Microsoft.Network/stable/2022-05-01/network.json rename to swagger-specs/frontdoor/resource-manager/Microsoft.Network/stable/2024-02-01/network.json index ac690b8b9..e6eb02ca2 100644 --- a/swagger-specs/frontdoor/resource-manager/Microsoft.Network/stable/2022-05-01/network.json +++ b/swagger-specs/frontdoor/resource-manager/Microsoft.Network/stable/2024-02-01/network.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2022-05-01" + "version": "2024-02-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/frontdoor/resource-manager/Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json b/swagger-specs/frontdoor/resource-manager/Microsoft.Network/stable/2024-02-01/webapplicationfirewall.json similarity index 89% rename from swagger-specs/frontdoor/resource-manager/Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json rename to swagger-specs/frontdoor/resource-manager/Microsoft.Network/stable/2024-02-01/webapplicationfirewall.json index 2ab308d39..a0a298270 100644 --- a/swagger-specs/frontdoor/resource-manager/Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json +++ b/swagger-specs/frontdoor/resource-manager/Microsoft.Network/stable/2024-02-01/webapplicationfirewall.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2022-05-01", + "version": "2024-02-01", "title": "WebApplicationFirewallManagement", "description": "APIs to manage web application firewall rules." }, @@ -521,6 +521,40 @@ "name": "PolicyRequestBodyCheck", "modelAsString": true } + }, + "javascriptChallengeExpirationInMinutes": { + "description": "Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30.", + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1440 + }, + "logScrubbing": { + "description": "Defines rules that scrub sensitive fields in the Web Application Firewall logs.", + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "state": { + "type": "string", + "description": "State of the log scrubbing config. Default value is Enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallScrubbingState", + "modelAsString": true + } + }, + "scrubbingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/WebApplicationFirewallScrubbingRules" + }, + "x-ms-identifiers": [], + "description": "List of log scrubbing rules applied to the Web Application Firewall logs." + } + } } } }, @@ -589,6 +623,14 @@ "type": "integer", "minimum": 0 }, + "groupBy": { + "description": "Describes the list of variables to group the rate limit requests", + "type": "array", + "items": { + "$ref": "#/definitions/GroupByVariable" + }, + "x-ms-identifiers": [] + }, "matchConditions": { "description": "List of match conditions.", "type": "array", @@ -602,6 +644,28 @@ } } }, + "GroupByVariable": { + "description": "Describes the variables available to group the rate limit requests", + "required": [ + "variableName" + ], + "type": "object", + "properties": { + "variableName": { + "description": "Describes the supported variable for group by", + "type": "string", + "enum": [ + "SocketAddr", + "GeoLocation", + "None" + ], + "x-ms-enum": { + "name": "VariableName", + "modelAsString": true + } + } + } + }, "TransformType": { "description": "Describes what transforms applied before matching.", "type": "string", @@ -958,13 +1022,69 @@ "Block", "Log", "Redirect", - "AnomalyScoring" + "AnomalyScoring", + "JSChallenge" ], "x-ms-enum": { "name": "ActionType", "modelAsString": true } }, + "WebApplicationFirewallScrubbingRules": { + "description": "Defines the contents of the log scrubbing rules.", + "type": "object", + "required": [ + "matchVariable", + "selectorMatchOperator" + ], + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestIPAddress", + "RequestUri", + "QueryStringArgNames", + "RequestHeaderNames", + "RequestCookieNames", + "RequestBodyPostArgNames", + "RequestBodyJsonArgNames" + ], + "description": "The variable to be scrubbed from the logs.", + "x-ms-enum": { + "name": "scrubbingRuleEntryMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "EqualsAny", + "Equals" + ], + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.", + "x-ms-enum": { + "name": " scrubbingRuleEntryMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to." + }, + "state": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Defines the state of a log scrubbing rule. Default value is enabled.", + "x-ms-enum": { + "name": " scrubbingRuleEntryState", + "modelAsString": true + } + } + } + }, "ManagedRuleSetActionType": { "description": "Defines the action to take when a managed rule set score threshold is met.", "type": "string", diff --git a/swagger-specs/frontdoor/resource-manager/api-set.json b/swagger-specs/frontdoor/resource-manager/api-set.json index cb4b54f1b..c42615237 100644 --- a/swagger-specs/frontdoor/resource-manager/api-set.json +++ b/swagger-specs/frontdoor/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Network/stable/2022-05-01/network.json", "Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json", "Microsoft.Network/stable/2021-06-01/frontdoor.json", "Microsoft.Network/stable/2019-11-01/networkexperiment.json"], "name": "package-2022-05"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.Network/stable/2024-02-01/network.json", "Microsoft.Network/stable/2024-02-01/webapplicationfirewall.json", "Microsoft.Network/stable/2021-06-01/frontdoor.json", "Microsoft.Network/stable/2019-11-01/networkexperiment.json"], "name": "package-2024-02"} \ No newline at end of file diff --git a/swagger-specs/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json b/swagger-specs/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json index 0d98906e3..3a35690bb 100644 --- a/swagger-specs/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json +++ b/swagger-specs/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json @@ -195,13 +195,14 @@ } }, "put": { + "deprecated": true, "tags": [ "HanaOnAzure" ], "operationId": "HanaInstances_Create", "x-ms-long-running-operation": true, "summary": "Creates a SAP HANA instance.", - "description": "Creates a SAP HANA instance for the specified subscription, resource group, and instance name.", + "description": "This action must be performed through our operations team.", "x-ms-examples": { "Create a HANA instance": { "$ref": "./examples/HanaInstances_Create.json" @@ -233,6 +234,12 @@ }, "201": { "description": "Creating HanaInstance", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + }, "schema": { "$ref": "#/definitions/HanaInstance" } @@ -246,13 +253,14 @@ } }, "delete": { + "deprecated": true, "tags": [ "HanaOnAzure" ], "operationId": "HanaInstances_Delete", "x-ms-long-running-operation": true, "summary": "Deletes a SAP HANA instance.", - "description": "Deletes a SAP HANA instance with the specified subscription, resource group, and instance name.", + "description": "This action must be performed through our operations team.", "x-ms-examples": { "Delete a HANA instance": { "$ref": "./examples/HanaInstances_Delete.json" @@ -277,7 +285,13 @@ "description": "Deleted HanaInstance" }, "202": { - "description": "Deleting HanaInstance" + "description": "Deleting HanaInstance", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } }, "204": { "description": "No HanaInstance to delete" @@ -376,7 +390,13 @@ "description": "OK" }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } }, "default": { "description": "Error response describing why the operation failed.", @@ -425,7 +445,13 @@ "description": "OK" }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } }, "default": { "description": "Error response describing why the operation failed.", @@ -474,7 +500,13 @@ "description": "OK" }, "202": { - "description": "Accepted" + "description": "Accepted", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } }, "default": { "description": "Error response describing why the operation failed.", diff --git a/swagger-specs/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json b/swagger-specs/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2024-03-31/healthcare-apis.json similarity index 97% rename from swagger-specs/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json rename to swagger-specs/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2024-03-31/healthcare-apis.json index abd7f4220..f48a4f2a2 100644 --- a/swagger-specs/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json +++ b/swagger-specs/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2024-03-31/healthcare-apis.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-11-01", + "version": "2024-03-31", "title": "HealthcareApisClient", "description": "Use this API to manage Microsoft HealthcareApis services in your Azure subscription." }, @@ -3439,6 +3439,14 @@ "encryption": { "description": "The encryption settings of the DICOM service", "$ref": "#/definitions/Encryption" + }, + "storageConfiguration": { + "description": "The configuration of external storage account", + "$ref": "#/definitions/StorageConfiguration" + }, + "enableDataPartitions": { + "description": "If data partitions is enabled or not.", + "$ref": "#/definitions/EnableDataPartitions" } } }, @@ -3903,9 +3911,69 @@ "type": "boolean", "description": "If the SMART on FHIR proxy is enabled", "readOnly": false + }, + "smartIdentityProviders": { + "type": "array", + "description": "The array of identity provider configurations for SMART on FHIR authentication.", + "readOnly": false, + "items": { + "$ref": "#/definitions/SmartIdentityProviderConfiguration" + }, + "x-ms-identifiers": [] } } }, + "SmartIdentityProviderConfiguration": { + "description": "An object to configure an identity provider for use with SMART on FHIR authentication.", + "type": "object", + "properties": { + "authority": { + "description": "The identity provider token authority also known as the token issuing authority.", + "type": "string" + }, + "applications": { + "type": "array", + "description": "The array of identity provider applications for SMART on FHIR authentication.", + "readOnly": false, + "items": { + "$ref": "#/definitions/SmartIdentityProviderApplication" + }, + "x-ms-identifiers": [] + } + } + }, + "SmartIdentityProviderApplication": { + "description": "An Application configured in the Identity Provider used to access FHIR resources.", + "type": "object", + "properties": { + "clientId": { + "description": "The application client id defined in the identity provider. This value will be used to validate bearer tokens against the given authority.", + "type": "string" + }, + "audience": { + "description": "The audience that will be used to validate bearer tokens against the given authority.", + "type": "string" + }, + "allowedDataActions": { + "description": "The actions that are permitted to be performed on FHIR resources for the application.", + "type": "array", + "items": { + "$ref": "#/definitions/SmartDataActions" + } + } + } + }, + "SmartDataActions": { + "type": "string", + "description": "The Data Actions that can be enabled for a Smart Identity Provider Application.", + "enum": [ + "Read" + ], + "x-ms-enum": { + "name": "SmartDataActions", + "modelAsString": true + } + }, "FhirServiceCorsConfiguration": { "description": "The settings for the CORS configuration of the service instance.", "type": "object", @@ -4096,6 +4164,26 @@ } } }, + "StorageConfiguration": { + "description": "The configuration of connected storage", + "type": "object", + "properties": { + "storageResourceId": { + "type": "string", + "description": "The resource id of connected storage account.", + "readOnly": false + }, + "fileSystemName": { + "type": "string", + "description": "The filesystem name of connected storage account.", + "readOnly": false + } + } + }, + "EnableDataPartitions": { + "description": "Boolean to indicate if data partitions is enabled or not.", + "type": "boolean" + }, "PrivateEndpointConnectionListResult": { "type": "object", "properties": { diff --git a/swagger-specs/healthcareapis/resource-manager/api-set.json b/swagger-specs/healthcareapis/resource-manager/api-set.json index 50ca10fdd..858f6bfae 100644 --- a/swagger-specs/healthcareapis/resource-manager/api-set.json +++ b/swagger-specs/healthcareapis/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json"], "name": "package-2023-11"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.HealthcareApis/stable/2024-03-31/healthcare-apis.json"], "name": "package-2024-03-31"} \ No newline at end of file diff --git a/swagger-specs/help/resource-manager/Microsoft.Help/preview/2023-09-01-preview/help.json b/swagger-specs/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/help.json similarity index 71% rename from swagger-specs/help/resource-manager/Microsoft.Help/preview/2023-09-01-preview/help.json rename to swagger-specs/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/help.json index 75a872373..4e7920f84 100644 --- a/swagger-specs/help/resource-manager/Microsoft.Help/preview/2023-09-01-preview/help.json +++ b/swagger-specs/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/help.json @@ -3,7 +3,7 @@ "info": { "title": "HelpRP", "description": "Help RP provider", - "version": "2023-09-01-preview" + "version": "2024-03-01-preview" }, "host": "management.azure.com", "schemes": [ @@ -77,7 +77,7 @@ "checkNameAvailability" ], "description": "This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solutions", - "operationId": "CheckNameAvailability_Post", + "operationId": "CheckNameAvailability_CheckAvailability", "parameters": [ { "$ref": "#/parameters/ScopeParameter" @@ -123,7 +123,7 @@ "tags": [ "diagnostics" ], - "description": "Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery solutions.
Diagnostics are powerful solutions that access product resources or other relevant data and provide the root cause of the issue and the steps to address the issue.

Note: ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics API.", + "description": "Creates a diagnostic for the specific resource using solutionId from discovery solutions.
Diagnostics are powerful solutions that access product resources or other relevant data and provide the root cause of the issue and the steps to address the issue.

", "operationId": "Diagnostics_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -149,13 +149,13 @@ } ], "responses": { - "201": { + "200": { "description": "Create or Update diagnostics successfully.", "schema": { "$ref": "#/definitions/DiagnosticResource" } }, - "200": { + "201": { "description": "Create or Update diagnostics successfully.", "schema": { "$ref": "#/definitions/DiagnosticResource" @@ -212,17 +212,14 @@ } } }, - "/{scope}/providers/Microsoft.Help/discoverySolutions": { + "/providers/Microsoft.Help/discoverySolutions": { "get": { "tags": [ "discoverySolutions" ], - "description": "Lists the relevant Azure diagnostics and solutions using [problemClassification API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND resourceUri or resourceType.
Discovery Solutions is the initial entry point within Help API, which identifies relevant Azure diagnostics and solutions.

Required Input : problemClassificationId (Use the [problemClassification API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
Optional input: resourceUri OR resource Type

Note: ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics and Solutions API.", + "description": "Lists the relevant Azure Diagnostics, Solutions and Troubleshooters using [problemClassification API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND resourceUri or resourceType.
Discovery Solutions is the initial entry point within Help API, which identifies relevant Azure diagnostics and solutions.

Required Input : problemClassificationId (Use the [problemClassification API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
Optional input: resourceUri OR resource Type

Note: ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics and Solutions API.", "operationId": "DiscoverySolution_List", "parameters": [ - { - "$ref": "#/parameters/ScopeParameter" - }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -252,10 +249,7 @@ }, "x-ms-examples": { "List DiscoverySolutions at resource scope": { - "$ref": "./examples/ListDiscoverySolutionsAtResourceScope.json" - }, - "List DiscoverySolutions at subscription scope": { - "$ref": "./examples/ListDiscoverySolutionsAtSubscriptionScope.json" + "$ref": "./examples/ListDiscoverySolutionsAtTenantScope.json" } } } @@ -265,7 +259,7 @@ "tags": [ "solutions" ], - "description": "Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and requiredInputs’ from discovery solutions.
Azure solutions comprise a comprehensive library of self-help resources that have been thoughtfully curated by Azure engineers to aid customers in resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual troubleshooting instructions. All these components are seamlessly converged into unified solutions tailored to address a specific support problem area. Each solution type may require one or more ‘requiredParameters’ that are required to execute the individual solution component. In the absence of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you might see an empty response.

Note:
1. ‘requiredInputs’ from Discovery solutions response must be passed via ‘parameters’ in the request body of Solutions API.
2. ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the request for diagnostics
3. ‘requiredParameters’ from the Solutions response is the same as ‘properties.parameters’ in the request for Troubleshooters", + "description": "Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and requiredInputs’ from discovery solutions.
Azure solutions comprise a comprehensive library of self-help resources that have been thoughtfully curated by Azure engineers to aid customers in resolving typical troubleshooting issues. These solutions encompass:
(1.) Dynamic and context-aware diagnostics, guided troubleshooting wizards, and data visualizations.
(2.) Rich instructional video tutorials and illustrative diagrams and images.
(3.) Thoughtfully assembled textual troubleshooting instructions.
All these components are seamlessly converged into unified solutions tailored to address a specific support problem area.", "operationId": "Solution_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -291,13 +285,13 @@ } ], "responses": { - "201": { + "200": { "description": "Create or Update solution invocation.", "schema": { "$ref": "#/definitions/SolutionResource" } }, - "200": { + "201": { "description": "Create or Update solution invocation.", "schema": { "$ref": "#/definitions/SolutionResource" @@ -383,7 +377,7 @@ } ], "responses": { - "202": { + "200": { "description": "Successful updated solution resource.", "headers": { "Location": { @@ -394,7 +388,7 @@ "$ref": "#/definitions/SolutionResource" } }, - "200": { + "202": { "description": "Successful updated solution resource.", "headers": { "Location": { @@ -419,6 +413,144 @@ } } }, + "/{scope}/providers/Microsoft.Help/simplifiedSolutions/{simplifiedSolutionsResourceName}": { + "put": { + "tags": [ + "simplifiedSolutions" + ], + "description": "Creates Simplified Solutions for an Azure subscription using 'solutionId' from Discovery Solutions as the input.

Simplified Solutions API makes the consumption of solutions APIs easier while still providing access to the same powerful solutions rendered in Solutions API. With Simplified Solutions, users don't have to worry about stitching together the article using replacement maps and can use the content in the API response to directly render as HTML content.
", + "operationId": "SimplifiedSolutions_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/SimplifiedSolutionsResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "simplifiedSolutionsRequestBody", + "description": "The required request body for simplified Solutions resource creation.", + "in": "body", + "schema": { + "$ref": "#/definitions/SimplifiedSolutionsResource" + } + } + ], + "responses": { + "201": { + "description": "Create simplified Solutions invocation.", + "schema": { + "$ref": "#/definitions/SimplifiedSolutionsResource" + } + }, + "200": { + "description": "Create solution invocation.", + "schema": { + "$ref": "#/definitions/SimplifiedSolutionsResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Solution_Create": { + "$ref": "./examples/SimplifiedSolutions_Create.json" + } + } + }, + "get": { + "tags": [ + "simplifiedSolutions" + ], + "description": "Get the simplified Solutions using the applicable solutionResourceName while creating the simplified Solutions.", + "operationId": "SimplifiedSolutions_Get", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/SimplifiedSolutionsResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successful fetched simplified Solutions result.", + "schema": { + "$ref": "#/definitions/SimplifiedSolutionsResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Solution_Get": { + "$ref": "./examples/SimplifiedSolutions_Get.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}/warmup": { + "post": { + "tags": [ + "solutions" + ], + "description": "Warm up the solution resource by preloading asynchronous diagnostics results into cache", + "operationId": "Solution_WarmUp", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/SolutionResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "solutionWarmUpRequestBody", + "description": "The required request body for warming up a solution resource.", + "in": "body", + "schema": { + "$ref": "#/definitions/SolutionWarmUpRequestBody" + } + } + ], + "responses": { + "204": { + "description": "Successfully warmed up the solution resource" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Solution_WarmUp": { + "$ref": "./examples/Solution_WarmUp.json" + } + } + } + }, "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}": { "put": { "tags": [ @@ -446,14 +578,14 @@ } ], "responses": { - "201": { - "description": "Successful Troubleshooter create invocation.", + "200": { + "description": "Successful Troubleshooter update invocation.", "schema": { "$ref": "#/definitions/TroubleshooterResource" } }, - "200": { - "description": "Successful Troubleshooter update invocation.", + "201": { + "description": "Successful Troubleshooter create invocation.", "schema": { "$ref": "#/definitions/TroubleshooterResource" } @@ -642,6 +774,127 @@ } } } + }, + "/providers/Microsoft.Help/selfHelp/{solutionId}": { + "get": { + "tags": [ + "SolutionSelfHelp" + ], + "description": "Gets Self Help Solutions for a given solutionId. Self Help Solutions consist of rich instructional video tutorials, links and guides to public documentation related to a specific problem that enables users to troubleshoot Azure issues.", + "operationId": "SolutionSelfHelp_Get", + "parameters": [ + { + "$ref": "#/parameters/solutionId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successful fetched solution result.", + "schema": { + "$ref": "#/definitions/SolutionResourceSelfHelp" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Solution_Get": { + "$ref": "./examples/SelfHelpSolution_Get.json" + } + } + } + }, + "/providers/Microsoft.Help/discoverSolutions": { + "post": { + "tags": [ + "discoverSolutions" + ], + "description": "Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue summary.", + "operationId": "DiscoverySolutionNLP_DiscoverSolutions", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "discoverSolutionRequest", + "description": "Request body for discovering solutions using NLP.", + "schema": { + "$ref": "#/definitions/DiscoveryNlpRequest" + } + } + ], + "responses": { + "200": { + "description": "Successful fetched list of solution metadata.", + "schema": { + "$ref": "#/definitions/DiscoveryNlpResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Discovery Solutions using issue summary and service id.": { + "$ref": "./examples/DiscoverSolutionsAtTenantScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Help/discoverSolutions": { + "post": { + "tags": [ + "discoverSolutions" + ], + "description": "Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue summary and subscription.", + "operationId": "DiscoverySolutionNLP_DiscoverSolutionsBySubscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "discoverSolutionRequest", + "description": "Request body for discovering solutions using NLP.", + "schema": { + "$ref": "#/definitions/DiscoveryNlpRequest" + } + } + ], + "responses": { + "200": { + "description": "Successful fetched list of solution metadata.", + "schema": { + "$ref": "#/definitions/DiscoveryNlpResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Discovery Solutions using issue summary and service id.": { + "$ref": "./examples/DiscoverSolutionsAtSubscriptionScope.json" + } + } + } } }, "definitions": { @@ -948,7 +1201,9 @@ "readOnly": true, "enum": [ "Diagnostics", - "Solutions" + "Solutions", + "Troubleshooters", + "SelfHelp" ], "x-ms-enum": { "name": "SolutionType", @@ -961,6 +1216,14 @@ { "value": "Solutions", "description": "Solutions resource type." + }, + { + "value": "Troubleshooters", + "description": "Troubleshooters resource type." + }, + { + "value": "SelfHelp", + "description": "SelfHelp resource type." } ] } @@ -989,7 +1252,7 @@ } }, "SolutionPatchRequestBody": { - "description": "Solution response", + "description": "Solution PatchRequest body", "type": "object", "x-ms-azure-resource": true, "properties": { @@ -999,6 +1262,19 @@ } } }, + "SolutionWarmUpRequestBody": { + "description": "Solution WarmUpRequest body", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, "SolutionResource": { "description": "Solution response.", "type": "object", @@ -1276,6 +1552,10 @@ "description": "Place holder used in HTML Content replace control with the content", "type": "string" }, + "estimatedCompletionTime": { + "description": "Diagnostics estimated completion time in minutes", + "type": "string" + }, "requiredParameters": { "description": "Required parameters of this item", "type": "array", @@ -1446,15 +1726,203 @@ } } }, - "ContinueRequestBody": { - "description": "Troubleshooter ContinueRequest body.", + "SimplifiedSolutionsResource": { + "description": "Simplified Solutions response.", "type": "object", + "x-ms-azure-resource": true, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], "properties": { - "stepId": { - "description": "Unique id of the result.", - "type": "string" - }, - "responses": { + "properties": { + "$ref": "#/definitions/SimplifiedSolutionsResourceProperties", + "x-ms-client-flatten": true + } + } + }, + "SimplifiedSolutionsResourceProperties": { + "description": "Simplified Solutions result", + "type": "object", + "properties": { + "solutionId": { + "description": "Solution Id to identify single Simplified Solution.", + "type": "string" + }, + "parameters": { + "description": "Client input parameters to run Simplified Solutions", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "title": { + "description": "The title.", + "readOnly": true, + "type": "string" + }, + "appendix": { + "description": "Additional parameter response for Simplified Solutions", + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "content": { + "description": "The HTML content that needs to be rendered and shown to customer.", + "readOnly": true, + "type": "string" + }, + "provisioningState": { + "description": "Status of Simplified Solution provisioning.", + "type": "string", + "readOnly": true, + "enum": [ + "Succeeded", + "PartialComplete", + "Failed", + "Running", + "Canceled" + ], + "x-ms-enum": { + "name": "SolutionProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded", + "description": "All Simplified Solutions in the Batch succeeded." + }, + { + "value": "PartialComplete", + "description": "Some Simplified Solutions are still running or failed." + }, + { + "value": "Failed", + "description": "All Simplified Solutions failed to run." + }, + { + "value": "Running", + "description": "All Simplified Solutions are still running." + }, + { + "value": "Canceled", + "description": "When Simplified Solutions request gets canceled." + } + ] + } + } + } + }, + "SolutionResourceSelfHelp": { + "description": "Self Help Solution response.", + "type": "object", + "x-ms-azure-resource": true, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SolutionsResourcePropertiesSelfHelp", + "x-ms-client-flatten": true + } + } + }, + "SolutionsResourcePropertiesSelfHelp": { + "description": "Solution result", + "type": "object", + "properties": { + "solutionId": { + "description": "SolutionId is a unique id to identify a solution. You can retrieve the solution id using the Discovery api - https://learn.microsoft.com/en-us/rest/api/help/discovery-solution/list?view=rest-help-2023-09-01-preview&tabs=HTTP", + "readOnly": true, + "type": "string" + }, + "title": { + "description": "The title.", + "readOnly": true, + "type": "string" + }, + "content": { + "description": "The HTML content that needs to be rendered and shown to customer.", + "readOnly": true, + "type": "string" + }, + "replacementMaps": { + "$ref": "#/definitions/ReplacementMapsSelfHelp", + "readOnly": true + }, + "sections": { + "description": "List of section object.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SectionSelfHelp" + }, + "x-ms-identifiers": [ + "title" + ] + } + } + }, + "SectionSelfHelp": { + "description": "Part of the solution and are dividers in the solution rendering.", + "type": "object", + "properties": { + "title": { + "description": "Solution sections title.", + "type": "string" + }, + "content": { + "description": "Solution sections content.", + "type": "string" + }, + "replacementMaps": { + "$ref": "#/definitions/ReplacementMapsSelfHelp" + } + } + }, + "ReplacementMapsSelfHelp": { + "description": "Solution replacement maps.", + "type": "object", + "properties": { + "webResults": { + "description": "Solution AzureKB results", + "type": "array", + "items": { + "$ref": "#/definitions/WebResult" + }, + "x-ms-identifiers": [] + }, + "videos": { + "description": "Video solutions, which have the power to engage the customer by stimulating their senses", + "type": "array", + "items": { + "$ref": "#/definitions/Video" + }, + "x-ms-identifiers": [] + }, + "videoGroups": { + "description": "Group of Videos", + "type": "array", + "items": { + "$ref": "#/definitions/VideoGroup" + }, + "x-ms-identifiers": [] + } + } + }, + "ContinueRequestBody": { + "description": "Troubleshooter ContinueRequest body.", + "type": "object", + "properties": { + "stepId": { + "description": "Unique id of the result.", + "type": "string" + }, + "responses": { "type": "array", "items": { "$ref": "#/definitions/TroubleshooterResponse" @@ -1601,7 +2069,8 @@ "Decision", "Solution", "Insight", - "AutomatedCheck" + "AutomatedCheck", + "Input" ], "x-ms-enum": { "name": "type", @@ -1642,6 +2111,14 @@ "description": "Only for AutomatedStep type", "type": "object", "properties": { + "version": { + "description": "Version for automated check result", + "type": "string" + }, + "status": { + "description": "Status for automated check result", + "type": "string" + }, "result": { "description": "Insight Article Content", "type": "string" @@ -1673,6 +2150,10 @@ "questionType": { "$ref": "#/definitions/QuestionType" }, + "questionTitle": { + "description": "Question title", + "type": "string" + }, "questionContent": { "description": "User question content.", "type": "string" @@ -1724,6 +2205,21 @@ "description": "Regex used for the input validation.", "type": "string" }, + "validationScope": { + "description": "Validation scope", + "type": "string", + "enum": [ + "None", + "URLFormat", + "GuidFormat", + "IpAddressFormat", + "NumberOnlyFormat" + ], + "x-ms-enum": { + "name": "validationScope", + "modelAsString": true + } + }, "isRequired": { "description": "Default True", "type": "boolean" @@ -1777,7 +2273,9 @@ "RadioButton", "Dropdown", "TextInput", - "MultiLineInfoBox" + "MultiLineInfoBox", + "DateTimePicker", + "MultiSelect" ], "x-ms-enum": { "name": "questionType", @@ -1798,6 +2296,14 @@ { "value": "MultiLineInfoBox", "description": "MultiLineInfoBox" + }, + { + "value": "DateTimePicker", + "description": "DateTime Picker" + }, + { + "value": "MultiSelect", + "description": "Multi Select" } ] } @@ -1846,9 +2352,136 @@ } } } + }, + "DiscoveryNlpRequest": { + "description": "Discover NLP request.", + "type": "object", + "required": [ + "issueSummary" + ], + "properties": { + "issueSummary": { + "description": "Natural language description of the issue.", + "type": "string" + }, + "resourceId": { + "description": "ARM resource Id of the resource that is having the issue. Only applicable for Discovery Solution NLP Subscription Scope.", + "type": "string" + }, + "serviceId": { + "description": "ARM service Id of the service that is having the issue. For more information on service Id see https://learn.microsoft.com/rest/api/support/services/list?tabs=HTTP.", + "type": "string" + }, + "additionalContext": { + "description": "Additional information in the form of a string.", + "type": "string" + } + } + }, + "DiscoveryNlpResponse": { + "description": "Successfully fetched list of solution metadata.", + "type": "object", + "properties": { + "value": { + "description": "The list of solution metadata.", + "type": "array", + "items": { + "$ref": "#/definitions/SolutionNlpMetadataResource" + } + } + } + }, + "SolutionNlpMetadataResource": { + "description": "Nlp Metadata resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NlpSolutions", + "description": "Solution metadata Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "NlpSolutions": { + "description": "Nlp metadata.", + "type": "object", + "properties": { + "problemTitle": { + "description": "Title of the problem classification.", + "type": "string" + }, + "problemDescription": { + "description": "Description of the problem classification.", + "type": "string" + }, + "serviceId": { + "description": "Id of the service (https://learn.microsoft.com/en-us/rest/api/support/services?view=rest-support-2020-04-01) that may be used to create a support ticket.", + "type": "string" + }, + "problemClassificationId": { + "description": "Id of the ProblemClassification (https://learn.microsoft.com/en-us/rest/api/support/problem-classifications?view=rest-support-2020-04-01) that may be used to create a support ticket.", + "type": "string" + }, + "solutions": { + "description": "The list of solution metadata.", + "type": "array", + "items": { + "$ref": "#/definitions/SolutionMetadataProperties" + }, + "x-ms-identifiers": [] + }, + "relatedServices": { + "description": "The set of services that are most likely related to the request. If relatedServices is included in the response then solutions may not be discovered until the client calls a second time specifying one of the service Ids in the relatedServices object.", + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationService" + }, + "x-ms-identifiers": [] + } + } + }, + "ClassificationService": { + "description": "Service Classification result object.", + "type": "object", + "properties": { + "serviceId": { + "description": "Azure resource Id of the service.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "displayName": { + "description": "Localized name of the azure service.", + "type": "string", + "readOnly": true + }, + "resourceTypes": { + "description": "List of applicable ARM resource types for this service.", + "type": "array", + "items": { + "type": "string" + } + } + } } }, "parameters": { + "solutionId": { + "name": "solutionId", + "in": "path", + "required": true, + "type": "string", + "description": "SolutionId is a unique id to identify a solution. You can retrieve the solution id using the Discovery api - https://learn.microsoft.com/en-us/rest/api/help/discovery-solution/list?view=rest-help-2023-09-01-preview&tabs=HTTP", + "x-ms-parameter-location": "method", + "minLength": 1, + "maxLength": 100 + }, "SolutionResourceNameParameter": { "name": "solutionResourceName", "in": "path", @@ -1860,6 +2493,17 @@ "maxLength": 100, "pattern": "^[A-Za-z0-9-+@()_]+$" }, + "SimplifiedSolutionsResourceNameParameter": { + "name": "simplifiedSolutionsResourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Simplified Solutions Resource Name.", + "x-ms-parameter-location": "method", + "minLength": 1, + "maxLength": 100, + "pattern": "^[A-Za-z0-9-+@()_]+$" + }, "ScopeParameter": { "name": "scope", "in": "path", diff --git a/swagger-specs/help/resource-manager/api-set.json b/swagger-specs/help/resource-manager/api-set.json index dc9662fa6..53ed535ba 100644 --- a/swagger-specs/help/resource-manager/api-set.json +++ b/swagger-specs/help/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Help/preview/2023-09-01-preview/help.json"], "name": "package-2023-09-01-preview"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.Help/preview/2024-03-01-preview/help.json"], "name": "package-2024-03-01-preview"} \ No newline at end of file diff --git a/swagger-specs/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json b/swagger-specs/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json similarity index 96% rename from swagger-specs/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json rename to swagger-specs/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json index 2f199eee7..6c390d119 100644 --- a/swagger-specs/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json +++ b/swagger-specs/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json @@ -3,7 +3,7 @@ "info": { "title": "VirtualMachineImageTemplate", "description": "Virtual Machine Image Template", - "version": "2023-07-01" + "version": "2024-02-01" }, "host": "management.azure.com", "schemes": [ @@ -234,6 +234,9 @@ }, "Remove identities for an Image Template.": { "$ref": "./examples/UpdateImageTemplateToRemoveIdentities.json" + }, + "Update parameters for vm profile.": { + "$ref": "./examples/UpdateImageTemplateVmProfile.json" } } }, @@ -1324,12 +1327,16 @@ "properties": { "subnetId": { "type": "string", - "description": "Resource id of a pre-existing subnet." + "description": "Resource id of a pre-existing subnet on which the build VM and validation VM will be deployed" + }, + "containerInstanceSubnetId": { + "type": "string", + "description": "Resource id of a pre-existing subnet on which Azure Container Instance will be deployed for Isolated Builds. This field may be specified only if `subnetId` is also specified and must be on the same Virtual Network as the subnet specified in `subnetId`." }, "proxyVmSize": { "type": "string", "default": "", - "description": "Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2)." + "description": "Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. This must not be specified if `containerInstanceSubnetId` is specified because no proxy virtual machine is deployed in that case. Omit or specify empty string to use the default (Standard_A1_v2)." } } }, @@ -1490,6 +1497,36 @@ } } }, + "ImageTemplateAutoRun": { + "type": "object", + "description": "Indicates if the image template needs to be built on create/update", + "properties": { + "state": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "AutoRunState", + "modelAsString": false, + "values": [ + { + "value": "Enabled", + "description": "Autorun is enabled", + "name": "AutoRunEnabled" + }, + { + "value": "Disabled", + "description": "Autorun is disabled", + "name": "AutoRunDisabled" + } + ] + }, + "description": "Enabling this field will trigger an automatic build on image template creation or update." + } + } + }, "ImageTemplateProperties": { "type": "object", "description": "Describes the properties of an image template", @@ -1613,6 +1650,22 @@ "type": "string", "description": "The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty.", "readOnly": true + }, + "autoRun": { + "$ref": "#/definitions/ImageTemplateAutoRun", + "description": "Indicates whether or not to automatically run the image template build on template creation or update." + }, + "managedResourceTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags that will be applied to the resource group and/or resources created by the service." } }, "required": [ @@ -1732,6 +1785,10 @@ }, "x-ms-identifiers": [], "description": "The distribution targets where the image output needs to go to." + }, + "vmProfile": { + "$ref": "#/definitions/ImageTemplateVmProfile", + "description": "Describes how virtual machine is set up to build images" } } } diff --git a/swagger-specs/imagebuilder/resource-manager/api-set.json b/swagger-specs/imagebuilder/resource-manager/api-set.json index 63ba1ba31..53e99d062 100644 --- a/swagger-specs/imagebuilder/resource-manager/api-set.json +++ b/swagger-specs/imagebuilder/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json"], "name": "package-2023-07"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json"], "name": "package-2024-02"} \ No newline at end of file diff --git a/swagger-specs/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json b/swagger-specs/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json index 0a9e59c4e..05d685fae 100644 --- a/swagger-specs/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json +++ b/swagger-specs/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json @@ -2,971 +2,938 @@ "swagger": "2.0", "info": { "title": "Azure Load Testing", + "version": "2022-11-01", "description": "These APIs allow end users to create, view and run load tests using Azure Load Test Service.", - "version": "2022-11-01" + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "https://{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "Oauth2": [ + "https://cnt-prod.loadtesting.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "Oauth2": { + "type": "oauth2", + "description": "OAuth 2.0 Flow with Microsoft Entra ID.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://cnt-prod.loadtesting.azure.com/.default": "" + } + } }, + "tags": [ + { + "name": "Test" + }, + { + "name": "TestRun" + } + ], "paths": { - "/tests/{testId}": { - "patch": { + "/test-runs": { + "get": { + "operationId": "LoadTestRun_ListTestRuns", "tags": [ - "Test" - ], - "summary": "Create a new test or update an existing test.", - "operationId": "LoadTestAdministration_CreateOrUpdateTest", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" + "TestRun" ], + "summary": "Get all test runs for the given filters.", + "description": "Get all test runs for the given filters.", "parameters": [ { - "$ref": "#/parameters/TestIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ApiVersion" + "$ref": "#/parameters/ListTestRunQueryParams.orderby" }, { - "in": "body", - "name": "body", - "description": "Load test model", - "required": true, - "schema": { - "$ref": "#/definitions/Test" - } - } - ], - "responses": { - "200": { - "description": "The test was updated.", - "schema": { - "$ref": "#/definitions/Test" - } + "$ref": "#/parameters/ListTestRunQueryParams.search" }, - "201": { - "description": "The test was created.", - "schema": { - "$ref": "#/definitions/Test" - } + { + "$ref": "#/parameters/ListTestRunQueryParams.testId" }, - "default": { - "description": "Load Testing service error response.", - "schema": { - "$ref": "#/definitions/ErrorResponseBody" - }, - "headers": { - "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" - } - } - } - }, - "x-ms-examples": { - "Create or update a test": { - "$ref": "./examples/CreateOrUpdateTest.json" - } - } - }, - "delete": { - "tags": [ - "Test" - ], - "summary": "Delete a test by its name.", - "operationId": "LoadTestAdministration_DeleteTest", - "produces": [ - "application/json" - ], - "parameters": [ { - "$ref": "#/parameters/TestIdPathParameter" + "$ref": "#/parameters/ListTestRunQueryParams.executionFrom" }, { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "204": { - "description": "The test is deleted." + "$ref": "#/parameters/ListTestRunQueryParams.executionTo" }, - "default": { - "description": "Load Testing service error response.", - "schema": { - "$ref": "#/definitions/ErrorResponseBody" - }, - "headers": { - "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" - } - } - } - }, - "x-ms-examples": { - "Delete a test": { - "$ref": "./examples/DeleteTest.json" - } - } - }, - "get": { - "tags": [ - "Test" - ], - "summary": "Get load test details by test name", - "operationId": "LoadTestAdministration_GetTest", - "produces": [ - "application/json" - ], - "parameters": [ { - "$ref": "#/parameters/TestIdPathParameter" + "$ref": "#/parameters/ListTestRunQueryParams.status" }, { - "$ref": "#/parameters/ApiVersion" + "$ref": "#/parameters/ListTestRunQueryParams.maxpagesize" } ], "responses": { "200": { - "description": "The requested test.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/Test" + "$ref": "#/definitions/PagedTestRun" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Get a test by an unique name": { - "$ref": "./examples/GetTest.json" + "List test runs.": { + "$ref": "./examples/ListTestRuns.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/tests": { + "/test-runs/{testRunId}": { "get": { + "operationId": "LoadTestRun_GetTestRun", "tags": [ - "Test" - ], - "summary": "Get all load tests by the fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.", - "operationId": "LoadTestAdministration_ListTests", - "produces": [ - "application/json" + "TestRun" ], + "summary": "Get test run details by test run Id.", + "description": "Get test run details by test run Id.", "parameters": [ { - "in": "query", - "name": "orderby", - "description": "Sort on the supported fields in (field asc/desc) format. eg: lastModifiedDateTime asc. Supported fields - lastModifiedDateTime", - "type": "string" - }, - { - "in": "query", - "name": "search", - "description": "Prefix based, case sensitive search on searchable fields - displayName, createdBy. For example, to search for a test, with display name is Login Test, the search parameter can be Login.", - "type": "string" - }, - { - "in": "query", - "name": "lastModifiedStartTime", - "description": "Start DateTime(ISO 8601 literal format) of the last updated time range to filter tests.", - "type": "string", - "format": "date-time" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "in": "query", - "name": "lastModifiedEndTime", - "description": "End DateTime(ISO 8601 literal format) of the last updated time range to filter tests.", + "name": "testRunId", + "in": "path", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxpagesize", - "description": "Number of results in response.", - "type": "integer", - "format": "int32", - "default": 50 - }, - { - "$ref": "#/parameters/ApiVersion" + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" } ], "responses": { "200": { - "description": "The requested tests.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TestsList" + "$ref": "#/definitions/TestRun" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Search test with filters": { - "$ref": "./examples/ListTests.json" + "Get a load test run.": { + "$ref": "./examples/GetTestRun.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/tests/{testId}/files/{fileName}": { - "put": { + }, + "patch": { + "operationId": "LoadTestRun_CreateOrUpdateTestRun", "tags": [ - "Test" + "TestRun" ], - "summary": "Upload input file for a given test name. File size can't be more than 50 MB. Existing file with same name for the given test will be overwritten. File should be provided in the request body as application/octet-stream.", - "operationId": "LoadTestAdministration_UploadTestFile", + "summary": "Create and start a new test run with the given test run Id.", + "description": "Create and start a new test run with the given test run Id.", "consumes": [ - "application/octet-stream" - ], - "produces": [ - "application/json" + "application/merge-patch+json" ], "parameters": [ { - "$ref": "#/parameters/TestIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { + "name": "testRunId", "in": "path", - "name": "fileName", - "description": "Unique name for test file with file extension like : App.jmx", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", "required": true, - "type": "string" - }, - { - "in": "query", - "name": "fileType", - "description": "File type", "type": "string", - "enum": [ - "JMX_FILE", - "USER_PROPERTIES", - "ADDITIONAL_ARTIFACTS" - ], - "x-ms-enum": { - "name": "fileType", - "modelAsString": true, - "values": [ - { - "value": "JMX_FILE", - "description": "If file is jmx script" - }, - { - "value": "USER_PROPERTIES", - "description": "If file is user properties" - }, - { - "value": "ADDITIONAL_ARTIFACTS", - "description": "If file is not any of other supported type" - } - ] - } + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" }, { - "$ref": "#/parameters/ApiVersion" + "$ref": "#/parameters/OldTestRunIdQueryParam" }, { - "in": "body", "name": "body", - "description": "The file content as application/octet-stream.", + "in": "body", + "description": "The resource instance.", "required": true, "schema": { - "format": "binary", - "type": "string" - } + "$ref": "#/definitions/TestRunCreateOrUpdate" + }, + "x-ms-client-name": "resource" } ], "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRun" + } + }, "201": { - "description": "The test artifact is uploaded.", + "description": "The request has succeeded and a new resource has been created as a result.", "schema": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestRun" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Upload a test file": { - "$ref": "./examples/UploadTestFile.json" + "Create/update and start a load test run": { + "$ref": "./examples/CreateOrUpdateTestRun.json" } } }, - "get": { + "delete": { + "operationId": "LoadTestRun_DeleteTestRun", "tags": [ - "Test" - ], - "summary": "Get test file by the file name.", - "operationId": "LoadTestAdministration_GetTestFile", - "produces": [ - "application/json" + "TestRun" ], + "summary": "Delete an existing load test run.", + "description": "Delete an existing load test run by providing the testRunId.", "parameters": [ { - "$ref": "#/parameters/TestIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { + "name": "testRunId", "in": "path", - "name": "fileName", - "description": "File name with file extension like app.jmx", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersion" + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" } ], "responses": { - "200": { - "description": "The requested test file info.", - "schema": { - "$ref": "#/definitions/FileInfo" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Get a test file by an unique name": { - "$ref": "./examples/GetTestFile.json" + "Delete a load test run": { + "$ref": "./examples/DeleteTestRun.json" } } - }, - "delete": { + } + }, + "/test-runs/{testRunId}:stop": { + "post": { + "operationId": "LoadTestRun_StopTestRun", "tags": [ - "Test" - ], - "summary": "Delete file by the file name for a test", - "operationId": "LoadTestAdministration_DeleteTestFile", - "produces": [ - "application/json" + "TestRun" ], + "summary": "Stop test run by test run Id.", + "description": "Stop test run by test run Id.", "parameters": [ { - "$ref": "#/parameters/TestIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { + "name": "testRunId", "in": "path", - "name": "fileName", - "description": "File name with file extension like app.jmx", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersion" + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" } ], "responses": { - "204": { - "description": "The requested file is deleted." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRun" + } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Delete a test file": { - "$ref": "./examples/DeleteTestFile.json" + "Stop test run by name.": { + "$ref": "./examples/StopTestRun.json" } } } }, - "/tests/{testId}/files": { + "/test-runs/{testRunId}/app-components": { "get": { + "operationId": "LoadTestRun_GetAppComponents", "tags": [ - "Test" - ], - "summary": "Get all test files.", - "operationId": "LoadTestAdministration_ListTestFiles", - "produces": [ - "application/json" + "TestRun" ], + "summary": "Get associated app component (collection of azure resources) for the given test\nrun.", + "description": "Get associated app component (collection of azure resources) for the given test\nrun.", "parameters": [ { - "$ref": "#/parameters/TestIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ApiVersion" + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" } ], "responses": { "200": { - "description": "The URLs for the requested test files.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/FileInfoList" + "$ref": "#/definitions/TestRunAppComponents" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Get all uploaded files to a test": { - "$ref": "./examples/ListTestFiles.json" + "Get associated app component for the given test run.": { + "$ref": "./examples/ListTestRunAppComponents.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/tests/{testId}/app-components": { + }, "patch": { + "operationId": "LoadTestRun_CreateOrUpdateAppComponents", "tags": [ - "Test" + "TestRun" ], - "summary": "Associate an app component (collection of azure resources) to a test", - "operationId": "LoadTestAdministration_CreateOrUpdateAppComponents", + "summary": "Add an app component to a test run.", + "description": "Add an app component to a test run by providing the resource Id, name and type.", "consumes": [ "application/merge-patch+json" ], - "produces": [ - "application/json" - ], "parameters": [ { - "$ref": "#/parameters/TestIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ApiVersion" + "name": "testRunId", + "in": "path", + "description": "Unique Id for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" }, { - "in": "body", "name": "body", + "in": "body", "description": "App Component model.", "required": true, "schema": { - "$ref": "#/definitions/TestAppComponents" + "$ref": "#/definitions/TestRunAppComponentsUpdate" } } ], "responses": { "200": { - "description": "The app component is updated.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TestAppComponents" + "$ref": "#/definitions/TestRunAppComponents" } }, "201": { - "description": "The app component is created.", + "description": "The request has succeeded and a new resource has been created as a result.", "schema": { - "$ref": "#/definitions/TestAppComponents" + "$ref": "#/definitions/TestRunAppComponents" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Create or update app components for a test": { - "$ref": "./examples/CreateOrUpdateTestAppComponents.json" + "Add or update app components to a load test run": { + "$ref": "./examples/CreateOrUpdateTestRunAppComponents.json" } } - }, + } + }, + "/test-runs/{testRunId}/files/{fileName}": { "get": { + "operationId": "LoadTestRun_GetTestRunFile", "tags": [ - "Test" - ], - "summary": "Get associated app component (collection of azure resources) for the given test.", - "operationId": "LoadTestAdministration_GetAppComponents", - "produces": [ - "application/json" + "TestRun" ], + "summary": "Get test run file by file name.", + "description": "Get test run file by file name.", "parameters": [ { - "$ref": "#/parameters/TestIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" }, { - "$ref": "#/parameters/ApiVersion" + "name": "fileName", + "in": "path", + "description": "Name of the file.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The requested app component.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TestAppComponents" + "$ref": "#/definitions/TestRunFileInfo" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "List app components for a test": { - "$ref": "./examples/ListTestAppComponents.json" + "Get a file associated to a load test run.": { + "$ref": "./examples/GetTestRunFile.json" } } } }, - "/tests/{testId}/server-metrics-config": { - "patch": { + "/test-runs/{testRunId}/metric-definitions": { + "get": { + "operationId": "LoadTestRun_ListMetricDefinitions", "tags": [ - "Test" - ], - "summary": "Configure server metrics for a test", - "operationId": "LoadTestAdministration_CreateOrUpdateServerMetricsConfig", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" + "TestRun" ], + "summary": "List the metric definitions for a load test run.", + "description": "List the metric definitions for a load test run.", "parameters": [ { - "$ref": "#/parameters/TestIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ApiVersion" + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" }, { - "in": "body", - "name": "body", - "description": "Server metric configuration model.", + "name": "metricNamespace", + "in": "query", + "description": "Metric namespace to query metric definitions for.", "required": true, - "schema": { - "$ref": "#/definitions/TestServerMetricConfig" - } + "type": "string" } ], "responses": { "200": { - "description": "The server metrics config is updated.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TestServerMetricConfig" - } - }, - "201": { - "description": "The server metrics config is created.", - "schema": { - "$ref": "#/definitions/TestServerMetricConfig" + "$ref": "#/definitions/MetricDefinitionCollection" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Configure server metrics config for a test": { - "$ref": "./examples/CreateOrUpdateTestServerMetricsConfig.json" + "List the metric definitions for a load test run.": { + "$ref": "./examples/ListTestRunMetricsDefinitions.json" } } - }, + } + }, + "/test-runs/{testRunId}/metric-dimensions/{name}/values": { "get": { + "operationId": "LoadTestRun_ListMetricDimensionValues", "tags": [ - "Test" - ], - "summary": "List server metrics configuration for the given test.", - "operationId": "LoadTestAdministration_GetServerMetricsConfig", - "produces": [ - "application/json" + "TestRun" ], + "summary": "List the dimension values for the given metric dimension name.", + "description": "List the dimension values for the given metric dimension name.", "parameters": [ { - "$ref": "#/parameters/TestIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "name", + "in": "path", + "description": "Dimension name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.metricname" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.interval" }, { - "$ref": "#/parameters/ApiVersion" + "$ref": "#/parameters/MetricDimensionsRequest.metricNamespace" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.timespan" } ], "responses": { "200": { - "description": "Requested server metrics configuration", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TestServerMetricConfig" + "$ref": "#/definitions/DimensionValueList" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "List server metrics configuration for a test": { - "$ref": "./examples/ListTestServerMetricsConfig.json" + "List the dimension values for the given metric dimension name.": { + "$ref": "./examples/ListMetricDimensionValues.json" } } } }, - "/test-runs/{testRunId}": { - "patch": { + "/test-runs/{testRunId}/metric-namespaces": { + "get": { + "operationId": "LoadTestRun_ListMetricNamespaces", "tags": [ "TestRun" ], - "summary": "Create and start a new test run with the given name.", - "operationId": "LoadTestRun_CreateOrUpdateTestRun", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], + "summary": "List the metric namespaces for a load test run.", + "description": "List the metric namespaces for a load test run.", "parameters": [ { - "$ref": "#/parameters/TestRunIdPathParameter" - }, - { - "in": "query", - "name": "oldTestRunId", - "description": "Existing test run identifier that should be rerun, if this is provided, the test will run with the JMX file, configuration and app components from the existing test run. You can override the configuration values for new test run in the request body.", - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersion" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "in": "body", - "name": "body", - "description": "Load test run model", + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", "required": true, - "schema": { - "$ref": "#/definitions/TestRun" - } + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" } ], "responses": { - "201": { - "description": "The test run is created.", - "schema": { - "$ref": "#/definitions/TestRun" - } - }, "200": { - "description": "The test run is updated.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TestRun" + "$ref": "#/definitions/MetricNamespaceCollection" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Create or update a test run": { - "$ref": "./examples/CreateAndUpdateTestRun.json" + "List the metric namespaces for a load test run.": { + "$ref": "./examples/ListTestRunMetricsNamespaces.json" } } - }, - "get": { + } + }, + "/test-runs/{testRunId}/metrics": { + "post": { + "operationId": "LoadTestRun_ListMetrics", "tags": [ "TestRun" ], - "summary": "Get test run details by name.", - "operationId": "LoadTestRun_GetTestRun", - "produces": [ - "application/json" - ], + "summary": "List the metric values for a load test run.", + "description": "List the metric values for a load test run.", "parameters": [ { - "$ref": "#/parameters/TestRunIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "aggregation", + "in": "query", + "description": "The aggregation", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.metricname" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.interval" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.metricNamespace" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.timespan" }, { - "$ref": "#/parameters/ApiVersion" + "name": "body", + "in": "body", + "description": "Metric dimension filter ", + "required": false, + "schema": { + "$ref": "#/definitions/MetricRequestPayload" + } } ], "responses": { "200": { - "description": "The requested test run details", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TestRun" + "$ref": "#/definitions/Metrics" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Get a test run": { - "$ref": "./examples/GetTestRun.json" + "List the metric values for a load test run.": { + "$ref": "./examples/ListTestRunMetrics.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "delete": { + } + }, + "/test-runs/{testRunId}/server-metrics-config": { + "get": { + "operationId": "LoadTestRun_GetServerMetricsConfig", "tags": [ "TestRun" ], - "summary": "Delete a test run by its name.", - "operationId": "LoadTestRun_DeleteTestRun", - "produces": [ - "application/json" - ], + "summary": "Get associated server metrics configuration for the given test run.", + "description": "Get associated server metrics configuration for the given test run.", "parameters": [ { - "$ref": "#/parameters/TestRunIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ApiVersion" + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" } ], "responses": { - "204": { - "description": "The test run is deleted." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRunServerMetricConfig" + } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Delete a test run": { - "$ref": "./examples/DeleteTestRun.json" + "List server metrics configuration for the given test run.": { + "$ref": "./examples/ListTestRunServerMetricsConfig.json" } } - } - }, - "/test-runs/{testRunId}/files/{fileName}": { - "get": { + }, + "patch": { + "operationId": "LoadTestRun_CreateOrUpdateServerMetricsConfig", "tags": [ "TestRun" ], - "summary": "Get test run file by file name.", - "operationId": "LoadTestRun_GetTestRunFile", - "produces": [ - "application/json" + "summary": "Configure server metrics for a test run", + "description": "Configure server metrics for a test run", + "consumes": [ + "application/merge-patch+json" ], "parameters": [ { - "$ref": "#/parameters/TestRunIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { + "name": "testRunId", "in": "path", - "name": "fileName", - "description": "Test run file name with file extension", + "description": "Unique Id for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", "required": true, - "type": "string" + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" }, { - "$ref": "#/parameters/ApiVersion" + "name": "body", + "in": "body", + "description": "Server metric configuration model.", + "required": true, + "schema": { + "$ref": "#/definitions/TestRunServerMetricConfig" + } } ], "responses": { "200": { - "description": "The URL for the requested test run file", + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRunServerMetricConfig" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", "schema": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestRunServerMetricConfig" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Get a test run file by an unique name": { - "$ref": "./examples/GetTestRunFile.json" + "Add or update server metrics configuration for a load test run": { + "$ref": "./examples/CreateOrUpdateTestRunServerMetricsConfig.json" } } } }, - "/test-runs": { + "/tests": { "get": { + "operationId": "LoadTestAdministration_ListTests", "tags": [ - "TestRun" - ], - "summary": "Get all test runs with given filters", - "operationId": "LoadTestRun_ListTestRuns", - "produces": [ - "application/json" + "Test" ], + "summary": "Get all load tests by the fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.", + "description": "Get all load tests by the fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.", "parameters": [ { - "in": "query", - "name": "orderby", - "description": "Sort on the supported fields in (field asc/desc) format. eg: executedDateTime asc. Supported fields - executedDateTime", - "type": "string" - }, - { - "in": "query", - "name": "search", - "description": "Prefix based, case sensitive search on searchable fields - description, executedUser. For example, to search for a test run, with description 500 VUs, the search parameter can be 500.", - "type": "string" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/TestIdQueryParameter" + "$ref": "#/parameters/ListTestQueryParams.orderby" }, { - "in": "query", - "name": "executionFrom", - "description": "Start DateTime(ISO 8601 literal format) of test-run execution time filter range.", - "type": "string", - "format": "date-time" + "$ref": "#/parameters/ListTestQueryParams.search" }, { - "in": "query", - "name": "executionTo", - "description": "End DateTime(ISO 8601 literal format) of test-run execution time filter range.", - "type": "string", - "format": "date-time" + "$ref": "#/parameters/ListTestQueryParams.lastModifiedStartTime" }, { - "in": "query", - "name": "status", - "description": "Comma separated list of test run status.", - "type": "string" + "$ref": "#/parameters/ListTestQueryParams.lastModifiedEndTime" }, { - "in": "query", - "name": "maxpagesize", - "description": "Number of results in response.", - "type": "integer", - "format": "int32", - "default": 50 - }, - { - "$ref": "#/parameters/ApiVersion" + "$ref": "#/parameters/ListTestQueryParams.maxpagesize" } ], "responses": { "200": { - "description": "The requested test runs", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TestRunsList" + "$ref": "#/definitions/PagedTest" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Search test runs with filters": { - "$ref": "./examples/ListTestRuns.json" + "Get all load tests.": { + "$ref": "./examples/ListTests.json" } }, "x-ms-pageable": { @@ -974,1355 +941,1586 @@ } } }, - "/test-runs/{testRunId}:stop": { - "post": { + "/tests/{testId}": { + "get": { + "operationId": "LoadTestAdministration_GetTest", "tags": [ - "TestRun" - ], - "summary": "Stop test run by name.", - "operationId": "LoadTestRun_StopTestRun", - "produces": [ - "application/json" + "Test" ], + "summary": "Get load test details by test Id", + "description": "Get load test details by test Id", "parameters": [ { - "$ref": "#/parameters/TestRunIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ApiVersion" + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" } ], "responses": { "200": { - "description": "The requested test run is getting cancelled. Call GET /test-runs/{testRunId} to check the status.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TestRun" + "$ref": "#/definitions/Test" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Stop a test run": { - "$ref": "./examples/StopTestRun.json" + "Get a load test.": { + "$ref": "./examples/GetTest.json" } } - } - }, - "/test-runs/{testRunId}/metric-namespaces": { - "get": { + }, + "patch": { + "operationId": "LoadTestAdministration_CreateOrUpdateTest", "tags": [ - "TestRun" + "Test" ], - "summary": "List the metric namespaces for a load test run.", - "operationId": "LoadTestRun_ListMetricNamespaces", - "produces": [ - "application/json" + "summary": "Create a new test or update an existing test by providing the test Id.", + "description": "Create a new test or update an existing test by providing the test Id.", + "consumes": [ + "application/merge-patch+json" ], "parameters": [ { - "$ref": "#/parameters/TestRunIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" }, { - "$ref": "#/parameters/ApiVersion" + "name": "body", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/TestCreateOrUpdate" + }, + "x-ms-client-name": "resource" } ], "responses": { "200": { - "description": "Successful request to get the list of metric namespaces", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/MetricNamespaceCollection" + "$ref": "#/definitions/Test" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Test" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Lists the metric namespaces for a load test run.": { - "$ref": "./examples/ListTestRunMetricsNamespaces.json" + "Create or update a load test": { + "$ref": "./examples/CreateOrUpdateTest.json" } } - } - }, - "/test-runs/{testRunId}/metric-definitions": { - "get": { + }, + "delete": { + "operationId": "LoadTestAdministration_DeleteTest", "tags": [ - "TestRun" - ], - "summary": "List the metric definitions for a load test run.", - "operationId": "LoadTestRun_ListMetricDefinitions", - "produces": [ - "application/json" + "Test" ], + "summary": "Delete a test by its test Id.", + "description": "Delete a test by its test Id.", "parameters": [ { - "$ref": "#/parameters/TestRunIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "in": "query", - "name": "metricNamespace", - "description": "Metric namespace to query metric definitions for.", + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersion" + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" } ], "responses": { - "200": { - "description": "The requested load test metrics definition", - "schema": { - "$ref": "#/definitions/MetricDefinitionCollection" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Lists the metric definitions for a load test run.": { - "$ref": "./examples/ListTestRunMetricsDefinitions.json" + "Delete a load test": { + "$ref": "./examples/DeleteTest.json" } } } }, - "/test-runs/{testRunId}/metrics": { - "post": { + "/tests/{testId}/app-components": { + "get": { + "operationId": "LoadTestAdministration_GetAppComponents", "tags": [ - "TestRun" - ], - "summary": "List the metric values for a load test run.", - "operationId": "LoadTestRun_ListMetrics", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" + "Test" ], + "summary": "Get associated app component (collection of azure resources) for the given test.", + "description": "Get associated app component (collection of azure resources) for the given test.", "parameters": [ { - "$ref": "#/parameters/TestRunIdPathParameter" - }, - { - "in": "query", - "name": "aggregation", - "description": "The aggregation", - "type": "string" - }, - { - "in": "query", - "name": "interval", - "description": "The interval (i.e. timegrain) of the query.", - "type": "string", - "default": "PT1M", - "enum": [ - "PT5S", - "PT10S", - "PT1M", - "PT5M", - "PT1H" - ], - "x-ms-enum": { - "name": "interval", - "modelAsString": true, - "values": [ - { - "value": "PT5S", - "description": "5 seconds, available only if test run duration is less than 10 minutes" - }, - { - "value": "PT10S", - "description": "10 seconds, available only if test run duration is less than 10 minutes" - }, - { - "value": "PT1M", - "description": "1 minute" - }, - { - "value": "PT5M", - "description": "5 minutes, available only if test run duration is greater than 1 minute" - }, - { - "value": "PT1H", - "description": "1 hour, available only if test run duration is greater than 1 minute" - } - ] - } - }, - { - "in": "query", - "name": "metricname", - "description": "Metric name", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "metricNamespace", - "description": "Metric namespace to query metric definitions for.", - "required": true, - "type": "string" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "in": "query", - "name": "timespan", - "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "in": "body", - "name": "body", - "description": "Metric dimension filter ", - "schema": { - "$ref": "#/definitions/MetricRequestPayload" - } + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" } ], "responses": { "200": { - "description": "The requested load test run metrics", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/Metrics" + "$ref": "#/definitions/TestAppComponents" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Lists the metric values for a load test run.": { - "$ref": "./examples/ListTestRunMetrics.json" + "Get associated app component for the given test.": { + "$ref": "./examples/ListTestAppComponents.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/test-runs/{testRunId}/metric-dimensions/{name}/values": { - "get": { + }, + "patch": { + "operationId": "LoadTestAdministration_CreateOrUpdateAppComponents", "tags": [ - "TestRun" + "Test" ], - "summary": "List the dimension values for the given metric dimension name.", - "operationId": "LoadTestRun_ListMetricDimensionValues", - "produces": [ - "application/json" + "summary": "Add an app component to a test.", + "description": "Add an app component to a test by providing the resource Id, name and type.", + "consumes": [ + "application/merge-patch+json" ], "parameters": [ { - "$ref": "#/parameters/TestRunIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { + "name": "testId", "in": "path", - "name": "name", - "description": "Dimension name", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", "required": true, - "type": "string" - }, - { - "in": "query", - "name": "interval", - "description": "The interval (i.e. timegrain) of the query.", "type": "string", - "default": "PT1M", - "enum": [ - "PT5S", - "PT10S", - "PT1M", - "PT5M", - "PT1H" - ], - "x-ms-enum": { - "name": "interval", - "modelAsString": true, - "values": [ - { - "value": "PT5S", - "description": "5 seconds, available only if test run duration is less than 10 minutes" - }, - { - "value": "PT10S", - "description": "10 seconds, available only if test run duration is less than 10 minutes" - }, - { - "value": "PT1M", - "description": "1 minute" - }, - { - "value": "PT5M", - "description": "5 minutes, available only if test run duration is greater than 1 minute" - }, - { - "value": "PT1H", - "description": "1 hour, available only if test run duration is greater than 1 minute" - } - ] - } - }, - { - "in": "query", - "name": "metricname", - "description": "Metric name", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "metricNamespace", - "description": "Metric namespace to query metric definitions for.", - "required": true, - "type": "string" + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" }, { - "in": "query", - "name": "timespan", - "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", + "name": "body", + "in": "body", + "description": "App Component model.", "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersion" + "schema": { + "$ref": "#/definitions/TestAppComponentsUpdate" + } } ], "responses": { "200": { - "description": "The requested dimension values for the given dimension.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/DimensionValueList" + "$ref": "#/definitions/TestAppComponents" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestAppComponents" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Lists the metric dimension values for a load test run.": { - "$ref": "./examples/ListMetricDimensionValues.json" + "Add or update app components to a load test": { + "$ref": "./examples/CreateOrUpdateTestAppComponents.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/test-runs/{testRunId}/app-components": { - "patch": { + "/tests/{testId}/files": { + "get": { + "operationId": "LoadTestAdministration_ListTestFiles", "tags": [ - "TestRun" - ], - "summary": "Associate an app component (collection of azure resources) to a test run", - "operationId": "LoadTestRun_CreateOrUpdateAppComponents", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" + "Test" ], + "summary": "Get all test files.", + "description": "Get all test files.", "parameters": [ { - "$ref": "#/parameters/TestRunIdPathParameter" - }, - { - "$ref": "#/parameters/ApiVersion" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "in": "body", - "name": "body", - "description": "App Component model.", + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", "required": true, - "schema": { - "$ref": "#/definitions/TestRunAppComponents" - } + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" } ], "responses": { "200": { - "description": "The app component is updated.", - "schema": { - "$ref": "#/definitions/TestRunAppComponents" - } - }, - "201": { - "description": "The app component is created.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TestRunAppComponents" + "$ref": "#/definitions/PagedTestFileInfo" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Create or update app components for a test run": { - "$ref": "./examples/CreateOrUpdateTestRunAppComponents.json" + "Get all test files.": { + "$ref": "./examples/ListTestFiles.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, + } + }, + "/tests/{testId}/files/{fileName}": { "get": { + "operationId": "LoadTestAdministration_GetTestFile", "tags": [ - "TestRun" - ], - "summary": "Get associated app component (collection of azure resources) for the given test run.", - "operationId": "LoadTestRun_GetAppComponents", - "produces": [ - "application/json" + "Test" ], + "summary": "Get all the files that are associated with a test.", + "description": "Get all the files that are associated with a test.", "parameters": [ { - "$ref": "#/parameters/TestRunIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" }, { - "$ref": "#/parameters/ApiVersion" + "name": "fileName", + "in": "path", + "description": "Name of the file.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The requested app component.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TestRunAppComponents" + "$ref": "#/definitions/TestFileInfo" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "List app components for a test run": { - "$ref": "./examples/ListTestRunAppComponents.json" + "Get a file from a load test": { + "$ref": "./examples/GetTestFile.json" } } - } - }, - "/test-runs/{testRunId}/server-metrics-config": { - "patch": { + }, + "put": { + "operationId": "LoadTestAdministration_UploadTestFile", "tags": [ - "TestRun" + "Test" ], - "summary": "Configure server metrics for a test run", - "operationId": "LoadTestRun_CreateOrUpdateServerMetricsConfig", + "summary": "Upload input file for a given test Id. File size can't be more than 50 MB.\nExisting file with same name for the given test will be overwritten. File\nshould be provided in the request body as application/octet-stream.", + "description": "Upload input file for a given test Id. File size can't be more than 50 MB.\nExisting file with same name for the given test will be overwritten. File\nshould be provided in the request body as application/octet-stream.", "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" + "application/octet-stream" ], "parameters": [ { - "$ref": "#/parameters/TestRunIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ApiVersion" + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "fileName", + "in": "path", + "description": "Unique name for test file with file extension like : App.jmx", + "required": true, + "type": "string" + }, + { + "name": "fileType", + "in": "query", + "description": "File type", + "required": false, + "type": "string", + "enum": [ + "JMX_FILE", + "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS" + ], + "x-ms-enum": { + "name": "FileType", + "modelAsString": true, + "values": [ + { + "name": "JMX_FILE", + "value": "JMX_FILE", + "description": "If the file is a JMX script." + }, + { + "name": "USER_PROPERTIES", + "value": "USER_PROPERTIES", + "description": "If the file is a user properties file." + }, + { + "name": "ADDITIONAL_ARTIFACTS", + "value": "ADDITIONAL_ARTIFACTS", + "description": "If the file is not among any of the other supported file types." + } + ] + } }, { - "in": "body", "name": "body", - "description": "Server metric configuration model.", + "in": "body", + "description": "The file content as application/octet-stream.", "required": true, "schema": { - "$ref": "#/definitions/TestRunServerMetricConfig" + "type": "string", + "format": "binary" } } ], "responses": { - "200": { - "description": "The server metrics config is updated.", + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", "schema": { - "$ref": "#/definitions/TestRunServerMetricConfig" + "$ref": "#/definitions/TestFileInfo" } }, - "201": { - "description": "The server metrics config is created.", + "default": { + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/TestRunServerMetricConfig" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } } + } + }, + "x-ms-examples": { + "Upload input file for a given test name.": { + "$ref": "./examples/UploadTestFile.json" + } + } + }, + "delete": { + "operationId": "LoadTestAdministration_DeleteTestFile", + "tags": [ + "Test" + ], + "summary": "Delete file by the file name for a test", + "description": "Delete file by the file name for a test", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "fileName", + "in": "path", + "description": "Name of the file.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "Configure server metrics config for a test run": { - "$ref": "./examples/CreateOrUpdateTestRunServerMetricsConfig.json" + "Delete a file from a load test": { + "$ref": "./examples/DeleteTestFile.json" } } - }, + } + }, + "/tests/{testId}/server-metrics-config": { "get": { + "operationId": "LoadTestAdministration_GetServerMetricsConfig", "tags": [ - "TestRun" + "Test" ], - "summary": "List server metrics configuration for the given test run.", - "operationId": "LoadTestRun_GetServerMetricsConfig", - "produces": [ - "application/json" + "summary": "List server metrics configuration for the given test.", + "description": "List server metrics configuration for the given test.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestServerMetricConfig" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List server metrics configuration for the given test.": { + "$ref": "./examples/ListTestServerMetricsConfig.json" + } + } + }, + "patch": { + "operationId": "LoadTestAdministration_CreateOrUpdateServerMetricsConfig", + "tags": [ + "Test" + ], + "summary": "Configure server metrics for a test", + "description": "Configure server metrics for a test", + "consumes": [ + "application/merge-patch+json" ], "parameters": [ { - "$ref": "#/parameters/TestRunIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" }, { - "$ref": "#/parameters/ApiVersion" + "name": "body", + "in": "body", + "description": "Server metric configuration model.", + "required": true, + "schema": { + "$ref": "#/definitions/TestServerMetricConfigUpdate" + } } ], "responses": { "200": { - "description": "Requested server metrics configuration", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TestRunServerMetricConfig" + "$ref": "#/definitions/TestServerMetricConfig" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestServerMetricConfig" } }, "default": { - "description": "Load Testing service error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { - "description": "The error code for specific error that occurred.", - "type": "string" + "type": "string", + "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { - "List server metrics configuration for a test run": { - "$ref": "./examples/ListTestRunServerMetricsConfig.json" + "Add or update server metrics configuration for a load test.": { + "$ref": "./examples/CreateOrUpdateTestServerMetricsConfig.json" } } } } }, "definitions": { + "AggregationType": { + "type": "string", + "description": "Aggregation type.", + "enum": [ + "Average", + "Count", + "None", + "Total", + "Percentile90", + "Percentile95", + "Percentile99" + ], + "x-ms-enum": { + "name": "AggregationType", + "modelAsString": true, + "values": [ + { + "name": "Average", + "value": "Average", + "description": "Average value." + }, + { + "name": "Count", + "value": "Count", + "description": "Total count." + }, + { + "name": "None", + "value": "None", + "description": "Aggregation will be average in this case." + }, + { + "name": "Total", + "value": "Total", + "description": "Total sum." + }, + { + "name": "Percentile90", + "value": "Percentile90", + "description": "90th percentile." + }, + { + "name": "Percentile95", + "value": "Percentile95", + "description": "95th percentile." + }, + { + "name": "Percentile99", + "value": "Percentile99", + "description": "99th percentile." + } + ] + } + }, "AppComponent": { - "description": "An Azure resource object (Refer azure generic resource model : https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource)", "type": "object", + "description": "An Azure resource object (Refer azure generic resource model :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource)", "properties": { "resourceId": { - "description": "fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}", "type": "string", + "description": "fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}", "readOnly": true }, "resourceName": { - "description": "Azure resource name, required while creating the app component.", - "type": "string" + "type": "string", + "description": "Azure resource name, required while creating the app component." }, "resourceType": { - "description": "Azure resource type, required while creating the app component.", - "type": "string" + "type": "string", + "description": "Azure resource type, required while creating the app component." }, "displayName": { - "description": "Azure resource display name", - "type": "string" + "type": "string", + "description": "Azure resource display name" }, "resourceGroup": { - "description": "Resource group name of the Azure resource", "type": "string", + "description": "Resource group name of the Azure resource", "readOnly": true }, "subscriptionId": { - "description": "Subscription Id of the Azure resource", "type": "string", + "description": "Subscription Id of the Azure resource", "readOnly": true }, "kind": { - "description": "Kind of Azure resource type", - "type": "string" + "type": "string", + "description": "Kind of Azure resource type" } - } + }, + "required": [ + "resourceId", + "resourceName", + "resourceType" + ] }, - "CertificateMetadata": { - "description": "Certificates metadata", + "AppComponentUpdate": { "type": "object", + "description": "An Azure resource object (Refer azure generic resource model :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource)", "properties": { - "value": { - "description": "The value of the certificate for respective type", - "type": "string" + "resourceName": { + "type": "string", + "description": "Azure resource name, required while creating the app component." }, - "type": { - "description": "Type of certificate", - "enum": [ - "AKV_CERT_URI" - ], + "resourceType": { "type": "string", - "x-ms-enum": { - "name": "CertificateType", - "modelAsString": true, - "values": [ - { - "value": "AKV_CERT_URI", - "description": "If the certificate is stored in an Azure Key Vault" - } - ] - } + "description": "Azure resource type, required while creating the app component." }, - "name": { - "description": "Name of the certificate.", - "type": "string" + "displayName": { + "type": "string", + "description": "Azure resource display name" + }, + "kind": { + "type": "string", + "description": "Kind of Azure resource type" } } }, - "DimensionFilter": { - "description": "Dimension name and values to filter", + "Azure.Core.Foundations.Error": { "type": "object", + "description": "The error object.", "properties": { - "name": { - "description": "The dimension name", - "type": "string" + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." }, - "values": { - "description": "The dimension values. Maximum values can be 20.", + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { "type": "array", + "description": "An array of details about specific errors that led to this reported error.", "items": { - "type": "string" - } - } - } - }, - "DimensionValue": { - "description": "Represents a metric dimension value.", - "type": "object", - "properties": { - "name": { - "description": "The name of the dimension.", - "type": "string" + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] }, - "value": { - "description": "The value of the dimension.", - "type": "string" + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." } - } + }, + "required": [ + "code", + "message" + ] }, - "DimensionValueList": { - "description": "Metrics dimension values.", + "Azure.Core.Foundations.ErrorResponse": { "type": "object", + "description": "A response containing error details.", "properties": { - "value": { - "description": "The dimension values", - "type": "array", - "items": { - "type": "string" - } - }, - "nextLink": { - "description": "Link for the next set of values in case of paginated results, if applicable", - "type": "string" + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." } - } - }, - "Error": { - "description": "Error from a REST request.", + }, "required": [ - "code", - "message" - ], + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", "properties": { "code": { - "description": "The error code.", - "type": "string" - }, - "message": { - "description": "The error message.", - "type": "string" - }, - "target": { - "description": "The error target.", - "type": "string" + "type": "string", + "description": "One of a server-defined set of error codes." }, - "details": { - "description": "Additional details and inner errors.", - "type": "array", - "items": { - "$ref": "#/definitions/Error" - } + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." } } }, - "ErrorDetails": { - "description": "Error details if there is any failure in load test run", + "CertificateMetadata": { "type": "object", + "description": "Certificates metadata", "properties": { - "message": { - "description": "Error details in case test run was not successfully run.", + "value": { "type": "string", - "readOnly": true + "description": "The value of the certificate for respective type" + }, + "type": { + "$ref": "#/definitions/CertificateType", + "description": "Type of certificate" + }, + "name": { + "type": "string", + "description": "Name of the certificate." } } }, - "ErrorResponseBody": { - "description": "The definition of an error object.", - "required": [ - "error" + "CertificateType": { + "type": "string", + "description": "Types of certificates supported.", + "enum": [ + "AKV_CERT_URI" ], + "x-ms-enum": { + "name": "CertificateType", + "modelAsString": true, + "values": [ + { + "name": "AKV_CERT_URI", + "value": "AKV_CERT_URI", + "description": "If the certificate is stored in an Azure Key Vault." + } + ] + } + }, + "DimensionFilter": { "type": "object", + "description": "Dimension name and values to filter", "properties": { - "error": { - "$ref": "#/definitions/Error" + "name": { + "type": "string", + "description": "The dimension name" + }, + "values": { + "type": "array", + "description": "The dimension values. Maximum values can be 20.", + "items": { + "type": "string" + } } } }, - "FileInfo": { - "description": "File info", + "DimensionValue": { "type": "object", + "description": "Represents a metric dimension value.", "properties": { - "url": { - "description": "File URL.", - "type": "string" - }, - "fileName": { - "description": "Name of the file.", - "type": "string" - }, - "fileType": { - "description": "File type", - "enum": [ - "JMX_FILE", - "USER_PROPERTIES", - "ADDITIONAL_ARTIFACTS" - ], + "name": { "type": "string", - "x-ms-enum": { - "name": "FileType", - "modelAsString": true, - "values": [ - { - "value": "JMX_FILE", - "description": "If file is jmx script" - }, - { - "value": "USER_PROPERTIES", - "description": "If file is user properties" - }, - { - "value": "ADDITIONAL_ARTIFACTS", - "description": "If file is not any of other supported type" - } - ] - } + "description": "The name of the dimension." }, - "expireDateTime": { - "format": "date-time", - "description": "Expiry time of the file (ISO 8601 literal format)", - "type": "string" - }, - "validationStatus": { - "description": "Validation status of the file", - "enum": [ - "NOT_VALIDATED", - "VALIDATION_SUCCESS", - "VALIDATION_FAILURE", - "VALIDATION_INITIATED", - "VALIDATION_NOT_REQUIRED" - ], + "value": { "type": "string", - "x-ms-enum": { - "name": "FileStatus", - "modelAsString": true, - "values": [ - { - "value": "NOT_VALIDATED", - "description": "File is not validated." - }, - { - "value": "VALIDATION_SUCCESS", - "description": "File is validated." - }, - { - "value": "VALIDATION_FAILURE", - "description": "File validation is failed." - }, - { - "value": "VALIDATION_INITIATED", - "description": "File validation is in progress." - }, - { - "value": "VALIDATION_NOT_REQUIRED", - "description": "Validation is not required." - } - ] - } - }, - "validationFailureDetails": { - "description": "Validation failure error details", - "type": "string" + "description": "The value of the dimension." } } }, - "FileInfoList": { - "description": "Collection of files.", - "required": [ - "value" - ], + "DimensionValueList": { "type": "object", + "description": "Metrics dimension values.", "properties": { "value": { - "description": "List of file info.", "type": "array", + "description": "The dimension value", "items": { - "$ref": "#/definitions/FileInfo" + "type": "string" } }, "nextLink": { - "description": "Link for the next list of file URLs, if applicable", - "type": "string" + "type": "string", + "format": "uri", + "description": "Link for the next set of values in case of paginated results, if applicable." + } + } + }, + "ErrorDetails": { + "type": "object", + "description": "Error details if there is any failure in load test run", + "properties": { + "message": { + "type": "string", + "description": "Error details in case test run was not successfully run.", + "readOnly": true } } }, + "FileStatus": { + "type": "string", + "description": "File status.", + "enum": [ + "NOT_VALIDATED", + "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", + "VALIDATION_INITIATED", + "VALIDATION_NOT_REQUIRED" + ], + "x-ms-enum": { + "name": "FileStatus", + "modelAsString": true, + "values": [ + { + "name": "NOT_VALIDATED", + "value": "NOT_VALIDATED", + "description": "File is not validated." + }, + { + "name": "VALIDATION_SUCCESS", + "value": "VALIDATION_SUCCESS", + "description": "File is validated." + }, + { + "name": "VALIDATION_FAILURE", + "value": "VALIDATION_FAILURE", + "description": "File validation is failed." + }, + { + "name": "VALIDATION_INITIATED", + "value": "VALIDATION_INITIATED", + "description": "File validation is in progress." + }, + { + "name": "VALIDATION_NOT_REQUIRED", + "value": "VALIDATION_NOT_REQUIRED", + "description": "Validation is not required." + } + ] + } + }, + "FileType": { + "type": "string", + "description": "Types of file supported.", + "enum": [ + "JMX_FILE", + "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS" + ], + "x-ms-enum": { + "name": "FileType", + "modelAsString": true, + "values": [ + { + "name": "JMX_FILE", + "value": "JMX_FILE", + "description": "If the file is a JMX script." + }, + { + "name": "USER_PROPERTIES", + "value": "USER_PROPERTIES", + "description": "If the file is a user properties file." + }, + { + "name": "ADDITIONAL_ARTIFACTS", + "value": "ADDITIONAL_ARTIFACTS", + "description": "If the file is not among any of the other supported file types." + } + ] + } + }, "LoadTestConfiguration": { - "description": "The load test configuration.", "type": "object", + "description": "Configurations for the load test.", "properties": { "engineInstances": { + "type": "integer", "format": "int32", - "description": "The number of engine instances to execute load test. Supported values are in range of 1-45. Required for creating a new test.", - "type": "integer" + "description": "The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test." }, "splitAllCSVs": { - "description": "If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly.", - "default": false, - "type": "boolean" + "type": "boolean", + "description": "If false, Azure Load Testing copies and processes your input files unmodified\nacross all test engine instances. If true, Azure Load Testing splits the CSV\ninput data evenly across all engine instances. If you provide multiple CSV\nfiles, each file will be split evenly.", + "default": false }, "quickStartTest": { - "description": "If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload.", - "default": false, - "type": "boolean" + "type": "boolean", + "description": "If true, optionalLoadTestConfig is required and JMX script for the load test is\nnot required to upload.", + "default": false }, "optionalLoadTestConfig": { - "$ref": "#/definitions/OptionalLoadTestConfig" + "$ref": "#/definitions/OptionalLoadTestConfig", + "description": "Configuration for quick load test" } } }, "MetricAvailability": { - "description": "Metric availability specifies the time grain (aggregation interval or frequency)", "type": "object", + "description": "Metric availability specifies the time grain (aggregation interval or frequency)", "properties": { "timeGrain": { - "description": "The time grain specifies the aggregation interval for the metric. Expressed as a duration 'PT1M', 'PT1H', etc.", - "enum": [ - "PT5S", - "PT10S", - "PT1M", - "PT5M", - "PT1H" - ], - "type": "string", - "x-ms-enum": { - "name": "TimeGrain", - "modelAsString": true, - "values": [ - { - "value": "PT5S", - "description": "5 seconds, available only if test run duration is less than 10 minutes" - }, - { - "value": "PT10S", - "description": "10 seconds, available only if test run duration is less than 10 minutes" - }, - { - "value": "PT1M", - "description": "1 minute" - }, - { - "value": "PT5M", - "description": "5 minutes, available only if test run duration is greater than 1 minute" - }, - { - "value": "PT1H", - "description": "1 hour, available only if test run duration is greater than 1 minute" - } - ] - } + "$ref": "#/definitions/TimeGrain", + "description": "The time grain specifies the aggregation interval for the metric. Expressed as\na duration 'PT1M', 'PT1H', etc." } } }, "MetricDefinition": { - "description": "Metric definition", "type": "object", + "description": "Metric definition", "properties": { "dimensions": { - "description": "List of dimensions", "type": "array", + "description": "List of dimensions", "items": { "$ref": "#/definitions/NameAndDesc" - } + }, + "x-ms-identifiers": [] }, "description": { - "description": "The metric description", - "type": "string" + "type": "string", + "description": "The metric description" }, "name": { - "description": "The metric name", - "type": "string" + "type": "string", + "description": "The metric name" }, "namespace": { - "description": "The namespace the metric belongs to.", - "type": "string" + "type": "string", + "description": "The namespace the metric belongs to." }, "primaryAggregationType": { - "description": "The primary aggregation type value defining how to use the values for display.", - "enum": [ - "Average", - "Count", - "None", - "Total", - "Percentile90", - "Percentile95", - "Percentile99" - ], - "type": "string", - "x-ms-enum": { - "name": "AggregationType", - "modelAsString": true, - "values": [ - { - "value": "Average", - "description": "Average value" - }, - { - "value": "Count", - "description": "Total count" - }, - { - "value": "None", - "description": "Aggregation will be average in this case" - }, - { - "value": "Total", - "description": "Total sum" - }, - { - "value": "Percentile90", - "description": "90th percentile" - }, - { - "value": "Percentile95", - "description": "95th percentile" - }, - { - "value": "Percentile99", - "description": "99th percentile" - } - ] - } + "$ref": "#/definitions/AggregationType", + "description": "The primary aggregation type value defining how to use the values for display." }, "supportedAggregationTypes": { - "description": "The collection of what all aggregation types are supported.", "type": "array", + "description": "The collection of what all aggregation types are supported.", "items": { "type": "string" } }, "unit": { - "description": "The unit of the metric.", - "enum": [ - "NotSpecified", - "Percent", - "Count", - "Seconds", - "Milliseconds", - "Bytes", - "BytesPerSecond", - "CountPerSecond" - ], - "type": "string", - "x-ms-enum": { - "name": "MetricUnit", - "modelAsString": true, - "values": [ - { - "value": "NotSpecified", - "description": "No unit specified" - }, - { - "value": "Percent", - "description": "Percentage" - }, - { - "value": "Count", - "description": "Value count" - }, - { - "value": "Seconds", - "description": "Seconds" - }, - { - "value": "Milliseconds", - "description": "Milliseconds" - }, - { - "value": "Bytes", - "description": "Bytes" - }, - { - "value": "BytesPerSecond", - "description": "Bytes per second" - }, - { - "value": "CountPerSecond", - "description": "Count per second" - } - ] - } + "$ref": "#/definitions/MetricUnit", + "description": "The unit of the metric." }, "metricAvailabilities": { - "description": "Metric availability specifies the time grain (aggregation interval or frequency).", "type": "array", + "description": "Metric availability specifies the time grain (aggregation interval or\nfrequency).", "items": { "$ref": "#/definitions/MetricAvailability" - } + }, + "x-ms-identifiers": [] } } }, "MetricDefinitionCollection": { - "description": "Represents collection of metric definitions.", - "required": [ - "value" - ], "type": "object", + "description": "Represents collection of metric definitions.", "properties": { "value": { - "description": "the values for the metric definitions.", "type": "array", + "description": "the values for the metric definitions.", "items": { "$ref": "#/definitions/MetricDefinition" - } + }, + "x-ms-identifiers": [] } - } + }, + "required": [ + "value" + ] }, "MetricNamespace": { - "description": "Metric namespace class specifies the metadata for a metric namespace.", "type": "object", + "description": "Metric namespace class specifies the metadata for a metric namespace.", "properties": { "description": { - "description": "The namespace description.", - "type": "string" + "type": "string", + "description": "The namespace description." }, "name": { - "description": "The metric namespace name.", - "type": "string" + "type": "string", + "description": "The metric namespace name." } } }, "MetricNamespaceCollection": { - "description": "Represents collection of metric namespaces.", - "required": [ - "value" - ], "type": "object", + "description": "Represents collection of metric namespaces.", "properties": { "value": { - "description": "The values for the metric namespaces.", "type": "array", + "description": "The values for the metric namespaces.", "items": { "$ref": "#/definitions/MetricNamespace" - } + }, + "x-ms-identifiers": [] } - } + }, + "required": [ + "value" + ] }, "MetricRequestPayload": { - "description": "Filters to fetch the set of metric", "type": "object", + "description": "Filters to fetch the set of metric.", "properties": { "filters": { - "description": "Get metrics for specific dimension values. Example: Metric contains dimension like SamplerName, Error. To retrieve all the time series data where SamplerName is equals to HTTPRequest1 or HTTPRequest2, the DimensionFilter value will be {\"SamplerName\", [\"HTTPRequest1\", \"HTTPRequest2\"}", "type": "array", + "description": "Get metrics for specific dimension values. Example: Metric contains dimension\nlike SamplerName, Error. To retrieve all the time series data where SamplerName\nis equals to HTTPRequest1 or HTTPRequest2, the DimensionFilter value will be\n{\"SamplerName\", [\"HTTPRequest1\", \"HTTPRequest2\"}", "items": { "$ref": "#/definitions/DimensionFilter" - } + }, + "x-ms-identifiers": [] } } }, + "MetricUnit": { + "type": "string", + "description": "Metric unit.", + "enum": [ + "NotSpecified", + "Percent", + "Count", + "Seconds", + "Milliseconds", + "Bytes", + "BytesPerSecond", + "CountPerSecond" + ], + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": true, + "values": [ + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "No unit specified." + }, + { + "name": "Percent", + "value": "Percent", + "description": "Percentage." + }, + { + "name": "Count", + "value": "Count", + "description": "Value count." + }, + { + "name": "Seconds", + "value": "Seconds", + "description": "Seconds." + }, + { + "name": "Milliseconds", + "value": "Milliseconds", + "description": "Milliseconds" + }, + { + "name": "Bytes", + "value": "Bytes", + "description": "Bytes" + }, + { + "name": "BytesPerSecond", + "value": "BytesPerSecond", + "description": "Bytes per second" + }, + { + "name": "CountPerSecond", + "value": "CountPerSecond", + "description": "Count per second" + } + ] + } + }, "MetricValue": { - "description": "Represents a metric value.", "type": "object", + "description": "Represents a metric value.", "properties": { "timestamp": { - "description": "The timestamp for the metric value in ISO 8601 format.", - "type": "string" + "type": "string", + "format": "date-time", + "description": "The timestamp for the metric value in RFC 3339 format." }, "value": { + "type": "number", "format": "double", - "description": "The metric value.", - "type": "number" + "description": "The metric value." } } }, "Metrics": { - "description": "The response to a metrics query.", "type": "object", + "description": "The response to a metrics query.", "properties": { "value": { - "description": "Timeseries data for metric query.", "type": "array", + "description": "The TimeSeriesElement items on this page", "items": { "$ref": "#/definitions/TimeSeriesElement" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "Link for the next set of timeseries in case of paginated results, if applicable", - "type": "string" + "type": "string", + "format": "uri", + "description": "The link to the next page of items" } - } + }, + "required": [ + "value" + ] }, "NameAndDesc": { - "description": "The name and description", "type": "object", + "description": "The name and description", "properties": { "description": { - "description": "The description", - "type": "string" + "type": "string", + "description": "The description" }, "name": { - "description": "The name", - "type": "string" + "type": "string", + "description": "The name" } } }, "OptionalLoadTestConfig": { - "description": "Optional load test config", "type": "object", + "description": "Configuration for quick load test", "properties": { "endpointUrl": { - "description": "Test URL. Provide the complete HTTP URL. For example, http://contoso-app.azurewebsites.net/login", - "type": "string" + "type": "string", + "description": "Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login" }, "virtualUsers": { + "type": "integer", "format": "int32", - "description": "No of concurrent virtual users", - "type": "integer" + "description": "No of concurrent virtual users." }, "rampUpTime": { + "type": "integer", "format": "int32", - "description": "Ramp up time", - "type": "integer" + "description": "Ramp up time in seconds." }, "duration": { + "type": "integer", "format": "int32", - "description": "Test run duration", - "type": "integer" + "description": "Test run duration in seconds." } } }, - "PassFailCriteria": { - "description": "Pass fail criteria for a test.", + "PFAgFunc": { + "type": "string", + "description": "Aggregation functions for pass/fail criteria.", + "enum": [ + "count", + "percentage", + "avg", + "p50", + "p90", + "p95", + "p99", + "min", + "max" + ], + "x-ms-enum": { + "name": "PFAgFunc", + "modelAsString": true, + "values": [ + { + "name": "count", + "value": "count", + "description": "Criteria applies for count value." + }, + { + "name": "percentage", + "value": "percentage", + "description": "Criteria applies for given percentage value." + }, + { + "name": "avg", + "value": "avg", + "description": "Criteria applies for avg value." + }, + { + "name": "p50", + "value": "p50", + "description": "Criteria applies for 50th percentile value." + }, + { + "name": "p90", + "value": "p90", + "description": "Criteria applies for 90th percentile value." + }, + { + "name": "p95", + "value": "p95", + "description": "Criteria applies for 95th percentile value." + }, + { + "name": "p99", + "value": "p99", + "description": "Criteria applies for 99th percentile value." + }, + { + "name": "min", + "value": "min", + "description": "Criteria applies for minimum value." + }, + { + "name": "max", + "value": "max", + "description": "Criteria applies for maximum value." + } + ] + } + }, + "PFMetrics": { + "type": "string", + "description": "Metrics for pass/fail criteria.", + "enum": [ + "response_time_ms", + "latency", + "error", + "requests", + "requests_per_sec" + ], + "x-ms-enum": { + "name": "PFMetrics", + "modelAsString": true, + "values": [ + { + "name": "response_time_ms", + "value": "response_time_ms", + "description": "Pass fail criteria for response time metric in milliseconds." + }, + { + "name": "latency", + "value": "latency", + "description": "Pass fail criteria for latency metric in milliseconds." + }, + { + "name": "error", + "value": "error", + "description": "Pass fail criteria for error metric." + }, + { + "name": "requests", + "value": "requests", + "description": "Pass fail criteria for total requests." + }, + { + "name": "requests_per_sec", + "value": "requests_per_sec", + "description": "Pass fail criteria for request per second." + } + ] + } + }, + "PFResult": { + "type": "string", + "description": "Pass/fail criteria result.", + "enum": [ + "passed", + "undetermined", + "failed" + ], + "x-ms-enum": { + "name": "PFResult", + "modelAsString": true, + "values": [ + { + "name": "passed", + "value": "passed", + "description": "Given pass fail criteria metric has passed." + }, + { + "name": "undetermined", + "value": "undetermined", + "description": "Given pass fail criteria metric couldn't determine." + }, + { + "name": "failed", + "value": "failed", + "description": "Given pass fail criteria metric has failed." + } + ] + } + }, + "PFTestResult": { + "type": "string", + "description": "Test result based on pass/fail criteria.", + "enum": [ + "PASSED", + "NOT_APPLICABLE", + "FAILED" + ], + "x-ms-enum": { + "name": "PFTestResult", + "modelAsString": true, + "values": [ + { + "name": "PASSED", + "value": "PASSED", + "description": "Pass/fail criteria has passed." + }, + { + "name": "NOT_APPLICABLE", + "value": "NOT_APPLICABLE", + "description": "Pass/fail criteria is not applicable." + }, + { + "name": "FAILED", + "value": "FAILED", + "description": "Pass/fail criteria has failed." + } + ] + } + }, + "PagedTest": { "type": "object", + "description": "Paged collection of Test items", "properties": { - "passFailMetrics": { - "description": "Map of id and pass fail metrics { id : pass fail metrics }.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/PassFailMetric" - } + "value": { + "type": "array", + "description": "The Test items on this page", + "items": { + "$ref": "#/definitions/Test" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" } - } + }, + "required": [ + "value" + ] }, - "PassFailMetric": { - "description": "Pass fail metric", + "PagedTestFileInfo": { "type": "object", + "description": "Paged collection of TestFileInfo items", "properties": { - "clientMetric": { - "description": "The client metric on which the criteria should be applied.", - "enum": [ - "response_time_ms", - "latency", - "error", - "requests", - "requests_per_sec" - ], + "value": { + "type": "array", + "description": "The TestFileInfo items on this page", + "items": { + "$ref": "#/definitions/TestFileInfo" + }, + "x-ms-identifiers": [] + }, + "nextLink": { "type": "string", - "x-ms-enum": { - "name": "PFMetrics", - "modelAsString": true, - "values": [ - { - "value": "response_time_ms", - "description": "Pass fail criteria for response time metric" - }, - { - "value": "latency", - "description": "Pass fail criteria for response time metric" - }, - { - "value": "error", - "description": "Pass fail criteria for error metric" - }, - { - "value": "requests", - "description": "Pass fail criteria for total requests" - }, - { - "value": "requests_per_sec", - "description": "Pass fail criteria for request rate." - } - ] - } + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedTestRun": { + "type": "object", + "description": "Paged collection of TestRun items", + "properties": { + "value": { + "type": "array", + "description": "The TestRun items on this page", + "items": { + "$ref": "#/definitions/TestRun" + }, + "x-ms-identifiers": [] }, - "aggregate": { - "description": "The aggregation function to be applied on the client metric. Allowed functions - ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’, ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, ‘count’ - for requests", - "enum": [ - "count", - "percentage", - "avg", - "p50", - "p90", - "p95", - "p99", - "min", - "max" - ], + "nextLink": { "type": "string", - "x-ms-enum": { - "name": "PFAgFunc", - "modelAsString": true, - "values": [ - { - "value": "count", - "description": "Criteria applies for count value" - }, - { - "value": "percentage", - "description": "Criteria applies for given percentage value" - }, - { - "value": "avg", - "description": "Criteria applies for avg value" - }, - { - "value": "p50", - "description": "Criteria applies for 50th percentile value" - }, - { - "value": "p90", - "description": "Criteria applies for 90th percentile value" - }, - { - "value": "p95", - "description": "Criteria applies for 95th percentile value" - }, - { - "value": "p99", - "description": "Criteria applies for 99th percentile value" - }, - { - "value": "min", - "description": "Criteria applies for minimum value" - }, - { - "value": "max", - "description": "Criteria applies for maximum value" - } - ] + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PassFailCriteria": { + "type": "object", + "description": "Pass fail criteria for a test.", + "properties": { + "passFailMetrics": { + "type": "object", + "description": "Map of id and pass fail metrics { id : pass fail metrics }.", + "additionalProperties": { + "$ref": "#/definitions/PassFailMetric" } + } + } + }, + "PassFailMetric": { + "type": "object", + "description": "Pass fail metric", + "properties": { + "clientMetric": { + "$ref": "#/definitions/PFMetrics", + "description": "The client metric on which the criteria should be applied." + }, + "aggregate": { + "$ref": "#/definitions/PFAgFunc", + "description": "The aggregation function to be applied on the client metric. Allowed functions\n- ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’,\n‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec,\n‘count’ - for requests" }, "condition": { - "description": "The comparison operator. Supported types ‘>’, ‘<’ ", - "type": "string" + "type": "string", + "description": "The comparison operator. Supported types ‘>’, ‘<’ " }, "requestName": { - "description": "Request name for which the Pass fail criteria has to be applied ", - "type": "string" + "type": "string", + "description": "Request name for which the Pass fail criteria has to be applied " }, "value": { + "type": "number", "format": "double", - "description": "The value to compare with the client metric. Allowed values - ‘error : [0.0 , 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms.", - "type": "number" + "description": "The value to compare with the client metric. Allowed values - ‘error : [0.0 ,\n100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms." }, "action": { + "type": "string", "description": "Action taken after the threshold is met. Default is ‘continue’.", "default": "continue", "enum": [ "continue", "stop" ], - "type": "string", "x-ms-enum": { "name": "PFAction", "modelAsString": true, "values": [ { + "name": "continue", "value": "continue", - "description": "Test will continue to run even if pass fail metric criteria metric gets failed" + "description": "Test will continue to run even if pass fail metric criteria metric gets failed." }, { + "name": "stop", "value": "stop", "description": "Test run will stop if pass fail criteria metric is not passed." } @@ -2330,929 +2528,1321 @@ } }, "actualValue": { + "type": "number", "format": "double", "description": "The actual value of the client metric for the test run.", - "type": "number", "readOnly": true }, "result": { + "$ref": "#/definitions/PFResult", "description": "Outcome of the test run.", - "enum": [ - "passed", - "undetermined", - "failed" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "PFResult", - "modelAsString": true, - "values": [ - { - "value": "passed", - "description": "Given pass fail criteria metric has passed." - }, - { - "value": "undetermined", - "description": "Given pass fail criteria metric couldn't determine." - }, - { - "value": "failed", - "description": "Given pass fail criteria metric has failed." - } - ] - } + "readOnly": true } } }, "ResourceMetric": { - "description": "Associated metric definition for particular metrics of the azure resource ( Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).", - "required": [ - "aggregation", - "metricNamespace", - "name", - "resourceId", - "resourceType" - ], "type": "object", + "description": "Associated metric definition for particular metrics of the azure resource (\nRefer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).", "properties": { "id": { - "description": "Unique name for metric.", "type": "string", + "description": "Unique name for metric.", "readOnly": true }, "resourceId": { - "description": "Azure resource id.", - "type": "string" + "type": "string", + "description": "Azure resource id." + }, + "metricNamespace": { + "type": "string", + "description": "Metric name space." + }, + "displayDescription": { + "type": "string", + "description": "Metric description." + }, + "name": { + "type": "string", + "description": "The invariant value of metric name" + }, + "aggregation": { + "type": "string", + "description": "Metric aggregation." + }, + "unit": { + "type": "string", + "description": "Metric unit." + }, + "resourceType": { + "type": "string", + "description": "Azure resource type." + } + }, + "required": [ + "resourceId", + "metricNamespace", + "name", + "aggregation", + "resourceType" + ] + }, + "ResourceMetricUpdate": { + "type": "object", + "description": "Associated metric definition for particular metrics of the azure resource (\nRefer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).", + "properties": { + "resourceId": { + "type": "string", + "description": "Azure resource id." }, "metricNamespace": { - "description": "Metric name space.", - "type": "string" + "type": "string", + "description": "Metric name space." }, "displayDescription": { - "description": "Metric description.", - "type": "string" + "type": "string", + "description": "Metric description." }, "name": { - "description": "The invariant value of metric name", - "type": "string" + "type": "string", + "description": "The invariant value of metric name" }, "aggregation": { - "description": "Metric aggregation.", - "type": "string" + "type": "string", + "description": "Metric aggregation." }, "unit": { - "description": "Metric unit.", - "type": "string" + "type": "string", + "description": "Metric unit." }, "resourceType": { - "description": "Azure resource type.", - "type": "string" + "type": "string", + "description": "Azure resource type." } } }, "Secret": { - "description": "Secret", "type": "object", + "description": "Secret", "properties": { "value": { - "description": "The value of the secret for the respective type", - "type": "string" + "type": "string", + "description": "The value of the secret for the respective type" }, "type": { - "description": "Type of secret", - "enum": [ - "AKV_SECRET_URI", - "SECRET_VALUE" - ], - "type": "string", - "x-ms-enum": { - "name": "SecretType", - "modelAsString": true, - "values": [ - { - "value": "AKV_SECRET_URI", - "description": "If the secret is stored in an Azure Key Vault" - }, - { - "value": "SECRET_VALUE", - "description": "If the Plain text secret value provided" - } - ] - } + "$ref": "#/definitions/SecretType", + "description": "Type of secret" } } }, + "SecretType": { + "type": "string", + "description": "Types of secrets supported.", + "enum": [ + "AKV_SECRET_URI", + "SECRET_VALUE" + ], + "x-ms-enum": { + "name": "SecretType", + "modelAsString": true, + "values": [ + { + "name": "AKV_SECRET_URI", + "value": "AKV_SECRET_URI", + "description": "If the secret is stored in an Azure Key Vault." + }, + { + "name": "SECRET_VALUE", + "value": "SECRET_VALUE", + "description": "If the secret value provided as plain text." + } + ] + } + }, + "Status": { + "type": "string", + "description": "Test run status.", + "enum": [ + "ACCEPTED", + "NOTSTARTED", + "PROVISIONING", + "PROVISIONED", + "CONFIGURING", + "CONFIGURED", + "EXECUTING", + "EXECUTED", + "DEPROVISIONING", + "DEPROVISIONED", + "DONE", + "CANCELLING", + "CANCELLED", + "FAILED", + "VALIDATION_SUCCESS", + "VALIDATION_FAILURE" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "ACCEPTED", + "value": "ACCEPTED", + "description": "Test run request is accepted." + }, + { + "name": "NOTSTARTED", + "value": "NOTSTARTED", + "description": "Test run is not yet started." + }, + { + "name": "PROVISIONING", + "value": "PROVISIONING", + "description": "Test run is provisioning." + }, + { + "name": "PROVISIONED", + "value": "PROVISIONED", + "description": "Test run is provisioned." + }, + { + "name": "CONFIGURING", + "value": "CONFIGURING", + "description": "Test run is getting configured." + }, + { + "name": "CONFIGURED", + "value": "CONFIGURED", + "description": "Test run configuration is done." + }, + { + "name": "EXECUTING", + "value": "EXECUTING", + "description": "Test run has started executing." + }, + { + "name": "EXECUTED", + "value": "EXECUTED", + "description": "Test run execution is completed." + }, + { + "name": "DEPROVISIONING", + "value": "DEPROVISIONING", + "description": "Test run is getting deprovisioned." + }, + { + "name": "DEPROVISIONED", + "value": "DEPROVISIONED", + "description": "Test run is deprovisioned." + }, + { + "name": "DONE", + "value": "DONE", + "description": "Test run is completed." + }, + { + "name": "CANCELLING", + "value": "CANCELLING", + "description": "Test run is being cancelled." + }, + { + "name": "CANCELLED", + "value": "CANCELLED", + "description": "Test run request is cancelled." + }, + { + "name": "FAILED", + "value": "FAILED", + "description": "Test run request is failed." + }, + { + "name": "VALIDATION_SUCCESS", + "value": "VALIDATION_SUCCESS", + "description": "Test run JMX file is validated." + }, + { + "name": "VALIDATION_FAILURE", + "value": "VALIDATION_FAILURE", + "description": "Test run JMX file validation is failed." + } + ] + } + }, "Test": { - "description": "Load test model", "type": "object", + "description": "Load test model.", "properties": { "passFailCriteria": { - "$ref": "#/definitions/PassFailCriteria" + "$ref": "#/definitions/PassFailCriteria", + "description": "Pass fail criteria for a test." }, "secrets": { - "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE.", "type": "object", + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the\nsecret is stored in an Azure Key Vault, the value should be the secret\nidentifier and the type should be AKV_SECRET_URI. If the secret is stored\nelsewhere, the secret value should be provided directly and the type should be\nSECRET_VALUE.", "additionalProperties": { "$ref": "#/definitions/Secret" } }, "certificate": { - "$ref": "#/definitions/CertificateMetadata" + "$ref": "#/definitions/CertificateMetadata", + "description": "Certificates metadata." }, "environmentVariables": { - "description": "Environment variables which are defined as a set of pairs.", "type": "object", + "description": "Environment variables which are defined as a set of pairs.", "additionalProperties": { "type": "string" } }, "loadTestConfiguration": { - "$ref": "#/definitions/LoadTestConfiguration" + "$ref": "#/definitions/LoadTestConfiguration", + "description": "The load test configuration." }, "inputArtifacts": { - "$ref": "#/definitions/TestInputArtifacts" + "$ref": "#/definitions/TestInputArtifacts", + "description": "The input artifacts for the test.", + "readOnly": true }, "testId": { - "description": "Unique test name as identifier.", - "maxLength": 50, - "minLength": 2, "type": "string", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$", "readOnly": true }, "description": { + "type": "string", "description": "The test description.", - "maxLength": 100, - "type": "string" + "maxLength": 100 }, "displayName": { + "type": "string", "description": "Display name of a test.", - "maxLength": 50, "minLength": 2, - "type": "string" + "maxLength": 50 }, "subnetId": { - "description": "Subnet ID on which the load test instances should run.", - "type": "string" + "type": "string", + "description": "Subnet ID on which the load test instances should run." }, "keyvaultReferenceIdentityType": { - "description": "Type of the managed identity referencing the Key vault.", - "type": "string" + "type": "string", + "description": "Type of the managed identity referencing the Key vault." }, "keyvaultReferenceIdentityId": { - "description": "Resource Id of the managed identity referencing the Key vault.", - "type": "string" + "type": "string", + "description": "Resource Id of the managed identity referencing the Key vault." }, "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", "format": "date-time", - "description": "The creation datetime(ISO 8601 literal format).", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "testId" + ] + }, + "TestAppComponents": { + "type": "object", + "description": "Test app components", + "properties": { + "components": { + "type": "object", + "description": "Azure resource collection { resource id (fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})\n: resource object } ", + "additionalProperties": { + "$ref": "#/definitions/AppComponent" + } + }, + "testId": { "type": "string", + "description": "Test identifier", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", "readOnly": true }, "createdBy": { + "type": "string", "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "components" + ] + }, + "TestAppComponentsUpdate": { + "type": "object", + "description": "Test app components", + "properties": { + "components": { + "type": "object", + "description": "Azure resource collection { resource id (fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})\n: resource object } ", + "additionalProperties": { + "$ref": "#/definitions/AppComponentUpdate" + } + } + } + }, + "TestCreateOrUpdate": { + "type": "object", + "description": "Load test model.", + "properties": { + "passFailCriteria": { + "$ref": "#/definitions/PassFailCriteria", + "description": "Pass fail criteria for a test." + }, + "secrets": { + "type": "object", + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the\nsecret is stored in an Azure Key Vault, the value should be the secret\nidentifier and the type should be AKV_SECRET_URI. If the secret is stored\nelsewhere, the secret value should be provided directly and the type should be\nSECRET_VALUE.", + "additionalProperties": { + "$ref": "#/definitions/Secret" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateMetadata", + "description": "Certificates metadata." + }, + "environmentVariables": { + "type": "object", + "description": "Environment variables which are defined as a set of pairs.", + "additionalProperties": { + "type": "string" + } + }, + "loadTestConfiguration": { + "$ref": "#/definitions/LoadTestConfiguration", + "description": "The load test configuration." + }, + "description": { + "type": "string", + "description": "The test description.", + "maxLength": 100 + }, + "displayName": { + "type": "string", + "description": "Display name of a test.", + "minLength": 2, + "maxLength": 50 + }, + "subnetId": { "type": "string", - "readOnly": true + "description": "Subnet ID on which the load test instances should run." }, - "lastModifiedDateTime": { - "format": "date-time", - "description": "The last Modified datetime(ISO 8601 literal format).", + "keyvaultReferenceIdentityType": { "type": "string", - "readOnly": true + "description": "Type of the managed identity referencing the Key vault." }, - "lastModifiedBy": { - "description": "The user that last modified.", + "keyvaultReferenceIdentityId": { "type": "string", - "readOnly": true + "description": "Resource Id of the managed identity referencing the Key vault." } } }, - "TestAppComponents": { - "description": "Test app component", - "required": [ - "components" - ], + "TestFileInfo": { "type": "object", + "description": "Test file info.", "properties": { - "components": { - "description": "Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AppComponent" - } + "fileName": { + "type": "string", + "description": "Name of the file." }, - "testId": { - "description": "Test identifier", + "url": { "type": "string", + "format": "uri", + "description": "File URL.", "readOnly": true }, - "createdDateTime": { - "format": "date-time", - "description": "The creation datetime(ISO 8601 literal format).", - "type": "string", + "fileType": { + "$ref": "#/definitions/FileType", + "description": "File type", "readOnly": true }, - "createdBy": { - "description": "The user that created.", + "expireDateTime": { "type": "string", + "format": "date-time", + "description": "Expiry time of the file (RFC 3339 literal format)", "readOnly": true }, - "lastModifiedDateTime": { - "format": "date-time", - "description": "The last Modified datetime(ISO 8601 literal format).", - "type": "string", + "validationStatus": { + "$ref": "#/definitions/FileStatus", + "description": "Validation status of the file", "readOnly": true }, - "lastModifiedBy": { - "description": "The user that last modified.", + "validationFailureDetails": { "type": "string", + "description": "Validation failure error details", "readOnly": true } - } + }, + "required": [ + "fileName" + ] }, "TestInputArtifacts": { - "description": "The input artifacts for the test.", "type": "object", + "description": "The input artifacts for the test.", "properties": { "configFileInfo": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestFileInfo", + "description": "File info" }, "testScriptFileInfo": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestFileInfo", + "description": "File info" }, "userPropFileInfo": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestFileInfo", + "description": "File info" }, "inputArtifactsZipFileInfo": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestFileInfo", + "description": "File info" }, "additionalFileInfo": { - "description": "Additional supported files for the test run", "type": "array", + "description": "Additional supported files for the test run", "items": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestFileInfo" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] } - }, - "readOnly": true + } }, "TestRun": { - "description": "Load test run model", "type": "object", + "description": "Load test run model", "properties": { + "testRunId": { + "type": "string", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$", + "readOnly": true + }, "passFailCriteria": { - "$ref": "#/definitions/PassFailCriteria" + "$ref": "#/definitions/PassFailCriteria", + "description": "Pass fail criteria for a test." }, "secrets": { - "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE.", "type": "object", + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the\nsecret is stored in an Azure Key Vault, the value should be the secret\nidentifier and the type should be AKV_SECRET_URI. If the secret is stored\nelsewhere, the secret value should be provided directly and the type should be\nSECRET_VALUE.", "additionalProperties": { "$ref": "#/definitions/Secret" } }, "certificate": { - "$ref": "#/definitions/CertificateMetadata" + "$ref": "#/definitions/CertificateMetadata", + "description": "Certificates metadata" }, "environmentVariables": { - "description": "Environment variables which are defined as a set of pairs.", "type": "object", + "description": "Environment variables which are defined as a set of pairs.", "additionalProperties": { "type": "string" } }, "errorDetails": { - "description": "Error details if there is any failure in load test run", "type": "array", + "description": "Error details if there is any failure in load test run", "items": { "$ref": "#/definitions/ErrorDetails" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "testRunStatistics": { - "description": "Test run statistics.", "type": "object", + "description": "Test run statistics. Key is the sampler name and value is the set of statistics for performance metrics like response time, throughput, etc. from the load test run.\nThe sampler name is the same as the name mentioned in the test script.\nSampler name \"Total\" represents the aggregated statistics of all the samplers.", "additionalProperties": { "$ref": "#/definitions/TestRunStatistics" }, "readOnly": true }, "loadTestConfiguration": { - "$ref": "#/definitions/LoadTestConfiguration" + "$ref": "#/definitions/LoadTestConfiguration", + "description": "The load test configuration." }, "testArtifacts": { - "$ref": "#/definitions/TestRunArtifacts" + "$ref": "#/definitions/TestRunArtifacts", + "description": "Collection of test run artifacts", + "readOnly": true }, "testResult": { + "$ref": "#/definitions/PFTestResult", "description": "Test result for pass/Fail criteria used during the test run.", - "enum": [ - "PASSED", - "NOT_APPLICABLE", - "FAILED" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "PFTestResult", - "modelAsString": true, - "values": [ - { - "value": "PASSED", - "description": "Pass/fail criteria has passed." - }, - { - "value": "NOT_APPLICABLE", - "description": "Pass/fail criteria is not applicable." - }, - { - "value": "FAILED", - "description": "Pass/fail criteria has failed." - } - ] - } + "readOnly": true }, "virtualUsers": { + "type": "integer", "format": "int32", "description": "Number of virtual users, for which test has been run.", - "type": "integer", - "readOnly": true - }, - "testRunId": { - "description": "Unique test run name as identifier", - "type": "string", "readOnly": true }, "displayName": { + "type": "string", "description": "Display name of a testRun.", - "maxLength": 50, "minLength": 2, - "type": "string" + "maxLength": 50 }, "testId": { + "type": "string", "description": "Associated test Id.", - "maxLength": 50, "minLength": 2, - "type": "string" + "maxLength": 50 }, "description": { + "type": "string", "description": "The test run description.", - "maxLength": 100, - "type": "string" + "maxLength": 100 }, "status": { + "$ref": "#/definitions/Status", "description": "The test run status.", - "enum": [ - "ACCEPTED", - "NOTSTARTED", - "PROVISIONING", - "PROVISIONED", - "CONFIGURING", - "CONFIGURED", - "EXECUTING", - "EXECUTED", - "DEPROVISIONING", - "DEPROVISIONED", - "DONE", - "CANCELLING", - "CANCELLED", - "FAILED", - "VALIDATION_SUCCESS", - "VALIDATION_FAILURE" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "Status", - "modelAsString": true, - "values": [ - { - "value": "ACCEPTED", - "description": "Test run request is accepted" - }, - { - "value": "NOTSTARTED", - "description": "Test run is not yet started." - }, - { - "value": "PROVISIONING", - "description": "Test run is getting provision" - }, - { - "value": "PROVISIONED", - "description": "Test run is provisioned" - }, - { - "value": "CONFIGURING", - "description": "Test run is getting configure" - }, - { - "value": "CONFIGURED", - "description": "Test run configuration is done" - }, - { - "value": "EXECUTING", - "description": "Test run has started executing" - }, - { - "value": "EXECUTED", - "description": "Test run has been executed" - }, - { - "value": "DEPROVISIONING", - "description": "Test run is getting deprovision" - }, - { - "value": "DEPROVISIONED", - "description": "Test run request is deprovisioned" - }, - { - "value": "DONE", - "description": "Test run request is finished" - }, - { - "value": "CANCELLING", - "description": "Test run request is getting cancelled" - }, - { - "value": "CANCELLED", - "description": "Test run request is cancelled" - }, - { - "value": "FAILED", - "description": "Test run request is failed" - }, - { - "value": "VALIDATION_SUCCESS", - "description": "Test run JMX file is validated" - }, - { - "value": "VALIDATION_FAILURE", - "description": "Test run JMX file validation is failed" - } - ] - } + "readOnly": true }, "startDateTime": { - "format": "date-time", - "description": "The test run start DateTime(ISO 8601 literal format).", "type": "string", + "format": "date-time", + "description": "The test run start DateTime(RFC 3339 literal format).", "readOnly": true }, "endDateTime": { - "format": "date-time", - "description": "The test run end DateTime(ISO 8601 literal format).", "type": "string", + "format": "date-time", + "description": "The test run end DateTime(RFC 3339 literal format).", "readOnly": true }, "executedDateTime": { + "type": "string", "format": "date-time", "description": "Test run initiated time.", - "type": "string", "readOnly": true }, "portalUrl": { - "description": "Portal url.", "type": "string", + "description": "Portal url.", "readOnly": true }, "duration": { + "type": "integer", "format": "int64", "description": "Test run duration in milliseconds.", - "type": "integer", "readOnly": true }, "subnetId": { - "description": "Subnet ID on which the load test instances should run.", "type": "string", + "description": "Subnet ID on which the load test instances should run.", "readOnly": true }, "createdDateTime": { - "format": "date-time", - "description": "The creation datetime(ISO 8601 literal format).", "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", "readOnly": true }, "createdBy": { - "description": "The user that created.", "type": "string", + "description": "The user that created.", "readOnly": true }, "lastModifiedDateTime": { - "format": "date-time", - "description": "The last Modified datetime(ISO 8601 literal format).", "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", "readOnly": true }, "lastModifiedBy": { - "description": "The user that last modified.", "type": "string", + "description": "The user that last modified.", "readOnly": true } - } + }, + "required": [ + "testRunId" + ] }, "TestRunAppComponents": { + "type": "object", "description": "Test run app component", + "properties": { + "components": { + "type": "object", + "description": "Azure resource collection { resource id (fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})\n: resource object } ", + "additionalProperties": { + "$ref": "#/definitions/AppComponent" + } + }, + "testRunId": { + "type": "string", + "description": "Test run identifier", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, "required": [ "components" - ], + ] + }, + "TestRunAppComponentsUpdate": { + "type": "object", + "description": "Test run app component", + "properties": { + "components": { + "type": "object", + "description": "Azure resource collection { resource id (fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})\n: resource object } ", + "additionalProperties": { + "$ref": "#/definitions/AppComponentUpdate" + } + } + } + }, + "TestRunArtifacts": { + "type": "object", + "description": "Collection of test run artifacts", + "properties": { + "inputArtifacts": { + "$ref": "#/definitions/TestRunInputArtifacts", + "description": "The input artifacts for the test run.", + "readOnly": true + }, + "outputArtifacts": { + "$ref": "#/definitions/TestRunOutputArtifacts", + "description": "The output artifacts for the test run." + } + } + }, + "TestRunCreateOrUpdate": { + "type": "object", + "description": "Load test run model", + "properties": { + "passFailCriteria": { + "$ref": "#/definitions/PassFailCriteria", + "description": "Pass fail criteria for a test." + }, + "secrets": { + "type": "object", + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the\nsecret is stored in an Azure Key Vault, the value should be the secret\nidentifier and the type should be AKV_SECRET_URI. If the secret is stored\nelsewhere, the secret value should be provided directly and the type should be\nSECRET_VALUE.", + "additionalProperties": { + "$ref": "#/definitions/Secret" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateMetadata", + "description": "Certificates metadata" + }, + "environmentVariables": { + "type": "object", + "description": "Environment variables which are defined as a set of pairs.", + "additionalProperties": { + "type": "string" + } + }, + "loadTestConfiguration": { + "$ref": "#/definitions/LoadTestConfiguration", + "description": "The load test configuration." + }, + "displayName": { + "type": "string", + "description": "Display name of a testRun.", + "minLength": 2, + "maxLength": 50 + }, + "testId": { + "type": "string", + "description": "Associated test Id.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The test run description.", + "maxLength": 100 + } + } + }, + "TestRunFileInfo": { "type": "object", + "description": "Test run file info.", "properties": { - "components": { - "description": "Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AppComponent" - } + "fileName": { + "type": "string", + "description": "Name of the file." }, - "testRunId": { - "description": "Test run identifier", + "url": { "type": "string", + "format": "uri", + "description": "File URL.", "readOnly": true }, - "createdDateTime": { - "format": "date-time", - "description": "The creation datetime(ISO 8601 literal format).", - "type": "string", + "fileType": { + "$ref": "#/definitions/FileType", + "description": "File type", "readOnly": true }, - "createdBy": { - "description": "The user that created.", + "expireDateTime": { "type": "string", + "format": "date-time", + "description": "Expiry time of the file (RFC 3339 literal format)", "readOnly": true }, - "lastModifiedDateTime": { - "format": "date-time", - "description": "The last Modified datetime(ISO 8601 literal format).", - "type": "string", + "validationStatus": { + "$ref": "#/definitions/FileStatus", + "description": "Validation status of the file", "readOnly": true }, - "lastModifiedBy": { - "description": "The user that last modified.", + "validationFailureDetails": { "type": "string", + "description": "Validation failure error details", "readOnly": true } - } - }, - "TestRunArtifacts": { - "description": "Collection of test run artifacts", - "type": "object", - "properties": { - "inputArtifacts": { - "$ref": "#/definitions/TestRunInputArtifacts" - }, - "outputArtifacts": { - "$ref": "#/definitions/TestRunOutputArtifacts" - } }, - "readOnly": true + "required": [ + "fileName" + ] }, "TestRunInputArtifacts": { - "description": "The input artifacts for the test run.", "type": "object", + "description": "The input artifacts for the test run.", "properties": { "configFileInfo": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" }, "testScriptFileInfo": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" }, "userPropFileInfo": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" }, "inputArtifactsZipFileInfo": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" }, "additionalFileInfo": { - "description": "Additional supported files for the test run", "type": "array", + "description": "Additional supported files for the test run", "items": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestRunFileInfo" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] } - }, - "readOnly": true + } }, "TestRunOutputArtifacts": { - "description": "The output artifacts for the test run.", "type": "object", + "description": "The output artifacts for the test run.", "properties": { "resultFileInfo": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" }, "logsFileInfo": { - "$ref": "#/definitions/FileInfo" + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" } } }, "TestRunServerMetricConfig": { - "description": "Test run server metrics configuration", "type": "object", + "description": "Test run server metrics configuration", "properties": { "testRunId": { - "description": "Test run identifier", "type": "string", + "description": "Test run identifier", "readOnly": true }, "metrics": { - "description": "Azure resource metrics collection {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id).", "type": "object", + "description": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).", "additionalProperties": { "$ref": "#/definitions/ResourceMetric" } }, "createdDateTime": { - "format": "date-time", - "description": "The creation datetime(ISO 8601 literal format).", "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", "readOnly": true }, "createdBy": { - "description": "The user that created.", "type": "string", + "description": "The user that created.", "readOnly": true }, "lastModifiedDateTime": { - "format": "date-time", - "description": "The last Modified datetime(ISO 8601 literal format).", "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", "readOnly": true }, "lastModifiedBy": { - "description": "The user that last modified.", "type": "string", + "description": "The user that last modified.", "readOnly": true } } }, "TestRunStatistics": { - "description": "Test run statistics.", "type": "object", + "description": "Test run statistics.", "properties": { "transaction": { - "description": "Transaction name.", "type": "string", + "description": "Transaction name.", "readOnly": true }, "sampleCount": { + "type": "number", "format": "double", "description": "Sampler count.", - "type": "number", "readOnly": true }, "errorCount": { + "type": "number", "format": "double", "description": "Error count.", - "type": "number", "readOnly": true }, "errorPct": { + "type": "number", "format": "double", "description": "Error percentage.", - "type": "number", "readOnly": true }, "meanResTime": { + "type": "number", "format": "double", "description": "Mean response time.", - "type": "number", "readOnly": true }, "medianResTime": { + "type": "number", "format": "double", "description": "Median response time.", - "type": "number", "readOnly": true }, "maxResTime": { + "type": "number", "format": "double", "description": "Max response time.", - "type": "number", "readOnly": true }, "minResTime": { + "type": "number", "format": "double", "description": "Minimum response time.", - "type": "number", "readOnly": true }, "pct1ResTime": { + "type": "number", "format": "double", "description": "90 percentile response time.", - "type": "number", "readOnly": true }, "pct2ResTime": { + "type": "number", "format": "double", "description": "95 percentile response time.", - "type": "number", "readOnly": true }, "pct3ResTime": { + "type": "number", "format": "double", "description": "99 percentile response time.", - "type": "number", "readOnly": true }, "throughput": { + "type": "number", "format": "double", "description": "Throughput.", - "type": "number", "readOnly": true }, "receivedKBytesPerSec": { + "type": "number", "format": "double", "description": "Received network bytes.", - "type": "number", "readOnly": true }, "sentKBytesPerSec": { + "type": "number", "format": "double", "description": "Send network bytes.", - "type": "number", "readOnly": true } - }, - "readOnly": true - }, - "TestRunsList": { - "description": "Collection of test runs", - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "description": "List of test runs", - "type": "array", - "items": { - "$ref": "#/definitions/TestRun" - } - }, - "nextLink": { - "description": "Link for the next list of test runs in case of paginated results, if applicable", - "type": "string" - } } }, "TestServerMetricConfig": { - "description": "Test server metrics configuration", "type": "object", + "description": "Test server metrics configuration", "properties": { "testId": { - "description": "Test identifier", "type": "string", + "description": "Test identifier", "readOnly": true }, "metrics": { - "description": "Azure resource metrics collection {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id).", "type": "object", + "description": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).", "additionalProperties": { "$ref": "#/definitions/ResourceMetric" } }, "createdDateTime": { - "format": "date-time", - "description": "The creation datetime(ISO 8601 literal format).", "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", "readOnly": true }, "createdBy": { - "description": "The user that created.", "type": "string", + "description": "The user that created.", "readOnly": true }, "lastModifiedDateTime": { - "format": "date-time", - "description": "The last Modified datetime(ISO 8601 literal format).", "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", "readOnly": true }, "lastModifiedBy": { - "description": "The user that last modified.", "type": "string", + "description": "The user that last modified.", "readOnly": true } - } - }, - "TestsList": { - "description": "Collection of tests", + }, "required": [ - "value" - ], + "metrics" + ] + }, + "TestServerMetricConfigUpdate": { "type": "object", + "description": "Test server metrics configuration", "properties": { - "value": { - "description": "List of tests", - "type": "array", - "items": { - "$ref": "#/definitions/Test" + "metrics": { + "type": "object", + "description": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).", + "additionalProperties": { + "$ref": "#/definitions/ResourceMetricUpdate" } - }, - "nextLink": { - "description": "Link for the next list of tests in case of paginated results, if applicable", - "type": "string" } } }, + "TimeGrain": { + "type": "string", + "description": "Time Grain", + "enum": [ + "PT5S", + "PT10S", + "PT1M", + "PT5M", + "PT1H" + ], + "x-ms-enum": { + "name": "TimeGrain", + "modelAsString": true, + "values": [ + { + "name": "PT5S", + "value": "PT5S", + "description": "5 seconds, available only if test run duration is less than 10 minutes." + }, + { + "name": "PT10S", + "value": "PT10S", + "description": "10 seconds, available only if test run duration is less than 10 minutes." + }, + { + "name": "PT1M", + "value": "PT1M", + "description": "1 minute" + }, + { + "name": "PT5M", + "value": "PT5M", + "description": "5 minutes, available only if test run duration is greater than 1 minute." + }, + { + "name": "PT1H", + "value": "PT1H", + "description": "1 hour, available only if test run duration is greater than 1 minute." + } + ] + } + }, "TimeSeriesElement": { - "description": "The time series returned when a data query is performed.", "type": "object", + "description": "The time series returned when a data query is performed.", "properties": { "data": { - "description": "An array of data points representing the metric values.", "type": "array", + "description": "An array of data points representing the metric values.", "items": { "$ref": "#/definitions/MetricValue" - } + }, + "x-ms-identifiers": [] }, "dimensionValues": { - "description": "The dimension values ", "type": "array", + "description": "The dimension values ", "items": { "$ref": "#/definitions/DimensionValue" - } + }, + "x-ms-identifiers": [] } } } }, "parameters": { - "ApiVersion": { - "in": "query", + "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", - "description": "API version", + "in": "query", + "description": "The API version to use for this operation.", "required": true, - "type": "string" + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "ListTestQueryParams.lastModifiedEndTime": { + "name": "lastModifiedEndTime", + "in": "query", + "description": "End DateTime(RFC 3339 literal format) of the last updated time range to filter tests.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.lastModifiedStartTime": { + "name": "lastModifiedStartTime", + "in": "query", + "description": "Start DateTime(RFC 3339 literal format) of the last updated time range to filter tests.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.maxpagesize": { + "name": "maxpagesize", + "in": "query", + "description": "Number of results in response.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50, + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.orderby": { + "name": "orderby", + "in": "query", + "description": "Sort on the supported fields in (field asc/desc) format. eg:\nlastModifiedDateTime asc. Supported fields - lastModifiedDateTime", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.search": { + "name": "search", + "in": "query", + "description": "Prefix based, case sensitive search on searchable fields - displayName,\ncreatedBy. For example, to search for a test, with display name is Login Test,\nthe search parameter can be Login.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.executionFrom": { + "name": "executionFrom", + "in": "query", + "description": "Start DateTime(RFC 3339 literal format) of test-run execution time filter range.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.executionTo": { + "name": "executionTo", + "in": "query", + "description": "End DateTime(RFC 3339 literal format) of test-run execution time filter range.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.maxpagesize": { + "name": "maxpagesize", + "in": "query", + "description": "Number of results in response.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50, + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.orderby": { + "name": "orderby", + "in": "query", + "description": "Sort on the supported fields in (field asc/desc) format. eg: executedDateTime\nasc. Supported fields - executedDateTime", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" }, - "TestIdQueryParameter": { + "ListTestRunQueryParams.search": { + "name": "search", "in": "query", + "description": "Prefix based, case sensitive search on searchable fields - description,\nexecutedUser. For example, to search for a test run, with description 500 VUs,\nthe search parameter can be 500.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.status": { + "name": "status", + "in": "query", + "description": "Comma separated list of test run status.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.testId": { "name": "testId", + "in": "query", "description": "Unique name of an existing load test.", + "required": false, "type": "string", "x-ms-parameter-location": "method" }, - "TestIdPathParameter": { - "in": "path", - "name": "testId", - "description": "Unique name for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "MetricDimensionsRequest.interval": { + "name": "interval", + "in": "query", + "description": "The interval (i.e. timegrain) of the query.", + "required": false, + "type": "string", + "default": "PT1M", + "enum": [ + "PT5S", + "PT10S", + "PT1M", + "PT5M", + "PT1H" + ], + "x-ms-enum": { + "name": "TimeGrain", + "modelAsString": true, + "values": [ + { + "name": "PT5S", + "value": "PT5S", + "description": "5 seconds, available only if test run duration is less than 10 minutes." + }, + { + "name": "PT10S", + "value": "PT10S", + "description": "10 seconds, available only if test run duration is less than 10 minutes." + }, + { + "name": "PT1M", + "value": "PT1M", + "description": "1 minute" + }, + { + "name": "PT5M", + "value": "PT5M", + "description": "5 minutes, available only if test run duration is greater than 1 minute." + }, + { + "name": "PT1H", + "value": "PT1H", + "description": "1 hour, available only if test run duration is greater than 1 minute." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "MetricDimensionsRequest.metricNamespace": { + "name": "metricNamespace", + "in": "query", + "description": "Metric namespace to query metric definitions for.", "required": true, "type": "string", - "maxLength": 50, - "minLength": 2, - "pattern": "^[a-z0-9_-]*$", "x-ms-parameter-location": "method" }, - "TestRunIdPathParameter": { - "in": "path", - "name": "testRunId", - "description": "Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "MetricDimensionsRequest.metricname": { + "name": "metricname", + "in": "query", + "description": "Metric name", "required": true, "type": "string", - "maxLength": 50, - "minLength": 2, - "pattern": "^[a-z0-9_-]*$", "x-ms-parameter-location": "method" }, - "Endpoint": { - "in": "path", - "name": "Endpoint", - "description": "URL to perform data plane API operations on the resource.", + "MetricDimensionsRequest.timespan": { + "name": "timespan", + "in": "query", + "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", "required": true, "type": "string", - "format": "uri", - "x-ms-parameter-location": "client", - "x-ms-skip-url-encoding": true - } - }, - "securityDefinitions": { - "oauth2": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", - "scopes": { - "https://cnt-prod.loadtesting.azure.com/.default": "OAuth2 scope for Azure Load Test Service" - }, - "description": "Azure Active Directory OAuth2 Flow" - } - }, - "security": [ - { - "oauth2": [ - "https://cnt-prod.loadtesting.azure.com/.default" - ] + "x-ms-parameter-location": "method" + }, + "OldTestRunIdQueryParam": { + "name": "oldTestRunId", + "in": "query", + "description": "Existing test run identifier that should be rerun, if this is provided, the\ntest will run with the JMX file, configuration and app components from the\nexisting test run. You can override the configuration values for new test run\nin the request body.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}", - "useSchemePrefix": true, - "positionInOperation": "first", - "parameters": [ - { - "$ref": "#/parameters/Endpoint" - } - ] - }, - "schemes": [ - "https" - ] + } } diff --git a/swagger-specs/machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute/preview/2017-08-01-preview/machineLearningCompute.json b/swagger-specs/machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute/preview/2017-08-01-preview/machineLearningCompute.json deleted file mode 100644 index bda780bbf..000000000 --- a/swagger-specs/machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute/preview/2017-08-01-preview/machineLearningCompute.json +++ /dev/null @@ -1,1267 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Machine Learning Compute Management Client", - "description": "These APIs allow end users to operate on Azure Machine Learning Compute resources. They support the following operations:
  • Create or update a cluster
  • Get a cluster
  • Patch a cluster
  • Delete a cluster
  • Get keys for a cluster
  • Check if updates are available for system services in a cluster
  • Update system services in a cluster
  • Get all clusters in a resource group
  • Get all clusters in a subscription
", - "version": "2017-08-01-preview" - }, - "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.MachineLearningCompute/operationalizationClusters/{clusterName}": { - "put": { - "tags": [ - "OperationalizationClusters" - ], - "operationId": "OperationalizationClusters_CreateOrUpdate", - "description": "Create or update an operationalization cluster.", - "x-ms-examples": { - "PUT Operationalization Cluster": { - "$ref": "examples/OperationalizationClusters_CreateOrUpdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OperationalizationCluster" - }, - "description": "Parameters supplied to create or update an Operationalization cluster." - } - ], - "responses": { - "200": { - "description": "The create or update succeeded.", - "schema": { - "$ref": "#/definitions/OperationalizationCluster" - } - }, - "201": { - "description": "The request was accepted and will complete asynchronously. To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field. For more information about Asynchronous Operations, see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-async-operations.", - "schema": { - "$ref": "#/definitions/OperationalizationCluster" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponseWrapper" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "OperationalizationClusters" - ], - "operationId": "OperationalizationClusters_Get", - "x-ms-examples": { - "GET Operationalization Cluster": { - "$ref": "examples/OperationalizationClusters_Get.json" - } - }, - "description": "Gets the operationalization cluster resource view. Note that the credentials are not returned by this call. Call ListKeys to get them.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationalizationCluster" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponseWrapper" - } - } - } - }, - "patch": { - "tags": [ - "OperationalizationClusters" - ], - "operationId": "OperationalizationClusters_Update", - "x-ms-examples": { - "PATCH Operationalization Cluster": { - "$ref": "examples/OperationalizationClusters_Update.json" - } - }, - "description": "The PATCH operation can be used to update only the tags for a cluster. Use PUT operation to update other properties.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The parameters supplied to patch the cluster.", - "required": true, - "schema": { - "$ref": "#/definitions/OperationalizationClusterUpdateParameters" - } - } - ], - "responses": { - "200": { - "description": "OK. The update completed successfully.", - "schema": { - "$ref": "#/definitions/OperationalizationCluster" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponseWrapper" - } - } - } - }, - "delete": { - "tags": [ - "OperationalizationClusters" - ], - "operationId": "OperationalizationClusters_Delete", - "x-ms-examples": { - "DELETE Operationalization Cluster": { - "$ref": "examples/OperationalizationClusters_Delete.json" - } - }, - "description": "Deletes the specified cluster.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/DeleteAllParameter" - } - ], - "responses": { - "202": { - "description": "The delete request was accepted and will complete asynchronously. The know the progress of the delete operation do a GET call on the URI in the Location header. For more information about Asynchronous Operations, see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-async-operations.", - "headers": { - "Location": { - "type": "string", - "description": "URI of the async operation." - } - } - }, - "204": { - "description": "No Content. The cluster did not exist but the request was well formed." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponseWrapper" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningCompute/operationalizationClusters/{clusterName}/listKeys": { - "post": { - "tags": [ - "OperationalizationClusters" - ], - "operationId": "OperationalizationClusters_ListKeys", - "x-ms-examples": { - "List Keys of an Operationalization Cluster": { - "$ref": "examples/OperationalizationClusters_ListKeys.json" - } - }, - "description": "Gets the credentials for the specified cluster such as Storage, ACR and ACS credentials. This is a long running operation because it fetches keys from dependencies.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request completed successfully.", - "schema": { - "$ref": "#/definitions/OperationalizationClusterCredentials" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningCompute/operationalizationClusters/{clusterName}/checkSystemServicesUpdatesAvailable": { - "post": { - "tags": [ - "OperationalizationClusters" - ], - "operationId": "OperationalizationClusters_CheckSystemServicesUpdatesAvailable", - "x-ms-examples": { - "Check Update for an Operationalization Cluster": { - "$ref": "examples/OperationalizationClusters_CheckSystemServicesUpdatesAvailable.json" - } - }, - "description": "Checks if updates are available for system services in the cluster.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request completed successfully.", - "schema": { - "$ref": "#/definitions/CheckSystemServicesUpdatesAvailableResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningCompute/operationalizationClusters/{clusterName}/updateSystemServices": { - "post": { - "tags": [ - "OperationalizationClusters" - ], - "operationId": "OperationalizationClusters_UpdateSystemServices", - "x-ms-examples": { - "Update System Services in an Operationalization Cluster": { - "$ref": "examples/OperationalizationClusters_UpdateSystemServices.json" - } - }, - "description": "Updates system services in a cluster.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request completed successfully. Check the response body for update details.", - "schema": { - "$ref": "#/definitions/UpdateSystemServicesResponse" - } - }, - "202": { - "description": "The request was accepted and will complete asynchronously. The know the progress of the async operation do a GET call on the URI in the Location header. For more information about Asynchronous Operations, see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-async-operations.", - "headers": { - "Location": { - "type": "string", - "description": "URI of the async operation." - } - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningCompute/operationalizationClusters": { - "get": { - "tags": [ - "OperationalizationClusters" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "operationId": "OperationalizationClusters_ListByResourceGroup", - "x-ms-examples": { - "List Operationalization Clusters by Resource Group": { - "$ref": "examples/OperationalizationClusters_ListByResourceGroup.json" - } - }, - "description": "Gets the clusters in the specified resource group.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "in": "query", - "name": "$skiptoken", - "type": "string", - "description": "Continuation token for pagination.", - "required": false - } - ], - "responses": { - "200": { - "description": "OK. The response includes a paginated array of cluster objects and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/. Note that the cluster objects are sparsely populated to conserve space in the response content. To get the full cluster object, call the GET operation on the cluster.", - "schema": { - "$ref": "#/definitions/PaginatedOperationalizationClustersList" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningCompute/operationalizationClusters": { - "get": { - "tags": [ - "OperationalizationClusters" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "operationId": "OperationalizationClusters_ListBySubscriptionId", - "x-ms-examples": { - "List Operationalization Clusters by Subscription": { - "$ref": "examples/OperationalizationClusters_ListBySubscription.json" - } - }, - "description": "Gets the operationalization clusters in the specified subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "in": "query", - "name": "$skiptoken", - "type": "string", - "description": "Continuation token for pagination.", - "required": false - } - ], - "responses": { - "200": { - "description": "OK. The response includes a paginated array of cluster objects and a URI to the next set of results, if any. Note that the cluster objects are sparsely populated to conserve space in the response content. To get the full cluster object, call the GET operation on the cluster.", - "schema": { - "$ref": "#/definitions/PaginatedOperationalizationClustersList" - } - } - } - } - }, - "/providers/Microsoft.MachineLearningCompute/operations": { - "get": { - "tags": [ - "MachineLearningComputeOperations" - ], - "operationId": "MachineLearningCompute_ListAvailableOperations", - "x-ms-examples": { - "Machine Learning Compute List Available Operations": { - "$ref": "examples/MachineLearningCompute_ListAvailableOperations.json" - } - }, - "description": "Gets all available operations.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AvailableOperations" - } - } - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "description": "The Azure subscription ID.", - "in": "path", - "type": "string", - "required": true - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "description": "Name of the resource group in which the cluster is located.", - "in": "path", - "type": "string", - "required": true, - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - }, - "ClusterNameParameter": { - "name": "clusterName", - "description": "The name of the cluster.", - "in": "path", - "type": "string", - "required": true, - "pattern": "^[a-zA-Z][-\\w\\._\\(\\)]+[a-zA-Z0-9]$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "in": "query", - "name": "api-version", - "type": "string", - "description": "The version of the Microsoft.MachineLearningCompute resource provider API to use.", - "required": true - }, - "DeleteAllParameter": { - "name": "deleteAll", - "description": "If true, deletes all resources associated with this cluster.", - "in": "query", - "type": "boolean", - "required": false, - "x-ms-parameter-location": "method" - } - }, - "definitions": { - "Resource": { - "description": "Azure resource", - "x-ms-azure-resource": true, - "required": [ - "location" - ], - "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", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "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" - } - } - } - }, - "OperationalizationCluster": { - "type": "object", - "description": "Instance of an Azure ML Operationalization Cluster resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/OperationalizationClusterProperties", - "description": "Properties of an operationalization cluster." - } - } - }, - "OperationalizationClusterProperties": { - "type": "object", - "description": "Properties of an operationalization cluster", - "required": [ - "clusterType" - ], - "properties": { - "description": { - "type": "string", - "description": "The description of the cluster." - }, - "createdOn": { - "type": "string", - "description": "The date and time when the cluster was created.", - "format": "date-time", - "readOnly": true - }, - "modifiedOn": { - "type": "string", - "description": "The date and time when the cluster was last modified.", - "format": "date-time", - "readOnly": true - }, - "provisioningState": { - "type": "string", - "description": "The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.", - "enum": [ - "Unknown", - "Updating", - "Creating", - "Deleting", - "Succeeded", - "Failed", - "Canceled" - ], - "x-ms-enum": { - "name": "OperationStatus", - "modelAsString": true - }, - "readOnly": true - }, - "provisioningErrors": { - "type": "array", - "description": "List of provisioning errors reported by the resource provider.", - "items": { - "$ref": "#/definitions/ErrorResponseWrapper" - }, - "x-ms-identifiers": [ - "/error/code" - ], - "readOnly": true - }, - "clusterType": { - "type": "string", - "description": "The cluster type.", - "enum": [ - "ACS", - "Local" - ], - "x-ms-enum": { - "name": "ClusterType", - "modelAsString": true - } - }, - "storageAccount": { - "description": "Storage Account properties.", - "$ref": "#/definitions/StorageAccountProperties" - }, - "containerRegistry": { - "description": "Container Registry properties.", - "$ref": "#/definitions/ContainerRegistryProperties" - }, - "containerService": { - "description": "Parameters for the Azure Container Service cluster.", - "$ref": "#/definitions/AcsClusterProperties" - }, - "appInsights": { - "description": "AppInsights configuration.", - "$ref": "#/definitions/AppInsightsProperties" - }, - "globalServiceConfiguration": { - "description": "Contains global configuration for the web services in the cluster.", - "$ref": "#/definitions/GlobalServiceConfiguration" - } - } - }, - "StorageAccountProperties": { - "type": "object", - "description": "Properties of Storage Account.", - "properties": { - "resourceId": { - "type": "string", - "description": "ARM resource ID of the Azure Storage Account to store CLI specific files. If not provided one will be created. This cannot be changed once the cluster is created." - } - } - }, - "ContainerRegistryProperties": { - "type": "object", - "description": "Properties of Azure Container Registry.", - "properties": { - "resourceId": { - "type": "string", - "description": "ARM resource ID of the Azure Container Registry used to store Docker images for web services in the cluster. If not provided one will be created. This cannot be changed once the cluster is created." - } - } - }, - "AppInsightsProperties": { - "type": "object", - "description": "Properties of App Insights.", - "properties": { - "resourceId": { - "type": "string", - "description": "ARM resource ID of the App Insights." - } - } - }, - "AcsClusterProperties": { - "type": "object", - "description": "Information about the container service backing the cluster", - "required": [ - "orchestratorType" - ], - "properties": { - "clusterFqdn": { - "type": "string", - "description": "The FQDN of the cluster. ", - "readOnly": true - }, - "orchestratorType": { - "type": "string", - "description": "Type of orchestrator. It cannot be changed once the cluster is created.", - "enum": [ - "Kubernetes", - "None" - ], - "x-ms-enum": { - "name": "OrchestratorType", - "modelAsString": true - } - }, - "orchestratorProperties": { - "description": "Orchestrator specific properties", - "$ref": "#/definitions/KubernetesClusterProperties" - }, - "systemServices": { - "type": "array", - "description": "The system services deployed to the cluster", - "items": { - "$ref": "#/definitions/SystemService" - }, - "x-ms-identifiers": [ - "publicIpAddress" - ] - }, - "masterCount": { - "type": "integer", - "description": "The number of master nodes in the container service.", - "minimum": 1, - "maximum": 5, - "default": 1 - }, - "agentCount": { - "type": "integer", - "description": "The number of agent nodes in the Container Service. This can be changed to scale the cluster.", - "minimum": 1, - "maximum": 100, - "default": 2 - }, - "agentVmSize": { - "type": "string", - "description": "The Azure VM size of the agent VM nodes. This cannot be changed once the cluster is created. This list is non exhaustive; refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes for the possible VM sizes.", - "default": "Standard_D3_v2", - "enum": [ - "Standard_A0", - "Standard_A1", - "Standard_A2", - "Standard_A3", - "Standard_A4", - "Standard_A5", - "Standard_A6", - "Standard_A7", - "Standard_A8", - "Standard_A9", - "Standard_A10", - "Standard_A11", - "Standard_D1", - "Standard_D2", - "Standard_D3", - "Standard_D4", - "Standard_D11", - "Standard_D12", - "Standard_D13", - "Standard_D14", - "Standard_D1_v2", - "Standard_D2_v2", - "Standard_D3_v2", - "Standard_D4_v2", - "Standard_D5_v2", - "Standard_D11_v2", - "Standard_D12_v2", - "Standard_D13_v2", - "Standard_D14_v2", - "Standard_G1", - "Standard_G2", - "Standard_G3", - "Standard_G4", - "Standard_G5", - "Standard_DS1", - "Standard_DS2", - "Standard_DS3", - "Standard_DS4", - "Standard_DS11", - "Standard_DS12", - "Standard_DS13", - "Standard_DS14", - "Standard_GS1", - "Standard_GS2", - "Standard_GS3", - "Standard_GS4", - "Standard_GS5" - ], - "x-ms-enum": { - "name": "AgentVMSizeTypes", - "modelAsString": true - } - } - } - }, - "KubernetesClusterProperties": { - "type": "object", - "description": "Kubernetes cluster specific properties", - "x-ms-discriminator-value": "Kubernetes", - "properties": { - "servicePrincipal": { - "description": "The Azure Service Principal used by Kubernetes", - "$ref": "#/definitions/ServicePrincipalProperties" - } - } - }, - "SystemService": { - "type": "object", - "description": "Information about a system service deployed in the cluster", - "required": [ - "systemServiceType" - ], - "properties": { - "systemServiceType": { - "type": "string", - "description": "The system service type", - "enum": [ - "None", - "ScoringFrontEnd", - "BatchFrontEnd" - ], - "x-ms-enum": { - "name": "SystemServiceType", - "modelAsString": true - } - }, - "publicIpAddress": { - "type": "string", - "description": "The public IP address of the system service", - "readOnly": true - }, - "version": { - "type": "string", - "description": "The state of the system service", - "readOnly": true - } - } - }, - "ServicePrincipalProperties": { - "type": "object", - "description": "The Azure service principal used by Kubernetes for configuring load balancers", - "required": [ - "clientId", - "secret" - ], - "properties": { - "clientId": { - "type": "string", - "description": "The service principal client ID" - }, - "secret": { - "type": "string", - "description": "The service principal secret. This is not returned in response of GET/PUT on the resource. To see this please call listKeys." - } - } - }, - "OperationalizationClusterUpdateParameters": { - "type": "object", - "description": "Parameters for PATCH operation on an operationalization cluster", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters." - } - } - }, - "GlobalServiceConfiguration": { - "type": "object", - "description": "Global configuration for services in the cluster.", - "properties": { - "etag": { - "type": "string", - "description": "The configuration ETag for updates." - }, - "ssl": { - "description": "The SSL configuration properties", - "$ref": "#/definitions/SslConfiguration" - }, - "serviceAuth": { - "description": "Optional global authorization keys for all user services deployed in cluster. These are used if the service does not have auth keys.", - "$ref": "#/definitions/ServiceAuthConfiguration" - }, - "autoScale": { - "description": "The auto-scale configuration", - "$ref": "#/definitions/AutoScaleConfiguration" - } - }, - "additionalProperties": { - "type": "object", - "description": "Any additional configuration key-value pairs." - } - }, - "SslConfiguration": { - "type": "object", - "description": "SSL configuration. If configured data-plane calls to user services will be exposed over SSL only.", - "properties": { - "status": { - "type": "string", - "default": "Enabled", - "description": "SSL status. Allowed values are Enabled and Disabled.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "Status", - "modelAsString": true - } - }, - "cert": { - "type": "string", - "description": "The SSL cert data in PEM format." - }, - "key": { - "type": "string", - "description": "The SSL key data in PEM format. This is not returned in response of GET/PUT on the resource. To see this please call listKeys API." - }, - "cname": { - "type": "string", - "description": "The CName of the certificate." - } - } - }, - "ServiceAuthConfiguration": { - "type": "object", - "description": "Global service auth configuration properties. These are the data-plane authorization keys and are used if a service doesn't define it's own.", - "required": [ - "primaryAuthKeyHash", - "secondaryAuthKeyHash" - ], - "properties": { - "primaryAuthKeyHash": { - "type": "string", - "description": "The primary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API." - }, - "secondaryAuthKeyHash": { - "type": "string", - "description": "The secondary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API." - } - } - }, - "AutoScaleConfiguration": { - "type": "object", - "description": "AutoScale configuration properties.", - "properties": { - "status": { - "type": "string", - "default": "Disabled", - "description": "If auto-scale is enabled for all services. Each service can turn it off individually.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "Status", - "modelAsString": true - } - }, - "minReplicas": { - "type": "integer", - "description": "The minimum number of replicas for each service.", - "minimum": 1, - "default": 1 - }, - "maxReplicas": { - "type": "integer", - "description": "The maximum number of replicas for each service.", - "minimum": 1, - "default": 100 - }, - "targetUtilization": { - "type": "number", - "description": "The target utilization." - }, - "refreshPeriodInSeconds": { - "type": "integer", - "description": "Refresh period in seconds." - } - } - }, - "OperationalizationClusterCredentials": { - "type": "object", - "description": "Credentials to resources in the cluster.", - "properties": { - "storageAccount": { - "description": "Credentials for the Storage Account.", - "$ref": "#/definitions/StorageAccountCredentials" - }, - "containerRegistry": { - "description": "Credentials for Azure Container Registry.", - "$ref": "#/definitions/ContainerRegistryCredentials" - }, - "containerService": { - "description": "Credentials for Azure Container Service.", - "$ref": "#/definitions/ContainerServiceCredentials" - }, - "appInsights": { - "description": "Credentials for Azure AppInsights.", - "$ref": "#/definitions/AppInsightsCredentials" - }, - "serviceAuthConfiguration": { - "description": "Global authorization keys for all user services deployed in cluster. These are used if the service does not have auth keys.", - "$ref": "#/definitions/ServiceAuthConfiguration" - }, - "sslConfiguration": { - "description": "The SSL configuration for the services.", - "$ref": "#/definitions/SslConfiguration" - } - } - }, - "StorageAccountCredentials": { - "type": "object", - "description": "Access information for the storage account.", - "properties": { - "resourceId": { - "type": "string", - "description": "The ARM resource ID of the storage account.", - "readOnly": true - }, - "primaryKey": { - "type": "string", - "description": "The primary key of the storage account.", - "readOnly": true - }, - "secondaryKey": { - "type": "string", - "description": "The secondary key of the storage account.", - "readOnly": true - } - } - }, - "ContainerRegistryCredentials": { - "type": "object", - "description": "Information about the Azure Container Registry which contains the images deployed to the cluster.", - "properties": { - "loginServer": { - "type": "string", - "description": "The ACR login server name. User name is the first part of the FQDN.", - "readOnly": true - }, - "password": { - "type": "string", - "description": "The ACR primary password.", - "readOnly": true - }, - "password2": { - "type": "string", - "description": "The ACR secondary password.", - "readOnly": true - }, - "username": { - "type": "string", - "description": "The ACR login username.", - "readOnly": true - } - } - }, - "ContainerServiceCredentials": { - "type": "object", - "description": "Information about the Azure Container Registry which contains the images deployed to the cluster.", - "properties": { - "acsKubeConfig": { - "type": "string", - "description": "The ACS kube config file.", - "readOnly": true - }, - "servicePrincipalConfiguration": { - "description": "Service principal configuration used by Kubernetes.", - "readOnly": true, - "$ref": "#/definitions/ServicePrincipalProperties" - }, - "imagePullSecretName": { - "type": "string", - "description": "The ACR image pull secret name which was created in Kubernetes.", - "readOnly": true - } - } - }, - "AppInsightsCredentials": { - "type": "object", - "description": "AppInsights credentials.", - "properties": { - "appId": { - "type": "string", - "description": "The AppInsights application ID." - }, - "instrumentationKey": { - "type": "string", - "description": "The AppInsights instrumentation key. This is not returned in response of GET/PUT on the resource. To see this please call listKeys API." - } - } - }, - "CheckSystemServicesUpdatesAvailableResponse": { - "type": "object", - "description": "Information about updates available for system services in a cluster.", - "properties": { - "updatesAvailable": { - "type": "string", - "description": "Yes if updates are available for the system services, No if not.", - "readOnly": true, - "enum": [ - "Yes", - "No" - ], - "x-ms-enum": { - "name": "UpdatesAvailable", - "modelAsString": true - } - } - } - }, - "UpdateSystemServicesResponse": { - "type": "object", - "description": "Response of the update system services API", - "properties": { - "updateStatus": { - "type": "string", - "description": "Update status", - "readOnly": true, - "enum": [ - "Unknown", - "Updating", - "Creating", - "Deleting", - "Succeeded", - "Failed", - "Canceled" - ], - "x-ms-enum": { - "name": "OperationStatus", - "modelAsString": true - } - }, - "updateStartedOn": { - "type": "string", - "description": "The date and time when the last system services update was started.", - "format": "date-time", - "readOnly": true - }, - "updateCompletedOn": { - "type": "string", - "description": "The date and time when the last system services update completed.", - "format": "date-time", - "readOnly": true - } - } - }, - "PaginatedOperationalizationClustersList": { - "type": "object", - "description": "Paginated list of operationalization clusters.", - "properties": { - "value": { - "type": "array", - "description": "An array of cluster objects.", - "items": { - "$ref": "#/definitions/OperationalizationCluster" - } - }, - "nextLink": { - "type": "string", - "description": "A continuation link (absolute URI) to the next page of results in the list." - } - } - }, - "ErrorResponseWrapper": { - "type": "object", - "description": "Wrapper for error response to follow ARM guidelines.", - "properties": { - "error": { - "description": "The error response.", - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "ErrorResponse": { - "type": "object", - "description": "Error response information.", - "properties": { - "code": { - "type": "string", - "description": "Error code." - }, - "message": { - "type": "string", - "description": "Error message." - }, - "details": { - "type": "array", - "description": "An array of error detail objects.", - "items": { - "$ref": "#/definitions/ErrorDetail" - }, - "x-ms-identifiers": [ - "code" - ] - } - }, - "required": [ - "code", - "message" - ] - }, - "ErrorDetail": { - "type": "object", - "description": "Error detail information.", - "properties": { - "code": { - "type": "string", - "description": "Error code." - }, - "message": { - "type": "string", - "description": "Error message." - } - }, - "required": [ - "code", - "message" - ] - }, - "AvailableOperations": { - "type": "object", - "description": "Available operation list.", - "properties": { - "value": { - "type": "array", - "description": "An array of available operations.", - "items": { - "$ref": "#/definitions/ResourceOperation" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "ResourceOperation": { - "type": "object", - "description": "Resource operation.", - "properties": { - "name": { - "type": "string", - "description": "Name of this operation." - }, - "display": { - "type": "object", - "description": "Display of the operation.", - "properties": { - "provider": { - "type": "string", - "description": "The resource provider name." - }, - "resource": { - "type": "string", - "description": "The resource name." - }, - "operation": { - "type": "string", - "description": "The operation." - }, - "description": { - "type": "string", - "description": "The description of the operation." - } - } - }, - "origin": { - "type": "string", - "description": "The operation origin." - } - } - } - } -} diff --git a/swagger-specs/machinelearningcompute/resource-manager/api-set.json b/swagger-specs/machinelearningcompute/resource-manager/api-set.json deleted file mode 100644 index f343ce631..000000000 --- a/swagger-specs/machinelearningcompute/resource-manager/api-set.json +++ /dev/null @@ -1 +0,0 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.MachineLearningCompute/preview/2017-08-01-preview/machineLearningCompute.json"], "name": "package-2017-08-preview"} \ No newline at end of file diff --git a/swagger-specs/machinelearningexperimentation/resource-manager/Microsoft.MachineLearningExperimentation/preview/2017-05-01-preview/machineLearningExperimentation.json b/swagger-specs/machinelearningexperimentation/resource-manager/Microsoft.MachineLearningExperimentation/preview/2017-05-01-preview/machineLearningExperimentation.json deleted file mode 100644 index f5bd6702e..000000000 --- a/swagger-specs/machinelearningexperimentation/resource-manager/Microsoft.MachineLearningExperimentation/preview/2017-05-01-preview/machineLearningExperimentation.json +++ /dev/null @@ -1,1383 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ML Team Account Management Client", - "description": "These APIs allow end users to operate on Azure Machine Learning Team Account resources. They support CRUD operations for Azure Machine Learning Team Accounts.", - "version": "2017-05-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.MachineLearningExperimentation/operations": { - "get": { - "tags": [ - "Operation" - ], - "description": "Lists all of the available Azure Machine Learning Team Accounts REST API operations.", - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}": { - "get": { - "tags": [ - "Accounts" - ], - "description": "Gets the properties of the specified machine learning team account.", - "operationId": "Accounts_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - } - ], - "x-ms-examples": { - "AccountGet": { - "$ref": "examples/GetAccount.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Accounts" - ], - "description": "Creates or updates a team account with the specified parameters.", - "operationId": "Accounts_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "name": "parameters", - "in": "body", - "description": "The parameters for creating or updating a machine learning team account.", - "required": true, - "schema": { - "$ref": "#/definitions/Account" - } - } - ], - "x-ms-examples": { - "AccountCreate": { - "$ref": "examples/CreateAccount.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the resource already exists and was updated.", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "201": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Accounts" - ], - "description": "Deletes a machine learning team account.", - "operationId": "Accounts_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - } - ], - "x-ms-examples": { - "AccountDelete": { - "$ref": "examples/DeleteAccount.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly." - }, - "204": { - "description": "The machine learning team account does not exist in the subscription." - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Accounts" - ], - "description": "Updates a machine learning team account with the specified parameters.", - "operationId": "Accounts_Update", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "name": "parameters", - "in": "body", - "description": "The parameters for updating a machine learning team account.", - "required": true, - "schema": { - "$ref": "#/definitions/AccountUpdateParameters" - } - } - ], - "x-ms-examples": { - "AccountUpdate": { - "$ref": "examples/UpdateAccount.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts": { - "get": { - "tags": [ - "Accounts" - ], - "description": "Lists all the available machine learning team accounts under the specified resource group.", - "operationId": "Accounts_ListByResourceGroup", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "x-ms-examples": { - "AccountListByResourceGroup": { - "$ref": "examples/ListAccountResourceGroup.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/AccountListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}": { - "get": { - "tags": [ - "Workspaces" - ], - "description": "Gets the properties of the specified machine learning workspace.", - "operationId": "Workspaces_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - } - ], - "x-ms-examples": { - "WorkspaceGet": { - "$ref": "examples/WorkspaceGet.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Workspaces" - ], - "description": "Creates or updates a machine learning workspace with the specified parameters.", - "operationId": "Workspaces_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "description": "The parameters for creating or updating a machine learning workspace.", - "required": true, - "schema": { - "$ref": "#/definitions/Workspace" - } - } - ], - "x-ms-examples": { - "WorkspaceCreate": { - "$ref": "examples/WorkspaceCreate.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the resource already exists and was updated.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "201": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Workspaces" - ], - "description": "Deletes a machine learning workspace.", - "operationId": "Workspaces_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - } - ], - "x-ms-examples": { - "WorkspaceDelete": { - "$ref": "examples/WorkspaceDelete.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly." - }, - "204": { - "description": "The machine learning workspace does not exist in the subscription." - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Workspaces" - ], - "description": "Updates a machine learning workspace with the specified parameters.", - "operationId": "Workspaces_Update", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "description": "The parameters for updating a machine learning workspace.", - "required": true, - "schema": { - "$ref": "#/definitions/WorkspaceUpdateParameters" - } - } - ], - "x-ms-examples": { - "WorkspaceUpdate": { - "$ref": "examples/WorkspaceUpdate.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces": { - "get": { - "tags": [ - "Workspaces" - ], - "description": "Lists all the available machine learning workspaces under the specified team account.", - "operationId": "Workspaces_ListByAccounts", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "x-ms-examples": { - "ListWorkspacesByAccounts": { - "$ref": "examples/ListWorkspacesByAccounts.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}/projects/{projectName}": { - "get": { - "tags": [ - "Projects" - ], - "description": "Gets the properties of the specified machine learning project.", - "operationId": "Projects_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ProjectNameParameter" - } - ], - "x-ms-examples": { - "GetProject": { - "$ref": "examples/GetProject.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Project" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Projects" - ], - "description": "Creates or updates a project with the specified parameters.", - "operationId": "Projects_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ProjectNameParameter" - }, - { - "name": "parameters", - "in": "body", - "description": "The parameters for creating or updating a project.", - "required": true, - "schema": { - "$ref": "#/definitions/Project" - } - } - ], - "x-ms-examples": { - "CreateProject": { - "$ref": "examples/CreateProject.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the resource already exists and was updated.", - "schema": { - "$ref": "#/definitions/Project" - } - }, - "201": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Project" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Projects" - ], - "description": "Deletes a project.", - "operationId": "Projects_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ProjectNameParameter" - } - ], - "x-ms-examples": { - "ProjectDelete": { - "$ref": "examples/DeleteProject.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly." - }, - "204": { - "description": "The machine learning team account does not exist in the subscription." - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Projects" - ], - "description": "Updates a project with the specified parameters.", - "operationId": "Projects_Update", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ProjectNameParameter" - }, - { - "name": "parameters", - "in": "body", - "description": "The parameters for updating a machine learning team account.", - "required": true, - "schema": { - "$ref": "#/definitions/ProjectUpdateParameters" - } - } - ], - "x-ms-examples": { - "UpdateProject": { - "$ref": "examples/UpdateProject.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Project" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}/projects": { - "get": { - "tags": [ - "Projects" - ], - "description": "Lists all the available machine learning projects under the specified workspace.", - "operationId": "Projects_ListByWorkspace", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "x-ms-examples": { - "ProjectListByWorkspaces": { - "$ref": "examples/ProjectListByWorkspaces.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/ProjectListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningExperimentation/accounts": { - "get": { - "tags": [ - "Accounts" - ], - "description": "Lists all the available machine learning team accounts under the specified subscription.", - "operationId": "Accounts_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "x-ms-examples": { - "AccountList": { - "$ref": "examples/ListAccount.json" - } - }, - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/AccountListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "Workspace": { - "type": "object", - "description": "An object that represents a machine learning team account workspace.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/WorkspaceProperties", - "description": "The properties of the machine learning team account workspace.", - "x-ms-client-flatten": true - } - } - }, - "WorkspaceProperties": { - "type": "object", - "description": "The properties of a machine learning team account workspace.", - "required": [ - "friendlyName" - ], - "properties": { - "description": { - "description": "The description of this workspace.", - "type": "string" - }, - "accountId": { - "description": "The immutable id of the team account which contains this workspace.", - "type": "string", - "readOnly": true - }, - "workspaceId": { - "description": "The immutable id of this workspace.", - "type": "string", - "readOnly": true - }, - "friendlyName": { - "description": "The friendly name for this workspace. This will be the workspace name in the arm id when the workspace object gets created", - "type": "string" - }, - "creationDate": { - "format": "date-time", - "description": "The creation date of the machine learning workspace in ISO8601 format.", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "type": "string", - "enum": [ - "Creating", - "Succeeded", - "Updating", - "Deleting", - "Failed" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - }, - "readOnly": true, - "description": "The current deployment state of team account workspace resource. The provisioningState is to indicate states for resource provisioning." - } - } - }, - "WorkspaceUpdateParameters": { - "description": "The parameters for updating a machine learning team account workspace.", - "properties": { - "tags": { - "description": "The resource tags for the machine learning team account workspace.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", - "description": "The properties that the machine learning workspace will be updated with.", - "x-ms-client-flatten": true - } - } - }, - "WorkspacePropertiesUpdateParameters": { - "description": "The parameters for updating the properties of a machine learning team account workspace.", - "properties": { - "friendlyName": { - "description": "Friendly name of this workspace.", - "type": "string" - }, - "description": { - "description": "Description for this workspace.", - "type": "string" - } - } - }, - "WorkspaceListResult": { - "description": "The result of a request to list machine learning team account workspaces.", - "properties": { - "value": { - "description": "The list of machine learning team account workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning team accounts.", - "type": "array", - "items": { - "$ref": "#/definitions/Workspace" - } - }, - "nextLink": { - "description": "The URI that can be used to request the next list of machine learning workspaces.", - "type": "string" - } - } - }, - "Project": { - "type": "object", - "description": "An object that represents a machine learning project.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ProjectProperties", - "description": "The properties of the Project.", - "x-ms-client-flatten": true - } - } - }, - "ProjectProperties": { - "type": "object", - "description": "The properties of a machine learning project.", - "required": [ - "friendlyName" - ], - "properties": { - "description": { - "description": "The description of this project.", - "type": "string" - }, - "accountId": { - "description": "The immutable id of the team account which contains this project.", - "type": "string", - "readOnly": true - }, - "workspaceId": { - "description": "The immutable id of the workspace which contains this project.", - "type": "string", - "readOnly": true - }, - "projectId": { - "description": "The immutable id of this project.", - "type": "string", - "readOnly": true - }, - "gitrepo": { - "description": "The reference to git repo for this project.", - "type": "string" - }, - "friendlyName": { - "description": "The friendly name for this project.", - "type": "string" - }, - "creationDate": { - "format": "date-time", - "description": "The creation date of the project in ISO8601 format.", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "type": "string", - "enum": [ - "Creating", - "Succeeded", - "Updating", - "Deleting", - "Failed" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - }, - "readOnly": true, - "description": "The current deployment state of project resource. The provisioningState is to indicate states for resource provisioning." - } - } - }, - "ProjectUpdateParameters": { - "description": "The parameters for updating a machine learning project.", - "properties": { - "tags": { - "description": "The resource tags for the machine learning project.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/ProjectPropertiesUpdateParameters", - "description": "The properties that the project will be updated with.", - "x-ms-client-flatten": true - } - } - }, - "ProjectPropertiesUpdateParameters": { - "description": "The parameters for updating the properties of a project.", - "properties": { - "friendlyName": { - "description": "The friendly name for this project.", - "type": "string" - }, - "description": { - "description": "The description of this project.", - "type": "string" - }, - "gitrepo": { - "description": "The reference to git repo for this project.", - "type": "string" - } - } - }, - "ProjectListResult": { - "description": "The result of a request to list projects.", - "properties": { - "value": { - "description": "The list of projects. Since this list may be incomplete, the nextLink field should be used to request the next list of projects.", - "type": "array", - "items": { - "$ref": "#/definitions/Project" - } - }, - "nextLink": { - "description": "The URI that can be used to request the next list of projects.", - "type": "string" - } - } - }, - "ErrorResponse": { - "description": "The error response send when an operation fails.", - "properties": { - "code": { - "type": "string", - "description": "error code" - }, - "message": { - "type": "string", - "description": "error message" - } - }, - "required": [ - "code", - "message" - ] - }, - "Account": { - "type": "object", - "description": "An object that represents a machine learning team account.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/AccountProperties", - "description": "The properties of the machine learning team account.", - "x-ms-client-flatten": true - } - } - }, - "AccountProperties": { - "type": "object", - "description": "The properties of a machine learning team account.", - "required": [ - "storageAccount", - "vsoAccountId", - "keyVaultId" - ], - "properties": { - "vsoAccountId": { - "description": "The fully qualified arm id of the vso account to be used for this team account.", - "type": "string" - }, - "accountId": { - "description": "The immutable id associated with this team account.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The description of this workspace.", - "type": "string" - }, - "friendlyName": { - "description": "The friendly name for this workspace. This will be the workspace name in the arm id when the workspace object gets created", - "type": "string" - }, - "keyVaultId": { - "description": "The fully qualified arm id of the user key vault.", - "type": "string" - }, - "seats": { - "description": "The no of users/seats who can access this team account. This property defines the charge on the team account.", - "type": "string" - }, - "discoveryUri": { - "description": "The uri for this machine learning team account.", - "type": "string", - "readOnly": true - }, - "creationDate": { - "format": "date-time", - "description": "The creation date of the machine learning team account in ISO8601 format.", - "type": "string", - "readOnly": true - }, - "storageAccount": { - "$ref": "#/definitions/StorageAccountProperties", - "description": "The properties of the storage account for the machine learning team account." - }, - "provisioningState": { - "type": "string", - "enum": [ - "Creating", - "Succeeded", - "Updating", - "Deleting", - "Failed" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - }, - "readOnly": true, - "description": "The current deployment state of team account resource. The provisioningState is to indicate states for resource provisioning." - } - } - }, - "StorageAccountProperties": { - "description": "The properties of a storage account for a machine learning team account.", - "required": [ - "storageAccountId", - "accessKey" - ], - "properties": { - "storageAccountId": { - "description": "The fully qualified arm Id of the storage account.", - "type": "string" - }, - "accessKey": { - "description": "The access key to the storage account.", - "type": "string" - } - } - }, - "AccountUpdateParameters": { - "description": "The parameters for updating a machine learning team account.", - "properties": { - "tags": { - "description": "The resource tags for the machine learning team account.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/AccountPropertiesUpdateParameters", - "description": "The properties that the machine learning team account will be updated with.", - "x-ms-client-flatten": true - } - } - }, - "AccountPropertiesUpdateParameters": { - "description": "The parameters for updating the properties of a machine learning team account.", - "properties": { - "description": { - "description": "The description of this workspace.", - "type": "string" - }, - "friendlyName": { - "description": "The friendly name for this workspace. This will be the workspace name in the arm id when the workspace object gets created", - "type": "string" - }, - "seats": { - "description": "The no of users/seats who can access this team account. This property defines the charge on the team account.", - "type": "string" - }, - "storageAccountKey": { - "description": "The key for storage account associated with this team account", - "type": "string" - } - } - }, - "AccountListResult": { - "description": "The result of a request to list machine learning team accounts.", - "properties": { - "value": { - "description": "The list of machine learning team accounts. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning team accounts.", - "type": "array", - "items": { - "$ref": "#/definitions/Account" - } - }, - "nextLink": { - "description": "The URI that can be used to request the next list of machine learning team accounts.", - "type": "string" - } - } - }, - "Operation": { - "description": "Azure Machine Learning team account REST API operation", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "Display name of operation", - "properties": { - "provider": { - "description": "The resource provider name: Microsoft.MachineLearningExperimentation", - "type": "string" - }, - "resource": { - "description": "The resource on which the operation is performed.", - "type": "string" - }, - "operation": { - "description": "The operation that users can perform.", - "type": "string" - }, - "description": { - "description": "The description for the operation.", - "type": "string" - } - } - } - } - }, - "OperationListResult": { - "description": "An array of operations supported by the resource provider.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "List of AML team account operations supported by the AML team account resource provider." - } - } - }, - "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 machine learning team account belongs.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "WorkspaceNameParameter": { - "name": "workspaceName", - "in": "path", - "description": "The name of the machine learning team account workspace.", - "required": true, - "type": "string", - "maxLength": 50, - "minLength": 5, - "pattern": "^[a-zA-Z0-9]*$", - "x-ms-parameter-location": "method" - }, - "ProjectNameParameter": { - "name": "projectName", - "in": "path", - "description": "The name of the machine learning project under a team account workspace.", - "required": true, - "type": "string", - "maxLength": 50, - "minLength": 5, - "pattern": "^[a-zA-Z0-9]*$", - "x-ms-parameter-location": "method" - }, - "AccountNameParameter": { - "name": "accountName", - "in": "path", - "description": "The name of the machine learning team account.", - "required": true, - "type": "string", - "maxLength": 50, - "minLength": 5, - "pattern": "^[a-zA-Z0-9]*$", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/machinelearningexperimentation/resource-manager/api-set.json b/swagger-specs/machinelearningexperimentation/resource-manager/api-set.json deleted file mode 100644 index 8ce43ba67..000000000 --- a/swagger-specs/machinelearningexperimentation/resource-manager/api-set.json +++ /dev/null @@ -1 +0,0 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.MachineLearningExperimentation/preview/2017-05-01-preview/machineLearningExperimentation.json"], "name": "package-2017-05-preview"} \ No newline at end of file diff --git a/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/artifact.json b/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/artifact.json deleted file mode 100644 index dc432c7e3..000000000 --- a/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/artifact.json +++ /dev/null @@ -1,1546 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2019-09-30", - "title": "Artifact API" - }, - "schemes": [ - "https" - ], - "paths": { - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/metadata": { - "post": { - "tags": [ - "Artifact" - ], - "summary": "Create Artifact.", - "description": "Create an Artifact.", - "operationId": "Artifacts_Create", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "artifact", - "in": "body", - "description": "The Artifact details.", - "required": true, - "schema": { - "$ref": "#/definitions/Artifact" - } - } - ], - "responses": { - "200": { - "description": "The Artifact is created successfully.", - "schema": { - "$ref": "#/definitions/Artifact" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/register": { - "post": { - "tags": [ - "Artifact" - ], - "summary": "Create an Artifact for an existing data location.", - "description": "Create an Artifact for an existing dataPath.", - "operationId": "Artifacts_Register", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "artifact", - "in": "body", - "description": "The Artifact creation details.", - "required": true, - "schema": { - "$ref": "#/definitions/Artifact" - } - } - ], - "responses": { - "200": { - "description": "The Artifact is created successfully.", - "schema": { - "$ref": "#/definitions/Artifact" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/metadata": { - "get": { - "tags": [ - "Artifact" - ], - "summary": "Get Artifact metadata by Id.", - "description": "Get Artifact metadata for a specific Id.", - "operationId": "Artifacts_Get", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The details of the Artifact are returned successfully.", - "schema": { - "$ref": "#/definitions/Artifact" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Artifact" - ], - "summary": "Delete Artifact Metadata.", - "description": "Delete an Artifact Metadata.", - "operationId": "Artifacts_DeleteMetaData", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - }, - { - "name": "hardDelete", - "in": "query", - "description": "If set to true. The delete cannot be revert at later time.", - "required": false, - "type": "boolean", - "default": false - } - ], - "responses": { - "200": { - "description": "The Artifact metadata deleted successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}": { - "get": { - "tags": [ - "Artifact" - ], - "summary": "Get Artifacts metadata in a container or path.", - "description": "Get Artifacts metadata in a specific container or path.", - "operationId": "Artifacts_ListInContainer", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - }, - { - "name": "continuationToken", - "in": "query", - "description": "The continuation token.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The details of the Artifacts are returned successfully.", - "schema": { - "$ref": "#/definitions/PaginatedArtifactList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/content": { - "get": { - "tags": [ - "Artifact" - ], - "summary": "Get Artifact content by Id.", - "description": "Get Artifact content of a specific Id.", - "operationId": "Artifacts_Download", - "consumes": [], - "produces": [ - "application/json", - "application/octet-stream" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "File Response", - "schema": { - "format": "byte", - "type": "file" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "post": { - "tags": [ - "Artifact" - ], - "summary": "Upload Artifact content.", - "description": "Upload content to an Artifact.", - "operationId": "Artifacts_Upload", - "consumes": [ - "application/octet-stream" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - }, - { - "name": "index", - "in": "query", - "description": "The index.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "append", - "in": "query", - "description": "Whether or not to append the content or replace it.", - "required": false, - "type": "boolean", - "default": false - }, - { - "name": "allowOverwrite", - "in": "query", - "description": "whether to allow overwrite if Artifact Content exist already. when set to true, Overwrite happens if Artifact Content already exists", - "required": false, - "type": "boolean", - "default": false - }, - { - "name": "content", - "in": "body", - "description": "The file upload.", - "required": true, - "schema": { - "format": "binary", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The Artifact content is uploaded successfully.", - "schema": { - "$ref": "#/definitions/Artifact" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/contentinfo": { - "get": { - "tags": [ - "Artifact" - ], - "summary": "Get Artifact content information.", - "description": "Get content information of an Artifact.", - "operationId": "Artifacts_GetContentInformation", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The Artifact content information is returned successfully.", - "schema": { - "$ref": "#/definitions/ArtifactContentInformation" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/contentinfo/storageuri": { - "get": { - "tags": [ - "Artifact" - ], - "summary": "Get Artifact storage content information.", - "description": "Get storage content information of an Artifact.", - "operationId": "Artifacts_GetStorageContentInformation", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The Artifact storage content information is returned successfully.", - "schema": { - "$ref": "#/definitions/ArtifactContentInformation" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/write": { - "get": { - "tags": [ - "Artifact" - ], - "summary": "Get writable shared access signature for Artifact.", - "description": "Get writable shared access signature for a specific Artifact.", - "operationId": "Artifacts_GetSas", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The Artifact writable shared access signature is returned successfully.", - "schema": { - "$ref": "#/definitions/ArtifactContentInformation" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/prefix/contentinfo": { - "get": { - "tags": [ - "Artifact" - ], - "summary": "Get shared access signature for an Artifact", - "description": "Get shared access signature for an Artifact in specific path.", - "operationId": "Artifacts_ListSasByPrefix", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - }, - { - "name": "continuationToken", - "in": "query", - "description": "The continuation token.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The Artifact writable shared access signature is returned successfully.", - "schema": { - "$ref": "#/definitions/PaginatedArtifactContentInformationList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/prefix/contentinfo/storageuri": { - "get": { - "tags": [ - "Artifact" - ], - "summary": "Get storage Uri for Artifacts in a path.", - "description": "Get storage Uri for Artifacts in a specific path.", - "operationId": "Artifacts_ListStorageUriByPrefix", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - }, - { - "name": "continuationToken", - "in": "query", - "description": "The continuation token.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The Artifact storage uri is returned successfully.", - "schema": { - "$ref": "#/definitions/PaginatedArtifactContentInformationList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/batch/metadata": { - "post": { - "tags": [ - "Artifact" - ], - "summary": "Get Batch Artifacts by Ids.", - "description": "Get Batch Artifacts by the specific Ids.", - "operationId": "Artifacts_BatchGetById", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "artifactIds", - "in": "body", - "description": "The command for Batch Artifact get request.", - "required": true, - "schema": { - "$ref": "#/definitions/ArtifactIdList" - } - } - ], - "responses": { - "200": { - "description": "The requested Batch Artifacts are returned successfully.", - "schema": { - "$ref": "#/definitions/BatchArtifactContentInformationResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/storageuri/batch/metadata": { - "post": { - "tags": [ - "Artifact" - ], - "summary": "Get Batch Artifacts storage by Ids.", - "description": "Get Batch Artifacts storage by specific Ids.", - "operationId": "Artifacts_BatchGetStorageById", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "artifactIds", - "in": "body", - "description": "The list of artifactIds to get.", - "required": true, - "schema": { - "$ref": "#/definitions/ArtifactIdList" - } - } - ], - "responses": { - "200": { - "description": "The Batch Artifact's storage are returned successfully.", - "schema": { - "$ref": "#/definitions/BatchArtifactContentInformationResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/batch/ingest/containersas": { - "post": { - "tags": [ - "Artifact" - ], - "summary": "Batch ingest using shared access signature.", - "description": "Ingest Batch Artifacts using shared access signature.", - "operationId": "Artifacts_BatchIngestFromSas", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "artifactContainerSas", - "in": "body", - "description": "The artifact container shared access signature to use for batch ingest.", - "required": true, - "schema": { - "$ref": "#/definitions/ArtifactContainerSas" - } - } - ], - "responses": { - "200": { - "description": "The Batch is ingested using shared access signature successfully.", - "schema": { - "$ref": "#/definitions/PaginatedArtifactList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/batch/metadata": { - "post": { - "tags": [ - "Artifact" - ], - "summary": "Create a batch of empty Artifacts.", - "description": "Create a Batch of empty Artifacts from the supplied paths.", - "operationId": "Artifacts_BatchCreateEmptyArtifacts", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "artifactPaths", - "in": "body", - "description": "The list of Artifact paths to create.", - "required": true, - "schema": { - "$ref": "#/definitions/ArtifactPathList" - } - } - ], - "responses": { - "200": { - "description": "The Batch of empty Artifacts created successfully.", - "schema": { - "$ref": "#/definitions/BatchArtifactContentInformationResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/batch/metadata:delete": { - "post": { - "tags": [ - "Artifact" - ], - "summary": "Delete Batch of Artifact Metadata.", - "description": "Delete a Batch of Artifact Metadata.", - "operationId": "Artifacts_DeleteBatchMetaData", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "artifactPaths", - "in": "body", - "description": "The list of Artifact paths to delete.", - "required": true, - "schema": { - "$ref": "#/definitions/ArtifactPathList" - } - }, - { - "name": "hardDelete", - "in": "query", - "description": "If set to true, the delete cannot be reverted at a later time.", - "required": false, - "type": "boolean", - "default": false - } - ], - "responses": { - "200": { - "description": "The batch delete of Artifact metadata completed successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/batch": { - "delete": { - "tags": [ - "Artifact" - ], - "summary": "Delete Artifact Metadata.", - "description": "Delete Artifact Metadata in a specific container.", - "operationId": "Artifacts_DeleteMetaDataInContainer", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "origin", - "in": "path", - "description": "The origin of the Artifact.", - "required": true, - "type": "string" - }, - { - "name": "container", - "in": "path", - "description": "The container name.", - "required": true, - "type": "string" - }, - { - "name": "hardDelete", - "in": "query", - "description": "If set to true. The delete cannot be revert at later time.", - "required": false, - "type": "boolean", - "default": false - } - ], - "responses": { - "200": { - "description": "The Artifact metadata deleted successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "Artifact": { - "description": "Details of an Artifact.", - "required": [ - "origin", - "container", - "path" - ], - "type": "object", - "properties": { - "artifactId": { - "description": "The identifier of an Artifact. Format of ArtifactId - {Origin}/{Container}/{Path}.", - "type": "string" - }, - "origin": { - "description": "The origin of the Artifact creation request. Available origins are 'ExperimentRun', 'LocalUpload', 'WebUpload', 'Dataset' and 'Unknown'.", - "type": "string" - }, - "container": { - "description": "The name of container. Artifacts can be grouped by container.", - "type": "string" - }, - "path": { - "description": "The path to the Artifact in a container.", - "type": "string" - }, - "etag": { - "description": "The Etag of the Artifact.", - "type": "string", - "readOnly": true - }, - "createdTime": { - "format": "date-time", - "description": "The Date and Time at which the Artifact is created. The DateTime is in UTC.", - "type": "string", - "readOnly": true - }, - "dataPath": { - "$ref": "#/definitions/DataPath" - } - } - }, - "DataPath": { - "type": "object", - "properties": { - "dataStoreName": { - "type": "string" - }, - "relativePath": { - "type": "string" - }, - "sqlDataPath": { - "$ref": "#/definitions/SqlDataPath" - } - } - }, - "SqlDataPath": { - "type": "object", - "properties": { - "sqlTableName": { - "type": "string" - }, - "sqlQuery": { - "type": "string" - }, - "sqlStoredProcedureName": { - "type": "string" - }, - "sqlStoredProcedureParams": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/StoredProcedureParameter" - } - } - } - }, - "StoredProcedureParameter": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - }, - "type": { - "enum": [ - "String", - "Int", - "Decimal", - "Guid", - "Boolean", - "Date" - ], - "type": "string", - "x-ms-enum": { - "name": "StoredProcedureParameterType", - "modelAsString": false - } - } - } - }, - "PaginatedArtifactList": { - "description": "A paginated list of Artifacts.", - "type": "object", - "properties": { - "value": { - "description": "An array of objects of type Artifact.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Artifact" - } - }, - "continuationToken": { - "description": "The token used in retrieving the next page. If null, there are no additional pages.", - "type": "string" - }, - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - } - } - }, - "ArtifactContentInformation": { - "description": "Details of an Artifact Content Information.", - "type": "object", - "properties": { - "contentUri": { - "description": "The URI of the content.", - "type": "string" - }, - "origin": { - "description": "The origin of the Artifact creation request. Available origins are 'ExperimentRun', 'LocalUpload', 'WebUpload', 'Dataset', 'ComputeRecord', 'Metric', and 'Unknown'.", - "type": "string" - }, - "container": { - "description": "The name of container. Artifacts can be grouped by container.", - "type": "string" - }, - "path": { - "description": "The path to the Artifact in a container.", - "type": "string" - } - } - }, - "PaginatedArtifactContentInformationList": { - "description": "A paginated list of ArtifactContentInformations.", - "type": "object", - "properties": { - "value": { - "description": "An array of objects of type ArtifactContentInformation.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ArtifactContentInformation" - } - }, - "continuationToken": { - "description": "The token used in retrieving the next page. If null, there are no additional pages.", - "type": "string" - }, - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - } - } - }, - "ArtifactIdList": { - "description": "Contains list of Artifact Ids.", - "required": [ - "artifactIds" - ], - "type": "object", - "properties": { - "artifactIds": { - "description": "List of Artifacts Ids.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "BatchArtifactContentInformationResult": { - "description": "Results of the Batch Artifact Content Information request.", - "type": "object", - "properties": { - "artifacts": { - "description": "Artifact details of the Artifact Ids requested.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Artifact" - } - }, - "artifactContentInformation": { - "description": "Artifact Content Information details of the Artifact Ids requested.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ArtifactContentInformation" - } - }, - "errors": { - "description": "Errors occurred while fetching the requested Artifact Ids.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "ErrorResponse": { - "description": "The error response.", - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/RootError", - "description": "The top level error that occurred." - }, - "correlation": { - "description": "Dictionary containing correlation details for the error.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "environment": { - "description": "The hosting environment.", - "type": "string" - }, - "location": { - "description": "The Azure region.", - "type": "string" - }, - "time": { - "format": "date-time", - "description": "The time in UTC.", - "type": "string" - } - } - }, - "RootError": { - "description": "The root error.", - "type": "object", - "properties": { - "code": { - "description": "The service-defined error code. Supported error codes: ServiceError, UserError, ValidationError, AzureStorageError, TransientError, RequestThrottled.", - "type": "string" - }, - "message": { - "description": "A human-readable representation of the error.", - "type": "string" - }, - "target": { - "description": "The target of the error (e.g., the name of the property in error).", - "type": "string" - }, - "details": { - "description": "The related errors that occurred during the request.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ErrorDetails" - } - }, - "innerError": { - "$ref": "#/definitions/InnerErrorResponse", - "description": "A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand." - } - } - }, - "ErrorDetails": { - "description": "The error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string" - }, - "message": { - "description": "The error message.", - "type": "string" - }, - "target": { - "description": "The target of the error (e.g., the name of the property in error).", - "type": "string" - } - } - }, - "InnerErrorResponse": { - "description": "A nested structure of errors.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string" - }, - "innerError": { - "$ref": "#/definitions/InnerErrorResponse", - "description": "A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand." - } - } - }, - "ArtifactContainerSas": { - "description": "Details of the Artifact Container's shared access signature.", - "required": [ - "containerSas", - "containerUri" - ], - "type": "object", - "properties": { - "containerSas": { - "description": "The shared access signature of the Container.", - "type": "string" - }, - "containerUri": { - "description": "The URI of the Container.", - "type": "string" - }, - "prefix": { - "description": "The Prefix to the Blobs in the Container.", - "type": "string" - }, - "artifactPrefix": { - "description": "The Prefix to the Artifact in the Blob.", - "type": "string" - } - } - }, - "ArtifactPathList": { - "description": "Contains list of Artifact Paths.", - "required": [ - "paths" - ], - "type": "object", - "properties": { - "paths": { - "description": "List of Artifact Paths.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ArtifactPath" - } - } - } - }, - "ArtifactPath": { - "description": "Details of an Artifact Path.", - "required": [ - "path" - ], - "type": "object", - "properties": { - "path": { - "description": "The path to the Artifact in a container.", - "type": "string" - } - } - } - }, - "parameters": { - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The Azure Subscription ID.", - "required": true, - "type": "string", - "format": "uuid", - "x-ms-parameter-location": "method" - }, - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The Name of the resource group in which the workspace is located.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "workspaceNameParameter": { - "name": "workspaceName", - "in": "path", - "description": "The name of the workspace.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "tags": [] -} diff --git a/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/datastore.json b/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/datastore.json deleted file mode 100644 index eaaf0271f..000000000 --- a/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/datastore.json +++ /dev/null @@ -1,925 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2019-09-30", - "title": "Azure Machine Learning Datastore Management Client" - }, - "schemes": [ - "https" - ], - "paths": { - "/datastore/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": { - "get": { - "tags": [ - "DataStore" - ], - "summary": "Get Datastores list.", - "description": "Get the list of Datastores attached to the workspace.", - "operationId": "DataStores_List", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "dataStoreNames", - "in": "query", - "description": "List of Datastore names.", - "required": false, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "uniqueItems": false - }, - { - "name": "continuationToken", - "in": "query", - "description": "The Continuation Token.", - "required": false, - "type": "string" - }, - { - "name": "count", - "in": "query", - "description": "Count of Datastores to be returned.", - "required": false, - "type": "integer", - "format": "int32", - "default": 30 - }, - { - "name": "includeSecret", - "in": "query", - "description": "Whether to include the datastore secret in the response.", - "required": false, - "type": "boolean", - "default": true - } - ], - "responses": { - "200": { - "description": "The list of Datastores are returned successfully.", - "schema": { - "$ref": "#/definitions/PaginatedDataStoreList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - }, - "post": { - "tags": [ - "DataStore" - ], - "summary": "Create or update a Datastore.", - "description": "Create or update a Datastore in the given workspace.", - "operationId": "DataStores_Create", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "dto", - "in": "body", - "description": "The Datastore details.", - "required": false, - "schema": { - "$ref": "#/definitions/DataStore" - } - }, - { - "name": "createIfNotExists", - "in": "query", - "description": "If set to true, the call will create an Datastore if it doesn't exist.", - "required": false, - "type": "boolean", - "default": false - }, - { - "name": "skipValidation", - "in": "query", - "description": "If set to true, the call will skip Datastore validation.", - "required": false, - "type": "boolean", - "default": false - } - ], - "responses": { - "200": { - "description": "The Datastore is created/updated successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "DataStore" - ], - "summary": "Delete all Datastores.", - "description": "Delete all Datastores in the workspace.", - "operationId": "DataStores_DeleteAll", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - } - ], - "responses": { - "200": { - "description": "All the Datastores in the workspace are deleted successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/datastore/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}": { - "get": { - "tags": [ - "DataStore" - ], - "summary": "Get Datastore details.", - "description": "Get details of a Datastore with a specific name.", - "operationId": "DataStores_Get", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "The Datastore name.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The Datastore details are returned successfully.", - "schema": { - "$ref": "#/definitions/DataStore" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "DataStore" - ], - "summary": "Update or create a Datastore.", - "description": "Update or create a Datastore in the given workspace.", - "operationId": "DataStores_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "The Datastore name.", - "required": true, - "type": "string" - }, - { - "name": "dto", - "in": "body", - "description": "The Datastore details.", - "required": false, - "schema": { - "$ref": "#/definitions/DataStore" - } - }, - { - "name": "createIfNotExists", - "in": "query", - "description": "If set to true, the call will create an Datastore if it doesn't exist.", - "required": false, - "type": "boolean", - "default": false - }, - { - "name": "skipValidation", - "in": "query", - "description": "If set to true, the call will skip Datastore validation.", - "required": false, - "type": "boolean", - "default": false - } - ], - "responses": { - "200": { - "description": "The Datastore is created/updated successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "DataStore" - ], - "summary": "Delete a Datastore.", - "description": "Delete a Datastore with a specific name.", - "operationId": "DataStores_Delete", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "The Datastore name.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The Datastore is deleted successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/datastore/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/default/{name}": { - "put": { - "tags": [ - "DataStoreDefault" - ], - "summary": "Set a default Datastore.", - "description": "Set a default Datastore in the workspace.", - "operationId": "DataStores_SetDefault", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "The Datastore name.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The default Datastore is set successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/datastore/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/default": { - "get": { - "tags": [ - "DataStoreDefault" - ], - "summary": "Get the default Datastore.", - "description": "Get the default Datastore in the workspace.", - "operationId": "DataStores_GetDefault", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - } - ], - "responses": { - "200": { - "description": "The default Datastore is returned successfully.", - "schema": { - "$ref": "#/definitions/DataStore" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "PaginatedDataStoreList": { - "description": "A paginated list of DataStores.", - "type": "object", - "properties": { - "value": { - "description": "An array of objects of type DataStore.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/DataStore" - } - }, - "continuationToken": { - "description": "The token used in retrieving the next page. If null, there are no additional pages.", - "type": "string" - }, - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - } - } - }, - "DataStore": { - "type": "object", - "properties": { - "name": { - "description": "Name of the datastore", - "type": "string" - }, - "dataStoreType": { - "description": "The Azure storage service this datastore points to.", - "enum": [ - "AzureBlob", - "AzureFile", - "AzureDataLake", - "AzureSqlDatabase", - "AzurePostgreSql", - "DBFS", - "AzureDataLakeGen2", - "GlusterFs" - ], - "type": "string", - "x-ms-enum": { - "name": "DataStoreType", - "modelAsString": false - } - }, - "hasBeenValidated": { - "description": "A read only property that denotes whether the service datastore has been validated with credentials.", - "type": "boolean" - }, - "tags": { - "description": "Tags to datastore", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "azureStorageSection": { - "$ref": "#/definitions/AzureStorage", - "description": "Data specific to azure storage" - }, - "azureDataLakeSection": { - "$ref": "#/definitions/AzureDataLake", - "description": "Data Specific to azure data lake" - }, - "azureSqlDatabaseSection": { - "$ref": "#/definitions/AzureSqlDatabase", - "description": "Data specific to azure SQL database" - }, - "azurePostgreSqlSection": { - "$ref": "#/definitions/AzurePostgreSql", - "description": "Data specific to azure PostgreSQL" - }, - "glusterFsSection": { - "$ref": "#/definitions/GlusterFs", - "description": "Data specific to GlusterFS" - } - } - }, - "AzureStorage": { - "type": "object", - "properties": { - "accountName": { - "description": "Storage Account Name", - "type": "string" - }, - "containerName": { - "description": "The storage container name", - "type": "string" - }, - "endpoint": { - "description": "The host of the container", - "type": "string" - }, - "protocol": { - "description": "The protocol to use. Defaults to https", - "type": "string" - }, - "credentialType": { - "description": "The credential type", - "enum": [ - "None", - "Sas", - "AccountKey", - "ClientCredentials" - ], - "type": "string", - "x-ms-enum": { - "name": "AzureStorageCredentialTypes", - "modelAsString": false - } - }, - "credential": { - "description": "The credential", - "type": "string" - }, - "clientCredentials": { - "$ref": "#/definitions/ClientCredentials", - "description": "Service principal credential when credential type is Microsoft.MachineLearning.DataStore.Contracts.AzureStorageCredentialTypes.ClientCredentials" - }, - "blobCacheTimeout": { - "format": "int32", - "description": "If this is an Microsoft.MachineLearning.DataStore.Contracts.DataStoreType.AzureBlob, the length of time (in seconds) to cache files locally after they are accessed (downloaded).", - "type": "integer" - }, - "isSas": { - "description": "Indicate if we are using SAS token or Account Key (Deprecated)", - "type": "boolean" - }, - "accountKey": { - "description": "Storage Account Key (Deprecated)", - "type": "string" - }, - "sasToken": { - "description": "SAS Token for the container (Deprecated)", - "type": "string" - }, - "areWorkspaceManagedIdentitiesAllowed": { - "description": "Indicate if we are using Workspace ManagedIdentities/MSI token", - "type": "boolean" - }, - "subscriptionId": { - "format": "uuid", - "description": "Subscription Id", - "type": "string" - }, - "resourceGroup": { - "description": "Resource Group Name", - "type": "string" - } - } - }, - "AzureDataLake": { - "type": "object", - "properties": { - "storeName": { - "description": "The Azure Data Lake store name", - "type": "string" - }, - "clientId": { - "format": "uuid", - "description": "The Client ID/Application ID", - "type": "string" - }, - "tenantId": { - "format": "uuid", - "description": "The ID of the tenant the service principal/app belongs to", - "type": "string" - }, - "isCertAuth": { - "description": "Is it using certificate to authenticate. If false then use client secret", - "type": "boolean" - }, - "certificate": { - "description": "The content of the certificate used for authentication", - "type": "string" - }, - "thumbprint": { - "description": "The thumbprint of the certificate above", - "type": "string" - }, - "clientSecret": { - "description": "The client secret", - "type": "string" - }, - "authorityUrl": { - "description": "The authority URL used for authentication", - "type": "string" - }, - "resourceUri": { - "description": "The resource the service principal/app has access to", - "type": "string" - }, - "subscriptionId": { - "format": "uuid", - "description": "Subscription Id", - "type": "string" - }, - "resourceGroup": { - "description": "Resource Group Name", - "type": "string" - } - } - }, - "AzureSqlDatabase": { - "type": "object", - "properties": { - "serverName": { - "description": "The Azure SQL server name", - "type": "string" - }, - "databaseName": { - "description": "The Azure SQL database name", - "type": "string" - }, - "endpoint": { - "description": "The server host endpoint", - "type": "string" - }, - "clientId": { - "format": "uuid", - "description": "The Client ID/Application ID", - "type": "string" - }, - "tenantId": { - "format": "uuid", - "description": "The ID of the tenant the service principal/app belongs to", - "type": "string" - }, - "isCertAuth": { - "description": "Is it using certificate to authenticate. If false then use client secret", - "type": "boolean" - }, - "certificate": { - "description": "The content of the certificate used for authentication", - "type": "string" - }, - "thumbprint": { - "description": "The thumbprint of the certificate above", - "type": "string" - }, - "clientSecret": { - "description": "The client secret", - "type": "string" - }, - "authorityUrl": { - "description": "The authority URL used for authentication", - "type": "string" - }, - "resourceUri": { - "description": "The resource the service principal/app has access to", - "type": "string" - }, - "subscriptionId": { - "format": "uuid", - "description": "Subscription Id", - "type": "string" - }, - "resourceGroup": { - "description": "Resource Group Name", - "type": "string" - } - } - }, - "AzurePostgreSql": { - "type": "object", - "properties": { - "serverName": { - "description": "The Azure PostgreSQL server name", - "type": "string" - }, - "databaseName": { - "description": "The Azure PostgreSQL database name", - "type": "string" - }, - "userId": { - "description": "The Azure PostgreSQL user id", - "type": "string" - }, - "userPassword": { - "description": "The Azure PostgreSQL user password", - "type": "string" - }, - "portNumber": { - "description": "The Azure PostgreSQL port number", - "type": "string" - }, - "endpoint": { - "description": "The Azure PostgreSQL server host endpoint", - "type": "string" - }, - "subscriptionId": { - "format": "uuid", - "description": "Subscription Id", - "type": "string" - }, - "resourceGroup": { - "description": "Resource Group Name", - "type": "string" - } - } - }, - "GlusterFs": { - "type": "object", - "properties": { - "serverAddress": { - "description": "The server address of one of the servers that hosts the GlusterFS. Can be either the IP address\r\nor server name.", - "type": "string" - }, - "volumeName": { - "description": "The name of the created GlusterFS volume.", - "type": "string" - } - } - }, - "ClientCredentials": { - "type": "object", - "properties": { - "clientId": { - "format": "uuid", - "description": "The Client ID/Application ID", - "type": "string" - }, - "tenantId": { - "format": "uuid", - "description": "The ID of the tenant the service principal/app belongs to", - "type": "string" - }, - "isCertAuth": { - "description": "Is it using certificate to authenticate. If false then use client secret", - "type": "boolean" - }, - "certificate": { - "description": "The content of the certificate used for authentication", - "type": "string" - }, - "thumbprint": { - "description": "The thumbprint of the certificate above", - "type": "string" - }, - "clientSecret": { - "description": "The client secret", - "type": "string" - }, - "authorityUrl": { - "description": "The authority URL used for authentication", - "type": "string" - }, - "resourceUri": { - "description": "The resource the service principal/app has access to", - "type": "string" - }, - "subscriptionId": { - "format": "uuid", - "description": "Subscription Id", - "type": "string" - }, - "resourceGroup": { - "description": "Resource Group Name", - "type": "string" - } - } - }, - "ErrorResponse": { - "description": "The error response.", - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/RootError", - "description": "The top level error that occurred." - }, - "correlation": { - "description": "Dictionary containing correlation details for the error.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "environment": { - "description": "The hosting environment.", - "type": "string" - }, - "location": { - "description": "The Azure region.", - "type": "string" - }, - "time": { - "format": "date-time", - "description": "The time in UTC.", - "type": "string" - } - } - }, - "RootError": { - "description": "The root error.", - "type": "object", - "properties": { - "code": { - "description": "The service-defined error code. Supported error codes: ServiceError, UserError, ValidationError, AzureStorageError, TransientError, RequestThrottled.", - "type": "string" - }, - "message": { - "description": "A human-readable representation of the error.", - "type": "string" - }, - "target": { - "description": "The target of the error (e.g., the name of the property in error).", - "type": "string" - }, - "details": { - "description": "The related errors that occurred during the request.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ErrorDetails" - } - }, - "innerError": { - "$ref": "#/definitions/InnerErrorResponse", - "description": "A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand." - } - } - }, - "ErrorDetails": { - "description": "The error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string" - }, - "message": { - "description": "The error message.", - "type": "string" - }, - "target": { - "description": "The target of the error (e.g., the name of the property in error).", - "type": "string" - } - } - }, - "InnerErrorResponse": { - "description": "A nested structure of errors.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string" - }, - "innerError": { - "$ref": "#/definitions/InnerErrorResponse", - "description": "A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand." - } - } - } - }, - "parameters": { - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The Azure Subscription ID.", - "required": true, - "type": "string", - "format": "uuid", - "x-ms-parameter-location": "method" - }, - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The Name of the resource group in which the workspace is located.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "workspaceNameParameter": { - "name": "workspaceName", - "in": "path", - "description": "The name of the workspace.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "tags": [] -} diff --git a/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/execution.json b/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/execution.json deleted file mode 100644 index 37ebac156..000000000 --- a/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/execution.json +++ /dev/null @@ -1,827 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2019-09-30", - "title": "Execution Service API" - }, - "schemes": [ - "https" - ], - "paths": { - "/execution/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/startlocalrun": { - "post": { - "tags": [ - "Execution" - ], - "summary": "Start a run on a local machine.", - "description": "Starts an experiment run using the provided definition.json file to define the run.\r\n The source code and configuration is defined in a zip archive in project.zip.", - "operationId": "Runs_StartLocalRun", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/octet-stream" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "definition", - "in": "body", - "description": "A JSON run definition structure.", - "required": true, - "schema": { - "$ref": "#/definitions/RunDefinition" - } - }, - { - "name": "runId", - "in": "query", - "description": "A run id. If not supplied a run id will be created automatically.", - "required": false, - "type": "string", - "pattern": "^[a-zA-Z0-9][\\w-]{0,255}$" - } - ], - "responses": { - "200": { - "description": "File Response", - "schema": { - "format": "byte", - "type": "file" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Start a local run": { - "$ref": "./examples/startLocalRun.json" - } - } - } - }, - "/execution/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/startrun": { - "post": { - "tags": [ - "Execution" - ], - "summary": "Start a run on a remote compute target.", - "description": "Starts an experiment run using the provided definition.json file to define the run.\r\n The source code and configuration is defined in a zip archive in project.zip.", - "operationId": "Runs_StartRun", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runDefinitionFile", - "in": "formData", - "description": "The JSON file containing the RunDefinition", - "required": true, - "type": "file" - }, - { - "name": "projectZipFile", - "in": "formData", - "description": "The zip archive of the project folder containing the source code to use for the run.", - "required": true, - "type": "file" - }, - { - "name": "runId", - "in": "query", - "description": "A run id. If not supplied a run id will be created automatically.", - "required": false, - "type": "string", - "pattern": "^[a-zA-Z0-9][\\w-]{0,255}$" - } - ], - "responses": { - "200": { - "description": "A run was successfully started.", - "schema": { - "$ref": "#/definitions/StartRunResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Start a run": { - "$ref": "./examples/startRun.json" - } - } - } - }, - "/execution/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/snapshotrun": { - "post": { - "tags": [ - "Execution" - ], - "summary": "Start a run from a snapshot on a remote compute target.", - "description": "Starts an experiment run on the remote compute target using the provided definition.json file to define the run.\r\n The code for the run is retrieved using the snapshotId in definition.json.", - "operationId": "Runs_StartSnapshotRun", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "definition", - "in": "body", - "description": "A JSON run definition structure.", - "required": true, - "schema": { - "$ref": "#/definitions/RunDefinition" - } - }, - { - "name": "runId", - "in": "query", - "description": "A run id. If not supplied a run id will be created automatically.", - "required": false, - "type": "string", - "pattern": "^[a-zA-Z0-9][\\w-]{0,255}$" - } - ], - "responses": { - "200": { - "description": "A snapshot run was successfully started.", - "schema": { - "$ref": "#/definitions/StartRunResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Start a snapshot run": { - "$ref": "./examples/startSnapshotRun.json" - } - } - } - }, - "/execution/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runId/{runId}/cancel": { - "post": { - "tags": [ - "Execution" - ], - "summary": "Cancel a run.", - "description": "Cancels a run within an experiment.", - "operationId": "Runs_CancelRunWithUri", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The id of the run to cancel.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][\\w-]{0,255}$" - } - ], - "responses": { - "200": { - "description": "The run was successfully cancelled.", - "schema": { - "$ref": "#/definitions/StartRunResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Cancel a run with URI": { - "$ref": "./examples/cancelRunWithUri.json" - } - } - } - } - }, - "definitions": { - "RunDefinition": { - "type": "object", - "properties": { - "configuration": { - "$ref": "#/definitions/RunConfiguration", - "description": "Fully specified configuration information for the run. Even when that information\r\nis contained in configuration files within the project folder, the client collapses\r\nit all and inlines it into the run definition when submitting a run." - }, - "snapshotId": { - "format": "uuid", - "description": "Snapshots are user project folders that have been uploaded to the cloud for subsequent\r\nexecution. This field is required when executing against cloud-based compute targets\r\nunless the run submission was against the API endpoint that takes a zipped project folder\r\ninline with the request.", - "type": "string" - }, - "parentRunId": { - "description": "Specifies that the run history entry for this execution should be scoped within\r\nan existing run as a child. Defaults to null, meaning the run has no parent.\r\nThis is intended for first-party service integration, not third-party API users.", - "type": "string", - "example": "myexperiment_155000000001_0" - }, - "runType": { - "description": "Specifies the runsource property for this run. The default value is \"experiment\" if not specified.", - "type": "string", - "example": "experiment" - } - } - }, - "RunConfiguration": { - "type": "object", - "properties": { - "script": { - "description": "The relative path to the python script file. The file path is relative to the source_directory passed to submit run.", - "type": "string", - "example": "findsquare.py" - }, - "arguments": { - "description": "Command line arguments for the python script file.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "example": "[\"234\"]" - }, - "framework": { - "description": "The supported frameworks are Python, PySpark, CNTK, TensorFlow, and PyTorch. Use Tensorflow for AmlCompute clusters, and Python for distributed training jobs.", - "enum": [ - "Python", - "PySpark", - "Cntk", - "TensorFlow", - "PyTorch" - ], - "type": "string", - "example": "Python", - "x-ms-enum": { - "name": "Framework", - "modelAsString": false - } - }, - "communicator": { - "description": "The supported communicators are None, ParameterServer, OpenMpi, and IntelMpi Keep in mind that OpenMpi requires a custom image with OpenMpi installed.\r\nUse ParameterServer or OpenMpi for AmlCompute clusters. Use IntelMpi for distributed training jobs.", - "enum": [ - "None", - "ParameterServer", - "Gloo", - "Mpi", - "Nccl" - ], - "type": "string", - "example": "None", - "x-ms-enum": { - "name": "Communicator", - "modelAsString": false - } - }, - "target": { - "description": "Target refers to compute where the job is scheduled for execution. The default target is \"local\" referring to the local machine.", - "type": "string", - "example": "amlcompute" - }, - "dataReferences": { - "description": "All the data sources are made available to the run during execution based on each configuration.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/DataReferenceConfiguration" - } - }, - "jobName": { - "description": "This is primarily intended for notebooks to override the default job name.\r\nDefaults to ArgumentVector[0] if not specified.", - "type": "string", - "example": "FindSquaresJob" - }, - "maxRunDurationSeconds": { - "format": "int64", - "description": "Maximum allowed time for the run. The system will attempt to automatically cancel the run if it took longer than this value.\r\nMaxRunDurationSeconds=null means infinite duration.", - "type": "integer", - "example": "84000" - }, - "nodeCount": { - "format": "int32", - "description": "Number of compute nodes to run the job on. Only applies to AMLCompute.", - "type": "integer", - "example": "1" - }, - "environment": { - "$ref": "#/definitions/EnvironmentDefinition", - "description": "The environment definition, This field configures the python environment.\r\nIt can be configured to use an existing Python environment or configured to setup a temp environment for the experiment.\r\nThe definition is also responsible for setting the required application dependencies." - }, - "history": { - "$ref": "#/definitions/HistoryConfiguration", - "description": "This section is used to disable and enable experiment history logging features." - }, - "spark": { - "$ref": "#/definitions/SparkConfiguration", - "description": "When the platform is set to Pyspark, The spark configuration is used to set the default sparkconf for the submitted job." - }, - "tensorflow": { - "$ref": "#/definitions/TensorflowConfiguration", - "description": "The attribute is used to configure the distributed tensorflow parameters.\r\nThis attribute takes effect only when the framework is set to TensorFlow, and the communicator to ParameterServer.\r\nAmlCompute is the only supported compute for this configuration." - }, - "mpi": { - "$ref": "#/definitions/MpiConfiguration", - "description": "The attribute is used to configure the distributed MPI job parameters.\r\nThis attribute takes effect only when the framework is set to Python, and the communicator to OpenMpi or IntelMpi.\r\nAmlCompute is the only supported compute type for this configuration." - }, - "hdi": { - "$ref": "#/definitions/HdiConfiguration", - "description": "This attribute takes effect only when the target is set to an Azure HDI compute.\r\nThe HDI Configuration is used to set the YARN deployment mode. It is defaulted to cluster mode." - } - } - }, - "DataReferenceConfiguration": { - "description": "A class for managing DataReferenceConfiguration.", - "type": "object", - "properties": { - "dataStoreName": { - "description": "The name of the data store.", - "type": "string", - "example": "myblobstore" - }, - "mode": { - "description": "Operation on the datastore, mount, download, upload.", - "enum": [ - "Mount", - "Download", - "Upload" - ], - "type": "string", - "example": "Mount", - "x-ms-enum": { - "name": "DataStoreMode", - "modelAsString": false - } - }, - "pathOnDataStore": { - "description": "Relative path on the datastore.", - "type": "string", - "example": "/images/validation" - }, - "pathOnCompute": { - "description": "The path on the compute target.", - "type": "string" - }, - "overwrite": { - "description": "Whether to overwrite the data if existing.", - "type": "boolean" - } - } - }, - "EnvironmentDefinition": { - "type": "object", - "properties": { - "name": { - "description": "The name of the environment.", - "type": "string", - "example": "mydevenvironment" - }, - "version": { - "description": "The environment version.", - "type": "string", - "example": "1" - }, - "python": { - "$ref": "#/definitions/PythonSection", - "description": "Settings for a Python environment." - }, - "environmentVariables": { - "description": "Definition of environment variables to be defined in the environment.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "docker": { - "$ref": "#/definitions/DockerSection", - "description": "The definition of a Docker container." - }, - "spark": { - "$ref": "#/definitions/SparkSection", - "description": "The configuration for a Spark environment." - }, - "inferencingStackVersion": { - "description": "The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: \"latest\".", - "type": "string", - "example": "latest" - } - } - }, - "HistoryConfiguration": { - "type": "object", - "properties": { - "outputCollection": { - "description": "Set to true to collect outputs and store in run history.", - "type": "boolean" - }, - "directoriesToWatch": { - "description": "The list of directories to monitor and upload files from.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "example": "[\"logs\", \"outputs\"]" - } - } - }, - "SparkConfiguration": { - "type": "object", - "properties": { - "configuration": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "TensorflowConfiguration": { - "type": "object", - "properties": { - "workerCount": { - "format": "int32", - "description": "The number of workers.", - "type": "integer", - "example": "2" - }, - "parameterServerCount": { - "format": "int32", - "description": "Number of parameter servers.", - "type": "integer", - "example": "1" - } - } - }, - "MpiConfiguration": { - "type": "object", - "properties": { - "processCountPerNode": { - "format": "int32", - "description": "Number of processes per node.", - "type": "integer", - "example": "2" - } - } - }, - "HdiConfiguration": { - "type": "object", - "properties": { - "yarnDeployMode": { - "enum": [ - "None", - "Client", - "Cluster" - ], - "type": "string", - "x-ms-enum": { - "name": "YarnDeployMode", - "modelAsString": false - } - } - } - }, - "PythonSection": { - "type": "object", - "properties": { - "interpreterPath": { - "description": "The python interpreter path. This is only used when user_managed_dependencies=True.", - "type": "string" - }, - "userManagedDependencies": { - "description": "True means that AzureML reuses an existing python environment; False means that AzureML will create a python environment based on the Conda dependencies specification.", - "type": "boolean" - }, - "condaDependencies": { - "type": "object" - }, - "baseCondaEnvironment": { - "type": "string" - } - } - }, - "DockerSection": { - "type": "object", - "properties": { - "baseImage": { - "description": "Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile.", - "type": "string", - "example": "ubuntu:latest" - }, - "baseDockerfile": { - "description": "Base Dockerfile used for Docker-based runs. Mutually exclusive with BaseImage.", - "type": "string", - "example": "FROM ubuntu:latest\r\nRUN echo \"Hello world!\"" - }, - "enabled": { - "description": "Set true to perform this run inside a Docker container.", - "type": "boolean" - }, - "sharedVolumes": { - "description": "Set false to disable AzureML's usage of the Docker shared volumes feature to work around bugs in certain versions of Docker for Windows.", - "type": "boolean" - }, - "arguments": { - "description": "Extra arguments to the Docker run command.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "baseImageRegistry": { - "$ref": "#/definitions/ContainerRegistry", - "description": "Image registry that contains the base image." - } - } - }, - "SparkSection": { - "type": "object", - "properties": { - "repositories": { - "description": "The list of spark repositories.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "packages": { - "description": "The Spark packages to use.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/SparkMavenPackage" - } - }, - "precachePackages": { - "description": "Whether to precache the packages.", - "type": "boolean" - } - } - }, - "ContainerRegistry": { - "type": "object", - "properties": { - "address": { - "type": "string" - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "SparkMavenPackage": { - "type": "object", - "properties": { - "group": { - "type": "string" - }, - "artifact": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "StartRunResult": { - "description": "Contains the details of a run.", - "required": [ - "runId" - ], - "type": "object", - "properties": { - "runId": { - "description": "The identifier for a run.", - "type": "string", - "example": "myexperiment_155000000001_0" - } - } - }, - "ErrorResponse": { - "description": "The error response.", - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/RootError", - "description": "The top level error that occurred." - }, - "correlation": { - "description": "Dictionary containing correlation details for the error.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "environment": { - "description": "The hosting environment.", - "type": "string" - }, - "location": { - "description": "The Azure region.", - "type": "string" - }, - "time": { - "format": "date-time", - "description": "The time in UTC.", - "type": "string" - } - } - }, - "RootError": { - "description": "The root error.", - "type": "object", - "properties": { - "code": { - "description": "The service-defined error code. Supported error codes: ServiceError, UserError, ValidationError, AzureStorageError, TransientError, RequestThrottled.", - "type": "string" - }, - "message": { - "description": "A human-readable representation of the error.", - "type": "string" - }, - "target": { - "description": "The target of the error (e.g., the name of the property in error).", - "type": "string" - }, - "details": { - "description": "The related errors that occurred during the request.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ErrorDetails" - } - }, - "innerError": { - "$ref": "#/definitions/InnerErrorResponse", - "description": "A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand." - } - } - }, - "ErrorDetails": { - "description": "The error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string" - }, - "message": { - "description": "The error message.", - "type": "string" - }, - "target": { - "description": "The target of the error (e.g., the name of the property in error).", - "type": "string" - } - } - }, - "InnerErrorResponse": { - "description": "A nested structure of errors.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string" - }, - "innerError": { - "$ref": "#/definitions/InnerErrorResponse", - "description": "A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand." - } - } - } - }, - "parameters": { - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The Azure Subscription ID.", - "required": true, - "type": "string", - "format": "uuid", - "x-ms-parameter-location": "method" - }, - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The Name of the resource group in which the workspace is located.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "workspaceNameParameter": { - "name": "workspaceName", - "in": "path", - "description": "The name of the workspace.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "tags": [] -} diff --git a/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/hyperdrive.json b/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/hyperdrive.json deleted file mode 100644 index 59acaf4a4..000000000 --- a/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/hyperdrive.json +++ /dev/null @@ -1,585 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "HyperDrive REST API", - "version": "2019-09-30", - "title": "HyperDrive" - }, - "tags": [], - "schemes": [ - "https" - ], - "paths": { - "/hyperdrive/v1.0/{armScope}/runs": { - "post": { - "tags": [ - "HyperDriveExperiment" - ], - "summary": "Create an Experiment.", - "description": "Create a HyperDrive Experiment.", - "operationId": "HyperparameterTuning_CreateExperiment", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ArmScopeParameter" - }, - { - "in": "formData", - "name": "config", - "description": "The configuration file with experiment JSON content. A text file that is a JSON-serialized '#/definitions/HyperDriveCreateExperiment' object.", - "type": "file", - "required": true - } - ], - "responses": { - "201": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HyperDriveExperimentResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/HyperDriveErrorResponse" - } - } - }, - "x-ms-examples": { - "Create a HyperDrive experiment": { - "$ref": "./examples/createHyperDriveExperiment.json" - } - } - } - }, - "/hyperdrive/v1.0/{armScope}/runs/{runId}/cancel": { - "post": { - "tags": [ - "HyperDriveExperiment" - ], - "summary": "Cancel an Experiment.", - "description": "Cancel a HyperDrive Experiment.", - "operationId": "HyperparameterTuning_CancelExperiment", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ArmScopeParameter" - }, - { - "name": "runId", - "in": "path", - "description": "Hyperdrive run id to cancel.", - "required": true, - "type": "string" - }, - { - "in": "header", - "name": "RunHistoryHost", - "description": "The host for run location.", - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HyperDriveCancelExperimentResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/HyperDriveErrorResponse" - } - } - }, - "x-ms-examples": { - "Cancel a HyperDrive experiment": { - "$ref": "./examples/cancelHyperDriveExperiment.json" - } - } - } - } - }, - "definitions": { - "HyperDriveErrorResponse": { - "properties": { - "code": { - "format": "int32", - "type": "integer", - "description": "Error response code." - }, - "message": { - "type": "string", - "description": "Error message." - } - }, - "required": [ - "code", - "message" - ], - "type": "object", - "description": "Response in case of an error." - }, - "HyperDriveCancelExperimentResponse": { - "properties": { - "code": { - "format": "int32", - "type": "integer", - "description": "Response code." - }, - "result": { - "type": "string", - "description": "Message indicating operation success." - } - }, - "required": [ - "code", - "result" - ], - "type": "object", - "description": "Response for HyperDrive_CancelExperiment in case of success." - }, - "HyperDriveExperimentBase": { - "description": "Base object for both request and response of HyperDrive_CreateExperiment api.", - "properties": { - "description": { - "maxLength": 511, - "type": "string", - "x-nullable": true, - "description": "The description for Hyperdrive run." - }, - "generator_config": { - "description": "Hyperparameter space and the sampling method configuration.", - "properties": { - "name": { - "type": "string", - "enum": [ - "RANDOM", - "GRID", - "BAYESIANOPTIMIZATION" - ], - "description": "Hyperparameter sampling method.", - "x-ms-enum": { - "name": "Name", - "modelAsString": true - } - }, - "parameter_space": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": {}, - "minItems": 2, - "maxItems": 2, - "description": "The first element in the array is a string identifying the parameter expression type like choice, uniform etc. The second element is a parameter expressions corresponding to the type.\r\n Please refer to https://docs.microsoft.com/en-us/python/api/azureml-train-core/azureml.train.hyperdrive.parameter_expressions?view=azure-ml-py for a list of supported types and options for each type.\r\n choice parameters are specified as ['choice', [[1, 2, 3, 4]]]. randint is in format ['randint', [1]].\r\n uniform, loguniform, normal, lognormal are in format [expression type, [0.01, 0.05]].\r\n quniform, qloguniform, qnormal, qlognormal are in format [expression type, [0.01, 0.05, 3]].\r\n", - "example": [ - "choice", - [ - [ - 1, - 2, - 3, - 4 - ] - ] - ] - }, - "description": "Dictionary specifying hyperparameter space." - } - }, - "required": [ - "name", - "parameter_space" - ], - "type": "object" - }, - "max_concurrent_jobs": { - "format": "int32", - "maximum": 100, - "minimum": 1, - "type": "integer", - "description": "Maximum number of runs to run concurrently." - }, - "max_duration_minutes": { - "format": "int32", - "maximum": 43200, - "minimum": 1, - "type": "integer", - "description": "Maximum duration of the Hyperdrive run." - }, - "max_total_jobs": { - "format": "int32", - "maximum": 1000, - "minimum": 1, - "type": "integer", - "description": "Maximum number of runs." - }, - "name": { - "maxLength": 255, - "type": "string", - "description": "Name of the Hyperdrive run." - }, - "platform": { - "type": "string", - "enum": [ - "AML" - ], - "description": "Platform of the Hyperdrive run.", - "x-ms-enum": { - "name": "Platform", - "modelAsString": true - } - }, - "platform_config": { - "type": "object", - "description": "Platform config object specifying the run definition structure." - }, - "policy_config": { - "description": "Early termination policy configuration.", - "$ref": "#/definitions/HyperDrivePolicyConfigBase" - }, - "primary_metric_config": { - "description": "Name of the primary metric and goal of optimizing.", - "properties": { - "goal": { - "type": "string", - "enum": [ - "MAXIMIZE", - "MINIMIZE" - ], - "description": "Determines if the primary metric has to be minimized/maximized.", - "x-ms-enum": { - "name": "Goal", - "modelAsString": true - } - }, - "name": { - "type": "string", - "description": "Name of the primary metric reported by runs." - } - }, - "required": [ - "goal", - "name" - ], - "type": "object" - }, - "study_id": { - "format": "int32", - "minimum": 0, - "type": "integer", - "x-nullable": true, - "description": "Study Id of the Hyperdrive run." - } - }, - "required": [ - "generator_config", - "name", - "platform", - "platform_config", - "policy_config", - "primary_metric_config" - ], - "type": "object" - }, - "HyperDriveExperiment": { - "type": "object", - "description": "Part of response for HyperDrive_CreateExperiment in case of success. Contains details about the created hyperdrive run.", - "allOf": [ - { - "$ref": "#/definitions/HyperDriveExperimentBase" - }, - { - "type": "object", - "properties": { - "all_jobs_generated": { - "type": "boolean", - "description": "Indicates if all runs have been generated." - }, - "cancellation_requested": { - "type": "boolean", - "description": "Indicates if cancellation has been requested for this Hyperdrive run." - }, - "created": { - "format": "date-time", - "type": "string", - "description": "Hyperdrive run creation time." - }, - "created_by_user_id": { - "format": "int32", - "type": "integer", - "description": "Id of the user who created the Hyperdrive run." - }, - "experiment_id": { - "type": "string", - "description": "Hyperdrive run id." - }, - "experiment_uri": { - "type": "string", - "description": "Hyperdrive run Uri." - }, - "modified": { - "format": "date-time", - "type": "string", - "description": "Hyperdrive run modification time." - }, - "status": { - "type": "string", - "description": "Hyperdrive run status." - }, - "study_uri": { - "type": "string", - "description": "Study Uri of the Hyperdrive run." - }, - "hyperdrive_run_id": { - "type": "string", - "description": "Hyperdrive run id." - } - }, - "required": [ - "all_jobs_generated", - "cancellation_requested", - "created", - "created_by_user_id", - "experiment_id", - "modified", - "status", - "hyperdrive_run_id" - ] - } - ], - "properties": {} - }, - "HyperDriveCreateExperiment": { - "type": "object", - "description": "Part of request for HyperDrive_CreateExperiment. Contains configuration details required to create hyperdrive run.", - "allOf": [ - { - "$ref": "#/definitions/HyperDriveExperimentBase" - }, - { - "type": "object", - "properties": { - "user": { - "maxLength": 255, - "type": "string", - "description": "User who is creating the Hyperdrive run." - } - }, - "required": [ - "user" - ] - } - ], - "properties": {} - }, - "HyperDrivePolicyConfigBase": { - "description": "Early termination policy configuration.", - "properties": { - "name": { - "type": "string", - "enum": [ - "Default", - "Bandit", - "MedianStopping", - "TruncationSelection" - ], - "description": "Type of early termination policy.", - "x-ms-enum": { - "name": "Name", - "modelAsString": true - } - } - }, - "required": [ - "name" - ], - "type": "object", - "discriminator": "name" - }, - "HyperDriveDefaultPolicy": { - "type": "object", - "description": "No early termination is applied in the case of DefaultPolicy", - "allOf": [ - { - "$ref": "#/definitions/HyperDrivePolicyConfigBase" - } - ], - "properties": {}, - "x-ms-discriminator-value": "Default" - }, - "HyperDriveBanditPolicy": { - "type": "object", - "description": "Bandit Policy configuration. Please refer https://docs.microsoft.com/en-us/python/api/azureml-train-core/azureml.train.hyperdrive.banditpolicy?view=azure-ml-py for more information.", - "allOf": [ - { - "$ref": "#/definitions/HyperDrivePolicyConfigBase" - }, - { - "type": "object", - "properties": { - "properties": { - "type": "object", - "description": "Policy configuration properties.", - "properties": { - "evaluation_interval": { - "format": "int32", - "type": "integer", - "description": "Evaluation interval of the policy." - }, - "delay_evaluation": { - "format": "int32", - "type": "integer", - "description": "Value indicating the number of sequences for which the first evaluation is delayed." - }, - "slack_factor": { - "format": "float", - "type": "number", - "description": "Slack factor." - }, - "slack_amount": { - "format": "float", - "type": "number", - "description": "Slack amount." - } - } - } - } - } - ], - "properties": {}, - "x-ms-discriminator-value": "Bandit" - }, - "HyperDriveMedianStoppingPolicy": { - "type": "object", - "description": "Median stopping policy configuration. Please refer https://docs.microsoft.com/en-us/python/api/azureml-train-core/azureml.train.hyperdrive.medianstoppingpolicy?view=azure-ml-py for more information.", - "allOf": [ - { - "$ref": "#/definitions/HyperDrivePolicyConfigBase" - }, - { - "type": "object", - "properties": { - "properties": { - "type": "object", - "description": "Policy configuration properties.", - "properties": { - "evaluation_interval": { - "format": "int32", - "type": "integer", - "description": "Evaluation interval of the policy." - }, - "delay_evaluation": { - "format": "int32", - "type": "integer", - "description": "Value indicating the number of sequences for which the first evaluation is delayed." - } - } - } - } - } - ], - "properties": {}, - "x-ms-discriminator-value": "MedianStopping" - }, - "HyperDriveTruncationSelectionPolicy": { - "type": "object", - "description": "Truncation selection policy configuration. Please refer https://docs.microsoft.com/en-us/python/api/azureml-train-core/azureml.train.hyperdrive.truncationselectionpolicy?view=azure-ml-py for more information.", - "allOf": [ - { - "$ref": "#/definitions/HyperDrivePolicyConfigBase" - }, - { - "type": "object", - "properties": { - "properties": { - "type": "object", - "description": "Policy configuration properties.", - "properties": { - "evaluation_interval": { - "format": "int32", - "type": "integer", - "description": "Evaluation interval of the policy." - }, - "delay_evaluation": { - "format": "int32", - "type": "integer", - "description": "Value indicating the number of sequences for which the first evaluation is delayed." - }, - "truncation_percentage": { - "format": "int32", - "type": "integer", - "description": "Truncation percentage value." - }, - "exclude_finished_jobs": { - "type": "boolean", - "description": "Boolean indicating if metrics from finished jobs should be excluded in the policy decision process." - } - } - } - } - } - ], - "properties": {}, - "x-ms-discriminator-value": "TruncationSelection" - }, - "HyperDriveExperimentResponse": { - "description": "Response for HyperDrive_CreateExperiment in case of success.", - "properties": { - "code": { - "format": "int32", - "type": "integer", - "description": "Response code." - }, - "result": { - "description": "Details about created Hyperdrive run.", - "$ref": "#/definitions/HyperDriveExperiment" - } - }, - "required": [ - "code", - "result" - ], - "type": "object" - } - }, - "parameters": { - "ArmScopeParameter": { - "name": "armScope", - "in": "path", - "description": "The ARM scope passed in through URL with format:\r\n subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}.\r\n", - "required": true, - "type": "string", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/modelManagement.json b/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/modelManagement.json deleted file mode 100644 index bbc288a35..000000000 --- a/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/modelManagement.json +++ /dev/null @@ -1,3603 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2019-09-30", - "title": "Azure Machine Learning Model Management Service", - "description": "These APIs allow end users to manage Azure Machine Learning Models, Images, Profiles, and Services." - }, - "paths": { - "/modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/assets": { - "get": { - "tags": [ - "Asset" - ], - "summary": "Query the list of Assets in a workspace.", - "description": "If no filter is passed, the query lists all the Assets in the given workspace. The returned list is paginated and the count of items in each page is an optional parameter.", - "operationId": "Assets_ListQuery", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "runId", - "in": "query", - "description": "The run Id associated with the Assets.", - "required": false, - "type": "string" - }, - { - "name": "name", - "in": "query", - "description": "The object name.", - "required": false, - "type": "string" - }, - { - "name": "count", - "in": "query", - "description": "The number of items to retrieve in a page.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$skipToken", - "in": "query", - "description": "The continuation token to retrieve the next page.", - "required": false, - "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "A set of tags with which to filter the returned models.\r\n It is a comma separated string of tags key or tags key=value\r\n Example: tagKey1,tagKey2,tagKey3=value3", - "required": false, - "type": "string" - }, - { - "name": "properties", - "in": "query", - "description": "A set of properties with which to filter the returned models.\r\n It is a comma separated string of properties key and/or properties key=value\r\n Example: propKey1,propKey2,propKey3=value3", - "required": false, - "type": "string" - }, - { - "name": "orderby", - "in": "query", - "description": "An option for specifying how to order the list.", - "required": false, - "type": "string", - "default": "CreatedAtDesc", - "enum": [ - "CreatedAtDesc", - "CreatedAtAsc", - "UpdatedAtDesc", - "UpdatedAtAsc" - ] - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedAssetList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - }, - "post": { - "tags": [ - "Asset" - ], - "summary": "Create an Asset.", - "description": "Create an Asset from the provided payload.", - "operationId": "Assets_Create", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "asset", - "in": "body", - "description": "The Asset to be created.", - "required": false, - "schema": { - "$ref": "#/definitions/Asset" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Asset" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - } - }, - "/modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/assets/{id}": { - "get": { - "tags": [ - "Asset" - ], - "summary": "Get an Asset.", - "description": "Get an Asset by Id.", - "operationId": "Assets_QueryById", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The Asset Id.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Asset" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Asset" - ], - "summary": "Delete an Asset.", - "description": "Delete the specified Asset.", - "operationId": "Assets_Delete", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The Id of the Asset to delete.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The resource exists and was deleted successfully." - }, - "204": { - "description": "The resource does not exist and the request was well formed." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Asset" - ], - "summary": "Update an Asset.", - "description": "Patch a specific Asset.", - "operationId": "Assets_Patch", - "consumes": [ - "application/json-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The Id of the Asset to patch.", - "required": true, - "type": "string" - }, - { - "name": "patch", - "in": "body", - "description": "The payload that is used to patch an Asset.", - "required": true, - "schema": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/JsonPatchOperation" - } - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Asset" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - } - }, - "/modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/models/{id}": { - "get": { - "tags": [ - "Model" - ], - "summary": "Gets a model.", - "description": "Gets a model by model id.", - "operationId": "MLModels_QueryById", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The model id.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Model" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Model" - ], - "summary": "Delete the specified Model.", - "description": "Deletes a model if it exists.", - "operationId": "MLModels_Delete", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The model id.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The resource exists and was deleted successfully." - }, - "204": { - "description": "The resource does not exist and the request was well formed." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Model" - ], - "summary": "Patch a specific model.", - "description": "Updates an existing model with the specified patch.", - "operationId": "MLModels_Patch", - "consumes": [ - "application/json-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The model id.", - "required": true, - "type": "string" - }, - { - "name": "patch", - "in": "body", - "description": "The payload that is used to patch the model.", - "required": true, - "schema": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/JsonPatchOperation" - } - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Model" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - } - }, - "/modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/models": { - "get": { - "tags": [ - "Model" - ], - "summary": "Query the list of Models in a workspace.", - "description": "The result list can be filtered using tag and name. If no filter is passed, the query lists all the Models in the given workspace. The returned list is paginated and the count of items in each page is an optional parameter.", - "operationId": "MLModels_ListQuery", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "name", - "in": "query", - "description": "The object name.", - "required": false, - "type": "string" - }, - { - "name": "framework", - "in": "query", - "description": "The framework.", - "required": false, - "type": "string" - }, - { - "name": "description", - "in": "query", - "description": "The object description.", - "required": false, - "type": "string" - }, - { - "name": "count", - "in": "query", - "description": "The number of items to retrieve in a page.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$skipToken", - "in": "query", - "description": "The continuation token to retrieve the next page.", - "required": false, - "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "A set of tags with which to filter the returned models.\r\n It is a comma separated string of tags key or tags key=value\r\n Example: tagKey1,tagKey2,tagKey3=value3", - "required": false, - "type": "string" - }, - { - "name": "properties", - "in": "query", - "description": "A set of properties with which to filter the returned models.\r\n It is a comma separated string of properties key and/or properties key=value\r\n Example: propKey1,propKey2,propKey3=value3", - "required": false, - "type": "string" - }, - { - "name": "runId", - "in": "query", - "description": "The runId which created the model.", - "required": false, - "type": "string" - }, - { - "name": "orderBy", - "in": "query", - "description": "An option to specify how the models are ordered in the response.", - "required": false, - "type": "string", - "default": "CreatedAtDesc", - "enum": [ - "CreatedAtDesc", - "CreatedAtAsc", - "UpdatedAtDesc", - "UpdatedAtAsc" - ] - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedModelList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - }, - "post": { - "tags": [ - "Model" - ], - "summary": "Register a model.", - "description": "Register the model provided.", - "operationId": "MLModels_Register", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "model", - "in": "body", - "description": "The payload that is used to register the model.", - "required": true, - "schema": { - "$ref": "#/definitions/Model" - } - } - ], - "responses": { - "200": { - "description": "The model registration was successful.", - "schema": { - "$ref": "#/definitions/Model" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - } - }, - "/modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/models/{id}/metrics": { - "get": { - "tags": [ - "Model" - ], - "summary": "Retrieve the metrics for a Model.", - "description": "The operational events collected for the Model are returned.", - "operationId": "MLModels_GetMetrics", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The Model Id.", - "required": true, - "type": "string" - }, - { - "name": "startDate", - "in": "query", - "description": "The start date from which to retrieve metrics, ISO 8601 literal format.", - "required": false, - "type": "string" - }, - { - "name": "endDate", - "in": "query", - "description": "The end date from which to retrieve metrics, ISO 8601 literal format.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ModelOperationalState" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - } - }, - "/modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/operations/{id}": { - "get": { - "tags": [ - "Operations" - ], - "summary": "Get the status of an async operation.", - "description": "Get the status of an async operation by operation id.", - "operationId": "Operations_Get", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The operation id.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AsyncOperationStatus" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - } - }, - "/modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/images/{imageId}/profiles/{id}": { - "get": { - "tags": [ - "Profile" - ], - "summary": "Get a Profile.", - "description": "Get the Profile for an Image.", - "operationId": "Profiles_QueryById", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "imageId", - "in": "path", - "description": "The Image Id.", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "The Profile Id.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ProfileResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - } - }, - "/modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/images/{imageId}/profiles": { - "get": { - "tags": [ - "Profile" - ], - "summary": "Get a list of Image Profiles.", - "description": "If no filter is passed, the query lists all Profiles for the Image. The returned list is paginated and the count of items in each page is an optional parameter.", - "operationId": "Profiles_ListQuery", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "imageId", - "in": "path", - "description": "The Image Id.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "query", - "description": "The Profile name.", - "required": false, - "type": "string" - }, - { - "name": "description", - "in": "query", - "description": "The Profile description.", - "required": false, - "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "A set of tags with which to filter the returned models.\r\n It is a comma separated string of tags key or tags key=value\r\n Example: tagKey1,tagKey2,tagKey3=value3", - "required": false, - "type": "string" - }, - { - "name": "properties", - "in": "query", - "description": "A set of properties with which to filter the returned models.\r\n It is a comma separated string of properties key and/or properties key=value\r\n Example: propKey1,propKey2,propKey3=value3", - "required": false, - "type": "string" - }, - { - "name": "count", - "in": "query", - "description": "The number of items to retrieve in a page.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$skipToken", - "in": "query", - "description": "The continuation token to retrieve the next page.", - "required": false, - "type": "string" - }, - { - "name": "orderBy", - "in": "query", - "description": "The option to order the response.", - "required": false, - "type": "string", - "default": "CreatedAtDesc", - "enum": [ - "CreatedAtDesc", - "CreatedAtAsc", - "UpdatedAtDesc", - "UpdatedAtAsc" - ] - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedProfileResponseList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - }, - "post": { - "tags": [ - "Profile" - ], - "summary": "Create a Profile.", - "description": "Create a Profile for an Image.", - "operationId": "Profiles_Create", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "imageId", - "in": "path", - "description": "The Image Id.", - "required": true, - "type": "string" - }, - { - "name": "inputRequest", - "in": "body", - "description": "The payload that is used to create the Profile.", - "required": true, - "schema": { - "$ref": "#/definitions/ProfileRequestBase" - } - } - ], - "responses": { - "202": { - "description": "The request was accepted. The header 'Operation-Location' contains the async operation location URL. Accessing this URL with a GET call will return the status of the background task." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - } - }, - "/modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services/{id}": { - "get": { - "tags": [ - "Service" - ], - "summary": "Get a Service.", - "description": "Get a Service by Id.", - "operationId": "Services_QueryById", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The Service Id.", - "required": true, - "type": "string" - }, - { - "name": "expand", - "in": "query", - "description": "Set to True to include Model details.", - "required": false, - "type": "boolean", - "default": false - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ServiceResponseBase" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Service" - ], - "summary": "Delete a Service.", - "description": "Delete a specific Service.", - "operationId": "Services_Delete", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The Service Id.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The resource exists and was deleted successfully." - }, - "202": { - "description": "Success" - }, - "204": { - "description": "The resource does not exist and the request was well formed." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Service" - ], - "summary": "Patch a Service.", - "description": "Patch a specific Service.", - "operationId": "Services_Patch", - "consumes": [ - "application/json-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The Service Id.", - "required": true, - "type": "string" - }, - { - "name": "patch", - "in": "body", - "description": "The payload that is used to patch the Service.", - "required": true, - "schema": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/JsonPatchOperation" - } - } - } - ], - "responses": { - "200": { - "description": "Success" - }, - "202": { - "description": "The request was accepted. The header 'Operation-Location' contains the async operation location URL. Accessing this URL with a GET call will return the status of the background task." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - } - }, - "/modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services": { - "get": { - "tags": [ - "Service" - ], - "summary": "Query the list of Services in a Workspace.", - "description": "If no filter is passed, the query lists all Services in the Workspace. The returned list is paginated and the count of item in each page is an optional parameter.", - "operationId": "Services_ListQuery", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "imageId", - "in": "query", - "description": "The Image Id.", - "required": false, - "type": "string" - }, - { - "name": "imageName", - "in": "query", - "description": "The Image name.", - "required": false, - "type": "string" - }, - { - "name": "modelId", - "in": "query", - "description": "The Model Id.", - "required": false, - "type": "string" - }, - { - "name": "modelName", - "in": "query", - "description": "The Model name.", - "required": false, - "type": "string" - }, - { - "name": "name", - "in": "query", - "description": "The object name.", - "required": false, - "type": "string" - }, - { - "name": "count", - "in": "query", - "description": "The number of items to retrieve in a page.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "computeType", - "in": "query", - "description": "The compute environment type.", - "required": false, - "type": "string" - }, - { - "name": "$skipToken", - "in": "query", - "description": "The continuation token to retrieve the next page.", - "required": false, - "type": "string" - }, - { - "name": "tags", - "in": "query", - "description": "A set of tags with which to filter the returned models.\r\n It is a comma separated string of tags key or tags key=value\r\n Example: tagKey1,tagKey2,tagKey3=value3", - "required": false, - "type": "string" - }, - { - "name": "properties", - "in": "query", - "description": "A set of properties with which to filter the returned models.\r\n It is a comma separated string of properties key and/or properties key=value\r\n Example: propKey1,propKey2,propKey3=value3", - "required": false, - "type": "string" - }, - { - "name": "expand", - "in": "query", - "description": "Set to True to include Model details.", - "required": false, - "type": "boolean", - "default": false - }, - { - "name": "orderby", - "in": "query", - "description": "The option to order the response.", - "required": false, - "type": "string", - "default": "UpdatedAtDesc", - "enum": [ - "CreatedAtDesc", - "CreatedAtAsc", - "UpdatedAtDesc", - "UpdatedAtAsc" - ] - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedServiceList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - }, - "post": { - "tags": [ - "Service" - ], - "summary": "Create a Service.", - "description": "Create a Service with the specified payload.", - "operationId": "Services_Create", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "request", - "in": "body", - "description": "The payload that is used to create the Service.", - "required": true, - "schema": { - "$ref": "#/definitions/CreateServiceRequest" - } - } - ], - "responses": { - "202": { - "description": "The request was accepted. The header 'Operation-Location' contains the async operation location URL. Accessing this URL with a GET call will return the status of the background task." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - } - }, - "/modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services/{id}/listkeys": { - "post": { - "tags": [ - "Service", - "Keys" - ], - "summary": "Lists Service keys.", - "description": "Gets a list of Service keys.", - "operationId": "Services_ListServiceKeys", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The Service Id.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AuthKeys" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - } - }, - "/modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services/{id}/regenerateKeys": { - "post": { - "tags": [ - "Service", - "Keys" - ], - "summary": "Regenerate Service Keys.", - "description": "Regenerate and return the Service keys.", - "operationId": "Services_RegenerateServiceKeys", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The Service Id.", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "The payload that is used to regenerate keys.", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateServiceKeysRequest" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AuthKeys" - } - }, - "202": { - "description": "The request was accepted. The header 'Operation-Location' contains the async operation location URL. Accessing this URL with a GET call will return the status of the background task." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - } - }, - "/modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services/{id}/token": { - "post": { - "tags": [ - "Service", - "Token" - ], - "summary": "Generate Service Access Token.", - "description": "Gets access token that can be used for calling service.", - "operationId": "Services_GetServiceToken", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupParameter" - }, - { - "$ref": "#/parameters/workspaceParameter" - }, - { - "name": "id", - "in": "path", - "description": "The Service Id.", - "required": true, - "type": "string" - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AuthToken" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ModelErrorResponse" - } - } - } - } - } - }, - "definitions": { - "Asset": { - "description": "The Asset definition.", - "required": [ - "name" - ], - "type": "object", - "properties": { - "id": { - "description": "The Asset Id.", - "type": "string" - }, - "name": { - "description": "The name of the Asset.", - "type": "string" - }, - "description": { - "description": "The Asset description.", - "type": "string" - }, - "artifacts": { - "description": "A list of child artifacts.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ArtifactDetails" - } - }, - "kvTags": { - "description": "The Asset tag dictionary. Tags are mutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "description": "The Asset property dictionary. Properties are immutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "runid": { - "description": "The RunId associated with this Asset.", - "type": "string" - }, - "meta": { - "description": "A dictionary containing metadata about the Asset.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "createdTime": { - "format": "date-time", - "description": "The time the Asset was created in UTC.", - "type": "string", - "readOnly": true - } - } - }, - "ArtifactDetails": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "prefix": { - "type": "string" - } - } - }, - "PaginatedAssetList": { - "description": "A paginated list of Assets.", - "type": "object", - "properties": { - "value": { - "description": "An array of objects of type Asset.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Asset" - } - }, - "nextLink": { - "description": "A continuation link (absolute URI) to the next page of results in the list.", - "type": "string" - } - } - }, - "JsonPatchOperation": { - "description": "The Json Patch definition.", - "type": "object", - "properties": { - "value": { - "description": "The value.", - "type": "object" - }, - "path": { - "description": "The target location.", - "type": "string" - }, - "op": { - "description": "The operation.", - "type": "string" - }, - "from": { - "description": "The source location.", - "type": "string" - } - } - }, - "Model": { - "description": "An Azure Machine Learning Model.", - "required": [ - "name", - "url", - "mimeType" - ], - "type": "object", - "properties": { - "id": { - "description": "The Model Id.", - "type": "string", - "example": "sklearn_mnist:1" - }, - "name": { - "description": "The Model name.", - "type": "string", - "example": "sklearn_mnist" - }, - "framework": { - "description": "The Model framework.", - "type": "string" - }, - "frameworkVersion": { - "description": "The Model framework version.", - "type": "string" - }, - "version": { - "format": "int64", - "description": "The Model version assigned by Model Management Service.", - "type": "integer", - "example": "1" - }, - "datasets": { - "description": "The list of datasets associated with the model.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/DatasetReference" - } - }, - "url": { - "description": "The URL of the Model. Usually a SAS URL.", - "type": "string" - }, - "mimeType": { - "description": "The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml", - "type": "string" - }, - "description": { - "description": "The Model description text.", - "type": "string", - "example": "A mnist model, first version." - }, - "createdTime": { - "format": "date-time", - "description": "The Model creation time (UTC).", - "type": "string", - "readOnly": true - }, - "modifiedTime": { - "format": "date-time", - "description": "The Model last modified time (UTC).", - "type": "string", - "readOnly": true - }, - "unpack": { - "description": "Indicates whether we need to unpack the Model during docker Image creation.", - "type": "boolean" - }, - "parentModelId": { - "description": "The Parent Model Id.", - "type": "string", - "example": "sklearn_mnist_root:1" - }, - "runId": { - "description": "The RunId that created this model.", - "type": "string" - }, - "experimentName": { - "description": "The name of the experiment where this model was created.", - "type": "string" - }, - "kvTags": { - "description": "The Model tag dictionary. Items are mutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "description": "The Model property dictionary. Properties are immutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "DatasetReference": { - "description": "The dataset reference object.", - "type": "object", - "properties": { - "name": { - "description": "The name of the dataset reference.", - "type": "string" - }, - "id": { - "description": "The id of the dataset reference.", - "type": "string" - } - } - }, - "PaginatedModelList": { - "description": "A paginated list of Models.", - "type": "object", - "properties": { - "value": { - "description": "An array of objects of type Model.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Model" - } - }, - "nextLink": { - "description": "A continuation link (absolute URI) to the next page of results in the list.", - "type": "string" - } - } - }, - "ModelOperationalState": { - "description": "The operational state of the Model.", - "type": "object", - "properties": { - "deploymentSummary": { - "$ref": "#/definitions/DeploymentSummary", - "description": "The summary of the deployment." - }, - "endTime": { - "description": "The deployment end time.", - "type": "string" - }, - "startTime": { - "description": "The deployment start time.", - "type": "string" - } - } - }, - "DeploymentSummary": { - "description": "The deployment summary.", - "type": "object", - "properties": { - "successfulDeployments": { - "format": "int32", - "description": "The number of successful deployments.", - "type": "integer" - }, - "unsuccessfulDeployments": { - "format": "int32", - "description": "The number of unsuccessful deployments.", - "type": "integer" - } - } - }, - "AsyncOperationStatus": { - "description": "The async operation status.", - "type": "object", - "properties": { - "id": { - "description": "The async operation id.", - "type": "string" - }, - "operationType": { - "description": "The async operation type.", - "type": "string" - }, - "state": { - "description": "The async operation state.", - "enum": [ - "NotStarted", - "Running", - "Cancelled", - "Succeeded", - "Failed", - "TimedOut" - ], - "type": "string", - "x-ms-enum": { - "name": "AsyncOperationState", - "modelAsString": false - } - }, - "createdTime": { - "format": "date-time", - "description": "The async operation creation time (UTC).", - "type": "string" - }, - "endTime": { - "format": "date-time", - "description": "The async operation end time (UTC)l", - "type": "string" - }, - "error": { - "$ref": "#/definitions/ModelErrorResponse", - "description": "The error details." - }, - "resourceLocation": { - "description": "The resource created/updated by the async operation.", - "type": "string" - }, - "operationLog": { - "description": "The async operation log.", - "type": "string" - }, - "operationDetails": { - "$ref": "#/definitions/AsyncOperationDetails", - "description": "The async operation details." - }, - "parentRequestId": { - "description": "The request id that created this operation", - "type": "string" - } - } - }, - "ModelErrorResponse": { - "description": "The Model Management Service Error object.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string" - }, - "statusCode": { - "format": "int32", - "description": "The HTTP status code.", - "type": "integer" - }, - "message": { - "description": "The error message.", - "type": "string" - }, - "details": { - "description": "An array of error detail objects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ErrorDetails" - } - } - } - }, - "AsyncOperationDetails": { - "description": "The async operation details.", - "type": "object", - "properties": { - "subOperationType": { - "description": "The suboperation type.", - "type": "string" - }, - "subOperationState": { - "description": "The suboperation state.", - "type": "string" - } - } - }, - "ErrorDetails": { - "description": "The error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string" - }, - "message": { - "description": "The error message.", - "type": "string" - }, - "target": { - "description": "The target of the error (e.g., the name of the property in error).", - "type": "string" - } - } - }, - "ProfileResponse": { - "description": "The profile response.", - "type": "object", - "properties": { - "name": { - "description": "The profile name.", - "type": "string" - }, - "description": { - "description": "The profile description.", - "type": "string" - }, - "imageId": { - "description": "The Image Id.", - "type": "string" - }, - "inputData": { - "description": "The input data.", - "type": "string" - }, - "state": { - "description": "The state of the profile.", - "type": "string" - }, - "createdTime": { - "format": "date-time", - "description": "The profile creation time (UTC).", - "type": "string" - }, - "kvTags": { - "description": "The profile tags dictionary. Tags are mutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "description": "The profile properties dictionary. Properties are immutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "recommendedMemoryInGB": { - "format": "double", - "description": "The recommended amount of memory to allocate in GB.", - "type": "number" - }, - "recommendedCpu": { - "format": "double", - "description": "The recommended CPU allocation.", - "type": "number" - }, - "recommendationLatencyInMs": { - "format": "double", - "description": "Latency associated with the recommended memory/cpu config", - "type": "number" - }, - "profileRunResult": { - "description": "The profile run result.", - "type": "string" - }, - "error": { - "$ref": "#/definitions/ModelErrorResponse", - "description": "The error details." - }, - "profilingErrorLogs": { - "description": "The profiling error logs.", - "type": "string" - } - } - }, - "PaginatedProfileResponseList": { - "description": "A paginated list of ProfileResponses.", - "type": "object", - "properties": { - "value": { - "description": "An array of objects of type ProfileResponse.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ProfileResponse" - } - }, - "nextLink": { - "description": "A continuation link (absolute URI) to the next page of results in the list.", - "type": "string" - } - } - }, - "ProfileRequestBase": { - "description": "The request for creating a profile.", - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The profile name.", - "type": "string" - }, - "description": { - "description": "The profile description.", - "type": "string" - }, - "inputData": { - "description": "The profile input data.", - "type": "string" - }, - "kvTags": { - "description": "The tags dictionary.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "description": "The properties dictionary.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "ServiceResponseBase": { - "description": "The base service response. The correct inherited response based on computeType will be returned (ex. ACIServiceResponse)", - "required": [ - "computeType" - ], - "type": "object", - "properties": { - "id": { - "description": "The service Id.", - "type": "string" - }, - "name": { - "description": "The service name.", - "type": "string" - }, - "description": { - "description": "The service description.", - "type": "string" - }, - "kvTags": { - "description": "The service tag dictionary. Tags are mutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "description": "The service property dictionary. Properties are immutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "operationId": { - "description": "The ID of the latest asynchronous operation for this service.", - "type": "string" - }, - "state": { - "description": "The current state of the service.", - "enum": [ - "Transitioning", - "Healthy", - "Unhealthy", - "Failed" - ], - "type": "string", - "example": "Healthy", - "x-ms-enum": { - "name": "WebServiceState", - "modelAsString": false - } - }, - "createdTime": { - "format": "date-time", - "description": "The time the service was created.", - "type": "string" - }, - "updatedTime": { - "format": "date-time", - "description": "The time the service was updated.", - "type": "string" - }, - "error": { - "$ref": "#/definitions/ModelErrorResponse", - "description": "The error details." - }, - "computeType": { - "description": "The compute environment type for the service.", - "enum": [ - "ACI", - "AKS", - "AMLCOMPUTE", - "IOT", - "AKSENDPOINT", - "UNKNOWN" - ], - "type": "string", - "example": "AKS", - "x-ms-enum": { - "name": "ComputeEnvironmentType", - "modelAsString": false - } - }, - "deploymentType": { - "description": "The deployment type for the service.", - "enum": [ - "GRPCRealtimeEndpoint", - "HttpRealtimeEndpoint", - "Batch" - ], - "type": "string", - "example": "HttpRealtimeEndpoint", - "x-ms-enum": { - "name": "DeploymentType", - "modelAsString": false - } - } - }, - "discriminator": "computeType" - }, - "PaginatedServiceList": { - "description": "A paginated list of Services.", - "type": "object", - "properties": { - "value": { - "description": "An array of objects of type Service.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ServiceResponseBase" - } - }, - "nextLink": { - "description": "A continuation link (absolute URI) to the next page of results in the list.", - "type": "string" - } - } - }, - "CreateServiceRequest": { - "description": "The base class for creating a service.", - "required": [ - "name", - "computeType" - ], - "type": "object", - "properties": { - "name": { - "description": "The service name.", - "type": "string" - }, - "description": { - "description": "The description of the service.", - "type": "string" - }, - "kvTags": { - "description": "The service tag dictionary. Tags are mutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "description": "The service properties dictionary. Properties are immutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "keys": { - "$ref": "#/definitions/AuthKeys", - "description": "The authentication keys." - }, - "computeType": { - "description": "The compute environment type for the service.", - "enum": [ - "ACI", - "AKS", - "AMLCOMPUTE", - "IOT", - "AKSENDPOINT", - "UNKNOWN" - ], - "type": "string", - "example": "AKS", - "x-ms-enum": { - "name": "ComputeEnvironmentType", - "modelAsString": false - } - }, - "deploymentType": { - "description": "The deployment type for the service.", - "enum": [ - "GRPCRealtimeEndpoint", - "HttpRealtimeEndpoint", - "Batch" - ], - "type": "string", - "example": "HttpRealtimeEndpoint", - "x-ms-enum": { - "name": "DeploymentType", - "modelAsString": false - } - }, - "imageId": { - "description": "The Image Id.", - "type": "string" - }, - "environmentImageRequest": { - "$ref": "#/definitions/EnvironmentImageRequest", - "description": "The Environment, models and assets needed for inferencing." - }, - "location": { - "description": "The location of the service.", - "type": "string" - } - }, - "discriminator": "computeType" - }, - "AuthKeys": { - "type": "object", - "properties": { - "primaryKey": { - "description": "The primary key.", - "type": "string" - }, - "secondaryKey": { - "description": "The secondary key.", - "type": "string" - } - } - }, - "ACIServiceResponse": { - "description": "The response for an ACI service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceResponseBase" - }, - { - "type": "object", - "properties": { - "containerResourceRequirements": { - "$ref": "#/definitions/ContainerResourceRequirements", - "description": "The container resource requirements." - }, - "imageId": { - "description": "The Id of the Image.", - "type": "string" - }, - "imageDetails": { - "$ref": "#/definitions/DockerImageResponse", - "description": "The Image details." - }, - "scoringUri": { - "description": "The Uri for sending scoring requests.", - "type": "string" - }, - "location": { - "description": "The location of the service.", - "type": "string" - }, - "authEnabled": { - "description": "Whether or not authentication is enabled on the service.", - "type": "boolean" - }, - "sslEnabled": { - "description": "Whether or not SSL is enabled.", - "type": "boolean" - }, - "appInsightsEnabled": { - "description": "Whether or not Application Insights is enabled.", - "type": "boolean" - }, - "dataCollection": { - "$ref": "#/definitions/ModelDataCollection", - "description": "Details of the data collection options specified." - }, - "sslCertificate": { - "description": "The SSL certificate to use if SSL is enabled.", - "type": "string" - }, - "sslKey": { - "description": "The SSL key for the certificate.", - "type": "string" - }, - "cname": { - "description": "The CName for the service.", - "type": "string" - }, - "publicIp": { - "description": "The public IP address for the service.", - "type": "string" - }, - "publicFqdn": { - "description": "The public Fqdn for the service.", - "type": "string" - }, - "swaggerUri": { - "description": "The Uri for sending swagger requests.", - "type": "string" - }, - "modelConfigMap": { - "description": "Details on the models and configurations.", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "environment": { - "$ref": "#/definitions/ModelEnvironmentDefinition", - "description": "Details on the Environment." - }, - "models": { - "description": "The list of models.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Model" - } - } - } - } - ], - "properties": {}, - "x-ms-discriminator-value": "ACI" - }, - "EnvironmentImageRequest": { - "description": "Request to create a Docker image based on Environment.", - "type": "object", - "properties": { - "driverProgram": { - "description": "The name of the driver file.", - "type": "string" - }, - "assets": { - "description": "The list of assets.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentImageAsset" - } - }, - "modelIds": { - "description": "The list of model Ids.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "example": "[mymodel:1, mymodel:2]" - }, - "environment": { - "$ref": "#/definitions/ModelEnvironmentDefinition", - "description": "The details of the AZURE ML environment." - } - } - }, - "EnvironmentImageAsset": { - "description": "An Image asset.", - "type": "object", - "properties": { - "id": { - "description": "The Asset Id.", - "type": "string" - }, - "mimeType": { - "description": "The mime type.", - "type": "string" - }, - "url": { - "description": "The Url of the Asset.", - "type": "string" - }, - "unpack": { - "description": "Whether the Asset is unpacked.", - "type": "boolean" - } - } - }, - "ModelEnvironmentDefinition": { - "type": "object", - "properties": { - "name": { - "description": "The name of the environment.", - "type": "string", - "example": "mydevenvironment" - }, - "version": { - "description": "The environment version.", - "type": "string", - "example": "1" - }, - "python": { - "$ref": "#/definitions/ModelPythonSection", - "description": "Settings for a Python environment." - }, - "environmentVariables": { - "description": "Definition of environment variables to be defined in the environment.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "docker": { - "$ref": "#/definitions/ModelDockerSection", - "description": "The definition of a Docker container." - }, - "spark": { - "$ref": "#/definitions/ModelSparkSection", - "description": "The configuration for a Spark environment." - }, - "inferencingStackVersion": { - "description": "The Inferencing stack version.", - "type": "string", - "example": "latest" - } - } - }, - "ModelPythonSection": { - "type": "object", - "properties": { - "interpreterPath": { - "description": "The python interpreter path. This is only used when user_managed_dependencies=True.", - "type": "string" - }, - "userManagedDependencies": { - "description": "True means that AzureML reuses an existing python environment; False means that AzureML will create a python environment based on the Conda dependencies specification.", - "type": "boolean" - }, - "condaDependencies": { - "type": "object" - }, - "baseCondaEnvironment": { - "type": "string" - } - } - }, - "ModelDockerSection": { - "type": "object", - "properties": { - "baseImage": { - "description": "Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile.", - "type": "string", - "example": "ubuntu:latest" - }, - "baseDockerfile": { - "description": "Base Dockerfile used for Docker-based runs. Mutually exclusive with BaseImage.", - "type": "string", - "example": "FROM ubuntu:latest\r\nRUN echo \"Hello world!\"" - }, - "enabled": { - "description": "Set True to perform this run inside a Docker container.", - "type": "boolean", - "example": "True" - }, - "sharedVolumes": { - "description": "Set False if necessary to work around shared volume bugs on Windows.", - "type": "boolean", - "example": "True" - }, - "gpuSupport": { - "description": "Run with NVidia Docker extension to support GPUs.", - "type": "boolean", - "example": "False" - }, - "shmSize": { - "description": "The shared memory size setting for NVidia GPUs.", - "type": "string", - "example": "1g" - }, - "arguments": { - "description": "Extra arguments to the Docker run command.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "baseImageRegistry": { - "$ref": "#/definitions/ContainerRegistry", - "description": "Image registry that contains the base image." - } - } - }, - "ModelSparkSection": { - "type": "object", - "properties": { - "repositories": { - "description": "The list of spark repositories.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "packages": { - "description": "The Spark packages to use.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/SparkMavenPackage" - } - }, - "precachePackages": { - "description": "Whether to precache the packages.", - "type": "boolean", - "example": "True" - } - } - }, - "ContainerRegistry": { - "type": "object", - "properties": { - "address": { - "type": "string" - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "SparkMavenPackage": { - "type": "object", - "properties": { - "group": { - "type": "string" - }, - "artifact": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "RegenerateServiceKeysRequest": { - "type": "object", - "properties": { - "keyType": { - "format": "int32", - "description": "Specification for which type of key to generate.", - "enum": [ - "Primary", - "Secondary" - ], - "type": "integer", - "example": "Primary", - "x-ms-enum": { - "name": "KeyType", - "modelAsString": false - } - }, - "keyValue": { - "description": "The value the key is set to.", - "type": "string" - } - } - }, - "AuthToken": { - "description": "Service Token", - "type": "object", - "properties": { - "accessToken": { - "description": "Access token.", - "type": "string" - }, - "tokenType": { - "description": "Access token type.", - "type": "string" - }, - "expiryOn": { - "format": "int64", - "description": "Access token expiry time (UTC).", - "type": "integer" - }, - "refreshAfter": { - "format": "int64", - "description": "Refresh access token after time (UTC).", - "type": "integer" - } - } - }, - "ContainerResourceRequirements": { - "description": "The resource requirements for the container (cpu and memory).", - "type": "object", - "properties": { - "cpu": { - "format": "double", - "description": "The number of CPU cores on the container.", - "type": "number", - "example": "4" - }, - "memoryInGB": { - "format": "double", - "description": "The amount of memory on the container in GB.", - "type": "number", - "example": "64" - }, - "gpu": { - "format": "int32", - "description": "The number of GPU cores in the container.", - "type": "integer" - }, - "fpga": { - "format": "int32", - "description": "The number of FPGA PCIE devices exposed to the container. Must be multiple of 2.", - "type": "integer" - } - } - }, - "DockerImageResponse": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ImageResponseBase" - }, - { - "type": "object", - "properties": { - "driverProgram": { - "description": "The name of the driver file.", - "type": "string" - }, - "assets": { - "description": "The list of assets.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentImageAsset" - } - }, - "targetRuntime": { - "$ref": "#/definitions/TargetRuntime", - "description": "The target runtime." - }, - "dockerFileUri": { - "description": "The Uri to the docker file.", - "type": "string" - }, - "generatedDockerFileUri": { - "description": "The Uri to the generated docker file.", - "type": "string" - } - } - } - ], - "properties": {}, - "x-ms-discriminator-value": "WEBAPICONTAINER" - }, - "ModelDataCollection": { - "description": "The Model data collection properties.", - "type": "object", - "properties": { - "eventHubEnabled": { - "description": "Option for enabling/disabling Event Hub.", - "type": "boolean" - }, - "storageEnabled": { - "description": "Option for enabling/disabling storage.", - "type": "boolean" - } - } - }, - "RegistryInfo": { - "description": "Contains registry information.", - "required": [ - "user", - "location", - "password" - ], - "type": "object", - "properties": { - "user": { - "description": "The user.", - "type": "string" - }, - "location": { - "description": "The location.", - "type": "string" - }, - "password": { - "description": "The password.", - "type": "string" - } - } - }, - "TargetRuntime": { - "description": "The target runtime.", - "type": "object", - "properties": { - "targetArchitecture": { - "description": "The target architecture.", - "enum": [ - "Amd64", - "Arm32v7" - ], - "type": "string", - "example": "Amd64", - "x-ms-enum": { - "name": "ArchitectureType", - "modelAsString": false - } - }, - "osType": { - "description": "The target operating system.", - "enum": [ - "Linux", - "Windows" - ], - "type": "string", - "example": "linux", - "x-ms-enum": { - "name": "OSType", - "modelAsString": false - } - }, - "runtimeType": { - "description": "The target runtime type.", - "enum": [ - "SparkPython", - "Tlc37", - "Tlc38", - "Tlc310", - "Python", - "PythonSlim", - "PythonCustom" - ], - "type": "string", - "example": "Python", - "x-ms-enum": { - "name": "RuntimeType", - "modelAsString": false - } - }, - "properties": { - "description": "The properties dictionary.", - "type": "object", - "additionalProperties": { - "type": "string" - }, - "readOnly": true - } - } - }, - "AKSEndpointResponse": { - "description": "The response for an AKS Endpoint.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceResponseBase" - }, - { - "type": "object", - "properties": { - "computeName": { - "description": "The name of the compute resource.", - "type": "string" - }, - "namespace": { - "description": "The Kubernetes namespace of the deployment.", - "type": "string" - }, - "appInsightsEnabled": { - "description": "Whether or not Application Insights is enabled.", - "type": "boolean" - }, - "authEnabled": { - "description": "Whether or not authentication is enabled.", - "type": "boolean" - }, - "aadAuthEnabled": { - "description": "Whether or not AAD authentication is enabled.", - "type": "boolean" - }, - "swaggerUri": { - "description": "The Uri for sending swagger requests.", - "type": "string" - }, - "scoringUri": { - "description": "The Uri for sending scoring requests.", - "type": "string" - }, - "variants": { - "description": "All the variants that belongs to this endpoint.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/AKSServiceResponse" - } - } - } - } - ], - "properties": {}, - "x-ms-discriminator-value": "AKSENDPOINT" - }, - "AKSServiceResponse": { - "description": "The response for an AKS service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AKSVariantResponse" - }, - { - "type": "object", - "properties": { - "imageDetails": { - "$ref": "#/definitions/ImageResponseBase", - "description": "The Docker Image details." - }, - "imageId": { - "description": "The Id of the Image.", - "type": "string" - }, - "models": { - "description": "The list of models.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Model" - } - }, - "containerResourceRequirements": { - "$ref": "#/definitions/ContainerResourceRequirements", - "description": "The container resource requirements." - }, - "maxConcurrentRequestsPerContainer": { - "format": "int32", - "description": "The maximum number of concurrent requests per container.", - "type": "integer" - }, - "maxQueueWaitMs": { - "format": "int32", - "description": "Maximum time a request will wait in the queue (in milliseconds). After this time, the service will return 503 (Service Unavailable)", - "type": "integer" - }, - "computeName": { - "description": "The name of the compute resource.", - "type": "string" - }, - "namespace": { - "description": "The Kubernetes namespace of the deployment.", - "type": "string" - }, - "numReplicas": { - "format": "int32", - "description": "The number of replicas on the cluster.", - "type": "integer" - }, - "dataCollection": { - "$ref": "#/definitions/ModelDataCollection", - "description": "Details of the data collection options specified." - }, - "appInsightsEnabled": { - "description": "Whether or not Application Insights is enabled.", - "type": "boolean" - }, - "autoScaler": { - "$ref": "#/definitions/AutoScaler", - "description": "The auto scaler properties." - }, - "scoringUri": { - "description": "The Uri for sending scoring requests.", - "type": "string" - }, - "deploymentStatus": { - "$ref": "#/definitions/AKSReplicaStatus", - "description": "The deployment status." - }, - "scoringTimeoutMs": { - "format": "int32", - "description": "The scoring timeout in milliseconds.", - "type": "integer" - }, - "livenessProbeRequirements": { - "$ref": "#/definitions/LivenessProbeRequirements", - "description": "The liveness probe requirements." - }, - "authEnabled": { - "description": "Whether or not authentication is enabled.", - "type": "boolean" - }, - "aadAuthEnabled": { - "description": "Whether or not AAD authentication is enabled.", - "type": "boolean" - }, - "swaggerUri": { - "description": "The Uri for sending swagger requests.", - "type": "string" - }, - "modelConfigMap": { - "description": "Details on the models and configurations.", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "environment": { - "$ref": "#/definitions/ModelEnvironmentDefinition", - "description": "Details on the Environment." - } - } - } - ], - "properties": {}, - "x-ms-discriminator-value": "AKS" - }, - "ImageResponseBase": { - "required": [ - "imageFlavor" - ], - "type": "object", - "properties": { - "id": { - "description": "The image Id.", - "type": "string", - "example": "myimage:3" - }, - "name": { - "description": "The image name.", - "type": "string", - "example": "myimage:3" - }, - "version": { - "format": "int64", - "description": "The image version.", - "type": "integer", - "example": "3" - }, - "description": { - "description": "The image description.", - "type": "string", - "example": "My docker image." - }, - "kvTags": { - "description": "The image tag dictionary. Tags are mutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "description": "The image properties dictionary. Properties are immutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "createdTime": { - "format": "date-time", - "description": "The time the image was created.", - "type": "string" - }, - "modifiedTime": { - "format": "date-time", - "description": "The time the image was last modified.", - "type": "string" - }, - "autoDelete": { - "description": "Whether the image will be automatically deleted with the last service using it.", - "type": "boolean" - }, - "imageType": { - "description": "The type of the image.", - "enum": [ - "Docker" - ], - "type": "string", - "example": "Docker", - "x-ms-enum": { - "name": "ImageType", - "modelAsString": false - } - }, - "imageFlavor": { - "description": "The flavor of the image.", - "enum": [ - "WebApiContainer", - "BatchContainer", - "IoTContainer", - "AccelContainer", - "UserProvidedContainer" - ], - "type": "string", - "example": "WebApiContainer", - "x-ms-enum": { - "name": "ImageFlavor", - "modelAsString": false - } - }, - "creationState": { - "description": "The state of the operation.", - "enum": [ - "NotStarted", - "Running", - "Cancelled", - "Succeeded", - "Failed", - "TimedOut" - ], - "type": "string", - "example": "Running", - "x-ms-enum": { - "name": "AsyncOperationState", - "modelAsString": false - } - }, - "error": { - "$ref": "#/definitions/ModelErrorResponse", - "description": "The error response." - }, - "modelIds": { - "description": "The list of model Ids.", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "modelDetails": { - "description": "The list of models.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Model" - } - }, - "imageLocation": { - "description": "The Image location string.", - "type": "string" - }, - "imageBuildLogUri": { - "description": "The Uri to the image build logs.", - "type": "string" - }, - "operationId": { - "description": "The ID of the asynchronous operation for this image.", - "type": "string" - } - }, - "discriminator": "imageFlavor" - }, - "AutoScaler": { - "description": "The Auto Scaler properties.", - "type": "object", - "properties": { - "autoscaleEnabled": { - "description": "Option to enable/disable auto scaling.", - "type": "boolean" - }, - "minReplicas": { - "format": "int32", - "description": "The minimum number of replicas to scale down to.", - "type": "integer", - "example": "1" - }, - "maxReplicas": { - "format": "int32", - "description": "The maximum number of replicas in the cluster.", - "type": "integer", - "example": "3" - }, - "targetUtilization": { - "format": "int32", - "description": "The target utilization percentage to use for determining whether to scale the cluster.", - "type": "integer", - "example": "70" - }, - "refreshPeriodInSeconds": { - "format": "int32", - "description": "The amount of seconds to wait between auto scale updates.", - "type": "integer", - "example": "120" - } - } - }, - "AKSReplicaStatus": { - "type": "object", - "properties": { - "desiredReplicas": { - "format": "int32", - "description": "The desired number of replicas.", - "type": "integer", - "example": "2" - }, - "updatedReplicas": { - "format": "int32", - "description": "The number of updated replicas.", - "type": "integer", - "example": "1" - }, - "availableReplicas": { - "format": "int32", - "description": "The number of available replicas.", - "type": "integer", - "example": "1" - }, - "error": { - "$ref": "#/definitions/ModelErrorResponse", - "description": "The error details." - } - } - }, - "LivenessProbeRequirements": { - "description": "The liveness probe requirements.", - "type": "object", - "properties": { - "failureThreshold": { - "format": "int32", - "description": "The number of failures to allow before returning an unhealthy status.", - "type": "integer" - }, - "successThreshold": { - "format": "int32", - "description": "The number of successful probes before returning a healthy status.", - "type": "integer" - }, - "timeoutSeconds": { - "format": "int32", - "description": "The probe timeout in seconds.", - "type": "integer" - }, - "periodSeconds": { - "format": "int32", - "description": "The length of time between probes in seconds.", - "type": "integer" - }, - "initialDelaySeconds": { - "format": "int32", - "description": "The delay before the first probe in seconds.", - "type": "integer" - } - } - }, - "AKSVariantResponse": { - "description": "The response for an AKS variant.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceResponseBase" - }, - { - "type": "object", - "properties": { - "isDefault": { - "description": "Is this the default variant.", - "type": "boolean" - }, - "trafficPercentile": { - "format": "float", - "description": "The amount of traffic variant receives.", - "type": "number" - }, - "type": { - "description": "The type of the variant.", - "enum": [ - "Control", - "Treatment" - ], - "type": "string", - "x-ms-enum": { - "name": "VariantType", - "modelAsString": false - } - } - } - } - ], - "properties": {} - }, - "BatchServiceResponse": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceResponseBase" - }, - { - "type": "object", - "properties": { - "modelIds": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "computeName": { - "type": "string" - }, - "environmentName": { - "type": "string" - }, - "environmentVersion": { - "type": "string" - }, - "scoringUri": { - "type": "string" - }, - "appInsightsEnabled": { - "type": "boolean" - }, - "modelDataCollection": { - "$ref": "#/definitions/ModelDataCollection" - }, - "entryScript": { - "type": "string" - }, - "inputFormat": { - "type": "string" - }, - "outputAction": { - "type": "string" - }, - "miniBatchSize": { - "format": "int32", - "type": "integer" - }, - "errorThreshold": { - "format": "double", - "type": "number" - }, - "nodeCount": { - "format": "int32", - "type": "integer" - }, - "processCountPerNode": { - "format": "int32", - "type": "integer" - } - } - } - ], - "properties": {}, - "x-ms-discriminator-value": "AMLCOMPUTE" - }, - "IotServiceResponse": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceResponseBase" - }, - { - "type": "object", - "properties": { - "iotDeviceId": { - "type": "string" - }, - "routes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "computeName": { - "type": "string" - }, - "iotEdgeModules": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/IotModuleSettings" - } - }, - "authEnabled": { - "type": "boolean" - }, - "imageDetails": { - "$ref": "#/definitions/ImageResponseBase" - }, - "imageId": { - "type": "string" - } - } - } - ], - "properties": {}, - "x-ms-discriminator-value": "IOT" - }, - "IotModuleSettings": { - "type": "object", - "properties": { - "imageLocation": { - "type": "string" - }, - "moduleName": { - "type": "string" - }, - "propertiesDesired": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "createOptions": { - "type": "string" - }, - "environmentVariables": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "UnknownServiceResponse": { - "description": "The response for an unsupported Service\r\nDefines the basic service properties", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceResponseBase" - }, - { - "type": "object", - "properties": {} - } - ], - "properties": {}, - "x-ms-discriminator-value": "UNKNOWON" - }, - "ACIServiceCreateRequest": { - "required": [ - "name" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CreateServiceRequest" - }, - { - "type": "object", - "properties": { - "containerResourceRequirements": { - "$ref": "#/definitions/ContainerResourceRequirements", - "description": "The container resource requirements." - }, - "authEnabled": { - "description": "Whether or not authentication is enabled on the service.", - "default": false, - "type": "boolean" - }, - "sslEnabled": { - "description": "Whether or not SSL is enabled.", - "default": false, - "type": "boolean" - }, - "appInsightsEnabled": { - "description": "Whether or not Application Insights is enabled.", - "default": false, - "type": "boolean" - }, - "dataCollection": { - "$ref": "#/definitions/ModelDataCollection", - "description": "Details of the data collection options specified." - }, - "sslCertificate": { - "description": "The SSL certificate to use if SSL is enabled.", - "type": "string" - }, - "sslKey": { - "description": "The SSL key for the certificate.", - "type": "string" - }, - "cname": { - "description": "The CName for the service.", - "type": "string" - }, - "dnsNameLabel": { - "description": "The Dns label for the service.", - "type": "string" - } - } - } - ], - "properties": {}, - "x-ms-discriminator-value": "ACI" - }, - "AKSServiceCreateRequest": { - "description": "The request to create an AKS service.", - "required": [ - "name" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CreateEndpointVariantRequest" - }, - { - "type": "object", - "properties": { - "numReplicas": { - "format": "int32", - "description": "The number of replicas on the cluster.", - "type": "integer" - }, - "dataCollection": { - "$ref": "#/definitions/ModelDataCollection", - "description": "Details of the data collection options specified." - }, - "computeName": { - "description": "The name of the compute resource.", - "type": "string" - }, - "appInsightsEnabled": { - "description": "Whether or not Application Insights is enabled.", - "type": "boolean" - }, - "autoScaler": { - "$ref": "#/definitions/AutoScaler", - "description": "The auto scaler properties." - }, - "containerResourceRequirements": { - "$ref": "#/definitions/ContainerResourceRequirements", - "description": "The container resource requirements." - }, - "maxConcurrentRequestsPerContainer": { - "format": "int32", - "description": "The maximum number of concurrent requests per container.", - "type": "integer" - }, - "maxQueueWaitMs": { - "format": "int32", - "description": "Maximum time a request will wait in the queue (in milliseconds). After this time, the service will return 503 (Service Unavailable)", - "type": "integer" - }, - "namespace": { - "description": "Kubernetes namespace for the service.", - "type": "string" - }, - "scoringTimeoutMs": { - "format": "int32", - "description": "The scoring timeout in milliseconds.", - "type": "integer" - }, - "authEnabled": { - "description": "Whether or not authentication is enabled.", - "type": "boolean" - }, - "livenessProbeRequirements": { - "$ref": "#/definitions/LivenessProbeRequirements", - "description": "The liveness probe requirements." - }, - "aadAuthEnabled": { - "description": "Whether or not AAD authentication is enabled.", - "type": "boolean" - } - } - } - ], - "properties": {}, - "x-ms-discriminator-value": "AKS" - }, - "CreateEndpointRequest": { - "description": "The request to create an Endpoint in the AKS.", - "required": [ - "name" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CreateServiceRequest" - }, - { - "type": "object", - "properties": { - "computeName": { - "description": "The name of the compute resource.", - "type": "string" - }, - "appInsightsEnabled": { - "description": "Whether or not Application Insights is enabled.", - "type": "boolean" - }, - "authEnabled": { - "description": "Whether or not authentication is enabled.", - "type": "boolean" - }, - "aadAuthEnabled": { - "description": "Whether or not AAD authentication is enabled.", - "type": "boolean" - }, - "namespace": { - "description": "Kubernetes namespace for the service.", - "type": "string" - }, - "variants": { - "description": "The service tag list.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/AKSServiceCreateRequest" - } - } - } - } - ], - "properties": {}, - "x-ms-discriminator-value": "AKSENDPOINT" - }, - "CreateEndpointVariantRequest": { - "description": "The Variant properties.", - "required": [ - "name" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CreateServiceRequest" - }, - { - "type": "object", - "properties": { - "isDefault": { - "description": "Is this the default variant.", - "type": "boolean" - }, - "trafficPercentile": { - "format": "float", - "description": "The amount of traffic variant receives.", - "type": "number" - }, - "type": { - "description": "The type of the variant.", - "enum": [ - "Control", - "Treatment" - ], - "type": "string", - "x-ms-enum": { - "name": "VariantType", - "modelAsString": false - } - } - } - } - ], - "properties": {} - }, - "CreateIotServiceRequest": { - "required": [ - "name" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CreateServiceRequest" - }, - { - "type": "object", - "properties": { - "iotDeviceId": { - "type": "string" - }, - "routes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "iotEdgeUserModule": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/IotModuleSettings" - } - }, - "iotEdgeModule": { - "$ref": "#/definitions/IotBaseModuleSettings" - }, - "computeName": { - "type": "string" - }, - "acrCredentials": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/RegistryInfo" - } - }, - "authEnabled": { - "type": "boolean" - } - } - } - ], - "properties": {}, - "x-ms-discriminator-value": "IOT" - }, - "IotBaseModuleSettings": { - "type": "object", - "properties": { - "moduleName": { - "type": "string" - }, - "propertiesDesired": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "createOptions": { - "type": "string" - }, - "environmentVariables": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "FPGADockerImageResponse": { - "description": "The FPGA Docker Image response.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ImageResponseBase" - }, - { - "type": "object", - "properties": {} - } - ], - "properties": {}, - "x-ms-discriminator-value": "ACCELCONTAINER" - } - }, - "parameters": { - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The Azure Subscription ID.", - "required": true, - "type": "string", - "format": "uuid", - "x-ms-parameter-location": "method" - }, - "resourceGroupParameter": { - "name": "resourceGroup", - "in": "path", - "description": "The Name of the resource group in which the workspace is located.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "workspaceParameter": { - "name": "workspace", - "in": "path", - "description": "The name of the workspace.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "tags": [] -} diff --git a/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/runHistory.json b/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/runHistory.json deleted file mode 100644 index 238be7979..000000000 --- a/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/runHistory.json +++ /dev/null @@ -1,2701 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2019-09-30", - "title": "Run History APIs" - }, - "schemes": [ - "https" - ], - "paths": { - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/events": { - "post": { - "tags": [ - "Events" - ], - "summary": "Batch post event data.", - "description": "Post event data to a specific Run Id.", - "operationId": "Events_BatchPost", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "batchEventCommand", - "in": "body", - "description": "The batch of Event details.", - "required": false, - "schema": { - "$ref": "#/definitions/BatchEventCommand" - } - } - ], - "responses": { - "200": { - "description": "The batch of Events is posted successfully.", - "schema": { - "$ref": "#/definitions/BatchEventCommandResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/events": { - "post": { - "tags": [ - "Events" - ], - "summary": "Post event data.", - "description": "Post event data to a specific Run Id.", - "operationId": "Events_Post", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier of the Run.", - "required": true, - "type": "string" - }, - { - "name": "eventMessage", - "in": "body", - "description": "The Event details.", - "required": false, - "schema": { - "$ref": "#/definitions/BaseEvent" - } - } - ], - "responses": { - "200": { - "description": "The Event is posted successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}": { - "get": { - "tags": [ - "Experiments" - ], - "summary": "Get details of an Experiment.", - "description": "Get details of an Experiment with specific Experiment name.", - "operationId": "Experiments_Get", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The details of the Experiment are returned successfully.", - "schema": { - "$ref": "#/definitions/Experiment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "post": { - "tags": [ - "Experiments" - ], - "summary": "Create an Experiment.", - "description": "Create a new Experiment.", - "operationId": "Experiments_Create", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The Experiment is created successfully.", - "schema": { - "$ref": "#/definitions/Experiment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}": { - "get": { - "tags": [ - "Experiments" - ], - "summary": "Get details of an Experiment.", - "description": "Get details of an Experiment with specific Experiment Id.", - "operationId": "Experiments_GetById", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentId", - "in": "path", - "description": "The identifier of the experiment.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Experiment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Experiments" - ], - "summary": "Update details of an Experiment.", - "description": "Update details of an Experiment with specific Experiment Id.", - "operationId": "Experiments_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentId", - "in": "path", - "description": "The identifier of the experiment.", - "required": true, - "type": "string" - }, - { - "name": "modifyExperimentDto", - "in": "body", - "description": "Experiment details which needs to be updated.", - "required": false, - "schema": { - "$ref": "#/definitions/ModifyExperiment" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Experiment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments:query": { - "post": { - "tags": [ - "Experiments" - ], - "summary": "Get all Experiments in a specific workspace.", - "description": "Get all experiments in a specific workspace with the specified query filters.", - "operationId": "Experiments_GetByQuery", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "queryParams", - "in": "body", - "description": "Query parameters for data sorting and filtering.", - "required": false, - "schema": { - "$ref": "#/definitions/QueryParams" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedExperimentList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/tags": { - "delete": { - "tags": [ - "Experiments" - ], - "summary": "Delete list of Tags in an Experiment.", - "description": "Delete list of Tags from a specific Experiment Id.", - "operationId": "Experiments_DeleteTags", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentId", - "in": "path", - "description": "The identifier of the experiment.", - "required": true, - "type": "string" - }, - { - "name": "tags", - "in": "body", - "description": "The requested tags list to be deleted.", - "required": false, - "schema": { - "$ref": "#/definitions/DeleteTagsCommand" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Experiment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/children": { - "get": { - "tags": [ - "Run" - ], - "summary": "Get details of all child runs.", - "description": "Get details of all child runs for the specified Run Id with the specified filters.", - "operationId": "Runs_GetChild", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier of the Run.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "Allows for filtering the collection of resources.\r\nThe expression specified is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response.", - "required": false, - "type": "string" - }, - { - "name": "$continuationtoken", - "in": "query", - "description": "The continuation token to use for getting the next set of resources.", - "required": false, - "type": "string" - }, - { - "name": "$orderby", - "in": "query", - "description": "The list of resource properties to use for sorting the requested resources.", - "required": false, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "uniqueItems": false - }, - { - "name": "$sortorder", - "in": "query", - "description": "The sort order of the returned resources. Not used, specify asc or desc after each property name in the OrderBy parameter.", - "required": false, - "type": "string", - "enum": [ - "Asc", - "Desc" - ] - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of items in the resource collection to be included in the result.\r\nIf not specified, all items are returned.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$count", - "in": "query", - "description": "Whether to include a count of the matching resources along with the resources returned in the response.", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The details of the child Runs are returned successfully.", - "schema": { - "$ref": "#/definitions/PaginatedRunList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/details": { - "get": { - "tags": [ - "Run" - ], - "summary": "Get Run Details.", - "description": "Get Run Details for a specific Run Id.", - "operationId": "Runs_GetDetails", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier of the Run.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The details of the Run are returned successfully.", - "schema": { - "$ref": "#/definitions/RunDetails" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/runs": { - "patch": { - "tags": [ - "Run" - ], - "summary": "Add or Modify a batch of Runs.", - "description": "Add or Modify a batch of Runs for a given experiment.", - "operationId": "Runs_BatchAddOrModify", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "requestDto", - "in": "body", - "description": "The list of requested Run Additions/modifications in an Experiment.", - "required": false, - "schema": { - "$ref": "#/definitions/BatchAddOrModifyRunRequest" - } - } - ], - "responses": { - "200": { - "description": "The Batch Runs are added/modified successfully.", - "schema": { - "$ref": "#/definitions/BatchAddOrModifyRunResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}": { - "get": { - "tags": [ - "Run" - ], - "summary": "Get Run details.", - "description": "Get Run details of a specific Run Id.", - "operationId": "Runs_Get", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier of the Run.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The details of the Run are returned successfully.", - "schema": { - "$ref": "#/definitions/Run" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Run" - ], - "summary": "Add or Modify a Run.", - "description": "Add a new Run or Modify an existing Run.", - "operationId": "Runs_Patch", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier of the Run.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][\\w-]{0,255}$" - }, - { - "name": "createRunDto", - "in": "body", - "description": "The requested Run parameter Additions/modifications.", - "required": false, - "schema": { - "$ref": "#/definitions/CreateRun" - } - } - ], - "responses": { - "200": { - "description": "The Run is added/modified successfully.", - "schema": { - "$ref": "#/definitions/Run" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/tags": { - "delete": { - "tags": [ - "Run" - ], - "summary": "Delete list of Tags in a Run.", - "description": "Delete list of Tags from a specific Run Id.", - "operationId": "Runs_DeleteTags", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier of the Run.", - "required": true, - "type": "string" - }, - { - "name": "tags", - "in": "body", - "description": "The requested tags list to be deleted.", - "required": false, - "schema": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Run" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs:query": { - "post": { - "tags": [ - "Run" - ], - "summary": "Get all Runs for a specific Experiment.", - "description": "Get all Runs for a specific Experiment with the specified query filters.", - "operationId": "Runs_GetByQuery", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "queryParams", - "in": "body", - "description": "Query parameters for data sorting and filtering.", - "required": false, - "schema": { - "$ref": "#/definitions/QueryParams" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedRunList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts": { - "get": { - "tags": [ - "RunArtifacts" - ], - "summary": "Get Artifacts in a container.", - "description": "Get Artifacts in container for a specific Run Id.", - "operationId": "RunArtifacts_ListInContainer", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier of the Run.", - "required": true, - "type": "string" - }, - { - "name": "continuationToken", - "in": "query", - "description": "The Continuation Token.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The Artifacts in Container are returned successfully.", - "schema": { - "$ref": "#/definitions/PaginatedArtifactList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/path": { - "get": { - "tags": [ - "RunArtifacts" - ], - "summary": "Get Artifacts in the provided path.", - "description": "Get Artifacts in the provided path for a specific Run Id.", - "operationId": "RunArtifacts_ListInPath", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier of the Run.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - }, - { - "name": "continuationToken", - "in": "query", - "description": "The Continuation Token.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedArtifactList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/metadata": { - "get": { - "tags": [ - "RunArtifacts" - ], - "summary": "Get Artifact by Id.", - "description": "Get Artifact for a specific Id.", - "operationId": "RunArtifacts_GetById", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier of the Run.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Artifact" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/contentinfo": { - "get": { - "tags": [ - "RunArtifacts" - ], - "summary": "Get Artifact content information.", - "description": "Get Artifact content information for give Run Id.", - "operationId": "RunArtifacts_GetContentInformation", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier of the Run.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The Artifact content information is returned successfully.", - "schema": { - "$ref": "#/definitions/ArtifactContentInformation" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/artifacturi": { - "get": { - "tags": [ - "RunArtifacts" - ], - "summary": "Get URI of an Artifact.", - "description": "Get URI of an Artifact for a specific Run Id.", - "operationId": "RunArtifacts_GetSasUri", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier of the Run.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "type": "string" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/prefix/contentinfo": { - "get": { - "tags": [ - "RunArtifacts" - ], - "summary": "Get SAS of an Artifact.", - "description": "Get SAS of an Artifact in the specified path.", - "operationId": "RunArtifacts_ListSasByPrefix", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier of the Run.", - "required": true, - "type": "string" - }, - { - "name": "path", - "in": "query", - "description": "The Artifact Path.", - "required": false, - "type": "string" - }, - { - "name": "continuationToken", - "in": "query", - "description": "The Continuation Token.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PaginatedArtifactContentInformationList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/batch/metadata": { - "post": { - "tags": [ - "RunArtifacts" - ], - "summary": "Create a batch of empty Artifacts.", - "description": "Create a batch of empty Artifacts in a specific Run.", - "operationId": "RunArtifacts_BatchCreateEmptyArtifacts", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier of the Run.", - "required": true, - "type": "string" - }, - { - "name": "artifactPaths", - "in": "body", - "description": "The list of artifact paths.", - "required": false, - "schema": { - "$ref": "#/definitions/ArtifactPathList" - } - } - ], - "responses": { - "200": { - "description": "The Batch Artifacts are created successfully.", - "schema": { - "$ref": "#/definitions/BatchArtifactContentInformationResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/metrics": { - "post": { - "tags": [ - "RunMetrics" - ], - "summary": "Post Metric to a Run.", - "description": "Post a Metric to a specific Run Id.", - "operationId": "RunMetrics_Post", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier for a run.", - "required": true, - "type": "string" - }, - { - "name": "metricDto", - "in": "body", - "description": "Details of the metric which will be added to the Run Id.", - "required": false, - "schema": { - "$ref": "#/definitions/Metric" - } - } - ], - "responses": { - "200": { - "description": "The Run Metric is posted successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/batch/metrics": { - "post": { - "tags": [ - "RunMetrics" - ], - "summary": "Post Metrics to a Run.", - "description": "Post Metrics to a specific Run Id.", - "operationId": "RunMetrics_BatchPost", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "runId", - "in": "path", - "description": "The identifier for a run.", - "required": true, - "type": "string" - }, - { - "name": "batchMetricDto", - "in": "body", - "description": "Details of the Metrics which will be added to the Run Id.", - "required": false, - "schema": { - "$ref": "#/definitions/BatchMetric" - } - } - ], - "responses": { - "200": { - "description": "The Run Metrics are posted successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/metrics/{metricId}": { - "get": { - "tags": [ - "RunMetrics" - ], - "summary": "Get Metric details.", - "description": "Get Metric details for a specific Metric Id.", - "operationId": "RunMetrics_Get", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "metricId", - "in": "path", - "description": "The identifier for a Metric.", - "required": true, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/RunMetric" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/metrics:query": { - "post": { - "tags": [ - "RunMetrics" - ], - "summary": "Get all Run Metrics for the specific Experiment.", - "description": "Get all Run Metrics for the specific Experiment with the specified query filters.", - "operationId": "RunMetrics_GetByQuery", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "experimentName", - "in": "path", - "description": "The experiment name.", - "required": true, - "type": "string" - }, - { - "name": "queryParams", - "in": "body", - "description": "Query Parameters for data sorting and filtering.", - "required": false, - "schema": { - "$ref": "#/definitions/QueryParams" - } - }, - { - "name": "MergeStrategyType", - "in": "query", - "description": "The type of merge strategy. Currently supported strategies are:\r\nNone - all logged values are returned as individual metrics.\r\nMergeToVector - merges multiple values into a vector of values.\r\nDefault - the system determines the behavior.", - "required": false, - "type": "string", - "enum": [ - "Default", - "None", - "MergeToVector" - ] - }, - { - "name": "MergeStrategyOptions", - "in": "query", - "description": "Controls behavior of the merge strategy in certain cases; e.g. when a metric is not merged.", - "required": false, - "type": "string", - "enum": [ - "None", - "ReportUnmergedMetricsValues" - ] - }, - { - "name": "MergeStrategySettings.Version", - "in": "query", - "description": "The strategy settings version.", - "required": false, - "type": "string" - }, - { - "name": "MergeStrategySettings.SelectMetrics", - "in": "query", - "description": "Defines how to select metrics when merging them together.", - "required": false, - "type": "string", - "enum": [ - "SelectAll", - "SelectByFirstValueSchema", - "SelectByFirstValueSchemaMergeNumericValues" - ] - } - ], - "responses": { - "200": { - "description": "The Run Metrics are returned successfully.", - "schema": { - "$ref": "#/definitions/PaginatedRunMetricList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "BatchEventCommand": { - "type": "object", - "properties": { - "events": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/BaseEvent" - } - } - } - }, - "BaseEvent": { - "description": "Base event is the envelope used to post event data to the Event controller", - "type": "object", - "properties": { - "timestamp": { - "format": "date-time", - "type": "string" - }, - "name": { - "type": "string" - }, - "data": { - "type": "object" - } - } - }, - "BatchEventCommandResult": { - "type": "object", - "properties": { - "errors": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/KeyValuePairBaseEventErrorResponse" - } - } - } - }, - "KeyValuePairBaseEventErrorResponse": { - "type": "object", - "properties": { - "key": { - "$ref": "#/definitions/BaseEvent", - "readOnly": true - }, - "value": { - "$ref": "#/definitions/ErrorResponse", - "readOnly": true - } - } - }, - "ErrorResponse": { - "description": "The error response.", - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/RootError", - "description": "The top level error that occurred." - }, - "correlation": { - "description": "Dictionary containing correlation details for the error.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "environment": { - "description": "The hosting environment.", - "type": "string" - }, - "location": { - "description": "The Azure region.", - "type": "string" - }, - "time": { - "format": "date-time", - "description": "The time in UTC.", - "type": "string" - } - } - }, - "RootError": { - "description": "The root error.", - "type": "object", - "properties": { - "code": { - "description": "The service-defined error code. Supported error codes: ServiceError, UserError, ValidationError, AzureStorageError, TransientError, RequestThrottled.", - "type": "string" - }, - "message": { - "description": "A human-readable representation of the error.", - "type": "string" - }, - "target": { - "description": "The target of the error (e.g., the name of the property in error).", - "type": "string" - }, - "details": { - "description": "The related errors that occurred during the request.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ErrorDetails" - } - }, - "innerError": { - "$ref": "#/definitions/InnerErrorResponse", - "description": "A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand." - } - } - }, - "ErrorDetails": { - "description": "The error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string" - }, - "message": { - "description": "The error message.", - "type": "string" - }, - "target": { - "description": "The target of the error (e.g., the name of the property in error).", - "type": "string" - } - } - }, - "InnerErrorResponse": { - "description": "A nested structure of errors.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string" - }, - "innerError": { - "$ref": "#/definitions/InnerErrorResponse", - "description": "A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand." - } - } - }, - "Experiment": { - "type": "object", - "properties": { - "experimentId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "createdUtc": { - "format": "date-time", - "type": "string" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "archivedTime": { - "format": "date-time", - "type": "string" - }, - "latestCreatedRunCreatedUtc": { - "format": "date-time", - "type": "string" - }, - "latestCreatedRunId": { - "type": "string" - } - } - }, - "ModifyExperiment": { - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "archive": { - "type": "boolean" - } - } - }, - "QueryParams": { - "description": "The set of supported filters.", - "type": "object", - "properties": { - "filter": { - "description": "Allows for filtering the collection of resources.\r\nThe expression specified is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response.\r\nSee https://docs.microsoft.com/en-us/azure/search/query-odata-filter-orderby-syntax for details on the expression syntax.", - "type": "string" - }, - "continuationToken": { - "description": "The continuation token to use for getting the next set of resources.", - "type": "string" - }, - "orderBy": { - "description": "The comma separated list of resource properties to use for sorting the requested resources.\r\nOptionally, can be followed by either 'asc' or 'desc'", - "type": "string", - "example": "Color, Size desc" - }, - "top": { - "format": "int32", - "description": "The maximum number of items in the resource collection to be included in the result.\r\nIf not specified, all items are returned.", - "type": "integer" - } - } - }, - "PaginatedExperimentList": { - "description": "A paginated list of Experiments.", - "type": "object", - "properties": { - "value": { - "description": "An array of objects of type Experiment.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Experiment" - } - }, - "continuationToken": { - "description": "The token used in retrieving the next page. If null, there are no additional pages.", - "type": "string" - }, - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - } - } - }, - "DeleteTagsCommand": { - "type": "object", - "properties": { - "tags": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "PaginatedRunList": { - "description": "A paginated list of Runs.", - "type": "object", - "properties": { - "value": { - "description": "An array of objects of type Run.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Run" - } - }, - "continuationToken": { - "description": "The token used in retrieving the next page. If null, there are no additional pages.", - "type": "string" - }, - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - } - } - }, - "Run": { - "description": "The definition of a Run.", - "type": "object", - "properties": { - "runNumber": { - "format": "int32", - "type": "integer" - }, - "rootRunId": { - "type": "string" - }, - "experimentId": { - "description": "The Id of the experiment that created this run.", - "type": "string" - }, - "createdUtc": { - "format": "date-time", - "description": "The time the run was created in UTC.", - "type": "string" - }, - "createdBy": { - "$ref": "#/definitions/CreatedBy", - "description": "The details of the user who created the run." - }, - "userId": { - "description": "The Id of the user that created the run.", - "type": "string" - }, - "token": { - "description": "A token used for authenticating a run.", - "type": "string" - }, - "tokenExpiryTimeUtc": { - "format": "date-time", - "description": "The Token expiration time in UTC.", - "type": "string" - }, - "error": { - "$ref": "#/definitions/ErrorResponse", - "description": "If an error occurred during the run, this will be populated." - }, - "warnings": { - "description": "A list of warnings that occurred during the run.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/RunDetailsWarning" - } - }, - "revision": { - "format": "int32", - "type": "integer" - }, - "runId": { - "description": "The identifier for the run. Run IDs must be less than 256 characters and contain only alphanumeric characters with dashes and underscores.", - "type": "string" - }, - "parentRunId": { - "description": "The parent of the run if the run is hierarchical; otherwise, Null.", - "type": "string" - }, - "status": { - "description": "The status of the run. The Status string value maps to the RunStatus Enum.", - "type": "string" - }, - "startTimeUtc": { - "format": "date-time", - "description": "The start time of the run in UTC.", - "type": "string" - }, - "endTimeUtc": { - "format": "date-time", - "description": "The end time of the run in UTC.", - "type": "string" - }, - "heartbeatEnabled": { - "type": "boolean" - }, - "options": { - "$ref": "#/definitions/RunOptions" - }, - "name": { - "type": "string" - }, - "dataContainerId": { - "type": "string" - }, - "description": { - "type": "string" - }, - "hidden": { - "type": "boolean" - }, - "runType": { - "type": "string" - }, - "properties": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "scriptName": { - "type": "string" - }, - "target": { - "type": "string" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "runDefinition": { - "type": "object" - }, - "createdFrom": { - "$ref": "#/definitions/CreatedFrom" - }, - "cancelUri": { - "type": "string" - }, - "diagnosticsUri": { - "type": "string" - } - } - }, - "CreatedBy": { - "type": "object", - "properties": { - "userObjectId": { - "description": "A user or service principal's object ID.\r\nThis is PII and should never be logged.", - "type": "string" - }, - "userTenantId": { - "description": "A user or service principal's tenant ID.", - "type": "string" - }, - "userName": { - "description": "A user's full name or a service principal's app ID.\r\nThis is PII and should never be logged.", - "type": "string" - } - } - }, - "RunDetailsWarning": { - "type": "object", - "properties": { - "source": { - "type": "string" - }, - "message": { - "type": "string" - } - } - }, - "RunOptions": { - "type": "object", - "properties": { - "generateDataContainerIdIfNotSpecified": { - "type": "boolean" - } - } - }, - "CreatedFrom": { - "type": "object", - "properties": { - "type": { - "enum": [ - "Notebook" - ], - "type": "string", - "x-ms-enum": { - "name": "CreatedFromType", - "modelAsString": false - } - }, - "locationType": { - "enum": [ - "ArtifactId" - ], - "type": "string", - "x-ms-enum": { - "name": "CreatedFromLocationType", - "modelAsString": false - } - }, - "location": { - "type": "string" - } - } - }, - "RunDetails": { - "description": "The details of the run.", - "type": "object", - "properties": { - "runId": { - "description": "The identifier for the run.", - "type": "string" - }, - "target": { - "description": "The name of the compute target where the run is executed.", - "type": "string" - }, - "status": { - "description": "The status of the run. The Status string value maps to the RunStatus Enum.", - "type": "string" - }, - "parentRunId": { - "description": "The parent of the run if the run is hierarchical.", - "type": "string" - }, - "startTimeUtc": { - "format": "date-time", - "description": "The start time of the run in UTC.", - "type": "string" - }, - "endTimeUtc": { - "format": "date-time", - "description": "The end time of the run in UTC.", - "type": "string" - }, - "error": { - "$ref": "#/definitions/ErrorResponse", - "description": "If an error occurred during the run, this will be populated." - }, - "warnings": { - "description": "A list of warnings that occurred during the run.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/RunDetailsWarning" - } - }, - "tags": { - "description": "The tag dictionary for the run. Tags are mutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "description": "The properties dictionary for the run. Properties are immutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "runDefinition": { - "description": "The run definition specification.", - "type": "object" - }, - "logFiles": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "revision": { - "format": "int32", - "type": "integer" - } - } - }, - "BatchAddOrModifyRunRequest": { - "type": "object", - "properties": { - "runs": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/CreateRun" - } - } - } - }, - "CreateRun": { - "type": "object", - "properties": { - "runId": { - "description": "The identifier for the run. Run IDs must be less than 256 characters and contain only alphanumeric characters with dashes and underscores.", - "type": "string" - }, - "parentRunId": { - "description": "The parent of the run if the run is hierarchical; otherwise, Null.", - "type": "string" - }, - "status": { - "description": "The status of the run. The Status string value maps to the RunStatus Enum.", - "type": "string" - }, - "startTimeUtc": { - "format": "date-time", - "description": "The start time of the run in UTC.", - "type": "string" - }, - "endTimeUtc": { - "format": "date-time", - "description": "The end time of the run in UTC.", - "type": "string" - }, - "heartbeatEnabled": { - "type": "boolean" - }, - "options": { - "$ref": "#/definitions/RunOptions" - }, - "name": { - "type": "string" - }, - "dataContainerId": { - "type": "string" - }, - "description": { - "type": "string" - }, - "hidden": { - "type": "boolean" - }, - "runType": { - "type": "string" - }, - "properties": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "scriptName": { - "type": "string" - }, - "target": { - "type": "string" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "runDefinition": { - "type": "object" - }, - "createdFrom": { - "$ref": "#/definitions/CreatedFrom" - }, - "cancelUri": { - "type": "string" - }, - "diagnosticsUri": { - "type": "string" - } - } - }, - "BatchAddOrModifyRunResult": { - "type": "object", - "properties": { - "runs": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Run" - } - }, - "errors": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "PaginatedArtifactList": { - "description": "A paginated list of Artifacts.", - "type": "object", - "properties": { - "value": { - "description": "An array of objects of type Artifact.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Artifact" - } - }, - "continuationToken": { - "description": "The token used in retrieving the next page. If null, there are no additional pages.", - "type": "string" - }, - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - } - } - }, - "Artifact": { - "description": "Details of an Artifact.", - "required": [ - "origin", - "container", - "path" - ], - "type": "object", - "properties": { - "artifactId": { - "description": "The identifier of an Artifact. Format of ArtifactId - {Origin}/{Container}/{Path}.", - "type": "string" - }, - "origin": { - "description": "The origin of the Artifact creation request. Available origins are 'ExperimentRun', 'LocalUpload', 'WebUpload', 'Dataset' and 'Unknown'.", - "type": "string" - }, - "container": { - "description": "The name of container. Artifacts can be grouped by container.", - "type": "string" - }, - "path": { - "description": "The path to the Artifact in a container.", - "type": "string" - }, - "etag": { - "description": "The Etag of the Artifact.", - "type": "string", - "readOnly": true - }, - "createdTime": { - "format": "date-time", - "description": "The Date and Time at which the Artifact is created. The DateTime is in UTC.", - "type": "string", - "readOnly": true - }, - "dataPath": { - "$ref": "#/definitions/DataPath" - } - } - }, - "DataPath": { - "type": "object", - "properties": { - "dataStoreName": { - "type": "string" - }, - "relativePath": { - "type": "string" - }, - "sqlDataPath": { - "$ref": "#/definitions/SqlDataPath" - } - } - }, - "SqlDataPath": { - "type": "object", - "properties": { - "sqlTableName": { - "type": "string" - }, - "sqlQuery": { - "type": "string" - }, - "sqlStoredProcedureName": { - "type": "string" - }, - "sqlStoredProcedureParams": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/StoredProcedureParameter" - } - } - } - }, - "StoredProcedureParameter": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - }, - "type": { - "enum": [ - "String", - "Int", - "Decimal", - "Guid", - "Boolean", - "Date" - ], - "type": "string", - "x-ms-enum": { - "name": "StoredProcedureParameterType", - "modelAsString": false - } - } - } - }, - "ArtifactContentInformation": { - "description": "Details of an Artifact Content Information.", - "type": "object", - "properties": { - "contentUri": { - "description": "The URI of the content.", - "type": "string" - }, - "origin": { - "description": "The origin of the Artifact creation request. Available origins are 'ExperimentRun', 'LocalUpload', 'WebUpload', 'Dataset', 'ComputeRecord', 'Metric', and 'Unknown'.", - "type": "string" - }, - "container": { - "description": "The name of container. Artifacts can be grouped by container.", - "type": "string" - }, - "path": { - "description": "The path to the Artifact in a container.", - "type": "string" - } - } - }, - "PaginatedArtifactContentInformationList": { - "description": "A paginated list of ArtifactContentInformations.", - "type": "object", - "properties": { - "value": { - "description": "An array of objects of type ArtifactContentInformation.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ArtifactContentInformation" - } - }, - "continuationToken": { - "description": "The token used in retrieving the next page. If null, there are no additional pages.", - "type": "string" - }, - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - } - } - }, - "ArtifactPathList": { - "description": "Contains list of Artifact Paths.", - "required": [ - "paths" - ], - "type": "object", - "properties": { - "paths": { - "description": "List of Artifact Paths.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ArtifactPath" - } - } - } - }, - "ArtifactPath": { - "description": "Details of an Artifact Path.", - "required": [ - "path" - ], - "type": "object", - "properties": { - "path": { - "description": "The path to the Artifact in a container.", - "type": "string" - } - } - }, - "BatchArtifactContentInformationResult": { - "description": "Results of the Batch Artifact Content Information request.", - "type": "object", - "properties": { - "artifacts": { - "description": "Artifact details of the Artifact Ids requested.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Artifact" - } - }, - "artifactContentInformation": { - "description": "Artifact Content Information details of the Artifact Ids requested.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ArtifactContentInformation" - } - }, - "errors": { - "description": "Errors occurred while fetching the requested Artifact Ids.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "Metric": { - "type": "object", - "properties": { - "metricId": { - "format": "uuid", - "type": "string" - }, - "dataContainerId": { - "type": "string" - }, - "metricType": { - "type": "string" - }, - "createdUtc": { - "format": "date-time", - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "label": { - "type": "string" - }, - "numCells": { - "format": "int32", - "type": "integer" - }, - "dataLocation": { - "type": "string" - }, - "cells": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - }, - "schema": { - "$ref": "#/definitions/MetricSchema" - } - } - }, - "MetricSchema": { - "type": "object", - "properties": { - "numProperties": { - "format": "int32", - "type": "integer" - }, - "properties": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/MetricSchemaProperty" - } - } - } - }, - "MetricSchemaProperty": { - "type": "object", - "properties": { - "propertyId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - } - } - }, - "BatchMetric": { - "type": "object", - "properties": { - "values": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Metric" - } - } - } - }, - "RunMetric": { - "type": "object", - "properties": { - "runId": { - "type": "string" - }, - "metricId": { - "format": "uuid", - "type": "string" - }, - "dataContainerId": { - "type": "string" - }, - "metricType": { - "type": "string" - }, - "createdUtc": { - "format": "date-time", - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "label": { - "type": "string" - }, - "numCells": { - "format": "int32", - "type": "integer" - }, - "dataLocation": { - "type": "string" - }, - "cells": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - }, - "schema": { - "$ref": "#/definitions/MetricSchema" - } - } - }, - "PaginatedRunMetricList": { - "description": "A paginated list of RunMetrics.", - "type": "object", - "properties": { - "value": { - "description": "An array of objects of type RunMetric.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/RunMetric" - } - }, - "continuationToken": { - "description": "The token used in retrieving the next page. If null, there are no additional pages.", - "type": "string" - }, - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - } - } - } - }, - "parameters": { - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The Azure Subscription ID.", - "required": true, - "type": "string", - "format": "uuid", - "x-ms-parameter-location": "method" - }, - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The Name of the resource group in which the workspace is located.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "workspaceNameParameter": { - "name": "workspaceName", - "in": "path", - "description": "The name of the workspace.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "tags": [] -} diff --git a/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2024-05-01-preview/azure-ai-assets.json b/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2024-05-01-preview/azure-ai-assets.json new file mode 100644 index 000000000..1be86681f --- /dev/null +++ b/swagger-specs/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2024-05-01-preview/azure-ai-assets.json @@ -0,0 +1,1079 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Data Plane Services", + "version": "2024-05-01-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/genericasset/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "Supported Azure-AI asset endpoints.", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The ID of the target subscription.", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the Resource Group.", + "required": true, + "type": "string" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the AzureML workspace or AI project.", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "OAuth2Auth": [ + "https://ml.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://ml.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/indexes": { + "get": { + "operationId": "Indexes_ListLatest", + "description": "List the latest version of each index. Latest is defined by most recent created by date.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedIndex" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_ListLatest": { + "$ref": "./examples/Indexes_ListLatest_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/indexes/{name}": { + "get": { + "operationId": "Indexes_GetLatest", + "description": "Get latest version of the Index. Latest is defined by most recent created by date.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the index.", + "required": true, + "type": "string", + "maxLength": 254, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_GetLatest": { + "$ref": "./examples/Indexes_GetLatest_MaximumSet_Gen.json" + } + } + } + }, + "/indexes/{name}:getNextVersion": { + "post": { + "operationId": "Indexes_GetNextVersion", + "description": "Get next Index version as defined by the server. The server keeps track of all versions that are string-representations of integers. If one exists, the nextVersion will be a string representation of the highest integer value + 1. Otherwise, the nextVersion will default to '1'.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the index.", + "required": true, + "type": "string", + "maxLength": 254, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/VersionInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_GetNextVersion": { + "$ref": "./examples/Indexes_GetNextVersion_MaximumSet_Gen.json" + } + } + } + }, + "/indexes/{name}/versions": { + "get": { + "operationId": "Indexes_List", + "description": "List the versions of an Index given the name.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the index.", + "required": true, + "type": "string", + "maxLength": 254, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" + }, + { + "name": "listViewType", + "in": "query", + "description": "View type for including/excluding (for example) archived entities.", + "required": true, + "type": "string", + "default": "ActiveOnly" + }, + { + "name": "orderby", + "in": "query", + "description": "Ordering of list: Please choose orderby value from ['createdAt', 'lastModifiedAt'].", + "required": false, + "type": "string" + }, + { + "name": "tags", + "in": "query", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedIndex" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_List": { + "$ref": "./examples/Indexes_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/indexes/{name}/versions/{version}": { + "get": { + "operationId": "Indexes_Get", + "description": "Get a specific version of an Index.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the index.", + "required": true, + "type": "string", + "maxLength": 254, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" + }, + { + "name": "version", + "in": "path", + "description": "Version of the index.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_Get": { + "$ref": "./examples/Indexes_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Indexes_CreateOrUpdate", + "description": "Creates or updates a IndexVersion.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the index.", + "required": true, + "type": "string", + "maxLength": 254, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" + }, + { + "name": "version", + "in": "path", + "description": "Version of the index.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "Properties of an Index Version.", + "required": true, + "schema": { + "$ref": "#/definitions/Index" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Indexes_CreateOrUpdate": { + "$ref": "./examples/Indexes_CreateOrUpdate_MaximumSet_Gen.json" + } + } + } + }, + "/prompts": { + "get": { + "operationId": "Prompts_ListLatest", + "description": "List the latest version of each prompt. Latest is defined by most recent created by date.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedPrompt" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Prompts_ListLatest": { + "$ref": "./examples/Prompts_ListLatest_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/prompts/{name}": { + "get": { + "operationId": "Prompts_GetLatest", + "description": "Get latest version of the Prompt. Latest is defined by most recent created by date.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the prompt", + "required": true, + "type": "string", + "maxLength": 254, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Prompt" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Prompts_GetLatest": { + "$ref": "./examples/Prompts_GetLatest_MaximumSet_Gen.json" + } + } + } + }, + "/prompts/{name}:getNextVersion": { + "post": { + "operationId": "Prompts_GetNextVersion", + "description": "Get next Prompt version as defined by the server. The server keeps track of all versions that are string-representations of integers. If one exists, the nextVersion will be a string representation of the highest integer value + 1. Otherwise, the nextVersion will default to '1'.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the prompt", + "required": true, + "type": "string", + "maxLength": 254, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/VersionInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Prompts_GetNextVersion": { + "$ref": "./examples/Prompts_GetNextVersion_MaximumSet_Gen.json" + } + } + } + }, + "/prompts/{name}/versions": { + "get": { + "operationId": "Prompts_List", + "description": "List the versions of a Prompt given the name.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the prompt", + "required": true, + "type": "string", + "maxLength": 254, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" + }, + { + "name": "listViewType", + "in": "query", + "description": "View type for including/excluding (for example) archived entities.", + "required": true, + "type": "string", + "default": "ActiveOnly" + }, + { + "name": "orderby", + "in": "query", + "description": "Ordering of list: Please choose orderby value from ['createdAt', 'lastModifiedAt'].", + "required": false, + "type": "string" + }, + { + "name": "tags", + "in": "query", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedPrompt" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Prompts_List": { + "$ref": "./examples/Prompts_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/prompts/{name}/versions/{version}": { + "get": { + "operationId": "Prompts_Get", + "description": "Get a specific version of a Prompt.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the prompt", + "required": true, + "type": "string", + "maxLength": 254, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" + }, + { + "name": "version", + "in": "path", + "description": "Version of the prompt", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Prompt" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Prompts_Get": { + "$ref": "./examples/Prompts_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Prompts_CreateOrUpdate", + "description": "Creates or updates a Prompt", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the prompt", + "required": true, + "type": "string", + "maxLength": 254, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" + }, + { + "name": "version", + "in": "path", + "description": "Version of the prompt", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "Properties of a Prompt Version.", + "required": true, + "schema": { + "$ref": "#/definitions/Prompt" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Prompt" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Prompt" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Prompts_CreateOrUpdate": { + "$ref": "./examples/Prompts_CreateOrUpdate_MaximumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AssetVersion": { + "type": "object", + "description": "AssetVersion Definition", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified resource Id: azureml://workspace/{workspaceName}/indexes/{name}/versions/{version} of the index.", + "readOnly": true + }, + "stage": { + "type": "string", + "description": "Update stage to 'Archive' to archive the asset. Default is Development, which means the asset is under development.", + "default": "Development" + }, + "description": { + "type": "string", + "description": "Description information of the asset." + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "description": "Metadata containing createdBy and modifiedBy information.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Asset's tags. Unlike properties, tags are fully mutable.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "Asset's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "id" + ] + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "Index": { + "type": "object", + "description": "Index resource Definition", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified resource Id: azureml://workspace/{workspaceName}/indexes/{name}/versions/{version} of the index.", + "readOnly": true + }, + "stage": { + "type": "string", + "description": "Update stage to 'Archive' to archive the asset. Default is Development, which means the asset is under development.", + "default": "Development" + }, + "description": { + "type": "string", + "description": "Description information of the asset." + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "description": "Metadata containing createdBy and modifiedBy information.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Asset's tags. Unlike properties, tags are fully mutable.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "Asset's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.", + "additionalProperties": { + "type": "string" + } + }, + "storageUri": { + "type": "string", + "description": "Default workspace blob storage Uri. Should work across storage types and auth scenarios." + } + }, + "required": [ + "id", + "storageUri" + ] + }, + "PagedIndex": { + "type": "object", + "description": "Paged collection of IndexVersion items.", + "properties": { + "value": { + "type": "array", + "description": "The list of Indexes.", + "items": { + "$ref": "#/definitions/Index" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedPrompt": { + "type": "object", + "description": "Paged collection of PromptVersion items", + "properties": { + "value": { + "type": "array", + "description": "The list of Prompts.", + "items": { + "$ref": "#/definitions/Prompt" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Prompt": { + "type": "object", + "description": "Prompt resource definition", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified resource Id: azureml://workspace/{workspaceName}/indexes/{name}/versions/{version} of the index.", + "readOnly": true + }, + "stage": { + "type": "string", + "description": "Update stage to 'Archive' to archive the asset. Default is Development, which means the asset is under development.", + "default": "Development" + }, + "description": { + "type": "string", + "description": "Description information of the asset." + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "description": "Metadata containing createdBy and modifiedBy information.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Asset's tags. Unlike properties, tags are fully mutable.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "type": "object", + "description": "Asset's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.", + "additionalProperties": { + "type": "string" + } + }, + "dataUri": { + "type": "string", + "description": "Default workspace blob storage Ui. Should work across storage types and auth scenarios." + }, + "templatePath": { + "type": "string", + "description": "Relative path of the prompt data file at the dataUri location" + } + }, + "required": [ + "id", + "dataUri", + "templatePath" + ] + }, + "SystemData": { + "type": "object", + "description": "Metadata pertaining to creation and last modification of the resource.", + "properties": { + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp the resource was created at.", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The identity that created the resource.", + "readOnly": true + }, + "createdByType": { + "type": "string", + "description": "The identity type that created the resource.", + "readOnly": true + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)", + "readOnly": true + } + } + }, + "VersionInfo": { + "type": "object", + "description": "Next version definition.", + "properties": { + "nextVersion": { + "type": "integer", + "format": "int64", + "description": "Next version as defined by the server. The server keeps track of all versions that are string-representations of integers. If one exists, the nextVersion will be a string representation of the highest integer value + 1. Otherwise, the nextVersion will default to '1'." + }, + "latestVersion": { + "type": "string", + "description": "Current latest version of the resource." + } + }, + "required": [ + "latestVersion" + ] + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "Azure.Core.MaxPageSizeQueryParameter": { + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of result items per page.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.SkipQueryParameter": { + "name": "skip", + "in": "query", + "description": "The number of result items to skip.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0, + "x-ms-parameter-location": "method" + }, + "Azure.Core.TopQueryParameter": { + "name": "top", + "in": "query", + "description": "The number of result items to return.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/machinelearningservices/data-plane/api-set.json b/swagger-specs/machinelearningservices/data-plane/api-set.json index 6191116c6..3b50fd349 100644 --- a/swagger-specs/machinelearningservices/data-plane/api-set.json +++ b/swagger-specs/machinelearningservices/data-plane/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.MachineLearningServices/preview/2019-09-30/execution.json", "Microsoft.MachineLearningServices/preview/2019-09-30/modelManagement.json", "Microsoft.MachineLearningServices/preview/2019-09-30/runHistory.json", "Microsoft.MachineLearningServices/preview/2019-09-30/datastore.json", "Microsoft.MachineLearningServices/preview/2019-09-30/artifact.json", "Microsoft.MachineLearningServices/preview/2019-09-30/hyperdrive.json"], "name": "package-2019-09-preview"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.MachineLearningServices/preview/2024-05-01-preview/azure-ai-assets.json"], "name": "package-2024-05-01-preview"} \ No newline at end of file diff --git a/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json b/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/machineLearningServices.json similarity index 93% rename from swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json rename to swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/machineLearningServices.json index 01219b62c..de9a74144 100644 --- a/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json +++ b/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/machineLearningServices.json @@ -3,7 +3,7 @@ "info": { "title": "Azure Machine Learning Services", "description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.", - "version": "2023-10-01" + "version": "2024-04-01" }, "host": "management.azure.com", "schemes": [ @@ -1875,6 +1875,54 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": { + "post": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "List all the secrets of a machine learning workspaces connections.", + "operationId": "WorkspaceConnections_ListSecrets", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/listSecrets.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { "get": { "tags": [ @@ -2554,6 +2602,22 @@ "featureStoreSettings": { "description": "Settings for feature store type workspace.", "$ref": "#/definitions/FeatureStoreSettings" + }, + "associatedWorkspaces": { + "type": "array", + "items": { + "type": "string" + } + }, + "enableDataIsolation": { + "type": "boolean" + }, + "hubResourceId": { + "type": "string" + }, + "workspaceHubConfig": { + "description": "WorkspaceHub's configuration object.", + "$ref": "#/definitions/WorkspaceHubConfig" } } }, @@ -2634,6 +2698,19 @@ "featureStoreSettings": { "description": "Settings for feature store type workspace.", "$ref": "#/definitions/FeatureStoreSettings" + }, + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" + }, + "enableDataIsolation": { + "type": "boolean" + }, + "v1LegacyMode": { + "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", + "type": "boolean" + }, + "encryption": { + "$ref": "#/definitions/EncryptionUpdateProperties" } } }, @@ -6150,6 +6227,7 @@ "type": "object", "properties": { "isolationMode": { + "description": "Isolation mode for the managed network of a machine learning workspace.", "$ref": "#/definitions/IsolationMode" }, "networkId": { @@ -6159,11 +6237,13 @@ "outboundRules": { "type": "object", "additionalProperties": { + "description": "Outbound Rule for the managed network of a machine learning workspace.", "$ref": "#/definitions/OutboundRule" }, "x-nullable": true }, "status": { + "description": "Status of the Provisioning for the managed network of a machine learning workspace.", "$ref": "#/definitions/ManagedNetworkProvisionStatus" } } @@ -6340,7 +6420,8 @@ "enum": [ "Required", "Recommended", - "UserDefined" + "UserDefined", + "Dependency" ], "type": "string", "x-ms-enum": { @@ -6428,28 +6509,134 @@ } }, "ConnectionAuthType": { + "description": "Authentication type of the connection target", "enum": [ "PAT", "ManagedIdentity", "UsernamePassword", "None", - "SAS" + "SAS", + "AccountKey", + "ServicePrincipal", + "AccessKey", + "ApiKey", + "CustomKeys", + "OAuth2", + "AAD" ], "type": "string", - "description": "Authentication type of the connection target", "x-ms-enum": { "name": "ConnectionAuthType", "modelAsString": true } }, "ConnectionCategory": { + "description": "Category of the connection", "enum": [ "PythonFeed", "ContainerRegistry", - "Git" + "Git", + "S3", + "Snowflake", + "AzureSqlDb", + "AzureSynapseAnalytics", + "AzureMySqlDb", + "AzurePostgresDb", + "ADLSGen2", + "Redis", + "ApiKey", + "AzureOpenAI", + "CognitiveSearch", + "CognitiveService", + "CustomKeys", + "AzureBlob", + "AzureOneLake", + "CosmosDb", + "CosmosDbMongoDbApi", + "AzureDataExplorer", + "AzureMariaDb", + "AzureDatabricksDeltaLake", + "AzureSqlMi", + "AzureTableStorage", + "AmazonRdsForOracle", + "AmazonRdsForSqlServer", + "AmazonRedshift", + "Db2", + "Drill", + "GoogleBigQuery", + "Greenplum", + "Hbase", + "Hive", + "Impala", + "Informix", + "MariaDb", + "MicrosoftAccess", + "MySql", + "Netezza", + "Oracle", + "Phoenix", + "PostgreSql", + "Presto", + "SapOpenHub", + "SapBw", + "SapHana", + "SapTable", + "Spark", + "SqlServer", + "Sybase", + "Teradata", + "Vertica", + "Cassandra", + "Couchbase", + "MongoDbV2", + "MongoDbAtlas", + "AmazonS3Compatible", + "FileServer", + "FtpServer", + "GoogleCloudStorage", + "Hdfs", + "OracleCloudStorage", + "Sftp", + "GenericHttp", + "ODataRest", + "Odbc", + "GenericRest", + "AmazonMws", + "Concur", + "Dynamics", + "DynamicsAx", + "DynamicsCrm", + "GoogleAdWords", + "Hubspot", + "Jira", + "Magento", + "Marketo", + "Office365", + "Eloqua", + "Responsys", + "OracleServiceCloud", + "PayPal", + "QuickBooks", + "Salesforce", + "SalesforceServiceCloud", + "SalesforceMarketingCloud", + "SapCloudForCustomer", + "SapEcc", + "ServiceNow", + "SharePointOnlineList", + "Shopify", + "Square", + "WebTable", + "Xero", + "Zoho", + "GenericContainerRegistry", + "OpenAI", + "Serp", + "BingLLMSearch", + "Serverless", + "AIServices" ], "type": "string", - "description": "Category of the connection", "x-ms-enum": { "name": "ConnectionCategory", "modelAsString": true @@ -6463,6 +6650,11 @@ }, "password": { "type": "string" + }, + "securityToken": { + "description": "Optional, required by connections like SalesForce for extra security in addition to UsernamePassword", + "type": "string", + "x-ms-secret": true } }, "additionalProperties": false @@ -6537,14 +6729,46 @@ "type": "object", "properties": { "authType": { + "description": "Authentication type of the connection target", "$ref": "#/definitions/ConnectionAuthType" }, "category": { + "description": "Category of the connection", "$ref": "#/definitions/ConnectionCategory" }, + "createdByWorkspaceArmId": { + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "expiryTime": { + "format": "date-time", + "type": "string" + }, + "group": { + "description": "Group based on connection category", + "$ref": "#/definitions/ConnectionGroup", + "readOnly": true + }, + "isSharedToAll": { + "type": "boolean" + }, "target": { "type": "string" }, + "metadata": { + "description": "Store user metadata for this connection", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sharedUserList": { + "type": "array", + "items": { + "type": "string" + } + }, "value": { "description": "Value details of the workspace connection.", "type": "string" @@ -6561,7 +6785,6 @@ } } }, - "additionalProperties": false, "discriminator": "authType" }, "NoneAuthTypeWorkspaceConnectionProperties": { @@ -6834,6 +7057,249 @@ "type": "string" } } + }, + "AADAuthTypeWorkspaceConnectionProperties": { + "description": "This connection type covers the AAD auth for any applicable Azure service", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "AAD" + }, + "AccessKeyAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionAccessKey" + } + }, + "x-ms-discriminator-value": "AccessKey" + }, + "WorkspaceConnectionAccessKey": { + "type": "object", + "properties": { + "accessKeyId": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" + } + } + }, + "AccountKeyAuthTypeWorkspaceConnectionProperties": { + "description": "This connection type covers the account key connection for Azure storage", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" + } + }, + "x-ms-discriminator-value": "AccountKey" + }, + "ApiKeyAuthWorkspaceConnectionProperties": { + "description": "This connection type covers the generic ApiKey auth connection categories, for examples:\r\nAzureOpenAI:\r\n Category:= AzureOpenAI\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= {ApiBase}\r\n \r\nCognitiveService:\r\n Category:= CognitiveService\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= ServiceRegion={serviceRegion}\r\n \r\nCognitiveSearch:\r\n Category:= CognitiveSearch\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= {Endpoint}\r\n \r\nUse Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionApiKey" + } + }, + "x-ms-discriminator-value": "ApiKey" + }, + "WorkspaceConnectionApiKey": { + "description": "Api key object for workspace connection credential.", + "type": "object", + "properties": { + "key": { + "type": "string" + } + } + }, + "CustomKeysWorkspaceConnectionProperties": { + "description": "Category:= CustomKeys\r\nAuthType:= CustomKeys (as type discriminator)\r\nCredentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys\r\nTarget:= {any value}\r\nUse Metadata property bag for ApiVersion and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "description": "Custom Keys credential object", + "$ref": "#/definitions/CustomKeys" + } + }, + "x-ms-discriminator-value": "CustomKeys" + }, + "CustomKeys": { + "description": "Custom Keys credential object", + "type": "object", + "properties": { + "keys": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "OAuth2AuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionOAuth2" + } + }, + "x-ms-discriminator-value": "OAuth2" + }, + "WorkspaceConnectionOAuth2": { + "description": "ClientId and ClientSecret are required. Other properties are optional\r\ndepending on each OAuth2 provider's implementation.", + "type": "object", + "properties": { + "authUrl": { + "description": "Required by Concur connection category", + "type": "string", + "format": "url" + }, + "clientId": { + "type": "string", + "description": "Client id in the format of UUID", + "format": "uuid" + }, + "clientSecret": { + "type": "string", + "x-ms-secret": true + }, + "developerToken": { + "description": "Required by GoogleAdWords connection category", + "type": "string", + "x-ms-secret": true + }, + "password": { + "type": "string", + "x-ms-secret": true + }, + "refreshToken": { + "description": "Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho\r\nwhere user needs to get RefreshToken offline", + "type": "string", + "x-ms-secret": true + }, + "tenantId": { + "description": "Required by QuickBooks and Xero connection categories", + "type": "string" + }, + "username": { + "description": "Concur, ServiceNow auth server AccessToken grant type is 'Password'\r\nwhich requires UsernamePassword", + "type": "string" + } + } + }, + "ServicePrincipalAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" + } + }, + "x-ms-discriminator-value": "ServicePrincipal" + }, + "WorkspaceConnectionServicePrincipal": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "clientSecret": { + "x-ms-secret": true, + "type": "string" + }, + "tenantId": { + "type": "string" + } + } + }, + "ConnectionGroup": { + "description": "Group based on connection category", + "enum": [ + "Azure", + "AzureAI", + "Database", + "NoSQL", + "File", + "GenericProtocol", + "ServicesAndApps" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionGroup", + "modelAsString": true + } + }, + "EncryptionUpdateProperties": { + "required": [ + "keyVaultProperties" + ], + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties" + } + } + }, + "EncryptionKeyVaultUpdateProperties": { + "required": [ + "keyIdentifier" + ], + "type": "object", + "properties": { + "keyIdentifier": { + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + } + }, + "WorkspaceHubConfig": { + "description": "WorkspaceHub's configuration object.", + "type": "object", + "properties": { + "additionalWorkspaceStorageAccounts": { + "type": "array", + "items": { + "type": "string" + } + }, + "defaultWorkspaceResourceGroup": { + "type": "string" + } + } } } } diff --git a/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/mfe.json b/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/mfe.json similarity index 92% rename from swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/mfe.json rename to swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/mfe.json index 618d167b5..fdab5a2bb 100644 --- a/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/mfe.json +++ b/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/mfe.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Azure Machine Learning Services", - "version": "2023-10-01" + "version": "2024-04-01" }, "host": "management.azure.com", "schemes": [ @@ -37,17 +37,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { @@ -93,8 +93,11 @@ } ], "responses": { - "200": { - "description": "Success" + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted", @@ -117,14 +120,11 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -169,17 +169,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CodeContainerResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } } }, "x-ms-examples": { @@ -232,6 +232,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { @@ -254,12 +260,6 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -322,17 +322,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" + } } }, "x-ms-examples": { @@ -385,8 +385,11 @@ } ], "responses": { - "200": { - "description": "Success" + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted", @@ -409,14 +412,11 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -468,17 +468,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CodeVersionResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } } }, "x-ms-examples": { @@ -538,6 +538,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { @@ -560,12 +566,6 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -631,17 +631,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PendingUploadResponseDto" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } } }, "x-ms-examples": { @@ -679,17 +679,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { @@ -735,8 +735,11 @@ } ], "responses": { - "200": { - "description": "Success" + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted", @@ -759,14 +762,11 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -811,17 +811,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ComponentContainerResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } } }, "x-ms-examples": { @@ -874,6 +874,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { @@ -896,12 +902,6 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -964,17 +964,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" + } } }, "x-ms-examples": { @@ -1027,8 +1027,11 @@ } ], "responses": { - "200": { - "description": "Success" + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted", @@ -1051,14 +1054,11 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -1110,17 +1110,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ComponentVersionResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } } }, "x-ms-examples": { @@ -1180,6 +1180,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { @@ -1202,12 +1208,6 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -1276,17 +1276,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { @@ -1331,8 +1331,11 @@ } ], "responses": { - "200": { - "description": "Success" + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted", @@ -1355,14 +1358,11 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -1406,19 +1406,19 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DataContainerResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } - } - }, + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + } + }, "x-ms-examples": { "Get Registry Data Container.": { "$ref": "./examples/Registry/DataContainer/get.json" @@ -1469,6 +1469,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { @@ -1491,12 +1497,6 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -1591,17 +1591,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" + } } }, "x-ms-examples": { @@ -1653,8 +1653,11 @@ } ], "responses": { - "200": { - "description": "Success" + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted", @@ -1677,14 +1680,11 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -1735,17 +1735,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DataVersionBaseResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } } }, "x-ms-examples": { @@ -1805,6 +1805,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { @@ -1827,12 +1833,6 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -1897,17 +1897,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PendingUploadResponseDto" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } } }, "x-ms-examples": { @@ -1969,17 +1969,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GetBlobReferenceSASResponseDto" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/GetBlobReferenceSASResponseDto" + } } }, "x-ms-examples": { @@ -2044,17 +2044,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { @@ -2100,8 +2100,11 @@ } ], "responses": { - "200": { - "description": "Success" + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted", @@ -2124,14 +2127,11 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -2176,17 +2176,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } } }, "x-ms-examples": { @@ -2239,6 +2239,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { @@ -2261,12 +2267,6 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -2356,17 +2356,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" + } } }, "x-ms-examples": { @@ -2419,8 +2419,11 @@ } ], "responses": { - "200": { - "description": "Success" + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted", @@ -2443,14 +2446,11 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -2502,17 +2502,17 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } } }, "x-ms-examples": { @@ -2572,6 +2572,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { @@ -2594,12 +2600,6 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { @@ -2613,13 +2613,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions": { "get": { "tags": [ - "ModelContainer" + "MarketplaceSubscription" ], - "summary": "List model containers.", - "operationId": "RegistryModelContainers_List", + "summary": "List containers.", + "operationId": "MarketplaceSubscriptions_List", "produces": [ "application/json" ], @@ -2631,47 +2631,20 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "registries.json#/parameters/RegistryNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + "$ref": "#/definitions/MarketplaceSubscriptionResourceArmPaginatedResult" } }, "default": { @@ -2682,8 +2655,8 @@ } }, "x-ms-examples": { - "List Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/list.json" + "List Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/list.json" } }, "x-ms-pageable": { @@ -2691,13 +2664,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions/{name}": { "delete": { "tags": [ - "ModelContainer" + "MarketplaceSubscription" ], - "summary": "Delete container.", - "operationId": "RegistryModelContainers_Delete", + "summary": "Delete Marketplace Subscription (asynchronous).", + "operationId": "MarketplaceSubscriptions_Delete", "produces": [ "application/json" ], @@ -2709,12 +2682,12 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "registries.json#/parameters/RegistryNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "in": "path", - "name": "modelName", - "description": "Container name.", + "name": "name", + "description": "Marketplace Subscription name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -2724,9 +2697,6 @@ } ], "responses": { - "200": { - "description": "Success" - }, "202": { "description": "Accepted", "headers": { @@ -2759,8 +2729,8 @@ } }, "x-ms-examples": { - "Delete Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/delete.json" + "Delete Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/delete.json" } }, "x-ms-long-running-operation": true, @@ -2770,10 +2740,10 @@ }, "get": { "tags": [ - "ModelContainer" + "MarketplaceSubscription" ], "summary": "Get container.", - "operationId": "RegistryModelContainers_Get", + "operationId": "MarketplaceSubscriptions_Get", "produces": [ "application/json" ], @@ -2785,15 +2755,14 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "registries.json#/parameters/RegistryNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "in": "path", - "name": "modelName", - "description": "Container name. This is case-sensitive.", + "name": "name", + "description": "Container name.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -2803,7 +2772,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/MarketplaceSubscriptionResource" } }, "default": { @@ -2814,17 +2783,17 @@ } }, "x-ms-examples": { - "Get Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/get.json" + "Get Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/get.json" } } }, "put": { "tags": [ - "ModelContainer" + "MarketplaceSubscription" ], - "summary": "Create or update model container.", - "operationId": "RegistryModelContainers_CreateOrUpdate", + "summary": "Create or update Marketplace Subscription (asynchronous).", + "operationId": "MarketplaceSubscriptions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -2839,12 +2808,12 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "registries.json#/parameters/RegistryNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "in": "path", - "name": "modelName", - "description": "Container name.", + "name": "name", + "description": "Marketplace Subscription name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -2855,10 +2824,10 @@ { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Marketplace Subscription entity to apply during operation.", "required": true, "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/MarketplaceSubscriptionResource" } } ], @@ -2866,13 +2835,13 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/MarketplaceSubscriptionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/MarketplaceSubscriptionResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -2894,8 +2863,8 @@ } }, "x-ms-examples": { - "CreateOrUpdate Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Marketplace Subscription.": { + "$ref": "./examples/Workspace/MarketplaceSubscription/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -2904,13 +2873,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models": { "get": { "tags": [ - "ModelVersion" + "ModelContainer" ], - "summary": "List versions.", - "operationId": "RegistryModelVersions_List", + "summary": "List model containers.", + "operationId": "RegistryModelContainers_List", "produces": [ "application/json" ], @@ -2924,57 +2893,12 @@ { "$ref": "registries.json#/parameters/RegistryNameParameter" }, - { - "in": "path", - "name": "modelName", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, - { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" - }, - { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" - }, - { - "in": "query", - "name": "version", - "description": "Version identifier.", - "type": "string" - }, - { - "in": "query", - "name": "description", - "description": "Model description.", - "type": "string" - }, - { - "in": "query", - "name": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" - }, - { - "in": "query", - "name": "properties", - "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", - "type": "string" - }, { "in": "query", "name": "listViewType", @@ -3004,22 +2928,22 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/list.json" + "List Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/list.json" } }, "x-ms-pageable": { @@ -3027,13 +2951,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}": { "delete": { "tags": [ - "ModelVersion" + "ModelContainer" ], - "summary": "Delete version.", - "operationId": "RegistryModelVersions_Delete", + "summary": "Delete container.", + "operationId": "RegistryModelContainers_Delete", "produces": [ "application/json" ], @@ -3055,20 +2979,16 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success" + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted", @@ -3091,19 +3011,16 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Delete Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/delete.json" + "Delete Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/delete.json" } }, "x-ms-long-running-operation": true, @@ -3113,10 +3030,10 @@ }, "get": { "tags": [ - "ModelVersion" + "ModelContainer" ], - "summary": "Get version.", - "operationId": "RegistryModelVersions_Get", + "summary": "Get container.", + "operationId": "RegistryModelContainers_Get", "produces": [ "application/json" ], @@ -3138,43 +3055,36 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ModelVersionResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } } }, "x-ms-examples": { - "Get Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/get.json" + "Get Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/get.json" } } }, "put": { "tags": [ - "ModelVersion" + "ModelContainer" ], - "summary": "Create or update version.", - "operationId": "RegistryModelVersions_CreateOrUpdate", + "summary": "Create or update model container.", + "operationId": "RegistryModelContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -3199,37 +3109,36 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/ModelContainerResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/ModelContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/ModelContainerResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -3242,17 +3151,11 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "CreateOrUpdate Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/createOrUpdate.json" + "CreateOrUpdate Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -3261,16 +3164,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}/startPendingUpload": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions": { + "get": { "tags": [ "ModelVersion" ], - "summary": "Generate a storage location and credential for the client to upload a model asset to.", - "operationId": "RegistryModelVersions_CreateOrGetStartPendingUpload", - "consumes": [ - "application/json" - ], + "summary": "List versions.", + "operationId": "RegistryModelVersions_List", "produces": [ "application/json" ], @@ -3287,103 +3187,99 @@ { "in": "path", "name": "modelName", - "description": "Model name. This is case-sensitive.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "in": "path", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, + "description": "Version identifier.", "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "description", + "description": "Model description.", + "type": "string" }, { - "in": "body", - "name": "body", - "description": "Pending upload request object", - "required": true, - "schema": { - "$ref": "#/definitions/PendingUploadRequestDto" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PendingUploadResponseDto" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CreateOrGetStartPendingUpload Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/createOrGetStartPendingUpload.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": { - "get": { - "tags": [ - "BatchEndpoint" - ], - "summary": "Lists Batch inference endpoint in the workspace.", - "operationId": "BatchEndpoints_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" }, { "in": "query", - "name": "count", - "description": "Number of endpoints to be retrieved in a page of results.", - "type": "integer", - "format": "int32" + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/list.json" + "List Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/list.json" } }, "x-ms-pageable": { @@ -3391,13 +3287,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}": { "delete": { "tags": [ - "BatchEndpoint" + "ModelVersion" ], - "summary": "Delete Batch Inference Endpoint (asynchronous).", - "operationId": "BatchEndpoints_Delete", + "summary": "Delete version.", + "operationId": "RegistryModelVersions_Delete", "produces": [ "application/json" ], @@ -3409,12 +3305,20 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", - "name": "endpointName", - "description": "Inference Endpoint name.", + "name": "modelName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", "required": true, "type": "string" }, @@ -3423,8 +3327,11 @@ } ], "responses": { - "200": { - "description": "Success" + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted", @@ -3447,19 +3354,16 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Delete Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/delete.json" + "Delete Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/delete.json" } }, "x-ms-long-running-operation": true, @@ -3469,10 +3373,10 @@ }, "get": { "tags": [ - "BatchEndpoint" + "ModelVersion" ], - "summary": "Gets a batch inference endpoint by name.", - "operationId": "BatchEndpoints_Get", + "summary": "Get version.", + "operationId": "RegistryModelVersions_Get", "produces": [ "application/json" ], @@ -3484,12 +3388,20 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", - "name": "endpointName", - "description": "Name for the Batch Endpoint.", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -3498,31 +3410,31 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } } }, "x-ms-examples": { - "Get Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/get.json" + "Get Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/get.json" } } }, - "patch": { + "put": { "tags": [ - "BatchEndpoint" + "ModelVersion" ], - "summary": "Update a batch inference endpoint (asynchronous).", - "operationId": "BatchEndpoints_Update", + "summary": "Create or update version.", + "operationId": "RegistryModelVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -3537,77 +3449,85 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", - "name": "endpointName", - "description": "Name for the Batch inference endpoint.", + "name": "modelName", + "description": "Container name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Mutable batch inference endpoint definition object.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + "$ref": "#/definitions/ModelVersionResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/ModelVersionResource" } }, - "202": { - "description": "Accepted", + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + }, "headers": { "x-ms-async-operation-timeout": { "description": "Timeout for the client to use when polling the asynchronous operation.", "type": "string", "format": "duration" }, - "Location": { - "description": "URI to poll for asynchronous operation result.", + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Update Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/update.json" + "CreateOrUpdate Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/createOrUpdate.json" } }, - "x-ms-long-running-operation": true - }, - "put": { + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}/startPendingUpload": { + "post": { "tags": [ - "BatchEndpoint" + "ModelVersion" ], - "summary": "Creates a batch inference endpoint (asynchronous).", - "operationId": "BatchEndpoints_CreateOrUpdate", + "summary": "Generate a storage location and credential for the client to upload a model asset to.", + "operationId": "RegistryModelVersions_CreateOrGetStartPendingUpload", "consumes": [ "application/json" ], @@ -3622,78 +3542,64 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", - "name": "endpointName", - "description": "Name for the Batch inference endpoint.", + "name": "modelName", + "description": "Model name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Batch inference endpoint definition object.", + "description": "Pending upload request object", "required": true, "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/PendingUploadRequestDto" } } ], "responses": { - "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/createOrUpdate.json" + "CreateOrGetStartPendingUpload Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/createOrGetStartPendingUpload.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": { "get": { "tags": [ - "BatchDeployment" + "BatchEndpoint" ], - "summary": "Lists Batch inference deployments in the workspace.", - "operationId": "BatchDeployments_List", + "summary": "Lists Batch inference endpoint in the workspace.", + "operationId": "BatchEndpoints_List", "produces": [ "application/json" ], @@ -3707,26 +3613,13 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, - { - "in": "path", - "name": "endpointName", - "description": "Endpoint name", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" - }, - { - "in": "query", - "name": "$top", - "description": "Top of list.", + "name": "count", + "description": "Number of endpoints to be retrieved in a page of results.", "type": "integer", "format": "int32" }, @@ -3735,22 +3628,22 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/list.json" + "List Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/list.json" } }, "x-ms-pageable": { @@ -3758,13 +3651,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": { "delete": { "tags": [ - "BatchDeployment" + "BatchEndpoint" ], - "summary": "Delete Batch Inference deployment (asynchronous).", - "operationId": "BatchDeployments_Delete", + "summary": "Delete Batch Inference Endpoint (asynchronous).", + "operationId": "BatchEndpoints_Delete", "produces": [ "application/json" ], @@ -3781,14 +3674,7 @@ { "in": "path", "name": "endpointName", - "description": "Endpoint name", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "Inference deployment identifier.", + "description": "Inference Endpoint name.", "required": true, "type": "string" }, @@ -3797,6 +3683,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Success" }, @@ -3823,17 +3715,11 @@ }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Delete Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/delete.json" + "Delete Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/delete.json" } }, "x-ms-long-running-operation": true, @@ -3843,10 +3729,10 @@ }, "get": { "tags": [ - "BatchDeployment" + "BatchEndpoint" ], - "summary": "Gets a batch inference deployment by id.", - "operationId": "BatchDeployments_Get", + "summary": "Gets a batch inference endpoint by name.", + "operationId": "BatchEndpoints_Get", "produces": [ "application/json" ], @@ -3863,14 +3749,7 @@ { "in": "path", "name": "endpointName", - "description": "Endpoint name", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "The identifier for the Batch deployments.", + "description": "Name for the Batch Endpoint.", "required": true, "type": "string" }, @@ -3879,31 +3758,31 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } } }, "x-ms-examples": { - "Get Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/get.json" + "Get Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/get.json" } } }, "patch": { "tags": [ - "BatchDeployment" + "BatchEndpoint" ], - "summary": "Update a batch inference deployment (asynchronous).", - "operationId": "BatchDeployments_Update", + "summary": "Update a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_Update", "consumes": [ "application/json" ], @@ -3923,15 +3802,7 @@ { "in": "path", "name": "endpointName", - "description": "Inference endpoint name", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "deploymentName", - "description": "The identifier for the Batch inference deployment.", + "description": "Name for the Batch inference endpoint.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -3942,18 +3813,24 @@ { "in": "body", "name": "body", - "description": "Batch inference deployment definition object.", + "description": "Mutable batch inference endpoint definition object.", "required": true, "schema": { - "$ref": "#/definitions/PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties" + "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" + "$ref": "#/definitions/BatchEndpointTrackedResource" } }, "202": { @@ -3976,27 +3853,21 @@ "minimum": 10 } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Update Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/update.json" + "Update Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/update.json" } }, "x-ms-long-running-operation": true }, "put": { "tags": [ - "BatchDeployment" + "BatchEndpoint" ], - "summary": "Creates/updates a batch inference deployment (asynchronous).", - "operationId": "BatchDeployments_CreateOrUpdate", + "summary": "Creates a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_CreateOrUpdate", "consumes": [ "application/json" ], @@ -4016,15 +3887,7 @@ { "in": "path", "name": "endpointName", - "description": "Inference endpoint name", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "deploymentName", - "description": "The identifier for the Batch inference deployment.", + "description": "Name for the Batch inference endpoint.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -4035,24 +3898,30 @@ { "in": "body", "name": "body", - "description": "Batch inference deployment definition object.", + "description": "Batch inference endpoint definition object.", "required": true, "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" + "$ref": "#/definitions/BatchEndpointTrackedResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" + "$ref": "#/definitions/BatchEndpointTrackedResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" + "$ref": "#/definitions/BatchEndpointTrackedResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -4065,17 +3934,11 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/createOrUpdate.json" + "CreateOrUpdate Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -4084,13 +3947,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments": { + "get": { "tags": [ - "BatchEndpoint" + "BatchDeployment" ], - "summary": "Lists batch Inference Endpoint keys.", - "operationId": "BatchEndpoints_ListKeys", + "summary": "Lists Batch inference deployments in the workspace.", + "operationId": "BatchDeployments_List", "produces": [ "application/json" ], @@ -4107,42 +3970,61 @@ { "in": "path", "name": "endpointName", - "description": "Inference Endpoint name.", + "description": "Endpoint name", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top of list.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { - "200": { - "description": "Success", + "default": { + "description": "Error", "schema": { - "$ref": "#/definitions/EndpointAuthKeys" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "default": { - "description": "Error", + "200": { + "description": "Success", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/BatchDeploymentTrackedResourceArmPaginatedResult" } } }, "x-ms-examples": { - "ListKeys Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/listKeys.json" + "List Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/list.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": { + "delete": { "tags": [ - "CodeContainer" + "BatchDeployment" ], - "summary": "List containers.", - "operationId": "CodeContainers_List", + "summary": "Delete Batch Inference deployment (asynchronous).", + "operationId": "BatchDeployments_Delete", "produces": [ "application/json" ], @@ -4157,43 +4039,74 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "endpointName", + "description": "Endpoint name", + "required": true, + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "path", + "name": "deploymentName", + "description": "Inference deployment identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "List Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/list.json" + "Delete Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/delete.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": { - "delete": { + }, + "get": { "tags": [ - "CodeContainer" + "BatchDeployment" ], - "summary": "Delete container.", - "operationId": "CodeContainers_Delete", + "summary": "Gets a batch inference deployment by id.", + "operationId": "BatchDeployments_Get", "produces": [ "application/json" ], @@ -4209,8 +4122,15 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "endpointName", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch deployments.", "required": true, "type": "string" }, @@ -4219,31 +4139,34 @@ } ], "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } } }, "x-ms-examples": { - "Delete Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/delete.json" + "Get Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/get.json" } } }, - "get": { + "patch": { "tags": [ - "CodeContainer" + "BatchDeployment" + ], + "summary": "Update a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_Update", + "consumes": [ + "application/json" ], - "summary": "Get container.", - "operationId": "CodeContainers_Get", "produces": [ "application/json" ], @@ -4259,41 +4182,81 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "endpointName", + "description": "Inference endpoint name", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Batch inference deployment definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties" + } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Success", "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" } }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } } }, "x-ms-examples": { - "Get Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/get.json" + "Update Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/update.json" } - } + }, + "x-ms-long-running-operation": true }, "put": { "tags": [ - "CodeContainer" + "BatchDeployment" ], - "summary": "Create or update container.", - "operationId": "CodeContainers_CreateOrUpdate", + "summary": "Creates/updates a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_CreateOrUpdate", "consumes": [ "application/json" ], @@ -4312,8 +4275,16 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "endpointName", + "description": "Inference endpoint name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -4324,47 +4295,62 @@ { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Batch inference deployment definition object.", "required": true, "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/CodeContainerResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/BatchDeploymentTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/createOrUpdate.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": { + "post": { "tags": [ - "CodeVersion" + "BatchEndpoint" ], - "summary": "List versions.", - "operationId": "CodeVersions_List", + "summary": "Lists batch Inference Endpoint keys.", + "operationId": "BatchEndpoints_ListKeys", "produces": [ "application/json" ], @@ -4380,60 +4366,80 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "endpointName", + "description": "Inference Endpoint name.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + } + }, + "x-ms-examples": { + "ListKeys Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": { + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "List containers.", + "operationId": "CodeContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "query", - "name": "hash", - "description": "If specified, return CodeVersion assets with specified content hash value, regardless of name", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "hashVersion", - "description": "Hash algorithm version when listing by hash", - "type": "string" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/list.json" + "List Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/list.json" } }, "x-ms-pageable": { @@ -4441,13 +4447,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": { "delete": { "tags": [ - "CodeVersion" + "CodeContainer" ], - "summary": "Delete version.", - "operationId": "CodeVersions_Delete", + "summary": "Delete container.", + "operationId": "CodeContainers_Delete", "produces": [ "application/json" ], @@ -4468,43 +4474,36 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/delete.json" + "Delete Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/delete.json" } } }, "get": { "tags": [ - "CodeVersion" + "CodeContainer" ], - "summary": "Get version.", - "operationId": "CodeVersions_Get", + "summary": "Get container.", + "operationId": "CodeContainers_Get", "produces": [ "application/json" ], @@ -4525,43 +4524,36 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CodeVersionResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } } }, "x-ms-examples": { - "Get Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/get.json" + "Get Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/get.json" } } }, "put": { "tags": [ - "CodeVersion" + "CodeContainer" ], - "summary": "Create or update version.", - "operationId": "CodeVersions_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "CodeContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -4586,63 +4578,53 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/CodeVersionResource" + "$ref": "#/definitions/CodeContainerResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/CodeVersionResource" + "$ref": "#/definitions/CodeContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/CodeVersionResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/CodeContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/createOrUpdate.json" + "CreateOrUpdate Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/publish": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": { + "get": { "tags": [ "CodeVersion" ], - "summary": "Publish version asset into registry.", - "operationId": "CodeVersions_Publish", - "consumes": [ - "application/json" - ], + "summary": "List versions.", + "operationId": "CodeVersions_List", "produces": [ "application/json" ], @@ -4659,78 +4641,73 @@ { "in": "path", "name": "name", - "description": "Container name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" }, { - "in": "body", - "name": "body", - "description": "Destination registry info", - "required": true, - "schema": { - "$ref": "#/definitions/DestinationAsset" - } + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "hash", + "description": "If specified, return CodeVersion assets with specified content hash value, regardless of name", + "type": "string" + }, + { + "in": "query", + "name": "hashVersion", + "description": "Hash algorithm version when listing by hash", + "type": "string" } ], "responses": { - "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "Publish Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/publish.json" + "List Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/list.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/startPendingUpload": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": { + "delete": { "tags": [ "CodeVersion" ], - "summary": "Generate a storage location and credential for the client to upload a code asset to.", - "operationId": "CodeVersions_CreateOrGetStartPendingUpload", - "consumes": [ - "application/json" - ], + "summary": "Delete version.", + "operationId": "CodeVersions_Delete", "produces": [ "application/json" ], @@ -4760,45 +4737,34 @@ }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Pending upload request object", - "required": true, - "schema": { - "$ref": "#/definitions/PendingUploadRequestDto" - } } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PendingUploadResponseDto" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "CreateOrGetStartPendingUpload Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json" + "Delete Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/delete.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components": { + }, "get": { "tags": [ - "ComponentContainer" + "CodeVersion" ], - "summary": "List component containers.", - "operationId": "ComponentContainers_List", + "summary": "Get version.", + "operationId": "CodeVersions_Get", "produces": [ "application/json" ], @@ -4813,70 +4779,52 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" }, { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } } }, "x-ms-examples": { - "List Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/list.json" + "Get Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/get.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}": { - "delete": { + }, + "put": { "tags": [ - "ComponentContainer" + "CodeVersion" + ], + "summary": "Create or update version.", + "operationId": "CodeVersions_CreateOrUpdate", + "consumes": [ + "application/json" ], - "summary": "Delete container.", - "operationId": "ComponentContainers_Delete", "produces": [ "application/json" ], @@ -4893,40 +4841,68 @@ { "in": "path", "name": "name", - "description": "Container name.", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } } ], "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } } }, "x-ms-examples": { - "Delete Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/delete.json" + "CreateOrUpdate Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/createOrUpdate.json" } } - }, - "get": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/publish": { + "post": { "tags": [ - "ComponentContainer" + "CodeVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "CodeVersions_Publish", + "consumes": [ + "application/json" ], - "summary": "Get container.", - "operationId": "ComponentContainers_Get", "produces": [ "application/json" ], @@ -4947,36 +4923,71 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ComponentContainerResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } } }, "x-ms-examples": { - "Get Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/get.json" + "Publish Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/publish.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/startPendingUpload": { + "post": { "tags": [ - "ComponentContainer" + "CodeVersion" ], - "summary": "Create or update container.", - "operationId": "ComponentContainers_CreateOrUpdate", + "summary": "Generate a storage location and credential for the client to upload a code asset to.", + "operationId": "CodeVersions_CreateOrGetStartPendingUpload", "consumes": [ "application/json" ], @@ -4996,10 +5007,16 @@ { "in": "path", "name": "name", - "description": "Container name.", + "description": "Container name. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -5007,47 +5024,41 @@ { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Pending upload request object", "required": true, "schema": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/PendingUploadRequestDto" } } ], "responses": { - "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/ComponentContainerResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ComponentContainerResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/createOrUpdate.json" + "CreateOrGetStartPendingUpload Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components": { "get": { "tags": [ - "ComponentVersion" + "ComponentContainer" ], - "summary": "List component versions.", - "operationId": "ComponentVersions_List", + "summary": "List component containers.", + "operationId": "ComponentContainers_List", "produces": [ "application/json" ], @@ -5061,29 +5072,9 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, - { - "in": "path", - "name": "name", - "description": "Component name.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, - { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" - }, - { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" - }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, @@ -5116,22 +5107,22 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/list.json" + "List Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/list.json" } }, "x-ms-pageable": { @@ -5139,13 +5130,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}": { "delete": { "tags": [ - "ComponentVersion" + "ComponentContainer" ], - "summary": "Delete version.", - "operationId": "ComponentVersions_Delete", + "summary": "Delete container.", + "operationId": "ComponentContainers_Delete", "produces": [ "application/json" ], @@ -5166,43 +5157,36 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/delete.json" + "Delete Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/delete.json" } } }, "get": { "tags": [ - "ComponentVersion" + "ComponentContainer" ], - "summary": "Get version.", - "operationId": "ComponentVersions_Get", + "summary": "Get container.", + "operationId": "ComponentContainers_Get", "produces": [ "application/json" ], @@ -5223,43 +5207,36 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ComponentVersionResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } } }, "x-ms-examples": { - "Get Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/get.json" + "Get Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/get.json" } } }, "put": { "tags": [ - "ComponentVersion" + "ComponentContainer" ], - "summary": "Create or update version.", - "operationId": "ComponentVersions_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "ComponentContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5284,63 +5261,53 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/ComponentContainerResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/ComponentContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ComponentVersionResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ComponentContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/createOrUpdate.json" + "CreateOrUpdate Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}/publish": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions": { + "get": { "tags": [ "ComponentVersion" ], - "summary": "Publish version asset into registry.", - "operationId": "ComponentVersions_Publish", - "consumes": [ - "application/json" - ], + "summary": "List component versions.", + "operationId": "ComponentVersions_List", "produces": [ "application/json" ], @@ -5357,75 +5324,88 @@ { "in": "path", "name": "name", - "description": "Container name.", + "description": "Component name.", "required": true, "type": "string" }, { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" }, { - "in": "body", - "name": "body", - "description": "Destination registry info", - "required": true, - "schema": { - "$ref": "#/definitions/DestinationAsset" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] } } ], "responses": { - "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "Publish Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/publish.json" + "List Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/list.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}": { + "delete": { "tags": [ - "DataContainer" + "ComponentVersion" ], - "summary": "List data containers.", - "operationId": "DataContainers_List", + "summary": "Delete version.", + "operationId": "ComponentVersions_Delete", "produces": [ "application/json" ], @@ -5440,70 +5420,49 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" }, { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "List Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/list.json" + "Delete Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/delete.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": { - "delete": { + }, + "get": { "tags": [ - "DataContainer" + "ComponentVersion" ], - "summary": "Delete container.", - "operationId": "DataContainers_Delete", + "summary": "Get version.", + "operationId": "ComponentVersions_Get", "produces": [ "application/json" ], @@ -5524,36 +5483,46 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } } }, "x-ms-examples": { - "Delete Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/delete.json" + "Get Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/get.json" } } }, - "get": { + "put": { "tags": [ - "DataContainer" + "ComponentVersion" + ], + "summary": "Create or update version.", + "operationId": "ComponentVersions_CreateOrUpdate", + "consumes": [ + "application/json" ], - "summary": "Get container.", - "operationId": "DataContainers_Get", "produces": [ "application/json" ], @@ -5572,38 +5541,63 @@ "name": "name", "description": "Container name.", "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/ComponentVersionResource" } }, - "default": { - "description": "Error", + "201": { + "description": "Created", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ComponentVersionResource" } } }, "x-ms-examples": { - "Get Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/get.json" + "CreateOrUpdate Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/createOrUpdate.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}/publish": { + "post": { "tags": [ - "DataContainer" + "ComponentVersion" ], - "summary": "Create or update container.", - "operationId": "DataContainers_CreateOrUpdate", + "summary": "Publish version asset into registry.", + "operationId": "ComponentVersions_Publish", "consumes": [ "application/json" ], @@ -5625,8 +5619,14 @@ "name": "name", "description": "Container name.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -5634,47 +5634,58 @@ { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Destination registry info", "required": true, "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/DestinationAsset" } } ], "responses": { - "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/DataContainerResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/DataContainerResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/createOrUpdate.json" + "Publish Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/publish.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": { "get": { "tags": [ - "DataVersion" + "DataContainer" ], - "summary": "List data versions in the data container", - "operationId": "DataVersions_List", + "summary": "List data containers.", + "operationId": "DataContainers_List", "produces": [ "application/json" ], @@ -5688,42 +5699,16 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, - { - "in": "path", - "name": "name", - "description": "Data container's name", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, - { - "in": "query", - "name": "$orderBy", - "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", - "type": "string" - }, - { - "in": "query", - "name": "$top", - "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", - "type": "integer", - "format": "int32" - }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, - { - "in": "query", - "name": "$tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" - }, { "in": "query", "name": "listViewType", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "description": "View type for including/excluding (for example) archived entities.", "type": "string", "default": "ActiveOnly", "enum": [ @@ -5749,22 +5734,22 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/list.json" + "List Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/list.json" } }, "x-ms-pageable": { @@ -5772,13 +5757,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": { "delete": { "tags": [ - "DataVersion" + "DataContainer" ], - "summary": "Delete version.", - "operationId": "DataVersions_Delete", + "summary": "Delete container.", + "operationId": "DataContainers_Delete", "produces": [ "application/json" ], @@ -5799,43 +5784,36 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/delete.json" + "Delete Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/delete.json" } } }, "get": { "tags": [ - "DataVersion" + "DataContainer" ], - "summary": "Get version.", - "operationId": "DataVersions_Get", + "summary": "Get container.", + "operationId": "DataContainers_Get", "produces": [ "application/json" ], @@ -5856,43 +5834,36 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DataVersionBaseResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataContainerResource" + } } }, "x-ms-examples": { - "Get Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/get.json" + "Get Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/get.json" } } }, "put": { "tags": [ - "DataVersion" + "DataContainer" ], - "summary": "Create or update version.", - "operationId": "DataVersions_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "DataContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5917,63 +5888,53 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/DataContainerResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/DataContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/DataVersionBaseResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/DataContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/createOrUpdate.json" + "CreateOrUpdate Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}/publish": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": { + "get": { "tags": [ "DataVersion" ], - "summary": "Publish version asset into registry.", - "operationId": "DataVersions_Publish", - "consumes": [ - "application/json" - ], + "summary": "List data versions in the data container", + "operationId": "DataVersions_List", "produces": [ "application/json" ], @@ -5990,75 +5951,94 @@ { "in": "path", "name": "name", - "description": "Container name.", + "description": "Data container's name", "required": true, "type": "string" }, { - "in": "path", - "name": "version", - "description": "Version identifier.", - "required": true, + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "$top", + "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", + "type": "integer", + "format": "int32" }, { - "in": "body", - "name": "body", - "description": "Destination registry info", - "required": true, - "schema": { - "$ref": "#/definitions/DestinationAsset" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] } } ], "responses": { - "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "Publish Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/publish.json" + "List Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/list.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": { + "delete": { "tags": [ - "Datastore" + "DataVersion" ], - "summary": "List datastores.", - "operationId": "Datastores_List", + "summary": "Delete version.", + "operationId": "DataVersions_Delete", "produces": [ "application/json" ], @@ -6073,85 +6053,49 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" }, { - "in": "query", - "name": "count", - "description": "Maximum number of results to return.", - "type": "integer", - "format": "int32", - "default": 30 + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } }, - { - "in": "query", - "name": "isDefault", - "description": "Filter down to the workspace default datastore.", - "type": "boolean" + "200": { + "description": "Success" }, - { - "in": "query", - "name": "names", - "description": "Names of datastores to return.", - "type": "array", - "items": { - "type": "string" - } - }, - { - "in": "query", - "name": "searchText", - "description": "Text to search for in the datastore names.", - "type": "string" - }, - { - "in": "query", - "name": "orderBy", - "description": "Order by property (createdtime | modifiedtime | name).", - "type": "string" - }, - { - "in": "query", - "name": "orderByAsc", - "description": "Order by property in ascending order.", - "type": "boolean", - "default": false - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DatastoreResourceArmPaginatedResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } + "204": { + "description": "No Content" } }, "x-ms-examples": { - "List datastores.": { - "$ref": "./examples/Datastore/list.json" + "Delete Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/delete.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}": { - "delete": { + }, + "get": { "tags": [ - "Datastore" + "DataVersion" ], - "summary": "Delete datastore.", - "operationId": "Datastores_Delete", + "summary": "Get version.", + "operationId": "DataVersions_Get", "produces": [ "application/json" ], @@ -6168,57 +6112,14 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name.", "required": true, "type": "string" }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete datastore.": { - "$ref": "./examples/Datastore/delete.json" - } - } - }, - "get": { - "tags": [ - "Datastore" - ], - "summary": "Get datastore.", - "operationId": "Datastores_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, { "in": "path", - "name": "name", - "description": "Datastore name.", + "name": "version", + "description": "Version identifier.", "required": true, "type": "string" }, @@ -6227,31 +6128,31 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DatastoreResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } } }, "x-ms-examples": { - "Get datastore.": { - "$ref": "./examples/Datastore/get.json" + "Get Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/get.json" } } }, "put": { "tags": [ - "Datastore" + "DataVersion" ], - "summary": "Create or update datastore.", - "operationId": "Datastores_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "DataVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -6271,74 +6172,68 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" }, { - "in": "query", - "name": "skipValidation", - "description": "Flag to skip validation.", - "type": "boolean", - "default": false + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Datastore entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/DataVersionBaseResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/DataVersionBaseResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/DatastoreResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/DataVersionBaseResource" } } }, "x-ms-examples": { - "CreateOrUpdate datastore (AzureBlob w/ AccountKey).": { - "$ref": "./examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json" - }, - "CreateOrUpdate datastore (Azure Data Lake Gen1 w/ ServicePrincipal).": { - "$ref": "./examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json" - }, - "CreateOrUpdate datastore (Azure Data Lake Gen2 w/ Service Principal).": { - "$ref": "./examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json" - }, - "CreateOrUpdate datastore (Azure File store w/ AccountKey).": { - "$ref": "./examples/Datastore/AzureFileWAccountKey/createOrUpdate.json" + "CreateOrUpdate Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}/publish": { "post": { "tags": [ - "Datastore" + "DataVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "DataVersions_Publish", + "consumes": [ + "application/json" ], - "summary": "Get datastore secrets.", - "operationId": "Datastores_ListSecrets", "produces": [ "application/json" ], @@ -6355,43 +6250,75 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } } ], "responses": { - "200": { - "description": "Success", - "schema": { - "description": "Base definition for datastore secrets.", - "$ref": "#/definitions/DatastoreSecrets" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } } }, "x-ms-examples": { - "Get datastore secrets.": { - "$ref": "./examples/Datastore/listSecrets.json" + "Publish Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/publish.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": { "get": { "tags": [ - "EnvironmentContainer" + "Datastore" ], - "summary": "List environment containers.", - "operationId": "EnvironmentContainers_List", + "summary": "List datastores.", + "operationId": "Datastores_List", "produces": [ "application/json" ], @@ -6413,49 +6340,64 @@ }, { "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] + "name": "count", + "description": "Maximum number of results to return.", + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "in": "query", + "name": "isDefault", + "description": "Filter down to the workspace default datastore.", + "type": "boolean" + }, + { + "in": "query", + "name": "names", + "description": "Names of datastores to return.", + "type": "array", + "items": { + "type": "string" } + }, + { + "in": "query", + "name": "searchText", + "description": "Text to search for in the datastore names.", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "Order by property (createdtime | modifiedtime | name).", + "type": "string" + }, + { + "in": "query", + "name": "orderByAsc", + "description": "Order by property in ascending order.", + "type": "boolean", + "default": false } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatastoreResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/list.json" + "List datastores.": { + "$ref": "./examples/Datastore/list.json" } }, "x-ms-pageable": { @@ -6463,13 +6405,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}": { "delete": { "tags": [ - "EnvironmentContainer" + "Datastore" ], - "summary": "Delete container.", - "operationId": "EnvironmentContainers_Delete", + "summary": "Delete datastore.", + "operationId": "Datastores_Delete", "produces": [ "application/json" ], @@ -6486,7 +6428,7 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Datastore name.", "required": true, "type": "string" }, @@ -6495,31 +6437,31 @@ } ], "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/delete.json" + "Delete datastore.": { + "$ref": "./examples/Datastore/delete.json" } } }, "get": { "tags": [ - "EnvironmentContainer" + "Datastore" ], - "summary": "Get container.", - "operationId": "EnvironmentContainers_Get", + "summary": "Get datastore.", + "operationId": "Datastores_Get", "produces": [ "application/json" ], @@ -6536,7 +6478,7 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Datastore name.", "required": true, "type": "string" }, @@ -6545,31 +6487,31 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatastoreResource" + } } }, "x-ms-examples": { - "Get Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/get.json" + "Get datastore.": { + "$ref": "./examples/Datastore/get.json" } } }, "put": { "tags": [ - "EnvironmentContainer" + "Datastore" ], - "summary": "Create or update container.", - "operationId": "EnvironmentContainers_CreateOrUpdate", + "summary": "Create or update datastore.", + "operationId": "Datastores_CreateOrUpdate", "consumes": [ "application/json" ], @@ -6589,7 +6531,7 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Datastore name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -6597,50 +6539,66 @@ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, + { + "in": "query", + "name": "skipValidation", + "description": "Flag to skip validation.", + "type": "boolean", + "default": false + }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Datastore entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/DatastoreResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/DatastoreResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/DatastoreResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/createOrUpdate.json" + "CreateOrUpdate datastore (AzureBlob w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen1 w/ ServicePrincipal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen2 w/ Service Principal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure File store w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureFileWAccountKey/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets": { + "post": { "tags": [ - "EnvironmentVersion" + "Datastore" ], - "summary": "List versions.", - "operationId": "EnvironmentVersions_List", + "summary": "Get datastore secrets.", + "operationId": "Datastores_ListSecrets", "produces": [ "application/json" ], @@ -6657,25 +6615,58 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Datastore name.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "description": "Base definition for datastore secrets.", + "$ref": "#/definitions/DatastoreSecrets" + } + } + }, + "x-ms-examples": { + "Get datastore secrets.": { + "$ref": "./examples/Datastore/listSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": { + "get": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "List environment containers.", + "operationId": "EnvironmentContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" @@ -6709,22 +6700,22 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/list.json" + "List Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/list.json" } }, "x-ms-pageable": { @@ -6732,14 +6723,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": { "delete": { "tags": [ - "EnvironmentVersion" + "EnvironmentContainer" ], - "summary": "Delete version.", - "operationId": "EnvironmentVersions_Delete", - "produces": [ + "summary": "Delete container.", + "operationId": "EnvironmentContainers_Delete", + "produces": [ "application/json" ], "parameters": [ @@ -6759,43 +6750,36 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/delete.json" + "Delete Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/delete.json" } } }, "get": { "tags": [ - "EnvironmentVersion" + "EnvironmentContainer" ], - "summary": "Get version.", - "operationId": "EnvironmentVersions_Get", + "summary": "Get container.", + "operationId": "EnvironmentContainers_Get", "produces": [ "application/json" ], @@ -6816,43 +6800,36 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } } }, "x-ms-examples": { - "Get Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/get.json" + "Get Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/get.json" } } }, "put": { "tags": [ - "EnvironmentVersion" + "EnvironmentContainer" ], - "summary": "Creates or updates an EnvironmentVersion.", - "operationId": "EnvironmentVersions_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "EnvironmentContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -6872,68 +6849,58 @@ { "in": "path", "name": "name", - "description": "Name of EnvironmentVersion. This is case-sensitive.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version of EnvironmentVersion.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Definition of EnvironmentVersion.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/EnvironmentContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/EnvironmentContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/createOrUpdate.json" + "CreateOrUpdate Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}/publish": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": { + "get": { "tags": [ "EnvironmentVersion" ], - "summary": "Publish version asset into registry.", - "operationId": "EnvironmentVersions_Publish", - "consumes": [ - "application/json" - ], + "summary": "List versions.", + "operationId": "EnvironmentVersions_List", "produces": [ "application/json" ], @@ -6950,14 +6917,7 @@ { "in": "path", "name": "name", - "description": "Container name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -6965,89 +6925,25 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "body", - "name": "body", - "description": "Destination registry info", - "required": true, - "schema": { - "$ref": "#/definitions/DestinationAsset" - } - } - ], - "responses": { - "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Publish Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/publish.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets": { - "get": { - "tags": [ - "FeaturesetContainer" - ], - "summary": "List featurestore entity containers.", - "operationId": "FeaturesetContainers_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, - { - "in": "query", - "name": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" - }, { "in": "query", "name": "listViewType", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "description": "View type for including/excluding (for example) archived entities.", "type": "string", "default": "ActiveOnly", "enum": [ @@ -7070,51 +6966,25 @@ } ] } - }, - { - "in": "query", - "name": "pageSize", - "description": "page size", - "type": "integer", - "format": "int32", - "default": 20 - }, - { - "in": "query", - "name": "name", - "description": "name for the featureset", - "type": "string" - }, - { - "in": "query", - "name": "description", - "description": "description for the feature set", - "type": "string" - }, - { - "in": "query", - "name": "createdBy", - "description": "createdBy user name", - "type": "string" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeaturesetContainerResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Featureset Container.": { - "$ref": "./examples/Workspace/FeaturesetContainer/list.json" + "List Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/list.json" } }, "x-ms-pageable": { @@ -7122,13 +6992,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": { + "delete": { "tags": [ - "Feature" + "EnvironmentVersion" ], - "summary": "List Features.", - "operationId": "Features_List", + "summary": "Delete version.", + "operationId": "EnvironmentVersions_Delete", "produces": [ "application/json" ], @@ -7144,110 +7014,108 @@ }, { "in": "path", - "name": "featuresetName", - "description": "Featureset name. This is case-sensitive.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" }, { "in": "path", - "name": "featuresetVersion", - "description": "Featureset Version identifier. This is case-sensitive.", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Get version.", + "operationId": "EnvironmentVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "query", - "name": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "query", - "name": "featureName", - "description": "feature name.", - "type": "string" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "query", - "name": "description", - "description": "Description of the featureset.", + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, "type": "string" }, { - "in": "query", - "name": "listViewType", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" }, { - "in": "query", - "name": "pageSize", - "description": "Page size.", - "type": "integer", - "format": "int32", - "default": 1000 + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeatureResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } } }, "x-ms-examples": { - "List Feature.": { - "$ref": "./examples/Feature/list.json" + "Get Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/get.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}": { - "get": { + }, + "put": { "tags": [ - "Feature" + "EnvironmentVersion" + ], + "summary": "Creates or updates an EnvironmentVersion.", + "operationId": "EnvironmentVersions_CreateOrUpdate", + "consumes": [ + "application/json" ], - "summary": "Get feature.", - "operationId": "Features_Get", "produces": [ "application/json" ], @@ -7263,59 +7131,69 @@ }, { "in": "path", - "name": "featuresetName", - "description": "Feature set name. This is case-sensitive.", + "name": "name", + "description": "Name of EnvironmentVersion. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", - "name": "featuresetVersion", - "description": "Feature set version identifier. This is case-sensitive.", + "name": "version", + "description": "Version of EnvironmentVersion.", "required": true, "type": "string" }, { - "in": "path", - "name": "featureName", - "description": "Feature Name. This is case-sensitive.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "body", + "name": "body", + "description": "Definition of EnvironmentVersion.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeatureResource" + "$ref": "#/definitions/EnvironmentVersionResource" } }, - "default": { - "description": "Error", + "201": { + "description": "Created", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/EnvironmentVersionResource" } } }, "x-ms-examples": { - "Get Feature.": { - "$ref": "./examples/Feature/get.json" + "CreateOrUpdate Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}/publish": { + "post": { "tags": [ - "FeaturesetContainer" + "EnvironmentVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "EnvironmentVersions_Publish", + "consumes": [ + "application/json" ], - "summary": "Delete container.", - "operationId": "FeaturesetContainers_Delete", "produces": [ "application/json" ], @@ -7332,26 +7210,43 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Success" }, "202": { "description": "Accepted", "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, "Location": { "description": "URI to poll for asynchronous operation result.", "type": "string" @@ -7364,33 +7259,26 @@ "minimum": 10 } } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Delete Workspace Featureset Container.": { - "$ref": "./examples/Workspace/FeaturesetContainer/delete.json" + "Publish Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/publish.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets": { "get": { "tags": [ "FeaturesetContainer" ], - "summary": "Get container.", - "operationId": "FeaturesetContainers_GetEntity", + "summary": "List featurestore entity containers.", + "operationId": "FeaturesetContainers_List", "produces": [ "application/json" ], @@ -7405,128 +7293,102 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeaturesetContainerResource" - } + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GetEntity Workspace Featureset Container.": { - "$ref": "./examples/Workspace/FeaturesetContainer/getEntity.json" - } - } - }, - "put": { - "tags": [ - "FeaturesetContainer" - ], - "summary": "Create or update container.", - "operationId": "FeaturesetContainers_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 }, { - "in": "path", + "in": "query", "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "description": "name for the featureset", + "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "description", + "description": "description for the feature set", + "type": "string" }, { - "in": "body", - "name": "body", - "description": "Container entity to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/FeaturesetContainerResource" - } + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" } ], "responses": { - "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/FeaturesetContainerResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/FeaturesetContainerResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Featureset Container.": { - "$ref": "./examples/Workspace/FeaturesetContainer/createOrUpdate.json" + "List Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/list.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features": { "get": { "tags": [ - "FeaturesetVersion" + "Feature" ], - "summary": "List versions.", - "operationId": "FeaturesetVersions_List", + "summary": "List Features.", + "operationId": "Features_List", "produces": [ "application/json" ], @@ -7542,9 +7404,17 @@ }, { "in": "path", - "name": "name", + "name": "featuresetName", "description": "Featureset name. This is case-sensitive.", "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "featuresetVersion", + "description": "Featureset Version identifier. This is case-sensitive.", + "required": true, "type": "string" }, { @@ -7559,6 +7429,18 @@ "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", "type": "string" }, + { + "in": "query", + "name": "featureName", + "description": "feature name.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Description of the featureset.", + "type": "string" + }, { "in": "query", "name": "listViewType", @@ -7589,59 +7471,29 @@ { "in": "query", "name": "pageSize", - "description": "page size", + "description": "Page size.", "type": "integer", "format": "int32", - "default": 20 - }, - { - "in": "query", - "name": "versionName", - "description": "name for the featureset version", - "type": "string" - }, - { - "in": "query", - "name": "version", - "description": "featureset version", - "type": "string" - }, - { - "in": "query", - "name": "description", - "description": "description for the feature set version", - "type": "string" - }, - { - "in": "query", - "name": "createdBy", - "description": "createdBy user name", - "type": "string" - }, - { - "in": "query", - "name": "stage", - "description": "Specifies the featurestore stage", - "type": "string" + "default": 1000 } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeaturesetVersionResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeatureResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/list.json" + "List Feature.": { + "$ref": "./examples/Feature/list.json" } }, "x-ms-pageable": { @@ -7649,13 +7501,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}": { + "get": { "tags": [ - "FeaturesetVersion" + "Feature" ], - "summary": "Delete version.", - "operationId": "FeaturesetVersions_Delete", + "summary": "Get feature.", + "operationId": "Features_Get", "produces": [ "application/json" ], @@ -7671,73 +7523,59 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "featuresetName", + "description": "Feature set name. This is case-sensitive.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "featuresetVersion", + "description": "Feature set version identifier. This is case-sensitive.", "required": true, "type": "string" }, + { + "in": "path", + "name": "featureName", + "description": "Feature Name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeatureResource" + } } }, - "x-ms-examples": { - "Delete Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/delete.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-examples": { + "Get Feature.": { + "$ref": "./examples/Feature/get.json" + } } - }, - "get": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}": { + "delete": { "tags": [ - "FeaturesetVersion" + "FeaturesetContainer" ], - "summary": "Get version.", - "operationId": "FeaturesetVersions_Get", + "summary": "Delete container.", + "operationId": "FeaturesetContainers_Delete", "produces": [ "application/json" ], @@ -7758,46 +7596,61 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeaturesetVersionResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Get Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/get.json" + "Delete Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/delete.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } }, - "put": { + "get": { "tags": [ - "FeaturesetVersion" - ], - "summary": "Create or update version.", - "operationId": "FeaturesetVersions_CreateOrUpdate", - "consumes": [ - "application/json" + "FeaturesetContainer" ], + "summary": "Get container.", + "operationId": "FeaturesetContainers_GetEntity", "produces": [ "application/json" ], @@ -7816,78 +7669,38 @@ "name": "name", "description": "Container name. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Version entity to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/FeaturesetVersionResource" - } } ], "responses": { - "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/FeaturesetVersionResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/FeaturesetVersionResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/createOrUpdate.json" + "GetEntity Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/getEntity.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/backfill": { - "post": { + }, + "put": { "tags": [ - "FeaturesetVersion" + "FeaturesetContainer" ], - "summary": "Backfill.", - "operationId": "FeaturesetVersions_Backfill", + "summary": "Create or update container.", + "operationId": "FeaturesetContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -7909,14 +7722,8 @@ "name": "name", "description": "Container name. This is case-sensitive.", "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -7924,61 +7731,62 @@ { "in": "body", "name": "body", - "description": "Feature set version backfill request entity.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/FeaturesetVersionBackfillRequest" + "$ref": "#/definitions/FeaturesetContainerResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeaturesetVersionBackfillResponse" + "$ref": "#/definitions/FeaturesetContainerResource" } }, - "202": { - "description": "Accepted", + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + }, "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Backfill Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/backfill.json" + "CreateOrUpdate Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/createOrUpdate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions": { "get": { "tags": [ - "FeaturestoreEntityContainer" + "FeaturesetVersion" ], - "summary": "List featurestore entity containers.", - "operationId": "FeaturestoreEntityContainers_List", + "summary": "List versions.", + "operationId": "FeaturesetVersions_List", "produces": [ "application/json" ], @@ -7992,6 +7800,13 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, + { + "in": "path", + "name": "name", + "description": "Featureset name. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, @@ -8041,14 +7856,20 @@ }, { "in": "query", - "name": "name", - "description": "name for the featurestore entity", + "name": "versionName", + "description": "name for the featureset version", + "type": "string" + }, + { + "in": "query", + "name": "version", + "description": "featureset version", "type": "string" }, { "in": "query", "name": "description", - "description": "description for the featurestore entity", + "description": "description for the feature set version", "type": "string" }, { @@ -8056,25 +7877,31 @@ "name": "createdBy", "description": "createdBy user name", "type": "string" + }, + { + "in": "query", + "name": "stage", + "description": "Specifies the featurestore stage", + "type": "string" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } - } - }, - "x-ms-examples": { - "List Workspace Featurestore Entity Container.": { - "$ref": "./examples/Workspace/FeaturestoreEntityContainer/list.json" + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/list.json" } }, "x-ms-pageable": { @@ -8082,13 +7909,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}": { "delete": { "tags": [ - "FeaturestoreEntityContainer" + "FeaturesetVersion" ], - "summary": "Delete container.", - "operationId": "FeaturestoreEntityContainers_Delete", + "summary": "Delete version.", + "operationId": "FeaturesetVersions_Delete", "produces": [ "application/json" ], @@ -8109,11 +7936,24 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Success" }, @@ -8140,17 +7980,11 @@ }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Delete Workspace Featurestore Entity Container.": { - "$ref": "./examples/Workspace/FeaturestoreEntityContainer/delete.json" + "Delete Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/delete.json" } }, "x-ms-long-running-operation": true, @@ -8160,10 +7994,10 @@ }, "get": { "tags": [ - "FeaturestoreEntityContainer" + "FeaturesetVersion" ], - "summary": "Get container.", - "operationId": "FeaturestoreEntityContainers_GetEntity", + "summary": "Get version.", + "operationId": "FeaturesetVersions_Get", "produces": [ "application/json" ], @@ -8184,36 +8018,43 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + } } }, "x-ms-examples": { - "GetEntity Workspace Featurestore Entity Container.": { - "$ref": "./examples/Workspace/FeaturestoreEntityContainer/getEntity.json" + "Get Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/get.json" } } }, "put": { "tags": [ - "FeaturestoreEntityContainer" + "FeaturesetVersion" ], - "summary": "Create or update container.", - "operationId": "FeaturestoreEntityContainers_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "FeaturesetVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -8238,30 +8079,43 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResource" + "$ref": "#/definitions/FeaturesetVersionResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResource" + "$ref": "#/definitions/FeaturesetVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResource" + "$ref": "#/definitions/FeaturesetVersionResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -8274,17 +8128,11 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Featurestore Entity Container.": { - "$ref": "./examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -8293,13 +8141,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/backfill": { + "post": { "tags": [ - "FeaturestoreEntityVersion" + "FeaturesetVersion" + ], + "summary": "Backfill.", + "operationId": "FeaturesetVersions_Backfill", + "consumes": [ + "application/json" ], - "summary": "List versions.", - "operationId": "FeaturestoreEntityVersions_List", "produces": [ "application/json" ], @@ -8316,13 +8167,94 @@ { "in": "path", "name": "name", - "description": "Feature entity name. This is case-sensitive.", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, + { + "in": "body", + "name": "body", + "description": "Feature set version backfill request entity.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetVersionBackfillRequest" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionBackfillResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Backfill Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/backfill.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities": { + "get": { + "tags": [ + "FeaturestoreEntityContainer" + ], + "summary": "List featurestore entity containers.", + "operationId": "FeaturestoreEntityContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, @@ -8369,20 +8301,14 @@ }, { "in": "query", - "name": "versionName", - "description": "name for the featurestore entity version", - "type": "string" - }, - { - "in": "query", - "name": "version", - "description": "featurestore entity version", + "name": "name", + "description": "name for the featurestore entity", "type": "string" }, { "in": "query", "name": "description", - "description": "description for the feature entity version", + "description": "description for the featurestore entity", "type": "string" }, { @@ -8390,31 +8316,25 @@ "name": "createdBy", "description": "createdBy user name", "type": "string" - }, - { - "in": "query", - "name": "stage", - "description": "Specifies the featurestore stage", - "type": "string" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Featurestore Entity Version.": { - "$ref": "./examples/Workspace/FeaturestoreEntityVersion/list.json" + "List Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/list.json" } }, "x-ms-pageable": { @@ -8422,13 +8342,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}": { "delete": { "tags": [ - "FeaturestoreEntityVersion" + "FeaturestoreEntityContainer" ], - "summary": "Delete version.", - "operationId": "FeaturestoreEntityVersions_Delete", + "summary": "Delete container.", + "operationId": "FeaturestoreEntityContainers_Delete", "produces": [ "application/json" ], @@ -8449,21 +8369,20 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success" - }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, "202": { "description": "Accepted", "headers": { @@ -8487,17 +8406,11 @@ }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Delete Workspace Featurestore Entity Version.": { - "$ref": "./examples/Workspace/FeaturestoreEntityVersion/delete.json" + "Delete Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/delete.json" } }, "x-ms-long-running-operation": true, @@ -8507,10 +8420,10 @@ }, "get": { "tags": [ - "FeaturestoreEntityVersion" + "FeaturestoreEntityContainer" ], - "summary": "Get version.", - "operationId": "FeaturestoreEntityVersions_Get", + "summary": "Get container.", + "operationId": "FeaturestoreEntityContainers_GetEntity", "produces": [ "application/json" ], @@ -8531,43 +8444,36 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + } } }, "x-ms-examples": { - "Get Workspace Featurestore Entity Version.": { - "$ref": "./examples/Workspace/FeaturestoreEntityVersion/get.json" + "GetEntity Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/getEntity.json" } } }, "put": { "tags": [ - "FeaturestoreEntityVersion" + "FeaturestoreEntityContainer" ], - "summary": "Create or update version.", - "operationId": "FeaturestoreEntityVersions_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "FeaturestoreEntityContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -8592,37 +8498,36 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResource" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResource" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/FeaturestoreEntityVersionResource" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -8635,17 +8540,11 @@ "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Featurestore Entity Version.": { - "$ref": "./examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json" + "CreateOrUpdate Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -8654,13 +8553,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions": { "get": { "tags": [ - "Job" + "FeaturestoreEntityVersion" ], - "summary": "Lists Jobs in the workspace.", - "operationId": "Jobs_List", + "summary": "List versions.", + "operationId": "FeaturestoreEntityVersions_List", "produces": [ "application/json" ], @@ -8675,27 +8574,28 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "name", + "description": "Feature entity name. This is case-sensitive.", + "required": true, + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "jobType", - "description": "Type of job to be returned.", - "type": "string" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { "in": "query", - "name": "tag", - "description": "Jobs returned will have this tag key.", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", "type": "string" }, { "in": "query", "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", "type": "string", "default": "ActiveOnly", "enum": [ @@ -8721,37 +8621,60 @@ }, { "in": "query", - "name": "properties", - "description": "Comma-separated list of user property names (and optionally values). Example: prop1,prop2=value2", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "versionName", + "description": "name for the featurestore entity version", + "type": "string" + }, + { + "in": "query", + "name": "version", + "description": "featurestore entity version", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature entity version", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" + }, + { + "in": "query", + "name": "stage", + "description": "Specifies the featurestore stage", "type": "string" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/JobBaseResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Command Job.": { - "$ref": "./examples/Job/CommandJob/list.json" - }, - "List AutoML Job.": { - "$ref": "./examples/Job/AutoMLJob/list.json" - }, - "List Sweep Job.": { - "$ref": "./examples/Job/SweepJob/list.json" - }, - "List Pipeline Job.": { - "$ref": "./examples/Job/PipelineJob/list.json" + "List Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/list.json" } }, "x-ms-pageable": { @@ -8759,13 +8682,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}": { "delete": { "tags": [ - "Job" + "FeaturestoreEntityVersion" ], - "summary": "Deletes a Job (asynchronous).", - "operationId": "Jobs_Delete", + "summary": "Delete version.", + "operationId": "FeaturestoreEntityVersions_Delete", "produces": [ "application/json" ], @@ -8781,8 +8704,15 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -8791,6 +8721,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Success" }, @@ -8817,17 +8753,11 @@ }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Delete Job.": { - "$ref": "./examples/Job/delete.json" + "Delete Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/delete.json" } }, "x-ms-long-running-operation": true, @@ -8837,10 +8767,10 @@ }, "get": { "tags": [ - "Job" + "FeaturestoreEntityVersion" ], - "summary": "Gets a Job by name/id.", - "operationId": "Jobs_Get", + "summary": "Get version.", + "operationId": "FeaturestoreEntityVersions_Get", "produces": [ "application/json" ], @@ -8856,8 +8786,15 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -8866,40 +8803,31 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/JobBaseResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } } }, "x-ms-examples": { - "Get Command Job.": { - "$ref": "./examples/Job/CommandJob/get.json" - }, - "Get AutoML Job.": { - "$ref": "./examples/Job/AutoMLJob/get.json" - }, - "Get Sweep Job.": { - "$ref": "./examples/Job/SweepJob/get.json" - }, - "Get Pipeline Job.": { - "$ref": "./examples/Job/PipelineJob/get.json" + "Get Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/get.json" } } }, "put": { "tags": [ - "Job" + "FeaturestoreEntityVersion" ], - "summary": "Creates and executes a Job.\r\nFor update case, the Tags in the definition passed in will replace Tags in the existing job.", - "operationId": "Jobs_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "FeaturestoreEntityVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -8918,137 +8846,81 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Job definition object.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" } } ], "responses": { - "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/JobBaseResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/JobBaseResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } - } - }, - "x-ms-examples": { - "CreateOrUpdate Command Job.": { - "$ref": "./examples/Job/CommandJob/createOrUpdate.json" - }, - "CreateOrUpdate AutoML Job.": { - "$ref": "./examples/Job/AutoMLJob/createOrUpdate.json" - }, - "CreateOrUpdate Sweep Job.": { - "$ref": "./examples/Job/SweepJob/createOrUpdate.json" - }, - "CreateOrUpdate Pipeline Job.": { - "$ref": "./examples/Job/PipelineJob/createOrUpdate.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": { - "post": { - "tags": [ - "Job" - ], - "summary": "Cancels a Job (asynchronous).", - "operationId": "Jobs_Cancel", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, - { - "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { "200": { - "description": "Success" + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } }, - "202": { - "description": "Accepted", + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + }, "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Cancel Job.": { - "$ref": "./examples/Job/cancel.json" + "CreateOrUpdate Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": { "get": { "tags": [ - "ModelContainer" + "Job" ], - "summary": "List model containers.", - "operationId": "ModelContainers_List", + "summary": "Lists Jobs in the workspace.", + "operationId": "Jobs_List", "produces": [ "application/json" ], @@ -9070,10 +8942,15 @@ }, { "in": "query", - "name": "count", - "description": "Maximum number of results to return.", - "type": "integer", - "format": "int32" + "name": "jobType", + "description": "Type of job to be returned.", + "type": "string" + }, + { + "in": "query", + "name": "tag", + "description": "Jobs returned will have this tag key.", + "type": "string" }, { "in": "query", @@ -9101,25 +8978,40 @@ } ] } + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of user property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/JobBaseResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Model Container.": { - "$ref": "./examples/Workspace/ModelContainer/list.json" + "List Command Job.": { + "$ref": "./examples/Job/CommandJob/list.json" + }, + "List AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/list.json" + }, + "List Sweep Job.": { + "$ref": "./examples/Job/SweepJob/list.json" + }, + "List Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/list.json" } }, "x-ms-pageable": { @@ -9127,13 +9019,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": { "delete": { "tags": [ - "ModelContainer" + "Job" ], - "summary": "Delete container.", - "operationId": "ModelContainers_Delete", + "summary": "Deletes a Job (asynchronous).", + "operationId": "Jobs_Delete", "produces": [ "application/json" ], @@ -9149,8 +9041,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, "type": "string" }, @@ -9159,31 +9051,56 @@ } ], "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Model Container.": { - "$ref": "./examples/Workspace/ModelContainer/delete.json" + "Delete Job.": { + "$ref": "./examples/Job/delete.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } }, "get": { "tags": [ - "ModelContainer" + "Job" ], - "summary": "Get container.", - "operationId": "ModelContainers_Get", + "summary": "Gets a Job by name/id.", + "operationId": "Jobs_Get", "produces": [ "application/json" ], @@ -9199,8 +9116,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, "type": "string" }, @@ -9209,31 +9126,40 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ModelContainerResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/JobBaseResource" + } } }, "x-ms-examples": { - "Get Workspace Model Container.": { - "$ref": "./examples/Workspace/ModelContainer/get.json" + "Get Command Job.": { + "$ref": "./examples/Job/CommandJob/get.json" + }, + "Get AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/get.json" + }, + "Get Sweep Job.": { + "$ref": "./examples/Job/SweepJob/get.json" + }, + "Get Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/get.json" } } }, "put": { "tags": [ - "ModelContainer" + "Job" ], - "summary": "Create or update container.", - "operationId": "ModelContainers_CreateOrUpdate", + "summary": "Creates and executes a Job.\r\nFor update case, the Tags in the definition passed in will replace Tags in the existing job.", + "operationId": "Jobs_CreateOrUpdate", "consumes": [ "application/json" ], @@ -9252,8 +9178,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -9264,47 +9190,56 @@ { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Job definition object.", "required": true, "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/JobBaseResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/JobBaseResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ModelContainerResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/JobBaseResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Model Container.": { - "$ref": "./examples/Workspace/ModelContainer/createOrUpdate.json" + "CreateOrUpdate Command Job.": { + "$ref": "./examples/Job/CommandJob/createOrUpdate.json" + }, + "CreateOrUpdate AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/createOrUpdate.json" + }, + "CreateOrUpdate Sweep Job.": { + "$ref": "./examples/Job/SweepJob/createOrUpdate.json" + }, + "CreateOrUpdate Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": { + "post": { "tags": [ - "ModelVersion" + "Job" ], - "summary": "List model versions.", - "operationId": "ModelVersions_List", + "summary": "Cancels a Job (asynchronous).", + "operationId": "Jobs_Cancel", "produces": [ "application/json" ], @@ -9320,67 +9255,86 @@ }, { "in": "path", - "name": "name", - "description": "Model name. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } }, + "200": { + "description": "Success" + } + }, + "x-ms-examples": { + "Cancel Job.": { + "$ref": "./examples/Job/cancel.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models": { + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "List model containers.", + "operationId": "ModelContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "query", - "name": "version", - "description": "Model version.", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "description", - "description": "Model description.", - "type": "string" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { "in": "query", - "name": "offset", - "description": "Number of initial results to skip.", + "name": "count", + "description": "Maximum number of results to return.", "type": "integer", "format": "int32" }, - { - "in": "query", - "name": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" - }, - { - "in": "query", - "name": "properties", - "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", - "type": "string" - }, - { - "in": "query", - "name": "feed", - "description": "Name of the feed.", - "type": "string" - }, { "in": "query", "name": "listViewType", @@ -9410,22 +9364,22 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/list.json" + "List Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/list.json" } }, "x-ms-pageable": { @@ -9433,13 +9387,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}": { "delete": { "tags": [ - "ModelVersion" + "ModelContainer" ], - "summary": "Delete version.", - "operationId": "ModelVersions_Delete", + "summary": "Delete container.", + "operationId": "ModelContainers_Delete", "produces": [ "application/json" ], @@ -9460,43 +9414,36 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/delete.json" + "Delete Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/delete.json" } } }, "get": { "tags": [ - "ModelVersion" + "ModelContainer" ], - "summary": "Get version.", - "operationId": "ModelVersions_Get", + "summary": "Get container.", + "operationId": "ModelContainers_Get", "produces": [ "application/json" ], @@ -9517,43 +9464,36 @@ "required": true, "type": "string" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ModelVersionResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } } }, "x-ms-examples": { - "Get Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/get.json" + "Get Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/get.json" } } }, "put": { "tags": [ - "ModelVersion" + "ModelContainer" ], - "summary": "Create or update version.", - "operationId": "ModelVersions_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "ModelContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -9578,63 +9518,53 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/ModelContainerResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/ModelContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ModelVersionResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ModelContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/createOrUpdate.json" + "CreateOrUpdate Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}/publish": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions": { + "get": { "tags": [ "ModelVersion" ], - "summary": "Publish version asset into registry.", - "operationId": "ModelVersions_Publish", - "consumes": [ - "application/json" - ], + "summary": "List model versions.", + "operationId": "ModelVersions_List", "produces": [ "application/json" ], @@ -9651,14 +9581,7 @@ { "in": "path", "name": "name", - "description": "Container name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier.", + "description": "Model name. This is case-sensitive.", "required": true, "type": "string" }, @@ -9666,153 +9589,103 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "body", - "name": "body", - "description": "Destination registry info", - "required": true, - "schema": { - "$ref": "#/definitions/DestinationAsset" - } - } - ], - "responses": { - "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Publish Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/publish.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints": { - "get": { - "tags": [ - "OnlineEndpoint" - ], - "summary": "List Online Endpoints.", - "operationId": "OnlineEndpoints_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "version", + "description": "Model version.", + "type": "string" }, { "in": "query", - "name": "name", - "description": "Name of the endpoint.", + "name": "description", + "description": "Model description.", "type": "string" }, { "in": "query", - "name": "count", - "description": "Number of endpoints to be retrieved in a page of results.", + "name": "offset", + "description": "Number of initial results to skip.", "type": "integer", "format": "int32" }, { "in": "query", - "name": "computeType", - "description": "EndpointComputeType to be filtered by.", - "type": "string", - "enum": [ - "Managed", - "Kubernetes", - "AzureMLCompute" - ], - "x-ms-enum": { - "name": "EndpointComputeType", - "modelAsString": true - } - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" }, { "in": "query", - "name": "tags", - "description": "A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .", + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", "type": "string" }, { "in": "query", - "name": "properties", - "description": "A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", + "name": "feed", + "description": "Name of the feed.", "type": "string" }, { "in": "query", - "name": "orderBy", - "description": "The option to order the response.", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", "type": "string", + "default": "ActiveOnly", "enum": [ - "CreatedAtDesc", - "CreatedAtAsc", - "UpdatedAtDesc", - "UpdatedAtAsc" + "ActiveOnly", + "ArchivedOnly", + "All" ], "x-ms-enum": { - "name": "OrderString", - "modelAsString": true + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] } } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/list.json" + "List Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/list.json" } }, "x-ms-pageable": { @@ -9820,13 +9693,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}": { "delete": { "tags": [ - "OnlineEndpoint" + "ModelVersion" ], - "summary": "Delete Online Endpoint (asynchronous).", - "operationId": "OnlineEndpoints_Delete", + "summary": "Delete version.", + "operationId": "ModelVersions_Delete", "produces": [ "application/json" ], @@ -9842,8 +9715,15 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -9852,56 +9732,31 @@ } ], "responses": { - "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/delete.json" + "Delete Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/delete.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } }, "get": { "tags": [ - "OnlineEndpoint" + "ModelVersion" ], - "summary": "Get Online Endpoint.", - "operationId": "OnlineEndpoints_Get", + "summary": "Get version.", + "operationId": "ModelVersions_Get", "produces": [ "application/json" ], @@ -9917,41 +9772,48 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" - } + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } } }, "x-ms-examples": { - "Get Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/get.json" + "Get Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/get.json" } } }, - "patch": { + "put": { "tags": [ - "OnlineEndpoint" + "ModelVersion" ], - "summary": "Update Online Endpoint (asynchronous).", - "operationId": "OnlineEndpoints_Update", + "summary": "Create or update version.", + "operationId": "ModelVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -9970,8 +9832,16 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -9981,61 +9851,47 @@ { "in": "body", "name": "body", - "description": "Online Endpoint entity to apply during operation.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + "$ref": "#/definitions/ModelVersionResource" } } ], "responses": { - "200": { - "description": "Success", + "default": { + "description": "Error", "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelVersionResource" } }, - "default": { - "description": "Error", + "201": { + "description": "Created", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ModelVersionResource" } } }, "x-ms-examples": { - "Update Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/update.json" + "CreateOrUpdate Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/createOrUpdate.json" } - }, - "x-ms-long-running-operation": true - }, - "put": { + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}/publish": { + "post": { "tags": [ - "OnlineEndpoint" + "ModelVersion" ], - "summary": "Create or update Online Endpoint (asynchronous).", - "operationId": "OnlineEndpoints_CreateOrUpdate", + "summary": "Publish version asset into registry.", + "operationId": "ModelVersions_Publish", "consumes": [ "application/json" ], @@ -10054,11 +9910,17 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -10066,62 +9928,58 @@ { "in": "body", "name": "body", - "description": "Online Endpoint entity to apply during operation.", + "description": "Destination registry info", "required": true, "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" + "$ref": "#/definitions/DestinationAsset" } } ], "responses": { - "200": { - "description": "Create or update request is successful.", + "default": { + "description": "Error", "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" - }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", + "Location": { + "description": "URI to poll for asynchronous operation result.", "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/createOrUpdate.json" + "Publish Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/publish.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints": { "get": { "tags": [ - "OnlineDeployment" + "OnlineEndpoint" ], - "summary": "List Inference Endpoint Deployments.", - "operationId": "OnlineDeployments_List", + "summary": "List Online Endpoints.", + "operationId": "OnlineEndpoints_List", "produces": [ "application/json" ], @@ -10135,50 +9993,86 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, - { - "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", + "name": "name", + "description": "Name of the endpoint.", "type": "string" }, { "in": "query", - "name": "$top", - "description": "Top of list.", + "name": "count", + "description": "Number of endpoints to be retrieved in a page of results.", "type": "integer", "format": "int32" }, + { + "in": "query", + "name": "computeType", + "description": "EndpointComputeType to be filtered by.", + "type": "string", + "enum": [ + "Managed", + "Kubernetes", + "AzureMLCompute" + ], + "x-ms-enum": { + "name": "EndpointComputeType", + "modelAsString": true + } + }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "The option to order the response.", + "type": "string", + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true + } } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "List Online Deployments.": { - "$ref": "./examples/OnlineDeployment/list.json" + "List Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/list.json" } }, "x-ms-pageable": { @@ -10186,13 +10080,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}": { "delete": { "tags": [ - "OnlineDeployment" + "OnlineEndpoint" ], - "summary": "Delete Inference Endpoint Deployment (asynchronous).", - "operationId": "OnlineDeployments_Delete", + "summary": "Delete Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_Delete", "produces": [ "application/json" ], @@ -10209,14 +10103,7 @@ { "in": "path", "name": "endpointName", - "description": "Inference endpoint name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", + "description": "Online Endpoint name.", "required": true, "type": "string" }, @@ -10225,8 +10112,14 @@ } ], "responses": { - "200": { - "description": "Success" + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "No Content" }, "202": { "description": "Accepted", @@ -10249,19 +10142,13 @@ } } }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } + "200": { + "description": "Success" } }, "x-ms-examples": { - "Delete Workspace Online Deployment.": { - "$ref": "./examples/Workspace/OnlineDeployment/delete.json" + "Delete Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/delete.json" } }, "x-ms-long-running-operation": true, @@ -10271,10 +10158,10 @@ }, "get": { "tags": [ - "OnlineDeployment" + "OnlineEndpoint" ], - "summary": "Get Inference Deployment Deployment.", - "operationId": "OnlineDeployments_Get", + "summary": "Get Online Endpoint.", + "operationId": "OnlineEndpoints_Get", "produces": [ "application/json" ], @@ -10291,14 +10178,7 @@ { "in": "path", "name": "endpointName", - "description": "Inference endpoint name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", + "description": "Online Endpoint name.", "required": true, "type": "string" }, @@ -10307,34 +10187,31 @@ } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } } }, "x-ms-examples": { - "Get Managed Online Deployment.": { - "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/get.json" - }, - "Get Kubernetes Online Deployment.": { - "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/get.json" + "Get Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/get.json" } } }, "patch": { "tags": [ - "OnlineDeployment" + "OnlineEndpoint" ], - "summary": "Update Online Deployment (asynchronous).", - "operationId": "OnlineDeployments_Update", + "summary": "Update Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_Update", "consumes": [ "application/json" ], @@ -10356,16 +10233,7 @@ "name": "endpointName", "description": "Online Endpoint name.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -10376,15 +10244,21 @@ "description": "Online Endpoint entity to apply during operation.", "required": true, "schema": { - "$ref": "#/definitions/PartialMinimalTrackedResourceWithSku" + "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" + "$ref": "#/definitions/OnlineEndpointTrackedResource" } }, "202": { @@ -10407,30 +10281,21 @@ "minimum": 10 } } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } } }, "x-ms-examples": { - "Update Managed Online Deployment.": { - "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/update.json" - }, - "Update Kubernetes Online Deployment.": { - "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/update.json" + "Update Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/update.json" } }, "x-ms-long-running-operation": true }, "put": { "tags": [ - "OnlineDeployment" + "OnlineEndpoint" ], - "summary": "Create or update Inference Endpoint Deployment (asynchronous).", - "operationId": "OnlineDeployments_CreateOrUpdate", + "summary": "Create or update Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_CreateOrUpdate", "consumes": [ "application/json" ], @@ -10450,15 +10315,7 @@ { "in": "path", "name": "endpointName", - "description": "Inference endpoint name.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", + "description": "Online Endpoint name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -10469,24 +10326,30 @@ { "in": "body", "name": "body", - "description": "Inference Endpoint entity to apply during operation.", + "description": "Online Endpoint entity to apply during operation.", "required": true, "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" + "$ref": "#/definitions/OnlineEndpointTrackedResource" } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" + "$ref": "#/definitions/OnlineEndpointTrackedResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" + "$ref": "#/definitions/OnlineEndpointTrackedResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -10499,38 +10362,916 @@ "type": "string" } } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments": { + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "List Inference Endpoint Deployments.", + "operationId": "OnlineDeployments_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top of list.", + "type": "integer", + "format": "int32" }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult" + } } }, "x-ms-examples": { - "CreateOrUpdate Managed Online Deployment.": { - "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json" - }, - "CreateOrUpdate Kubernetes Online Deployment.": { - "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json" + "List Online Deployments.": { + "$ref": "./examples/OnlineDeployment/list.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": { + "delete": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Delete Inference Endpoint Deployment (asynchronous).", + "operationId": "OnlineDeployments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Delete Workspace Online Deployment.": { + "$ref": "./examples/Workspace/OnlineDeployment/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Get Inference Deployment Deployment.", + "operationId": "OnlineDeployments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + } + }, + "x-ms-examples": { + "Get Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/get.json" + }, + "Get Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/get.json" + } + } + }, + "patch": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Update Online Deployment (asynchronous).", + "operationId": "OnlineDeployments_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithSku" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Update Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/update.json" + }, + "Update Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Create or update Inference Endpoint Deployment (asynchronous).", + "operationId": "OnlineDeployments_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Inference Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json" + }, + "CreateOrUpdate Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs": { + "post": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Polls an Endpoint operation.", + "operationId": "OnlineDeployments_GetLogs", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The name and identifier for the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The request containing parameters for retrieving logs.", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentLogsRequest" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentLogs" + } + } + }, + "x-ms-examples": { + "Get Online Deployment Logs.": { + "$ref": "./examples/OnlineDeployment/getLogs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/skus": { + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "List Inference Endpoint Deployment Skus.", + "operationId": "OnlineDeployments_ListSkus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of Skus to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SkuResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Managed Online Deployment Skus.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json" + }, + "List Kubernetes Online Deployment Skus.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/listKeys": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", + "operationId": "OnlineEndpoints_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + } + }, + "x-ms-examples": { + "ListKeys Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).", + "operationId": "OnlineEndpoints_RegenerateKeys", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "RegenerateKeys request .", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateEndpointKeysRequest" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "RegenerateKeys Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/regenerateKeys.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/token": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.", + "operationId": "OnlineEndpoints_GetToken", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthToken" + } + } + }, + "x-ms-examples": { + "GetToken Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/getToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules": { + "get": { + "tags": [ + "Schedule" + ], + "summary": "List schedules in specified workspace.", + "operationId": "Schedules_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "Status filter for schedule.", + "type": "string", + "default": "EnabledOnly", + "enum": [ + "EnabledOnly", + "DisabledOnly", + "All" + ], + "x-ms-enum": { + "name": "ScheduleListViewType", + "modelAsString": true, + "values": [ + { + "value": "EnabledOnly" + }, + { + "value": "DisabledOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Schedules.": { + "$ref": "./examples/Schedule/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}": { + "delete": { + "tags": [ + "Schedule" + ], + "summary": "Delete schedule.", + "operationId": "Schedules_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Schedule.": { + "$ref": "./examples/Schedule/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { "tags": [ - "OnlineDeployment" - ], - "summary": "Polls an Endpoint operation.", - "operationId": "OnlineDeployments_GetLogs", - "consumes": [ - "application/json" + "Schedule" ], + "summary": "Get schedule.", + "operationId": "Schedules_Get", "produces": [ "application/json" ], @@ -10546,59 +11287,44 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "The name and identifier for the endpoint.", + "name": "name", + "description": "Schedule name.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "The request containing parameters for retrieving logs.", - "required": true, - "schema": { - "$ref": "#/definitions/DeploymentLogsRequest" - } } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeploymentLogs" - } - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResource" + } } }, "x-ms-examples": { - "Get Online Deployment Logs.": { - "$ref": "./examples/OnlineDeployment/getLogs.json" + "Get Schedule.": { + "$ref": "./examples/Schedule/get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/skus": { - "get": { + }, + "put": { "tags": [ - "OnlineDeployment" + "Schedule" + ], + "summary": "Create or update schedule.", + "operationId": "Schedules_CreateOrUpdate", + "consumes": [ + "application/json" ], - "summary": "List Inference Endpoint Deployment Skus.", - "operationId": "OnlineDeployments_ListSkus", "produces": [ "application/json" ], @@ -10614,66 +11340,74 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", + "name": "name", + "description": "Schedule name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "count", - "description": "Number of Skus to be retrieved in a page of results.", - "type": "integer", - "format": "int32" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "body", + "name": "body", + "description": "Schedule definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduleResource" + } } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/SkuResourceArmPaginatedResult" + "$ref": "#/definitions/ScheduleResource" } }, - "default": { - "description": "Error", + "201": { + "description": "Created", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ScheduleResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } } } }, "x-ms-examples": { - "List Managed Online Deployment Skus.": { - "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json" - }, - "List Kubernetes Online Deployment Skus.": { - "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json" + "CreateOrUpdate Schedule.": { + "$ref": "./examples/Schedule/createOrUpdate.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/listKeys": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints": { + "get": { "tags": [ - "OnlineEndpoint" + "ServerlessEndpoint" ], - "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", - "operationId": "OnlineEndpoints_ListKeys", + "summary": "List Serverless Endpoints.", + "operationId": "ServerlessEndpoints_List", "produces": [ "application/json" ], @@ -10688,21 +11422,17 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EndpointAuthKeys" + "$ref": "#/definitions/ServerlessEndpointTrackedResourceArmPaginatedResult" } }, "default": { @@ -10713,22 +11443,22 @@ } }, "x-ms-examples": { - "ListKeys Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/listKeys.json" + "List Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/list.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}": { + "delete": { "tags": [ - "OnlineEndpoint" - ], - "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).", - "operationId": "OnlineEndpoints_RegenerateKeys", - "consumes": [ - "application/json" + "ServerlessEndpoint" ], + "summary": "Delete Serverless Endpoint (asynchronous).", + "operationId": "ServerlessEndpoints_Delete", "produces": [ "application/json" ], @@ -10744,31 +11474,25 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Serverless Endpoint name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "RegenerateKeys request .", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateEndpointKeysRequest" - } } ], "responses": { - "200": { - "description": "Success" - }, "202": { "description": "Accepted", "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, "Location": { "description": "URI to poll for asynchronous operation result.", "type": "string" @@ -10782,6 +11506,9 @@ } } }, + "204": { + "description": "No Content" + }, "default": { "description": "Error", "schema": { @@ -10790,23 +11517,21 @@ } }, "x-ms-examples": { - "RegenerateKeys Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/regenerateKeys.json" + "Delete Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/delete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/token": { - "post": { + }, + "get": { "tags": [ - "OnlineEndpoint" + "ServerlessEndpoint" ], - "summary": "Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.", - "operationId": "OnlineEndpoints_GetToken", + "summary": "Get Serverless Endpoint.", + "operationId": "ServerlessEndpoints_Get", "produces": [ "application/json" ], @@ -10822,8 +11547,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Serverless Endpoint name.", "required": true, "type": "string" }, @@ -10835,7 +11560,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EndpointAuthToken" + "$ref": "#/definitions/ServerlessEndpointTrackedResource" } }, "default": { @@ -10846,63 +11571,51 @@ } }, "x-ms-examples": { - "GetToken Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/getToken.json" + "Get Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules": { - "get": { + }, + "patch": { "tags": [ - "Schedule" + "ServerlessEndpoint" + ], + "summary": "Update Serverless Endpoint (asynchronous).", + "operationId": "ServerlessEndpoints_Update", + "consumes": [ + "application/json" ], - "summary": "List schedules in specified workspace.", - "operationId": "Schedules_List", "produces": [ "application/json" ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "listViewType", - "description": "Status filter for schedule.", - "type": "string", - "default": "EnabledOnly", - "enum": [ - "EnabledOnly", - "DisabledOnly", - "All" - ], - "x-ms-enum": { - "name": "ScheduleListViewType", - "modelAsString": true, - "values": [ - { - "value": "EnabledOnly" - }, - { - "value": "DisabledOnly" - }, - { - "value": "All" - } - ] + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Serverless Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithSkuAndIdentity" } } ], @@ -10910,7 +11623,28 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ScheduleResourceArmPaginatedResult" + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } }, "default": { @@ -10921,22 +11655,21 @@ } }, "x-ms-examples": { - "List Schedules.": { - "$ref": "./examples/Schedule/list.json" + "Update Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/update.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}": { - "delete": { + "x-ms-long-running-operation": true + }, + "put": { "tags": [ - "Schedule" + "ServerlessEndpoint" + ], + "summary": "Create or update Serverless Endpoint (asynchronous).", + "operationId": "ServerlessEndpoints_CreateOrUpdate", + "consumes": [ + "application/json" ], - "summary": "Delete schedule.", - "operationId": "Schedules_Delete", "produces": [ "application/json" ], @@ -10953,42 +11686,48 @@ { "in": "path", "name": "name", - "description": "Schedule name.", + "description": "Serverless Endpoint name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{0,51}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Serverless Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } } ], "responses": { "200": { - "description": "Success" + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } }, - "202": { - "description": "Accepted", + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + }, "headers": { "x-ms-async-operation-timeout": { "description": "Timeout for the client to use when polling the asynchronous operation.", "type": "string", "format": "duration" }, - "Location": { - "description": "URI to poll for asynchronous operation result.", + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { @@ -10997,21 +11736,23 @@ } }, "x-ms-examples": { - "Delete Schedule.": { - "$ref": "./examples/Schedule/delete.json" + "CreateOrUpdate Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/createOrUpdate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "original-uri" } - }, - "get": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}/listKeys": { + "post": { "tags": [ - "Schedule" + "ServerlessEndpoint" ], - "summary": "Get schedule.", - "operationId": "Schedules_Get", + "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", + "operationId": "ServerlessEndpoints_ListKeys", "produces": [ "application/json" ], @@ -11028,9 +11769,10 @@ { "in": "path", "name": "name", - "description": "Schedule name.", + "description": "Serverless Endpoint name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -11040,7 +11782,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ScheduleResource" + "$ref": "#/definitions/EndpointAuthKeys" } }, "default": { @@ -11051,17 +11793,19 @@ } }, "x-ms-examples": { - "Get Schedule.": { - "$ref": "./examples/Schedule/get.json" + "ListKeys Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/listKeys.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}/regenerateKeys": { + "post": { "tags": [ - "Schedule" + "ServerlessEndpoint" ], - "summary": "Create or update schedule.", - "operationId": "Schedules_CreateOrUpdate", + "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).", + "operationId": "ServerlessEndpoints_RegenerateKeys", "consumes": [ "application/json" ], @@ -11081,7 +11825,7 @@ { "in": "path", "name": "name", - "description": "Schedule name.", + "description": "Serverless Endpoint name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -11092,34 +11836,33 @@ { "in": "body", "name": "body", - "description": "Schedule definition.", + "description": "RegenerateKeys request .", "required": true, "schema": { - "$ref": "#/definitions/ScheduleResource" + "$ref": "#/definitions/RegenerateEndpointKeysRequest" } } ], "responses": { "200": { - "description": "Create or update request is successful.", + "description": "Success", "schema": { - "$ref": "#/definitions/ScheduleResource" + "$ref": "#/definitions/EndpointAuthKeys" } }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ScheduleResource" - }, + "202": { + "description": "Accepted", "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", + "Location": { + "description": "URI to poll for asynchronous operation result.", "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 } } }, @@ -11131,13 +11874,13 @@ } }, "x-ms-examples": { - "CreateOrUpdate Schedule.": { - "$ref": "./examples/Schedule/createOrUpdate.json" + "RegenerateKeys Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/regenerateKeys.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "location" } } } @@ -11896,6 +12639,11 @@ "type": "string", "x-nullable": true }, + "deploymentConfiguration": { + "description": "Properties relevant to different deployment types.", + "$ref": "#/definitions/BatchDeploymentConfiguration", + "x-nullable": true + }, "errorThreshold": { "format": "int32", "description": "Error threshold, if the error count for the entire input goes above this value,\r\nthe batch inference will be aborted. Range is [-1, int.MaxValue].\r\nFor FileDataset, this value is the count of file failures.\r\nFor TabularDataset, this value is the count of record failures.\r\nIf set to -1 (the lower bound), all failures during batch inference will be ignored.", @@ -11956,6 +12704,41 @@ "x-ms-client-name": "BatchDeploymentProperties", "additionalProperties": false }, + "BatchDeploymentConfiguration": { + "description": "Properties relevant to different deployment types.", + "required": [ + "deploymentConfigurationType" + ], + "type": "object", + "properties": { + "deploymentConfigurationType": { + "description": "[Required] The type of the deployment", + "$ref": "#/definitions/BatchDeploymentConfigurationType" + } + }, + "discriminator": "deploymentConfigurationType" + }, + "BatchDeploymentConfigurationType": { + "description": "The enumerated property types for batch deployments.", + "enum": [ + "Model", + "PipelineComponent" + ], + "type": "string", + "x-ms-enum": { + "name": "BatchDeploymentConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "Model" + }, + { + "value": "PipelineComponent" + } + ] + }, + "additionalProperties": false + }, "BatchDeploymentTrackedResource": { "required": [ "location", @@ -12140,6 +12923,47 @@ }, "additionalProperties": false }, + "BatchPipelineComponentDeploymentConfiguration": { + "description": "Properties for a Batch Pipeline Component Deployment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BatchDeploymentConfiguration" + } + ], + "properties": { + "componentId": { + "description": "The ARM id of the component to be run.", + "$ref": "#/definitions/IdAssetReference", + "x-nullable": true + }, + "description": { + "description": "The description which will be applied to the job.", + "type": "string", + "x-nullable": true + }, + "settings": { + "description": "Run-time settings for the pipeline job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "tags": { + "description": "The tags which will be applied to the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PipelineComponent", + "additionalProperties": false + }, "BatchRetrySettings": { "description": "Retry settings for a batch inference operation.", "type": "object", @@ -12879,6 +13703,33 @@ }, "additionalProperties": false }, + "Collection": { + "type": "object", + "properties": { + "clientId": { + "description": "The msi client id used to collect logging to blob storage. If it's null,backend will pick a registered endpoint identity to auth.", + "type": "string", + "x-nullable": true + }, + "dataCollectionMode": { + "description": "Enable or disable data collection.", + "default": "Disabled", + "$ref": "#/definitions/DataCollectionMode" + }, + "dataId": { + "description": "The data asset arm resource id. Client side will ensure data asset is pointing to the blob storage, and backend will collect data to the blob storage.", + "type": "string", + "x-nullable": true + }, + "samplingRate": { + "format": "double", + "description": "The sampling rate for collection. Sampling rate 1.0 means we collect 100% of data by default.", + "default": 1, + "type": "number" + } + }, + "additionalProperties": false + }, "ColumnTransformer": { "description": "Column transformer parameters.", "type": "object", @@ -13219,25 +14070,59 @@ }, "additionalProperties": false }, - "ContainerType": { + "ContainerType": { + "enum": [ + "StorageInitializer", + "InferenceServer" + ], + "type": "string", + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true, + "values": [ + { + "value": "StorageInitializer" + }, + { + "value": "InferenceServer" + } + ] + }, + "additionalProperties": false + }, + "ContentSafety": { + "additionalProperties": false, + "properties": { + "contentSafetyStatus": { + "$ref": "#/definitions/ContentSafetyStatus", + "description": "[Required] Specifies the status of content safety." + } + }, + "required": [ + "contentSafetyStatus" + ], + "type": "object" + }, + "ContentSafetyStatus": { + "additionalProperties": false, + "description": "Specifies the status of content safety.", "enum": [ - "StorageInitializer", - "InferenceServer" + "Enabled", + "Disabled" ], "type": "string", "x-ms-enum": { - "name": "ContainerType", "modelAsString": true, + "name": "ContentSafetyStatus", "values": [ { - "value": "StorageInitializer" + "value": "Enabled" }, { - "value": "InferenceServer" + "value": "Disabled" } ] - }, - "additionalProperties": false + } }, "CreateMonitorAction": { "required": [ @@ -13569,6 +14454,53 @@ }, "additionalProperties": false }, + "DataCollectionMode": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "DataCollectionMode", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "DataCollector": { + "required": [ + "collections" + ], + "type": "object", + "properties": { + "collections": { + "description": "[Required] The collection configuration. Each collection has it own configuration to collect model data and the name of collection can be arbitrary string.\r\nModel data collector can be used for either payload logging or custom logging or both of them. Collection request and response are reserved for payload logging, others are for custom logging.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Collection", + "x-nullable": true + } + }, + "requestLogging": { + "description": "The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional.", + "$ref": "#/definitions/RequestLogging", + "x-nullable": true + }, + "rollingRate": { + "description": "When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file.\r\nIf the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/.\r\nIf it's day, all data will be collected in blob path /yyyy/MM/dd/.\r\nThe other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly.", + "default": "Hour", + "$ref": "#/definitions/RollingRateType" + } + }, + "additionalProperties": false + }, "DataContainer": { "description": "Container for data asset versions.", "required": [ @@ -14102,7 +15034,8 @@ "AzureBlob", "AzureDataLakeGen1", "AzureDataLakeGen2", - "AzureFile" + "AzureFile", + "OneLake" ], "type": "string", "x-ms-enum": { @@ -14120,6 +15053,9 @@ }, { "value": "AzureFile" + }, + { + "value": "OneLake" } ] }, @@ -17069,6 +18005,16 @@ "read" ] }, + "notificationSetting": { + "description": "Notification setting for the job", + "$ref": "#/definitions/NotificationSetting", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, "services": { "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.", "type": "object", @@ -17543,7 +18489,8 @@ "AutoML", "Command", "Sweep", - "Pipeline" + "Pipeline", + "Spark" ], "type": "string", "x-ms-enum": { @@ -17561,6 +18508,9 @@ }, { "value": "Pipeline" + }, + { + "value": "Spark" } ] }, @@ -17604,6 +18554,16 @@ "x-ms-discriminator-value": "Kubernetes", "additionalProperties": false }, + "LakeHouseArtifact": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OneLakeArtifact" + } + ], + "x-ms-discriminator-value": "LakeHouse", + "additionalProperties": false + }, "LearningRateScheduler": { "description": "Learning rate scheduler enum.", "enum": [ @@ -17907,6 +18867,187 @@ "x-ms-discriminator-value": "Managed", "additionalProperties": false }, + "MarketplacePlan": { + "additionalProperties": false, + "properties": { + "offerId": { + "description": "The identifying name of the Offer of the Marketplace Plan.", + "readOnly": true, + "type": "string", + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "planId": { + "description": "The identifying name of the Plan of the Marketplace Plan.", + "readOnly": true, + "type": "string", + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "publisherId": { + "description": "The identifying name of the Publisher of the Marketplace Plan.", + "readOnly": true, + "type": "string", + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "type": "object" + }, + "MarketplaceSubscription": { + "additionalProperties": false, + "properties": { + "marketplacePlan": { + "$ref": "#/definitions/MarketplacePlan", + "description": "Marketplace Plan associated with the Marketplace Subscription.", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "marketplaceSubscriptionStatus": { + "$ref": "#/definitions/MarketplaceSubscriptionStatus", + "description": "Current status of the Marketplace Subscription.", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "modelId": { + "description": "[Required] Target Marketplace Model ID to create a Marketplace Subscription for.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "provisioningState": { + "$ref": "#/definitions/MarketplaceSubscriptionProvisioningState", + "description": "Provisioning State of the Marketplace Subscription.", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "required": [ + "modelId" + ], + "type": "object", + "x-ms-client-name": "MarketplaceSubscriptionProperties" + }, + "MarketplaceSubscriptionProvisioningState": { + "additionalProperties": false, + "enum": [ + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Updating", + "Canceled" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MarketplaceSubscriptionProvisioningState", + "values": [ + { + "description": "MarketplaceSubscription is being created.", + "value": "Creating" + }, + { + "description": "MarketplaceSubscription is being deleted.", + "value": "Deleting" + }, + { + "description": "MarketplaceSubscription is successfully provisioned.", + "value": "Succeeded" + }, + { + "description": "MarketplaceSubscription provisioning failed.", + "value": "Failed" + }, + { + "description": "MarketplaceSubscription is being updated.", + "value": "Updating" + }, + { + "value": "Canceled" + } + ] + } + }, + "MarketplaceSubscriptionResource": { + "additionalProperties": false, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "description": "Azure Resource Manager resource envelope.", + "properties": { + "properties": { + "$ref": "#/definitions/MarketplaceSubscription", + "description": "[Required] Additional attributes of the entity." + } + }, + "required": [ + "properties" + ], + "type": "object", + "x-ms-client-name": "MarketplaceSubscription" + }, + "MarketplaceSubscriptionResourceArmPaginatedResult": { + "additionalProperties": false, + "description": "A paginated list of MarketplaceSubscription entities.", + "properties": { + "nextLink": { + "description": "The link to the next page of MarketplaceSubscription objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type MarketplaceSubscription.", + "items": { + "$ref": "#/definitions/MarketplaceSubscriptionResource" + }, + "type": "array" + } + }, + "type": "object" + }, + "MarketplaceSubscriptionStatus": { + "additionalProperties": false, + "enum": [ + "Subscribed", + "Suspended", + "Unsubscribed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MarketplaceSubscriptionStatus", + "values": [ + { + "description": "The customer can now use the Marketplace Subscription's\nmodel and will be billed.", + "value": "Subscribed" + }, + { + "description": "The customer could not be billed for the Marketplace Subscription.\nThe customer will not be able to access the model.", + "value": "Suspended" + }, + { + "description": "Marketplace Subscriptions reach this state in response to an explicit customer or CSP action.\nA Marketplace Subscription can also be canceled implicitly, as a result of nonpayment of dues,\nafter being in the Suspended state for some time.", + "value": "Unsubscribed" + } + ] + } + }, "MaterializationComputeResource": { "description": "DTO object representing compute resource", "type": "object", @@ -18051,6 +19192,17 @@ }, "additionalProperties": false }, + "ModelSettings": { + "additionalProperties": false, + "properties": { + "modelId": { + "description": "The unique model identifier that this ServerlessEndpoint should provision.", + "type": "string", + "x-nullable": true + } + }, + "type": "object" + }, "ModelSize": { "description": "Image model size.", "enum": [ @@ -19070,43 +20222,139 @@ "x-ms-discriminator-value": "Numerical", "additionalProperties": false }, - "ObjectDetectionPrimaryMetrics": { - "description": "Primary metrics for Image ObjectDetection task.", + "ObjectDetectionPrimaryMetrics": { + "description": "Primary metrics for Image ObjectDetection task.", + "enum": [ + "MeanAveragePrecision" + ], + "type": "string", + "x-ms-enum": { + "name": "ObjectDetectionPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "MeanAveragePrecision", + "description": "Mean Average Precision (MAP) is the average of AP (Average Precision).\nAP is calculated for each class and averaged to get the MAP." + } + ] + }, + "additionalProperties": false + }, + "Objective": { + "description": "Optimization objective.", + "required": [ + "goal", + "primaryMetric" + ], + "type": "object", + "properties": { + "goal": { + "description": "[Required] Defines supported metric goals for hyperparameter tuning", + "$ref": "#/definitions/Goal" + }, + "primaryMetric": { + "description": "[Required] Name of the metric to optimize.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, + "OneLakeArtifact": { + "description": "OneLake artifact (data source) configuration.", + "required": [ + "artifactName", + "artifactType" + ], + "type": "object", + "properties": { + "artifactName": { + "description": "[Required] OneLake artifact name", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "artifactType": { + "description": "[Required] OneLake artifact type", + "$ref": "#/definitions/OneLakeArtifactType" + } + }, + "discriminator": "artifactType" + }, + "OneLakeArtifactType": { + "description": "Enum to determine OneLake artifact type.", "enum": [ - "MeanAveragePrecision" + "LakeHouse" ], "type": "string", "x-ms-enum": { - "name": "ObjectDetectionPrimaryMetrics", + "name": "OneLakeArtifactType", "modelAsString": true, "values": [ { - "value": "MeanAveragePrecision", - "description": "Mean Average Precision (MAP) is the average of AP (Average Precision).\nAP is calculated for each class and averaged to get the MAP." + "value": "LakeHouse" } ] }, "additionalProperties": false }, - "Objective": { - "description": "Optimization objective.", + "OneLakeDatastore": { + "description": "OneLake (Trident) datastore configuration.", "required": [ - "goal", - "primaryMetric" + "artifact", + "oneLakeWorkspaceName" ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Datastore" + } + ], "properties": { - "goal": { - "description": "[Required] Defines supported metric goals for hyperparameter tuning", - "$ref": "#/definitions/Goal" + "artifact": { + "description": "[Required] OneLake artifact backing the datastore.", + "$ref": "#/definitions/OneLakeArtifact", + "x-ms-mutability": [ + "create", + "read" + ] }, - "primaryMetric": { - "description": "[Required] Name of the metric to optimize.", + "endpoint": { + "description": "OneLake endpoint to use for the datastore.", + "type": "string", + "example": "data.microsoft.com", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "oneLakeWorkspaceName": { + "description": "[Required] OneLake workspace name.", "minLength": 1, "pattern": "[a-zA-Z0-9_]", - "type": "string" + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] } }, + "x-ms-discriminator-value": "OneLake", "additionalProperties": false }, "OnlineDeployment": { @@ -19125,6 +20373,11 @@ "default": false, "type": "boolean" }, + "dataCollector": { + "description": "The mdc configuration, we disable mdc when it's null.", + "$ref": "#/definitions/DataCollector", + "x-nullable": true + }, "egressPublicNetworkAccess": { "description": "If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.", "default": "Enabled", @@ -19346,7 +20599,7 @@ }, "maxQueueWait": { "format": "duration", - "description": "The maximum amount of time a request will stay in the queue in ISO 8601 format.\r\nDefaults to 500ms.", + "description": "(Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format.\r\nDefaults to 500ms.\r\n(Now increase `request_timeout_ms` to account for any networking/queue delays)", "default": "PT0.5S", "type": "string" }, @@ -19426,7 +20679,8 @@ "description": "Output data delivery mode enums.", "enum": [ "ReadWriteMount", - "Upload" + "Upload", + "Direct" ], "type": "string", "x-ms-enum": { @@ -19438,6 +20692,9 @@ }, { "value": "Upload" + }, + { + "value": "Direct" } ] }, @@ -19562,6 +20819,26 @@ }, "additionalProperties": false }, + "PartialMinimalTrackedResourceWithSkuAndIdentity": { + "additionalProperties": false, + "allOf": [ + { + "$ref": "#/definitions/PartialMinimalTrackedResource" + } + ], + "description": "Strictly used in update requests.", + "properties": { + "identity": { + "$ref": "#/definitions/PartialManagedServiceIdentity", + "description": "Managed service identity (system assigned and/or user assigned identities)" + }, + "sku": { + "$ref": "#/definitions/PartialSku", + "description": "Sku details required for ARM contract for Autoscaling." + } + }, + "type": "object" + }, "PartialSku": { "description": "Common SKU definition.", "type": "object", @@ -20279,6 +21556,20 @@ }, "additionalProperties": false }, + "RequestLogging": { + "type": "object", + "properties": { + "captureHeaders": { + "description": "For payload logging, we only collect payload by default. If customers also want to collect the specified headers, they can set them in captureHeaders so that backend will collect those headers along with payload.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, "ResourceBase": { "type": "object", "properties": { @@ -20390,6 +21681,38 @@ "x-ms-discriminator-value": "Rolling", "additionalProperties": false }, + "RollingRateType": { + "enum": [ + "Year", + "Month", + "Day", + "Hour", + "Minute" + ], + "type": "string", + "x-ms-enum": { + "name": "RollingRateType", + "modelAsString": true, + "values": [ + { + "value": "Year" + }, + { + "value": "Month" + }, + { + "value": "Day" + }, + { + "value": "Hour" + }, + { + "value": "Minute" + } + ] + }, + "additionalProperties": false + }, "Route": { "required": [ "path", @@ -20796,31 +22119,234 @@ "SecretsType": { "description": "Enum to determine the datastore secrets type.", "enum": [ - "AccountKey", - "Certificate", - "Sas", - "ServicePrincipal" + "AccountKey", + "Certificate", + "Sas", + "ServicePrincipal" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretsType", + "modelAsString": true, + "values": [ + { + "value": "AccountKey" + }, + { + "value": "Certificate" + }, + { + "value": "Sas" + }, + { + "value": "ServicePrincipal" + } + ] + }, + "additionalProperties": false + }, + "ServerlessEndpoint": { + "additionalProperties": false, + "properties": { + "authMode": { + "$ref": "#/definitions/ServerlessInferenceEndpointAuthMode", + "description": "[Required] Specifies the authentication mode for the Serverless endpoint." + }, + "contentSafety": { + "$ref": "#/definitions/ContentSafety", + "description": "Specifies the content safety options. If omitted, the default content safety settings will be configured", + "x-nullable": true + }, + "endpointState": { + "$ref": "#/definitions/ServerlessEndpointState", + "description": "The current state of the ServerlessEndpoint.", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "inferenceEndpoint": { + "$ref": "#/definitions/ServerlessInferenceEndpoint", + "description": "The inference uri to target when making requests against the serverless endpoint", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "marketplaceSubscriptionId": { + "description": "The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint.", + "readOnly": true, + "type": "string", + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "modelSettings": { + "$ref": "#/definitions/ModelSettings", + "description": "The model settings (model id) for the model being serviced on the ServerlessEndpoint.", + "x-nullable": true + }, + "provisioningState": { + "$ref": "#/definitions/EndpointProvisioningState", + "description": "Provisioning state for the endpoint.", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "required": [ + "authMode" + ], + "type": "object", + "x-ms-client-name": "ServerlessEndpointProperties" + }, + "ServerlessEndpointState": { + "additionalProperties": false, + "description": "State of the Serverless Endpoint.", + "enum": [ + "Unknown", + "Creating", + "Deleting", + "Suspending", + "Reinstating", + "Online", + "Suspended", + "CreationFailed", + "DeletionFailed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ServerlessEndpointState", + "values": [ + { + "value": "Unknown" + }, + { + "value": "Creating" + }, + { + "value": "Deleting" + }, + { + "value": "Suspending" + }, + { + "value": "Reinstating" + }, + { + "value": "Online" + }, + { + "value": "Suspended" + }, + { + "value": "CreationFailed" + }, + { + "value": "DeletionFailed" + } + ] + } + }, + "ServerlessEndpointTrackedResource": { + "additionalProperties": false, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "Managed service identity (system assigned and/or user assigned identities)" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ServerlessEndpoint", + "description": "[Required] Additional attributes of the entity." + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "Sku details required for ARM contract for Autoscaling." + } + }, + "required": [ + "location", + "properties" + ], + "type": "object", + "x-ms-client-name": "ServerlessEndpoint" + }, + "ServerlessEndpointTrackedResourceArmPaginatedResult": { + "additionalProperties": false, + "description": "A paginated list of ServerlessEndpoint entities.", + "properties": { + "nextLink": { + "description": "The link to the next page of ServerlessEndpoint objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ServerlessEndpoint.", + "items": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + }, + "type": "array" + } + }, + "type": "object" + }, + "ServerlessInferenceEndpoint": { + "additionalProperties": false, + "properties": { + "headers": { + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "description": "Specifies any required headers to target this serverless endpoint.", + "readOnly": true, + "type": "object", + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "uri": { + "description": "[Required] The inference uri to target when making requests against the Serverless Endpoint.", + "format": "uri", + "type": "string", + "x-ms-mutability": [ + "read" + ] + } + }, + "required": [ + "uri" + ], + "type": "object" + }, + "ServerlessInferenceEndpointAuthMode": { + "additionalProperties": false, + "enum": [ + "Key" ], "type": "string", "x-ms-enum": { - "name": "SecretsType", "modelAsString": true, + "name": "ServerlessInferenceEndpointAuthMode", "values": [ { - "value": "AccountKey" - }, - { - "value": "Certificate" - }, - { - "value": "Sas" - }, - { - "value": "ServicePrincipal" + "value": "Key" } ] - }, - "additionalProperties": false + } }, "ServiceDataAccessAuthIdentity": { "enum": [ @@ -21071,6 +22597,301 @@ }, "additionalProperties": false }, + "SparkJob": { + "description": "Spark job definition.", + "required": [ + "codeId", + "entry" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "archives": { + "description": "Archive files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "args": { + "description": "Arguments for the job.", + "type": "string", + "example": " --input abfss://blob-container@testgen2.dfs.core.windows.net/mltable", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "codeId": { + "format": "arm-id", + "description": "[Required] arm-id of the code asset.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "conf": { + "description": "Spark configured properties.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "example": [ + { + "spark.driver.memory": "2g" + } + ], + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "entry": { + "description": "[Required] The entry to execute on startup of the job.", + "$ref": "#/definitions/SparkJobEntry", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentId": { + "format": "arm-id", + "description": "The ARM resource ID of the Environment specification for the job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "files": { + "description": "Files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Mapping of input data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jars": { + "description": "Jar files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "pyFiles": { + "description": "Python files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "$ref": "#/definitions/SparkResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Spark", + "additionalProperties": false + }, + "SparkJobEntry": { + "description": "Spark job entry point definition.", + "required": [ + "sparkJobEntryType" + ], + "type": "object", + "properties": { + "sparkJobEntryType": { + "description": "[Required] Type of the job's entry point.", + "$ref": "#/definitions/SparkJobEntryType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "sparkJobEntryType" + }, + "SparkJobEntryType": { + "enum": [ + "SparkJobPythonEntry", + "SparkJobScalaEntry" + ], + "type": "string", + "x-ms-enum": { + "name": "SparkJobEntryType", + "modelAsString": true, + "values": [ + { + "value": "SparkJobPythonEntry" + }, + { + "value": "SparkJobScalaEntry" + } + ] + }, + "additionalProperties": false + }, + "SparkJobPythonEntry": { + "required": [ + "file" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SparkJobEntry" + } + ], + "properties": { + "file": { + "description": "[Required] Relative python file path for job entry point.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "train.py", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "SparkJobPythonEntry", + "additionalProperties": false + }, + "SparkJobScalaEntry": { + "required": [ + "className" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SparkJobEntry" + } + ], + "properties": { + "className": { + "description": "[Required] Scala class name used as entry point.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "microsoft.aml.sample.myapp", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "SparkJobScalaEntry", + "additionalProperties": false + }, + "SparkResourceConfiguration": { + "type": "object", + "properties": { + "instanceType": { + "description": "Optional type of VM used as supported by the compute target.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "runtimeVersion": { + "description": "Version of spark runtime used for the job.", + "default": "3.1", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, "StackEnsembleSettings": { "description": "Advances setting to customize StackEnsemble run.", "type": "object", diff --git a/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/registries.json b/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/registries.json similarity index 99% rename from swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/registries.json rename to swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/registries.json index 927f5796a..d58ba78a0 100644 --- a/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/registries.json +++ b/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/registries.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Azure Machine Learning Services", - "version": "2023-10-01" + "version": "2024-04-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/workspaceFeatures.json b/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/workspaceFeatures.json similarity index 99% rename from swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/workspaceFeatures.json rename to swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/workspaceFeatures.json index 19e145947..9e107b898 100644 --- a/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/workspaceFeatures.json +++ b/swagger-specs/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/workspaceFeatures.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Azure Machine Learning Services", - "version": "2023-10-01" + "version": "2024-04-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/machinelearningservices/resource-manager/api-set.json b/swagger-specs/machinelearningservices/resource-manager/api-set.json index 4414eca54..48b1578a2 100644 --- a/swagger-specs/machinelearningservices/resource-manager/api-set.json +++ b/swagger-specs/machinelearningservices/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json", "Microsoft.MachineLearningServices/stable/2023-10-01/mfe.json", "Microsoft.MachineLearningServices/stable/2023-10-01/registries.json", "Microsoft.MachineLearningServices/stable/2023-10-01/workspaceFeatures.json"], "name": "package-2023-10"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.MachineLearningServices/stable/2024-04-01/machineLearningServices.json", "Microsoft.MachineLearningServices/stable/2024-04-01/mfe.json", "Microsoft.MachineLearningServices/stable/2024-04-01/registries.json", "Microsoft.MachineLearningServices/stable/2024-04-01/workspaceFeatures.json"], "name": "package-2024-04"} \ No newline at end of file diff --git a/swagger-specs/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json b/swagger-specs/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json index f1763aea0..733f43d10 100644 --- a/swagger-specs/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json +++ b/swagger-specs/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json @@ -1468,105 +1468,12 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/applyUpdates": { - "get": { - "tags": [ - "ApplyUpdate" - ], - "summary": "Get Configuration records within a subscription", - "operationId": "ApplyUpdates_List", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListApplyUpdate" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "ApplyUpdates_List": { - "$ref": "./examples/ApplyUpdates_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maintenance/applyUpdates": { - "get": { - "tags": [ - "ApplyUpdate" - ], - "summary": "Get Configuration records within a subscription and resource group", - "operationId": "ApplyUpdateForResourceGroup_List", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource Group Name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListApplyUpdate" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "ApplyUpdatesResourceGroup_List": { - "$ref": "./examples/ApplyUpdatesResourceGroup_List.json" - } - } - } - }, "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/configurationAssignments": { "get": { "tags": [ "ConfigurationAssignments" ], - "summary": "Get configuration assignment within a subscription", + "summary": "Get configuration assignment within a subscription. This API is not implemented yet.", "operationId": "ConfigurationAssignmentsWithinSubscription_List", "consumes": [], "produces": [ diff --git a/swagger-specs/maps/data-plane/Common/stable/2023-06-01/common.json b/swagger-specs/maps/data-plane/Common/stable/2023-06-01/common.json index 1ac85f0d0..6c5fdfa75 100644 --- a/swagger-specs/maps/data-plane/Common/stable/2023-06-01/common.json +++ b/swagger-specs/maps/data-plane/Common/stable/2023-06-01/common.json @@ -786,7 +786,7 @@ "name": "zoom", "x-ms-client-name": "z", "in": "query", - "description": "Zoom level for the desired tile. \n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "description": "Zoom level for the desired tile. \n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.", "required": true, "type": "integer", "format": "int32", diff --git a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/alias.json b/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/alias.json deleted file mode 100644 index f48f941f0..000000000 --- a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/alias.json +++ /dev/null @@ -1,311 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Alias Service", - "version": "2023-07-01", - "description": "APIs for managing aliases in Azure Maps." - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "client" - }, - "CreateCreatorDataItemId": { - "name": "creatorDataItemId", - "description": "The unique id that references a creator data item to be aliased.", - "type": "string", - "in": "query", - "x-ms-parameter-location": "method" - }, - "AssignCreatorDataItemId": { - "name": "creatorDataItemId", - "description": "The unique id that references a creator data item to be aliased.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "method" - }, - "AliasId": { - "name": "aliasId", - "description": "The unique id that references an existing alias.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/aliases": { - "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to create an alias. You can also assign the alias during the create request. An alias can reference an ID generated by a creator service, but cannot reference another alias ID.\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response with the alias resource in the body.\n\nA sample response from creating an alias:\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", - "operationId": "Alias_Create", - "x-ms-examples": { - "Create an alias that does not reference any resource": { - "$ref": "./examples/alias/Alias_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/CreateCreatorDataItemId" - } - ], - "responses": { - "201": { - "description": "Content created successfully. The response body contains the newly created alias id `aliasId`.", - "schema": { - "$ref": "#/definitions/Alias" - }, - "headers": { - "Access-Control-Expose-Headers": { - "type": "string", - "description": "The list of response headers that can be read by the client." - } - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all previously successfully created aliases.\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ\n\nA sample response returning 2 alias resources:\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33.123Z\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"creatorDataItemId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33.123Z\"\n }\n ]\n}\n```", - "operationId": "Alias_List", - "x-ms-examples": { - "List all the previously created aliases": { - "$ref": "./examples/alias/Alias_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "x-ms-pageable": { - "itemName": "aliases", - "nextLinkName": "nextLink" - }, - "responses": { - "200": { - "description": "List alias request completed successfully. The response body contains a list of all the previously created aliases.", - "schema": { - "$ref": "#/definitions/AliasListResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/aliases/{aliasId}": { - "put": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to assign an alias to reference a resource.\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter.\n\n### Assign Alias Response\n\nThe Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", - "operationId": "Alias_Assign", - "x-ms-examples": { - "Assign an alias to a resource": { - "$ref": "./examples/alias/Alias_Assign.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/AliasId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/AssignCreatorDataItemId" - } - ], - "responses": { - "200": { - "description": "Alias was assigned successfully.", - "schema": { - "$ref": "#/definitions/Alias" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete a previously created alias. You can also use this API to delete old/unused aliases to create space for new content.This API does not delete the references resource, only the alias referencing the resource.\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.", - "operationId": "Alias_Delete", - "x-ms-examples": { - "Delete previously created alias": { - "$ref": "./examples/alias/Alias_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/AliasId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "204": { - "description": "Alias delete request completed successfully. The content for `aliasId` was deleted on the server." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch the details of a previously created alias.\n\n### Submit Get Details Request\n\nTo get the details of your alias, you will issue a `GET` request with the `aliasId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource:\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\nHere's a sample response:\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", - "operationId": "Alias_Get", - "x-ms-examples": { - "Get a previously created alias": { - "$ref": "./examples/alias/Alias_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/AliasId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "Get alias request completed successfully. The response body contains the previously created alias.", - "schema": { - "$ref": "#/definitions/Alias" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "AliasListResult": { - "description": "The response model for the List API. Returns a list of all the previously created aliases.", - "type": "object", - "properties": { - "aliases": { - "description": "A list of all the previously created aliases.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Alias" - } - }, - "nextLink": { - "description": "If present, the location of the next page of data.", - "type": "string", - "readOnly": true - } - } - }, - "Alias": { - "description": "Detailed information for the alias.", - "type": "object", - "properties": { - "createdTimestamp": { - "description": "The created timestamp for the alias.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "aliasId": { - "description": "The id for the alias.", - "type": "string", - "readOnly": true - }, - "creatorDataItemId": { - "description": "The id for the creator data item that this alias references (could be null if the alias has not been assigned).", - "type": "string", - "x-nullable": true, - "readOnly": true - }, - "lastUpdatedTimestamp": { - "description": "The timestamp of the last time the alias was assigned.", - "type": "string", - "format": "date-time", - "readOnly": true - } - } - } - } -} diff --git a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/dataset.json b/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/dataset.json deleted file mode 100644 index 4de2fac85..000000000 --- a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/dataset.json +++ /dev/null @@ -1,361 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Dataset Service", - "version": "2023-07-01", - "description": "APIs for managing datasets from uploaded data in Azure Maps." - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "client" - }, - "ConversionIdQuery": { - "name": "conversionId", - "description": "ID to create the dataset. The `conversionId` must be obtained from a successful call to the Conversion Service [Convert API](https://docs.microsoft.com/en-us/rest/api/maps/2023-07-01/conversion/convert). Only one conversionId can be provided per API call.", - "type": "string", - "in": "query", - "required": false, - "x-ms-parameter-location": "method" - }, - "DatasetDescription": { - "name": "description", - "description": "The description to be given to the dataset.", - "type": "string", - "in": "query", - "x-ms-parameter-location": "method" - }, - "DatasetId": { - "name": "datasetId", - "type": "string", - "in": "path", - "description": "The identifier for the dataset to query from.", - "required": true, - "x-ms-parameter-location": "method" - }, - "AppendDatasetId": { - "name": "datasetId", - "type": "string", - "in": "query", - "description": "The ID of the dataset to append with.", - "x-ms-parameter-location": "method" - }, - "DatasetOperationId": { - "name": "operationId", - "type": "string", - "in": "path", - "description": "The ID to query the status for the dataset create/import request.", - "required": true, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/datasets": { - "post": { - "description": "This API allows the caller to create a dataset from data that was uploaded to the [Azure Maps Data Service](https://docs.microsoft.com/en-us/rest/api/maps/data-v2) and converted using the [Azure Maps Conversion Service](https://docs.microsoft.com/en-us/rest/api/maps/2023-07-01/conversion).\n\n### Submit Create Request\n\nTo create your dataset, issue a `POST` request with the required parameters. The Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", - "operationId": "Dataset_Create", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Create dataset from a converted CAD file provided by conversionId": { - "$ref": "./examples/dataset/Dataset_Create_ConversionId.json" - }, - "Create dataset with conversionId and append to it another dataset created with conversionId": { - "$ref": "./examples/dataset/Dataset_Append_ConversionId.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ConversionIdQuery" - }, - { - "$ref": "#/parameters/AppendDatasetId" - }, - { - "$ref": "#/parameters/DatasetDescription" - } - ], - "responses": { - "202": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "This API allows the caller to fetch a list of all previously successfully created datasets.\n\n### Submit List Request\n\nTo list all your datasets, issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 2 dataset resources:\n\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53.123Z\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"custom\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n ]\n}\n```", - "operationId": "Dataset_List", - "x-ms-examples": { - "List all the previously created datasets": { - "$ref": "./examples/dataset/Dataset_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "x-ms-pageable": { - "itemName": "datasets", - "nextLinkName": "nextLink" - }, - "responses": { - "200": { - "description": "The dataset request completed successfully. The response body contains the previously created dataset.", - "schema": { - "$ref": "#/definitions/DatasetListResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/datasets/{datasetId}": { - "get": { - "description": "This API allows the caller to fetch a previously successfully created dataset.\n\n### Submit Get Details Request\n\nTo get the details for a previously created dataset, you will issue a `GET` request with the `datasetId` in the path.\n\n### Get Details Response\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:\n\n```json\n{\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n```", - "operationId": "Dataset_Get", - "x-ms-examples": { - "Get details for a previously created dataset": { - "$ref": "./examples/dataset/Dataset_GetDetails.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/DatasetId" - } - ], - "responses": { - "200": { - "description": "The get dataset request completed successfully.", - "schema": { - "$ref": "#/definitions/Dataset" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "You can use this API to delete old/unused datasets to create space for new Creator content.\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.", - "operationId": "Dataset_Delete", - "x-ms-examples": { - "Delete previously created dataset": { - "$ref": "./examples/dataset/Dataset_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/DatasetId" - } - ], - "responses": { - "204": { - "description": "The dataset delete request completed successfully. The resource referenced by the `datasetId` was deleted from the server." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/datasets/operations/{operationId}": { - "get": { - "description": "This API allows the caller to view the current progress of a dataset operation and the path is obtained from a call to the Create API.\n\n### Submit Operations Request\n\nTo view the current progress of a dataset operation, you will use a `GET` request where the `operationId` is the ID representing the operation.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code will be returned with no extra headers. If the operation succeeds, a `200-OK` http status code with Resource-Location header will be returned.", - "operationId": "Dataset_GetOperation", - "x-ms-examples": { - "Get the status of an operation which is still running": { - "$ref": "./examples/dataset/Dataset_GetOperationStillRunning.json" - }, - "Get the status of an operation which has finished successfully": { - "$ref": "./examples/dataset/Dataset_GetOperation.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/DatasetOperationId" - } - ], - "responses": { - "200": { - "description": "The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result.", - "schema": { - "$ref": "./tileset.json#/definitions/LongRunningOperationResult" - }, - "headers": { - "Resource-Location": { - "type": "string", - "description": "If successful, a URI where details on the newly created resource can be found." - } - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "DatasetListResult": { - "description": "The response model for the Dataset List API. The response body will contain a list of all the previously created datasets.", - "type": "object", - "properties": { - "datasets": { - "description": "A list of all the previously created datasets.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Dataset" - } - }, - "nextLink": { - "description": "If present, the location of the next page of data.", - "type": "string", - "readOnly": true - } - } - }, - "Dataset": { - "description": "Detail information for the dataset.", - "type": "object", - "properties": { - "created": { - "description": "The created timestamp for the dataset.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "datasetId": { - "description": "The id for the dataset.", - "type": "string", - "readOnly": true - }, - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "description": { - "description": "The description for the dataset.", - "type": "string", - "readOnly": true - }, - "datasetSources": { - "$ref": "#/definitions/DatasetSources" - }, - "featureCounts": { - "description": "The feature counts for the dataset.", - "type": "object", - "readOnly": true - } - } - }, - "DatasetSources": { - "description": "Information about the details of the create request for the dataset.", - "type": "object", - "properties": { - "conversionIds": { - "description": "The `conversionIds` used to create the dataset.", - "type": "array", - "readOnly": true, - "items": { - "type": "string" - } - }, - "appendDatasetId": { - "description": "The dataset that was appended to create the current dataset.", - "type": "string", - "readOnly": true - } - } - } - } -} diff --git a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/dwgconversion.json b/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/dwgconversion.json deleted file mode 100644 index efb05d6a8..000000000 --- a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/dwgconversion.json +++ /dev/null @@ -1,348 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Conversion Service", - "version": "2023-07-01", - "description": "APIs for converting DWG Packages in Azure Maps." - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "client" - }, - "UdidQuery": { - "name": "udid", - "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) call.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "method" - }, - "ConversionId": { - "name": "conversionId", - "description": "The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert) call.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "DwgPackageVersion": { - "name": "dwgPackageVersion", - "description": "The drawing package version.", - "type": "string", - "in": "query", - "required": true, - "enum": [ - "1.0", - "2.0" - ], - "x-ms-enum": { - "name": "DwgPackageVersion", - "modelAsString": true, - "values": [ - { - "value": "1.0", - "description": "The drawing package version 1.0. Please refer to this [article](https://docs.microsoft.com/en-us/azure/azure-maps/drawing-requirements?pivots=1.0) for more information." - }, - { - "value": "2.0", - "description": "The drawing package version 2.0. Please refer to this [article](https://docs.microsoft.com/en-us/azure/azure-maps/drawing-requirements?pivots=2.0) for more information." - } - ] - }, - "x-ms-client-default": "1.0", - "x-ms-parameter-location": "method" - }, - "DescriptionDwgConversion": { - "name": "description", - "description": "User provided description of the content being converted.", - "type": "string", - "in": "query", - "x-ms-parameter-location": "method" - }, - "ConversionOperationId": { - "name": "operationId", - "type": "string", - "in": "path", - "description": "The ID to query the status for the Conversion create/import request.", - "required": true, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/conversions": { - "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be uploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the `udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload-preview) to call this Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running operation](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", - "operationId": "Conversion_Create", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Convert previously uploaded DWG Package": { - "$ref": "./examples/conversion/Conversion_Conversion.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/UdidQuery" - }, - { - "$ref": "#/parameters/DwgPackageVersion" - }, - { - "$ref": "#/parameters/DescriptionDwgConversion" - } - ], - "responses": { - "202": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
", - "operationId": "Conversion_List", - "x-ms-examples": { - "Returns a list of all the data processed by the Conversion Service for the account": { - "$ref": "./examples/conversion/Conversion_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "x-ms-pageable": { - "itemName": "conversions", - "nextLinkName": "nextLink" - }, - "responses": { - "200": { - "description": "List request completed successfully.", - "schema": { - "$ref": "#/definitions/ConversionListResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/conversions/{conversionId}": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a successful data conversion submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert). ", - "operationId": "Conversion_Get", - "x-ms-examples": { - "Get the details for one conversion operation": { - "$ref": "./examples/conversion/Conversion_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ConversionId" - } - ], - "responses": { - "200": { - "description": "Returns details of the specified conversion.", - "schema": { - "$ref": "#/definitions/Conversion" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", - "operationId": "Conversion_Delete", - "x-ms-examples": { - "Delete previously converted content": { - "$ref": "./examples/conversion/Conversion_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ConversionId" - } - ], - "responses": { - "204": { - "description": "Conversion delete request completed successfully. The content for `conversionId` was deleted on the server." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/conversions/operations/{operationId}": { - "get": { - "description": "This path will be obtained from a call to POST /conversions. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once successfully completed.", - "operationId": "Conversion_GetOperation", - "x-ms-examples": { - "Get the status of an operation which is still running": { - "$ref": "./examples/conversion/Conversion_GetOperationStillRunning.json" - }, - "Get the status of an operation which has finished successfully, with non-fatal warnings": { - "$ref": "./examples/conversion/Conversion_GetOperation.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ConversionOperationId" - } - ], - "responses": { - "200": { - "description": "The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result.", - "schema": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/LongRunningOperationResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "ConversionListResult": { - "description": "The response model for the Conversion List API.", - "type": "object", - "properties": { - "conversions": { - "description": "A list of all the previously submitted conversion requests.", - "type": "array", - "items": { - "$ref": "#/definitions/Conversion" - } - }, - "nextLink": { - "description": "If present, the location of the next page of data.", - "type": "string" - } - } - }, - "Conversion": { - "description": "Detail information for the conversion requests.", - "type": "object", - "properties": { - "conversionId": { - "description": "A unique id that represents the artifact of a _successfully_ completed conversion process.", - "type": "string" - }, - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "udid": { - "description": "The unique id of the content provided to create this conversion.", - "type": "string" - }, - "created": { - "description": "The date and time of this conversion.", - "type": "string" - }, - "description": { - "description": "User provided description of the content being converted.", - "type": "string" - }, - "featureCounts": { - "description": "A summary of feature counts in this conversion.", - "additionalProperties": { - "type": "integer", - "format": "int64" - }, - "type": "object" - } - } - } - } -} diff --git a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/features.json b/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/features.json deleted file mode 100644 index 1d995c8cf..000000000 --- a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/features.json +++ /dev/null @@ -1,1097 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Features Service", - "version": "2023-07-01", - "description": "Azure Maps Features REST APIs" - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "client" - }, - "LimitFeatures": { - "name": "limit", - "in": "query", - "type": "integer", - "format": "int32", - "minimum": 1, - "maximum": 5000, - "description": "The optional limit parameter limits the number of features that are presented in the response document.\nOnly features that are on the first level of the collection in the response document are counted. Nested objects contained within the explicitly requested features shall not be counted.\n* Minimum = 1 * Maximum = 500 * Default = 10", - "x-ms-parameter-location": "method" - }, - "Filter": { - "name": "filter", - "in": "query", - "type": "string", - "description": "Filter expression to search for features with specific property values in a given collection. Only feature properties of scalar type and equals operator are supported.\nThis is a special parameter where the parameter name is a case sensitive property name. The scheme for this parameter is {property name}={property value}. Unless \"filter\" is one of the property names in the collection, \"filter\" should not be used as a parameter name. To search for features with \"name\" property value \"21N13\", use \"name=21N13\".\nMultiple filters are supported and should be represented as multiple query parameters. E.g., =&= String values are case sensitive.", - "x-ms-parameter-location": "method" - }, - "Bbox": { - "name": "bbox", - "x-ms-client-name": "boundingBox", - "in": "query", - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "number", - "format": "double" - }, - "description": "Only features that have a geometry that intersects the supplied bounding box are selected.\n* Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2\nThe coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter `bbox-crs`.\nFor WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).", - "x-ms-parameter-location": "method" - }, - "CollectionId": { - "name": "collectionId", - "in": "path", - "type": "string", - "required": true, - "description": "Identifier (name) of a specific collection.", - "x-ms-parameter-location": "method" - }, - "FeatureId": { - "name": "featureId", - "in": "path", - "type": "string", - "description": "Case sensitive identifier of a specific feature.", - "required": true, - "x-ms-parameter-location": "method" - }, - "FeatureBody": { - "name": "feature", - "in": "body", - "required": true, - "description": "A valid `GeoJSON Feature` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.2) for details.", - "x-ms-parameter-location": "client", - "schema": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FeatureType" - }, - { - "$ref": "#/definitions/FeatureAttributes" - } - ] - } - }, - "FeatureAttributesBody": { - "name": "featureAttributes", - "in": "body", - "required": true, - "description": "The geometry and properties of a feature.", - "x-ms-parameter-location": "client", - "schema": { - "$ref": "#/definitions/FeatureAttributes" - } - } - }, - "paths": { - "/features/datasets/{datasetId}": { - "get": { - "description": "The Get Landing Page API provides links to the API definition, the Conformance statements, and the metadata about the feature data in this dataset.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", - "operationId": "Features_GetLandingPage", - "x-ms-examples": { - "GetLandingPage": { - "$ref": "./examples/features/Features_GetLandingPage.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "./dataset.json#/parameters/DatasetId" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/LandingPageResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/features/datasets/{datasetId}/api": { - "get": { - "description": "The Get API Definition API provides a description of the capabilities of the Features service. It can be used by developers to understand the API or by development tools to support the implementation of servers and clients.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", - "operationId": "Features_GetApiDefinition", - "x-ms-examples": { - "GetApiDefinition": { - "$ref": "./examples/features/Features_GetApiDefinition.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "./dataset.json#/parameters/DatasetId" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/ApiDefinitionResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/features/datasets/{datasetId}/conformance": { - "get": { - "description": "The Get Conformance API lists all requirements classes specified in the standard that the server conforms to.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", - "operationId": "Features_ListConformance", - "x-ms-examples": { - "GetConformance": { - "$ref": "./examples/features/Features_ListConformance.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "./dataset.json#/parameters/DatasetId" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/ConformanceResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/features/datasets/{datasetId}/collections": { - "get": { - "description": "The Get Collections API provides a list of all the collections in a given dataset.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", - "operationId": "Features_GetCollections", - "x-ms-examples": { - "GetCollections": { - "$ref": "./examples/features/Features_GetCollections.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "./dataset.json#/parameters/DatasetId" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/CollectionsResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/features/datasets/{datasetId}/collections/{collectionId}": { - "get": { - "description": "The Get Collection API returns the collection identified by the provided id in the given dataset.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", - "operationId": "Features_GetCollection", - "x-ms-examples": { - "GetCollection": { - "$ref": "./examples/features/Features_GetCollection.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "./dataset.json#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/CollectionId" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/CollectionResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/features/datasets/{datasetId}/collections/{collectionId}/definition": { - "get": { - "description": "The Collection Definition API provides the detailed data model of a given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", - "operationId": "Features_GetCollectionDefinition", - "x-ms-examples": { - "GetCollectionDefinition": { - "$ref": "./examples/features/Features_GetCollectionDefinition.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "./dataset.json#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/CollectionId" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/CollectionDefinitionResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/features/datasets/{datasetId}/collections/{collectionId}/items": { - "get": { - "description": "The Get Features API returns the list of features in the given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", - "operationId": "Features_GetItems", - "x-ms-examples": { - "GetFeatures": { - "$ref": "./examples/features/Features_GetItems.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "./dataset.json#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/CollectionId" - }, - { - "$ref": "#/parameters/LimitFeatures" - }, - { - "$ref": "#/parameters/Bbox" - }, - { - "$ref": "#/parameters/Filter" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/ExtendedGeoJsonFeatureCollection" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "post": { - "description": "This Post Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API creates a feature with the provided attributes in the given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", - "operationId": "Features_Create", - "x-ms-examples": { - "PostFeature": { - "$ref": "./examples/features/Features_Create.json" - } - }, - "consumes": [ - "application/geo+json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "./dataset.json#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/CollectionId" - }, - { - "$ref": "#/parameters/FeatureBody" - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/CreateFeatureResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/features/datasets/{datasetId}/collections/{collectionId}/items/{featureId}": { - "get": { - "description": "The Get Feature API returns the feature identified by the provided id in the given collection.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", - "operationId": "Features_Get", - "x-ms-examples": { - "GetFeature": { - "$ref": "./examples/features/Features_Get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "./dataset.json#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/CollectionId" - }, - { - "$ref": "#/parameters/FeatureId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/FeatureResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "put": { - "description": "This Put Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API **replaces** the feature identified by the provided id in the given collection, i.e., the request body overwrites all the existing attributes of a feature.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", - "operationId": "Features_Replace", - "x-ms-examples": { - "PutFeature": { - "$ref": "./examples/features/Features_Replace.json" - } - }, - "consumes": [ - "application/geo+json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "./dataset.json#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/CollectionId" - }, - { - "$ref": "#/parameters/FeatureId" - }, - { - "$ref": "#/parameters/FeatureBody" - } - ], - "responses": { - "204": { - "description": "Feature Updated." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "patch": { - "description": "This Patch Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API **updates** attributes by performing a merge patch on the feature identified by the provided id in the given collection. It allows for the update of individual feature attributes without implicitly overwriting excluded attributes in the request body.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", - "operationId": "Features_Update", - "x-ms-examples": { - "PatchFeature": { - "$ref": "./examples/features/Features_Update.json" - } - }, - "consumes": [ - "application/merge-patch+json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "./dataset.json#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/CollectionId" - }, - { - "$ref": "#/parameters/FeatureId" - }, - { - "$ref": "#/parameters/FeatureAttributesBody" - } - ], - "responses": { - "204": { - "description": "Feature Updated." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "This Delete Feature API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) document. This API deletes the feature identified by the provided id in the given collection. Please note that if other existing features are dependent on the requested feature for deletion, the delete request will fail until the dependent features are deleted first.\n\nThe Features API is a part of [Creator](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v20220901preview/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).", - "operationId": "Features_Delete", - "x-ms-examples": { - "DeleteFeature": { - "$ref": "./examples/features/Features_Delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "./dataset.json#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/CollectionId" - }, - { - "$ref": "#/parameters/FeatureId" - } - ], - "responses": { - "204": { - "description": "Feature Deleted." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "LandingPageResult": { - "description": "Response after a successful request to the landing page.", - "type": "object", - "required": [ - "links" - ], - "properties": { - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "links": { - "description": "Links to other Features endpoints.", - "type": "array", - "items": { - "$ref": "#/definitions/FeaturesEndpointLink" - } - } - } - }, - "ApiDefinitionResult": { - "description": "Response after a successful request to get the API definition.", - "type": "object", - "required": [ - "openapi", - "info", - "paths", - "components", - "tags" - ], - "properties": { - "openapi": { - "description": "The OpenAPI version.", - "type": "string", - "example": "3.0.1" - }, - "info": { - "description": "The OpenAPI info object.", - "type": "object", - "properties": { - "title": { - "description": "The title of the API.", - "type": "string", - "example": "Azure Maps Web Feature Service" - }, - "version": { - "description": "The version of the API.", - "type": "string", - "example": "2023-07-01" - }, - "description": { - "description": "The description of the API.", - "type": "string", - "example": "Azure Maps Web Feature REST APIs" - } - } - }, - "paths": { - "description": "The OpenAPI paths object.", - "type": "object" - }, - "components": { - "description": "The OpenAPI components object.", - "type": "object", - "properties": { - "parameters": { - "description": "The OpenAPI parameters object.", - "type": "object", - "additionalProperties": true - }, - "schemas": { - "description": "The OpenAPI schemas object.", - "type": "object", - "additionalProperties": true - } - } - }, - "tags": { - "description": "The OpenAPI tags object.", - "type": "array", - "items": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "description": "The name of the tag.", - "type": "string", - "example": "Features" - }, - "description": { - "description": "The description of the tag.", - "type": "string", - "example": "Access to data (features)." - } - } - } - } - } - }, - "ConformanceResult": { - "description": "Response after a successful request to the conformance page.", - "type": "object", - "required": [ - "conformsTo" - ], - "properties": { - "conformsTo": { - "description": "List of requirements classes that the server conforms to.", - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core", - "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas3", - "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson" - ] - } - } - }, - "FeaturesEndpointLink": { - "description": "Links to other Features endpoints. For more details about link relations, please visit the [OGC API - Features - Part 1](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1#_link_relations) standard.", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "The link target.", - "type": "string", - "format": "uri", - "example": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4" - }, - "rel": { - "description": "The relation type.", - "type": "string", - "example": "self" - }, - "title": { - "description": "Used to label the destination of a link such that it can be used as a human-readable identifier (e.g., a menu entry) in the language indicated by the Content-Language header field (if present).", - "type": "string", - "example": "Azure Maps Features" - } - } - }, - "CollectionsResult": { - "description": "Response after a successful request to list collections.", - "type": "object", - "required": [ - "links", - "collections" - ], - "properties": { - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "collections": { - "description": "All the collections in a given dataset.", - "type": "array", - "items": { - "$ref": "#/definitions/CollectionResult" - } - }, - "links": { - "description": "Links to other Features endpoints.", - "type": "array", - "items": { - "$ref": "#/definitions/FeaturesEndpointLink" - }, - "example": [ - { - "href": "http://data.example.org/collections.json", - "rel": "self", - "title": "this document" - } - ] - } - } - }, - "CollectionResult": { - "description": "Response after a successful request to get a collection.", - "type": "object", - "required": [ - "id", - "title", - "links" - ], - "properties": { - "id": { - "description": "Identifier of the collection used, for example, in URIs.", - "type": "string", - "example": "buildings" - }, - "title": { - "description": "Human readable title of the collection.", - "type": "string", - "example": "Buildings" - }, - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "itemType": { - "description": "The type of the items in the collection.", - "type": "string", - "example": "feature" - }, - "description": { - "description": "A description of the features in the collection.", - "type": "string", - "example": "Buildings in the city of Bonn." - }, - "links": { - "description": "Links to other Features endpoints.", - "type": "array", - "items": { - "$ref": "#/definitions/FeaturesEndpointLink" - }, - "example": [ - { - "href": "http://data.example.org/collections/buildings/items", - "rel": "items", - "title": "Buildings" - }, - { - "href": "http://data.example.org/collections/buildings/definition", - "rel": "describedBy", - "title": "Metadata catalogue for unit" - }, - { - "href": "http://data.example.org/collections/buildings", - "rel": "self", - "title": "Information for unit collection" - } - ] - } - } - }, - "CollectionDefinitionResult": { - "description": "Response after a successful request to read a collection's definition.", - "type": "object", - "required": [ - "id", - "title", - "geometryType" - ], - "properties": { - "id": { - "description": "Identifier of the collection used, for example, in URIs.", - "type": "string", - "example": "buildings" - }, - "title": { - "description": "Title of collection.", - "type": "string", - "example": "Feature Class buildings" - }, - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "itemType": { - "description": "The type of the items in the collection.", - "type": "string", - "example": "feature" - }, - "description": { - "description": "Describes the collection.", - "type": "string" - }, - "geometryType": { - "description": "Type of geometry returned.", - "type": "string", - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ], - "x-ms-enum": { - "name": "GeoJsonGeometryType", - "modelAsString": true, - "values": [ - { - "value": "Point", - "description": "`GeoJSON Point` geometry.", - "name": "GeoJsonPoint" - }, - { - "value": "MultiPoint", - "description": "`GeoJSON MultiPoint` geometry.", - "name": "GeoJsonMultiPoint" - }, - { - "value": "LineString", - "description": "`GeoJSON LineString` geometry.", - "name": "GeoJsonLineString" - }, - { - "value": "MultiLineString", - "description": "`GeoJSON MultiLineString` geometry.", - "name": "GeoJsonMultiLineString" - }, - { - "value": "Polygon", - "description": "`GeoJSON Polygon` geometry.", - "name": "GeoJsonPolygon" - }, - { - "value": "MultiPolygon", - "description": "`GeoJSON MultiPolygon` geometry.", - "name": "GeoJsonMultiPolygon" - }, - { - "value": "GeometryCollection", - "description": "`GeoJSON GeometryCollection` geometry.", - "name": "GeoJsonGeometryCollection" - } - ] - } - }, - "properties": { - "description": "Attributes of the collection used.", - "type": "array", - "items": { - "$ref": "#/definitions/DefinitionProperty" - } - }, - "links": { - "description": "Links to other Features endpoints.", - "type": "array", - "items": { - "$ref": "#/definitions/FeaturesEndpointLink" - } - } - } - }, - "DefinitionProperty": { - "description": "The definition of a property in a collection.", - "type": "object", - "required": [ - "name", - "required", - "type" - ], - "properties": { - "name": { - "description": "Name of attribute.", - "type": "string", - "example": "external_id" - }, - "required": { - "description": "Is attribute required.", - "type": "boolean" - }, - "type": { - "description": "Type of attribute.", - "type": "object" - } - } - }, - "ExtendedGeoJsonFeatureCollection": { - "description": "A valid `GeoJSON FeatureCollection` object type extended with numberReturned and links array. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FeatureCollectionData" - }, - { - "$ref": "#/definitions/ExtendedGeoJsonFeatureCollectionData" - } - ], - "properties": { - "type": { - "description": "Specifies the `GeoJSON` type: FeatureCollection.", - "type": "string", - "enum": [ - "FeatureCollection" - ], - "x-ms-enum": { - "name": "GeoJsonObjectType", - "modelAsString": false, - "values": [ - { - "value": "FeatureCollection", - "description": "`GeoJSON FeatureCollection` object." - } - ] - } - } - } - }, - "ExtendedGeoJsonFeatureCollectionData": { - "type": "object", - "properties": { - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "numberReturned": { - "description": "Number of returned features.", - "type": "integer", - "format": "int32" - }, - "links": { - "description": "Links to other Features endpoints.", - "type": "array", - "items": { - "$ref": "#/definitions/FeaturesEndpointLink" - } - } - } - }, - "FeatureResult": { - "description": "Response after a feature is successfully read.", - "type": "object", - "required": [ - "feature" - ], - "properties": { - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "feature": { - "$ref": "#/definitions/Feature" - }, - "links": { - "description": "Links to other Features endpoints.", - "type": "array", - "items": { - "$ref": "#/definitions/FeaturesEndpointLink" - } - } - } - }, - "CreateFeatureResult": { - "description": "Response after a feature is successfully created.", - "type": "object", - "required": [ - "id", - "ontology", - "links" - ], - "properties": { - "id": { - "description": "Identifier for the feature.", - "type": "string" - }, - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "links": { - "description": "Links to other Features endpoints.", - "type": "array", - "items": { - "$ref": "#/definitions/FeaturesEndpointLink" - } - } - } - }, - "Feature": { - "description": "A valid `GeoJSON Feature` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.2) for details.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/FeatureId" - }, - { - "$ref": "#/definitions/FeatureType" - }, - { - "$ref": "#/definitions/FeatureAttributes" - } - ] - }, - "FeatureType": { - "type": "object", - "properties": { - "type": { - "description": "Specifies the `GeoJSON` type: Feature", - "type": "string" - } - } - }, - "FeatureId": { - "type": "object", - "properties": { - "id": { - "description": "Case sensitive identifier of a specific feature.", - "type": "string" - } - } - }, - "FeatureAttributes": { - "description": "The geometry and properties of a feature.", - "type": "object", - "properties": { - "geometry": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonGeometry" - }, - "properties": { - "description": "Properties can contain any additional metadata about the `Feature` and are defined by the GET Collection Definition API. Value can be any JSON object or a JSON null value, but please note that feature properties not defined in the collection definition will be ignored.", - "type": "object" - } - } - }, - "FeatureCollectionData": { - "type": "object", - "properties": { - "features": { - "description": "Contains a list of valid `GeoJSON Feature` objects.", - "type": "array", - "items": { - "$ref": "#/definitions/Feature" - } - } - }, - "required": [ - "features" - ] - } - } -} diff --git a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/featurestate.json b/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/featurestate.json deleted file mode 100644 index 7cbe197da..000000000 --- a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/featurestate.json +++ /dev/null @@ -1,693 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Feature State Service", - "version": "2023-07-01", - "description": "APIs for managing the dynamic feature states in Azure Maps." - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "client" - }, - "FeatureStateSetDescription": { - "name": "description", - "description": "Description for the stateset. Max length allowed is 1000.", - "type": "string", - "in": "query", - "required": false, - "x-ms-parameter-location": "method" - }, - "DatasetIdForCreate": { - "name": "datasetId", - "description": "The datasetId must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create) call.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "method" - }, - "StatesetIdInPath": { - "name": "statesetId", - "description": "The stateset id that was created.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "FeatureIdSet": { - "name": "featureId", - "description": "The id of a feature in the given dataset. If the featureId is not present in the dataset, Bad Request response will be returned.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "FeatureIdGet": { - "name": "featureId", - "description": "The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "FeatureIdDelete": { - "name": "featureId", - "description": "The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "StateKeyName": { - "name": "stateKeyName", - "x-ms-client-name": "keyName", - "description": "The Name of the state to be deleted.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/featureStateSets": { - "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the [State Tile documentation](https://docs.microsoft.com/rest/api/maps/render/get-map-state-tile) for more information.", - "operationId": "FeatureState_CreateStateset", - "x-ms-examples": { - "Create a new stateset with a datasetId": { - "$ref": "./examples/featurestate/Featurestate_CreateStateset.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/DatasetIdForCreate" - }, - { - "$ref": "#/parameters/FeatureStateSetDescription" - }, - { - "name": "styleRules", - "in": "body", - "description": "The stateset style JSON data.", - "required": true, - "schema": { - "$ref": "#/definitions/StyleRules" - } - } - ], - "responses": { - "200": { - "description": "Stateset created.", - "schema": { - "$ref": "#/definitions/StatesetCreatedResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API allows the caller to fetch a list of all previously successfully created statesets.", - "operationId": "FeatureState_ListStatesets", - "x-ms-examples": { - "List all the previously created statesets": { - "$ref": "./examples/featurestate/Featurestate_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "x-ms-pageable": { - "itemName": "statesets", - "nextLinkName": "nextLink" - }, - "responses": { - "200": { - "description": "The list stateset request completed successfully. The response body contains a list of all the previously created statesets.", - "schema": { - "$ref": "#/definitions/StatesetListResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/featureStateSets/{statesetId}": { - "put": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis PUT API allows the user to update the stateset style rules.", - "operationId": "FeatureState_UpdateStateset", - "x-ms-examples": { - "Update stateset style rules with a statesetId": { - "$ref": "./examples/featurestate/Featurestate_UpdateStateset.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StatesetIdInPath" - }, - { - "name": "styleRules", - "in": "body", - "description": "The stateset style JSON data. Only style rules are allowed to be updated, update on keyname and type is not allowed.", - "required": true, - "schema": { - "$ref": "#/definitions/StyleRules" - } - } - ], - "responses": { - "200": { - "description": "Stateset styles are updated successfully." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This DELETE API allows the user to delete the stateset and the associated data.", - "operationId": "FeatureState_DeleteStateset", - "x-ms-examples": { - "Delete an existing stateset": { - "$ref": "./examples/featurestate/Featurestate_DeleteStateset.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StatesetIdInPath" - } - ], - "responses": { - "204": { - "description": "Stateset Deleted." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis GET API allows the user to get the stateset Information.\n\nThe stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.", - "operationId": "FeatureState_GetStateset", - "x-ms-examples": { - "Get stateset information with a statesetId": { - "$ref": "./examples/featurestate/Featurestate_GetStateset.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StatesetIdInPath" - } - ], - "responses": { - "200": { - "description": "Get request completed successfully.", - "schema": { - "$ref": "#/definitions/Stateset" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/featureStateSets/{statesetId}/featureStates/{featureId}": { - "put": { - "operationId": "FeatureState_UpdateStates", - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis PUT API allows the user to update the state of the given feature in the given stateset.", - "x-ms-examples": { - "Update the states of a feature": { - "$ref": "./examples/featurestate/Featurestate_UpdateStates.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StatesetIdInPath" - }, - { - "$ref": "#/parameters/FeatureIdSet" - }, - { - "name": "featureStates", - "in": "body", - "description": "The feature state JSON data. A feature can have only one state at a given point in time. The specified state keyname must have been defined during the stateset creation.", - "required": true, - "schema": { - "$ref": "#/definitions/FeatureStatesStructure" - } - } - ], - "responses": { - "200": { - "description": "Feature states are updated successfully." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "operationId": "FeatureState_DeleteState", - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.", - "x-ms-examples": { - "Delete the given feature state": { - "$ref": "./examples/featurestate/Featurestate_DeleteFeatureState.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StatesetIdInPath" - }, - { - "$ref": "#/parameters/FeatureIdDelete" - }, - { - "$ref": "#/parameters/StateKeyName" - } - ], - "responses": { - "204": { - "description": "Feature states deleted successfully." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "operationId": "FeatureState_ListStates", - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API returns the current state information associated with the given feature in the given stateset.", - "x-ms-examples": { - "Get the current states of a feature": { - "$ref": "./examples/featurestate/Featurestate_ListStates.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StatesetIdInPath" - }, - { - "$ref": "#/parameters/FeatureIdGet" - } - ], - "responses": { - "200": { - "description": "Get request completed successfully.", - "schema": { - "$ref": "#/definitions/FeatureStatesStructure" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "Stateset": { - "description": "The response model for the successful Stateset Get API.", - "type": "object", - "properties": { - "description": { - "description": "Description associated with the stateset.", - "type": "string", - "readOnly": true - }, - "datasetIds": { - "description": "Dataset ID associated with the stateset.", - "type": "array", - "items": { - "type": "string" - } - }, - "statesetStyle": { - "x-ms-client-name": "styleRules", - "$ref": "#/definitions/StyleRules" - } - } - }, - "StatesetListResult": { - "description": "The response model for the successful Stateset List API.", - "type": "object", - "properties": { - "statesets": { - "description": "A list of statesets information.", - "type": "array", - "items": { - "$ref": "#/definitions/StatesetInfo" - } - }, - "nextLink": { - "description": "If present, the location of the next page of data.", - "type": "string", - "readOnly": true - } - } - }, - "StatesetInfo": { - "description": "The stateset information detail.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Stateset" - } - ], - "properties": { - "statesetId": { - "description": "The stateset ID of this stateset.", - "type": "string", - "readOnly": true - } - } - }, - "StatesetCreatedResult": { - "description": "The response model for the successful Stateset Create API.", - "type": "object", - "properties": { - "statesetId": { - "description": "The ID for the new stateset created.", - "type": "string", - "readOnly": true - } - } - }, - "FeatureStatesStructure": { - "description": "The feature states model for a feature.", - "type": "object", - "properties": { - "states": { - "description": "The feature states array.", - "type": "array", - "items": { - "$ref": "#/definitions/FeatureState" - } - } - } - }, - "FeatureState": { - "description": "Single feature state model.", - "type": "object", - "properties": { - "keyName": { - "description": "Feature state Keyname. Maximum length allowed is 1000.", - "type": "string" - }, - "value": { - "description": "Value for the feature state. Type should comply with the style definition attached to the featurestate. Maximum length allowed for string type is 1024.", - "type": "string" - }, - "eventTimestamp": { - "description": "Valid Timestamp when the feature state was captured.", - "type": "string" - } - } - }, - "StyleRules": { - "description": "The styles model.", - "type": "object", - "properties": { - "styles": { - "x-ms-client-name": "styleRules", - "description": "An array of stateset style rules. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRule, StringRule and BooleanRule definitions [here](https://aka.ms/AzureMapsStatesetStyles). ", - "type": "array", - "items": { - "$ref": "#/definitions/StyleRule" - } - } - } - }, - "NumberRule": { - "description": "The numeric rule. The color is selected from the first range it falls into.", - "type": "object", - "properties": { - "range": { - "$ref": "#/definitions/Range" - }, - "color": { - "description": "The color when value is within the range. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", - "type": "string" - } - } - }, - "Range": { - "description": "The numeric value range for this style rule. If the value is in the range, all the conditions must hold true.", - "type": "object", - "properties": { - "minimum": { - "description": "All the number x that x ≥ minimum.", - "type": "string" - }, - "maximum": { - "description": "All the number x that x ≤ maximum.", - "type": "string" - }, - "exclusiveMinimum": { - "description": "All the number x that x > exclusiveMinimum.", - "type": "string" - }, - "exclusiveMaximum": { - "description": "All the number x that x < exclusiveMaximum.", - "type": "string" - } - } - }, - "BooleanRule": { - "description": "The boolean rule. The color is selected based on the logic value of the key.", - "type": "object", - "properties": { - "true": { - "description": "The color when value is true. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", - "type": "string" - }, - "false": { - "description": "The color when value is false. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", - "type": "string" - } - } - }, - "StringRuleObject": { - "description": "The string rule. The string value matching is case sensitive. If a feature's state doesn't match any of the values defined here, that feature will not have any dynamic style. If duplicate string values are given, the first one takes precedence.", - "type": "object", - "additionalProperties": { - "description": "The color when the keyName value string is equal to this property name. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", - "type": "string" - } - }, - "StyleRule": { - "description": "The stateset style model. The style rule could be a numeric type style rule or a boolean type style rule. Refer to NumberRule, StringRuleObject and BooleanRule definitions [here](https://aka.ms/AzureMapsStatesetStyles). ", - "discriminator": "type", - "type": "object", - "required": [ - "keyName", - "type" - ], - "properties": { - "keyName": { - "description": "Stateset style key name. Key names are random strings but they should be unique inside style array.", - "type": "string" - }, - "type": { - "description": "The type of stateset style.", - "type": "string", - "enum": [ - "boolean", - "number", - "string" - ], - "x-ms-enum": { - "name": "StyleRuleType", - "modelAsString": true, - "values": [ - { - "value": "boolean", - "description": "Boolean type of stateset style." - }, - { - "value": "number", - "description": "Number type of stateset style." - }, - { - "value": "string", - "description": "String type of stateset style." - } - ] - } - } - } - }, - "BooleanStyleRule": { - "description": "The boolean type style rule object.", - "x-ms-discriminator-value": "boolean", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StyleRule" - } - ], - "properties": { - "rules": { - "description": "Boolean style rules.", - "type": "array", - "items": { - "$ref": "#/definitions/BooleanRule" - } - } - }, - "required": [ - "rules" - ] - }, - "NumberStyleRule": { - "description": "The numeric type style rule object.", - "x-ms-discriminator-value": "number", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StyleRule" - } - ], - "properties": { - "rules": { - "description": "Numeric style rules.", - "type": "array", - "items": { - "$ref": "#/definitions/NumberRule" - } - } - }, - "required": [ - "rules" - ] - }, - "StringStyleRule": { - "description": "The string type style rule object.", - "x-ms-discriminator-value": "string", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StyleRule" - } - ], - "properties": { - "rules": { - "description": "String style rules.", - "type": "array", - "items": { - "$ref": "#/definitions/StringRuleObject" - } - } - }, - "required": [ - "rules" - ] - } - } -} diff --git a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/mapconfiguration.json b/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/mapconfiguration.json deleted file mode 100644 index 094e98ad2..000000000 --- a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/mapconfiguration.json +++ /dev/null @@ -1,505 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Map Configuration Service", - "version": "2023-07-01", - "description": "This is an extension of the Azure Maps Tileset API to serve custom styles. It will allow a client to create a list of map styling information which can be combined with tilesetIds to create a map configuration that can be consumed directly by front-end services (map control web & mobile SDKs, styling tools like [Maputnik](https://maputnik.github.io/editor/)). Map configuration can be viewed as the backend representation for a style picker at frontend." - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "client" - }, - "MapConfigurationId": { - "name": "mapConfigurationId", - "description": "The map configuration Id.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "DescriptionMapConfiguration": { - "name": "description", - "description": "User provided description of the map configuration. Maximum length 1024 characters.", - "type": "string", - "in": "query", - "x-ms-parameter-location": "method" - }, - "MapConfigurationOperationId": { - "name": "operationId", - "type": "string", - "in": "path", - "description": "The ID to query the status for the map configuration create request.", - "required": true, - "x-ms-parameter-location": "method" - }, - "Alias": { - "name": "alias", - "description": "The alias of the map configuration. Maximum length 1024 characters. Alias cannot start with `microsoft-maps` which is a reserved prefix. Alias can be provided optionally during creating a map configuration, and can be used as same as mapConfigurationId after map configuration creation.", - "type": "string", - "in": "query", - "required": false, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/styles/mapconfigurations": { - "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Map Configuration Create request allows the caller to create a map configuration in their Azure Maps account.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n## Submit Create Request\n\nTo create your map configuration you will make a `POST` request with a map configuration file. \n\n### POST Body for Create Request\nAn `HTTP POST` request with the map configuration data in the body of the request is required to create a new map configuration in your Azure Maps account. The map configuration data must be in JSON format with `Content-Type` set to `application/json` in the header. Alternatively, you can send the map configuration JSON in a ZIP file along with any thumbnail images it references, with `Content-Type` set to `application/zip` in the header. \n\n Note: The embedded JSON size limit is 1 MB and zip file size limit is 23 MB.\n\n\n Here's a sample map configuration json:\n\n\n```json\n{\n \"version\": 1.0,\n \"description\": \"First indoor map configuration!\",\n \"defaultConfiguration\": \"indoor_light\",\n \"configurations\": [\n {\n \"name\": \"indoor_light\",\n \"displayName\": \"Indoor light\",\n \"theme\": \"light\",\n \"thumbnail\": \"indoor_2022-01-01.png\",\n \"baseMap\": \"microsoft_light\",\n \"layers\": [\n {\n \"tilesetId\": \"9601b149-cff6-dae6-af94-396f1b795fdb\",\n \"styleId\": \"microsoft-maps:indoor_2022-01-01\"\n }\n ] \n },\n {\n \"name\": \"indoor_dark\",\n \"displayName\": \"Indoor dark\",\n \"theme\": \"dark\",\n \"baseMap\": \"microsoft_dark\",\n \"thumbnail\": \"indoor_dark_2022-01-01.png\",\n \"layers\": [\n {\n \"tilesetId\": \"9601b149-cff6-dae6-af94-396f1b795fdb\",\n \"styleId\": \"microsoft-maps:indoor_dark_2022-01-01\"\n }\n ]\n }\n ]\n}\n``` \n\n Since the map configuration json contains two thumbnail image references 'indoor_2022-01-01.png' and 'indoor_dark_2022-01-01.png', a zip file including the map configuration json file and two thumbnail images should be provided as request body to make a valid create request. \n\nThe Create Map Configuration API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", - "operationId": "MapConfiguration_Create", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Create a map configuration by providing a configuration file": { - "$ref": "./examples/mapconfiguration/MapConfiguration_Create.json" - } - }, - "consumes": [ - "application/json", - "application/zip" - ], - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/Alias" - }, - { - "$ref": "#/parameters/DescriptionMapConfiguration" - }, - { - "name": "MapConfiguration", - "in": "body", - "description": "The configuration file used to create the map configuration. If JSON data format is provided, then the request body should follow [MapConfiguration specification](/rest/api/documentation-preview/map-configuration/create?#mapconfiguration). If ZIP data format is provided, you should also provide the thumbnail images referenced in the configuration JSON file.", - "required": true, - "schema": { - "$ref": "#/definitions/MapConfiguration" - } - } - ], - "responses": { - "202": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Map Configuration List request allows the caller to fetch a list of all map configurations created. You will see all the default map configurations which are created during tileset creation.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. \n
", - "operationId": "MapConfiguration_List", - "x-ms-examples": { - "Get a list of all map configurations": { - "$ref": "./examples/mapconfiguration/MapConfiguration_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "x-ms-pageable": { - "itemName": "mapConfiguration", - "nextLinkName": "nextLink" - }, - "responses": { - "200": { - "description": "List map configuration request completed successfully. The response body contains a list of all map configurations.", - "schema": { - "$ref": "#/definitions/MapConfigurationListResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/styles/mapconfigurations/{mapConfigurationId}": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Map Configuration Get request allows the caller to fetch a map configuration. The response contains a zip file with the map configuration JSON and any image files it references. You can always get the default map configuration using predefined alias `defaultIndoor_{tilesetId}` for a given tileset if you deleted the auto-generated map configuration. The two predefined styles used in default map configuration are `microsoft-maps:indoor_2022-01-01` and `microsoft-maps:indoor_dark_2022-01-01`.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n", - "operationId": "MapConfiguration_Get", - "x-ms-examples": { - "Gets the details for a single map configuration": { - "$ref": "./examples/mapconfiguration/MapConfiguration_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/MapConfigurationId" - } - ], - "produces": [ - "application/zip" - ], - "responses": { - "200": { - "description": "Get map configuration request completed successfully. The response body contains a single map configuration zip file.", - "schema": { - "type": "object", - "format": "file", - "readOnly": true - }, - "headers": { - "Content-Type": { - "type": "string", - "description": "The content-type for the response." - } - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Map Configuration Delete request allows the caller to remove a map configuration from their Azure Maps account. You can use this API if a map configuration is no longer needed. \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n### Submit Delete Request\n\nAn `HTTP DELETE` request with the `mapConfigurationId` in the path of the request is required to remove an existing map configuration from your Azure Maps account.
\n\n#### Delete request \"Successful\"\n\nThe Map Configuration Delete API returns a HTTP `204 No Content` response with an empty body, if the map configuration was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the map configuration with the passed-in `mapConfigurationId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - MapConfiguration Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", - "operationId": "MapConfiguration_Delete", - "x-ms-examples": { - "Delete a created map configuration": { - "$ref": "./examples/mapconfiguration/MapConfiguration_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/MapConfigurationId" - } - ], - "responses": { - "204": { - "description": "Map configuration delete request completed successfully." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/styles/mapconfigurations/operations/{operationId}": { - "get": { - "description": "The Map Configuration Get Operation request is obtained from the call to create a map configuration. It is returned in the response headers Resource-Location key once the creation process has completed successfully.", - "operationId": "MapConfiguration_GetOperation", - "x-ms-examples": { - "Get the status of an operation which is still running": { - "$ref": "./examples/mapconfiguration/MapConfiguration_GetOperationStillRunning.json" - }, - "Get the status of an operation which has finished successfully": { - "$ref": "./examples/mapconfiguration/MapConfiguration_GetOperation.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/MapConfigurationOperationId" - } - ], - "responses": { - "200": { - "description": "The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result.", - "schema": { - "$ref": "./tileset.json#/definitions/LongRunningOperationResult" - }, - "headers": { - "Resource-Location": { - "type": "string", - "description": "If successful, a URI where details on the newly created resource can be found." - } - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "MapConfigurationListResult": { - "description": "The response model for the Map Configuration List API. Returns a list of all map configurations.", - "type": "object", - "properties": { - "mapConfigurations": { - "description": "A list of all map configurations.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/MapConfigurationListItem" - } - }, - "nextLink": { - "description": "If present, the location of the next page of data.", - "type": "string", - "readOnly": true - } - } - }, - "MapConfigurationListItem": { - "description": "One item in map configuration list.", - "type": "object", - "properties": { - "mapConfigurationId": { - "description": "The unique id for the map configuration.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The description the caller provided when creating the map configuration. Maximum length 1024 characters.", - "type": "string", - "readOnly": true - }, - "alias": { - "description": "The alias used for the map configuration. Maximum length 1024 characters. Alias cannot start with `microsoft-maps` which is a reserved prefix.", - "type": "string", - "readOnly": true - }, - "created": { - "description": "The creation date and time of this map configuration. As defined by `date-time` - [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)", - "type": "string", - "format": "date-time", - "readOnly": true - } - } - }, - "MapConfiguration": { - "description": "A map configuration object which describes the map configuration json format.", - "type": "object", - "required": [ - "version" - ], - "properties": { - "version": { - "description": "The version of the map configuration, currently only version 1.0 is supported.", - "type": "number", - "format": "float" - }, - "description": { - "description": "The description the caller provided when creating the map configuration. Maximum length 1024 characters.", - "type": "string" - }, - "defaultConfiguration": { - "description": "The default configuration for the map configuration. The value should be one of the 'name' field in ConfigurationObject under 'configurations' array. If not provided, first entry in the 'configurations' list will be used.", - "type": "string" - }, - "configurations": { - "description": "'Configurations' array will allow customer to configure different map representations for their tileset. Each configuration configured here will be reflected as one map style in style picker in client SDK. The name should be unique in the configurations array.", - "items": { - "$ref": "#/definitions/ConfigurationObject" - } - } - } - }, - "ConfigurationObject": { - "description": "Define the format to configure a style picker and the associated map in client SDK.", - "type": "object", - "required": [ - "name", - "layers" - ], - "properties": { - "name": { - "description": "The name for the style. Maximum length 255 characters.", - "type": "string" - }, - "displayName": { - "description": "The display name for the style picker in client SDK. Maximum length 255 characters.", - "type": "string" - }, - "description": { - "description": "The description for the style. Maximum length 500 characters.", - "type": "string" - }, - "theme": { - "description": "The theme for client SDK widgets(style picker, zoom, level picker).", - "type": "string", - "enum": [ - "light", - "dark" - ], - "x-ms-enum": { - "name": "theme", - "modelAsString": true, - "values": [ - { - "value": "light", - "description": "The light theme for client SDK widgets(style picker, zoom, level picker)." - }, - { - "value": "dark", - "description": "The dark theme for client SDK widgets(style picker, zoom, level picker)." - } - ] - } - }, - "thumbnail": { - "description": "The thumbnail image file for the style picker in client SDK. Maximum length 255 characters. The size limit is 400KB and pixel limit is 512*512.", - "type": "string" - }, - "baseMap": { - "description": "The base map is a background layer for private indoor map. This property is optional, no base map will show if not provided. Maximum length 100 characters.", - "$ref": "#/definitions/BaseMapType" - }, - "layers": { - "description": "To configure the style for tileset. You can have one style for the whole tileset. And you can have different styles for different layers in one tileset, for example, one style for `indoor unit` layer and another style for `indoor facility` layer. And you have also have one style for different tileset", - "items": { - "$ref": "#/definitions/TilesetStyleTuple" - } - } - } - }, - "TilesetStyleTuple": { - "description": "TilesetId and StyleId tuple", - "type": "object", - "required": [ - "tilesetId", - "styleId" - ], - "properties": { - "tilesetId": { - "description": "The unique id of a tileset.", - "type": "string" - }, - "styleId": { - "description": "The unique id of an azure map style. Two predefined styleId aliases are `microsoft-maps:indoor_2022-01-01` for indoor light and `microsoft-maps:indoor_dark_2022-01-01` for indoor dark.", - "type": "string" - } - } - }, - "BaseMapType": { - "description": "The available base map types. Currently, we support 9 base map types.", - "type": "string", - "enum": [ - "microsoft_light", - "microsoft_dark", - "microsoft_grayscale_light", - "microsoft_grayscale_dark", - "microsoft_high_contrast_light", - "microsoft_high_contrast_dark", - "microsoft_shaded_relief", - "microsoft_satellite", - "microsoft_satellite_road" - ], - "x-ms-enum": { - "name": "BaseMap", - "modelAsString": true, - "values": [ - { - "value": "microsoft_light", - "description": "The base road map style." - }, - { - "value": "microsoft_dark", - "description": "The base dark road map style." - }, - { - "value": "microsoft_grayscale_light", - "description": "The grayscale light map style." - }, - { - "value": "microsoft_grayscale_dark", - "description": "The grayscale dark map style." - }, - { - "value": "microsoft_high_contrast_light", - "description": "The high contrast light map style." - }, - { - "value": "microsoft_high_contrast_dark", - "description": "The high contrast dark map style." - }, - { - "value": "microsoft_shaded_relief", - "description": "The shaded relief map style." - }, - { - "value": "microsoft_satellite", - "description": "The satellite imagery map style." - }, - { - "value": "microsoft_satellite_road", - "description": "The satellite and road map style." - } - ] - } - } - } -} diff --git a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/style.json b/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/style.json deleted file mode 100644 index a4c398327..000000000 --- a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/style.json +++ /dev/null @@ -1,408 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Style Service", - "version": "2023-07-01", - "description": "This is an extension of the Azure Maps Tileset API to serve custom styles. It will allow a client to create a list of map styling information which can be combined with tilesetIds to create map configurations that can be consumed directly by front-end services (map control web & mobile SDKs, styling tools like [Maputnik](https://maputnik.github.io/editor/))." - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "client" - }, - "StyleId": { - "name": "styleId", - "description": "The Style Id.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "DescriptionStyle": { - "name": "description", - "description": "User provided description of the style. Maximum length 1024 characters.", - "type": "string", - "in": "query", - "x-ms-parameter-location": "method" - }, - "StyleOperationId": { - "name": "operationId", - "type": "string", - "in": "path", - "description": "The ID to query the status for the style create request.", - "required": true, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/styles": { - "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Style Create request allows the caller to create an Azure Maps style.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n## Submit Create Request\n\nTo create your style you will make a `POST` request with an azure maps style. \n\nThe Create Style API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", - "operationId": "Style_Create", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Create Style by providing an azure maps style json file": { - "$ref": "./examples/style/Style_Create.json" - } - }, - "consumes": [ - "application/json", - "application/zip" - ], - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/DescriptionStyle" - }, - { - "name": "CreateContent", - "in": "body", - "description": "The style content to be uploaded. If JSON data format is provided, then the request body should follow [Layers specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/layers) in MapLibre Style specification. If ZIP data format is provided, you should also provide the sprite sheets and associated index files which contains icons used in the style configuration json file. The zip file should contain five files, including two sprite sheet PNG files, two JSON sprite index files with matching filenames to their corresponding PNG files, and one JSON style file. Ensure that the filenames are appropriately descriptive to convey their purpose and maintain consistency between the associated files. \n\n Note: The embedded JSON size limit is 1 MB and zip file size limit is 23 MB.\n\n\n Learn more about how to use [MapLibre sprite](https://maplibre.org/maplibre-style-spec/sprite) here.", - "required": true, - "schema": { - "type": "object" - } - } - ], - "responses": { - "202": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Style List request allows the caller to fetch a list of all styles created. The default indoor style `microsoft-maps:indoor_2022-01-01` and `microsoft-maps:indoor_dark_2022-01-01` will not show in the list response. But you can still use it as your own style by the predefined alias.\n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. \n
", - "operationId": "Style_List", - "x-ms-examples": { - "Get a list of all styles": { - "$ref": "./examples/style/Style_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "x-ms-pageable": { - "itemName": "styles", - "nextLinkName": "nextLink" - }, - "responses": { - "200": { - "description": "List style request completed successfully. The response body contains a list of all styles.", - "schema": { - "$ref": "#/definitions/StyleListResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/styles/{styleId}": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Style Get request allows the caller to get a style. Customers can get two predefined default styles using alias `microsoft-maps:indoor_2022-01-01` for indoor light and `microsoft-maps:indoor_dark_2022-01-01` for indoor dark. \n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", - "operationId": "Style_Get", - "x-ms-examples": { - "Get the details for a single style": { - "$ref": "./examples/style/Style_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StyleId" - } - ], - "produces": [ - "application/zip" - ], - "responses": { - "200": { - "description": "Get style request completed successfully. The response body contains a zip file with style content.", - "schema": { - "type": "object", - "format": "file", - "readOnly": true - }, - "headers": { - "Content-Type": { - "type": "string", - "description": "The content-type for the response." - } - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Style Delete request allows the caller to remove a style from their Azure Maps account.
\n\n### Submit Delete Request\n\nAn `HTTP DELETE` request with the `styleId` in the path of the request is required to remove an existing style from your Azure Maps account.
\n\n#### Delete request \"Successful\"\n\nThe Style Delete API returns a HTTP `204 No Content` response with an empty body, if the style was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the style with the passed-in `styleId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Style Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", - "operationId": "Style_Delete", - "x-ms-examples": { - "Delete a created style": { - "$ref": "./examples/style/Style_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StyleId" - } - ], - "responses": { - "204": { - "description": "Style delete request completed successfully." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/styles/operations/{operationId}": { - "get": { - "description": "The Style Get Operation request is obtained from the call to create a style. It is returned in the response headers Resource-Location key once the creation process has completed successfully.", - "operationId": "Style_GetOperation", - "x-ms-examples": { - "Get the status of an operation which is still running": { - "$ref": "./examples/style/Style_GetOperationStillRunning.json" - }, - "Get the status of an operation which has finished successfully": { - "$ref": "./examples/style/Style_GetOperation.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StyleOperationId" - } - ], - "responses": { - "200": { - "description": "The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result.", - "schema": { - "$ref": "./tileset.json#/definitions/LongRunningOperationResult" - }, - "headers": { - "Resource-Location": { - "type": "string", - "description": "If successful, a URI where details on the newly created resource can be found." - } - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "StyleListResult": { - "description": "The response model for the Style List API. Returns a list of all styles.", - "type": "object", - "properties": { - "styles": { - "description": "A list of all styles.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/StyleListItem" - } - }, - "nextLink": { - "description": "If present, the location of the next page of data.", - "type": "string", - "readOnly": true - } - } - }, - "StyleListItem": { - "description": "Detail information for the data.", - "type": "object", - "properties": { - "styleId": { - "description": "The unique style id for the style.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The description the caller provided when creating the style. Maximum length 1024 characters.", - "type": "string", - "readOnly": true - }, - "created": { - "description": "The creation date and time of this style. As defined by `date-time` - [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)", - "type": "string", - "format": "date-time", - "readOnly": true - } - } - }, - "StyleLayerObject": { - "description": "A layer object.", - "type": "object", - "properties": { - "id": { - "description": "The unique id for the layer.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The type of the layer.", - "type": "string", - "readOnly": true - }, - "source-layer": { - "description": "The source layer.", - "type": "string", - "readOnly": true - }, - "source": { - "description": "The source.", - "type": "string", - "readOnly": true - }, - "layout": { - "description": "The layout of the layer.", - "type": "object", - "readOnly": true - }, - "paint": { - "description": "The paint configuration of the layer.", - "type": "object", - "readOnly": true - } - } - }, - "Style": { - "description": "Detail information for the data.", - "type": "object", - "properties": { - "id": { - "description": "The unique style id for the style.", - "type": "string", - "readOnly": true - }, - "version": { - "description": "The version of the style.", - "type": "number", - "readOnly": true - }, - "created": { - "description": "The creation date and time of this style.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The description the caller provided when creating the style. Maximum length 1024 characters.", - "type": "string", - "readOnly": true - }, - "sources": { - "description": "Data source specifications.", - "type": "object", - "readOnly": true - }, - "sprite": { - "description": "A base URL for retrieving the sprite image and metadata.", - "type": "string", - "readOnly": true - }, - "layers": { - "description": "A style's layers property lists all the layers available in that style", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/StyleLayerObject" - } - } - } - } - } -} diff --git a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/tileset.json b/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/tileset.json deleted file mode 100644 index 3898e7bbc..000000000 --- a/swagger-specs/maps/data-plane/Creator/stable/2023-07-01/tileset.json +++ /dev/null @@ -1,645 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Tileset Service", - "version": "2023-07-01", - "description": "APIs for managing Tilesets." - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "client" - }, - "DatasetIdQuery": { - "name": "datasetId", - "description": "The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create) call.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "method" - }, - "TilesetId": { - "name": "tilesetId", - "description": "The Tileset Id", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "DescriptionTileset": { - "name": "description", - "description": "User provided description of the tileset. Maximum length 1024 characters.", - "type": "string", - "in": "query", - "x-ms-parameter-location": "method" - }, - "TilesetOperationId": { - "name": "operationId", - "type": "string", - "in": "path", - "description": "The ID to query the status for the tileset create/import request.", - "required": true, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/tilesets": { - "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Create request creates a tileset from the specified dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/v2/dataset/create).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an **optional request body** as [tileset configuration](/rest/api/documentation-preview/tileset/create?#tilesetconfiguration). The `datasetId` query parameter will be used as the source of the tileset data.\n\nThe Create Tileset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", - "operationId": "Tileset_Create", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Create Tileset by providing a Dataset Id": { - "$ref": "./examples/tileset/Tileset_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/DatasetIdQuery" - }, - { - "$ref": "#/parameters/DescriptionTileset" - }, - { - "name": "TilesetConfiguration", - "in": "body", - "description": "The custom tileset configuration to use.", - "required": false, - "schema": { - "$ref": "#/definitions/TilesetConfiguration" - } - } - ], - "responses": { - "202": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset List request allows the caller to fetch a list of all tilesets created.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. \n
", - "operationId": "Tileset_List", - "x-ms-examples": { - "Get a list of all tilesets": { - "$ref": "./examples/tileset/Tileset_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "x-ms-pageable": { - "itemName": "tilesets", - "nextLinkName": "nextLink" - }, - "responses": { - "200": { - "description": "List tileset request completed successfully. The response body contains a list of all tilesets.", - "schema": { - "$ref": "#/definitions/TilesetListResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/tilesets/{tilesetId}": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Get request allows the caller to fetch a tileset.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", - "operationId": "Tileset_Get", - "x-ms-examples": { - "Gets the details for a single tileset": { - "$ref": "./examples/tileset/Tileset_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/TilesetId" - } - ], - "responses": { - "200": { - "description": "List tileset request completed successfully. The response body contains a list of all tilesets.", - "schema": { - "$ref": "#/definitions/Tileset" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Delete request allows the caller to delete a created tileset. You can use this API if a tileset is no longer needed. \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", - "operationId": "Tileset_Delete", - "x-ms-examples": { - "Delete a created tileset": { - "$ref": "./examples/tileset/Tileset_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/TilesetId" - } - ], - "responses": { - "204": { - "description": "Tileset delete request completed successfully." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/tilesets:fetchConfiguration": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Get Configuration request allows the caller to get a default [tileset configuration](/rest/api/documentation-preview/tileset/get-configuration?#tilesetconfiguration) based on the dataset provided. Then the tileset configuration can be used to create custom tileset using the [Tileset Create API](/rest/api/documentation-preview/tileset/create).\n\n Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", - "operationId": "Tileset_GetConfiguration", - "x-ms-examples": { - "Gets the tileset configuration for a given dataset": { - "$ref": "./examples/tileset/Tileset_GetConfiguration.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/DatasetIdQuery" - } - ], - "responses": { - "200": { - "description": "Get tileset configuration request completed successfully. The response body contains a default [tileset configuration](/rest/api/documentation-preview/tileset/get-configuration?#tilesetconfiguration) generated for the given dataset.", - "schema": { - "$ref": "#/definitions/TilesetConfiguration" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/tilesets:validateConfiguration": { - "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Tileset Validate Configuration request allows the caller to validate a [tileset configuration](/rest/api/documentation-preview/tileset/validate-configuration?#tilesetconfiguration).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.", - "operationId": "Tileset_ValidateConfiguration", - "x-ms-examples": { - "Validates the correctness of a tileset configuration": { - "$ref": "./examples/tileset/Tileset_ValidateConfiguration.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/DatasetIdQuery" - }, - { - "name": "TilesetConfiguration", - "in": "body", - "description": "The custom tileset configuration to use.", - "required": false, - "schema": { - "$ref": "#/definitions/TilesetConfiguration" - } - } - ], - "responses": { - "200": { - "description": "Validate tileset configuration request completed successfully. The response body contains the validation results.", - "schema": { - "$ref": "#/definitions/TilesetConfigurationValidationResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/tilesets/operations/{operationId}": { - "get": { - "description": "This path will be obtained from a call to /tilesets/create. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once successfully completed.", - "operationId": "Tileset_GetOperation", - "x-ms-examples": { - "Get the status of an operation which is still running": { - "$ref": "./examples/tileset/Tileset_GetOperationStillRunning.json" - }, - "Get the status of an operation which has finished successfully": { - "$ref": "./examples/tileset/Tileset_GetOperation.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/TilesetOperationId" - } - ], - "responses": { - "200": { - "description": "The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result.", - "schema": { - "$ref": "./tileset.json#/definitions/LongRunningOperationResult" - }, - "headers": { - "Resource-Location": { - "type": "string", - "description": "If successful, a URI where details on the newly created resource can be found." - } - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "LongRunningOperationResult": { - "description": "The response model for a Long-Running Operations API.", - "type": "object", - "properties": { - "operationId": { - "description": "The Id for this long-running operation.", - "type": "string" - }, - "status": { - "description": "The status state of the request.", - "type": "string", - "enum": [ - "NotStarted", - "Running", - "Failed", - "Succeeded" - ], - "x-ms-enum": { - "name": "LroStatus", - "modelAsString": true, - "values": [ - { - "value": "NotStarted", - "description": "The request has not started processing yet." - }, - { - "value": "Running", - "description": "The request has started processing." - }, - { - "value": "Failed", - "description": "The request has one or more failures." - }, - { - "value": "Succeeded", - "description": "The request has successfully completed." - } - ] - }, - "readOnly": true - }, - "created": { - "description": "The created timestamp.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "error": { - "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" - }, - "warning": { - "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" - } - } - }, - "TilesetListResult": { - "description": "The response model for the Tileset List API. Returns a list of all tilesets.", - "type": "object", - "properties": { - "tilesets": { - "description": "A list of all tilesets.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Tileset" - } - }, - "nextLink": { - "description": "If present, the location of the next page of data.", - "type": "string", - "readOnly": true - } - } - }, - "Tileset": { - "description": "Detail information for the data.", - "type": "object", - "properties": { - "tilesetId": { - "description": "The unique tileset id for the tileset.", - "type": "string", - "readOnly": true - }, - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "datasetId": { - "description": "The unique dataset Id used to create the tileset.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The description the caller provided when creating the tileset. Maximum length 1024 characters.", - "type": "string", - "readOnly": true - }, - "minZoom": { - "description": "The lowest tile zoom level tile generated for the tileset.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "maxZoom": { - "description": "The highest tile zoom level tile generated for the tileset.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "bbox": { - "description": "Bounding box which all features of the tileset lay within. Projection used - EPSG:3857. Format : 'minLon, minLat, maxLon, maxLat'.", - "$ref": "../../../Common/preview/1.0/common.json#/definitions/BoundingBox" - }, - "tilesetConfiguration": { - "description": "Tileset configuration which is used to build the tileset.", - "$ref": "#/definitions/TilesetConfiguration" - }, - "defaultMapConfigurationId": { - "description": "The default generated map configuration id for the tileset", - "type": "string", - "readOnly": true - } - } - }, - "TilesetConfiguration": { - "description": "Tileset configuration top-level fields. A tileset configuration is a JSON object that must contain the following top-level fields:", - "type": "object", - "required": [ - "version", - "layers" - ], - "properties": { - "version": { - "description": "The version of Azure Maps Tiling service configuration reference that the tileset configuration uses. Currently only version 1 is allowed. Using any version other the current version or a previous version will result in an error.", - "type": "integer", - "format": "int32" - }, - "layers": { - "description": "The names of the layers and their configuration options. The configuration layers object contains key-value pairs associating the names of tile layers with their configuration. For each key-value pair, the key is the name of the layer, and the value is a LayerObject containing the configuration and options for the layer. Each layer must have a name. This is the unique identifier for the layer of data in your final tileset. In any tileset, each layer name must be unique. The layer name must be a string with only underscores (_) and alphanumeric characters. The corresponding LayerObject for each layer name describes how that vector tile layer should be created. It specifies which feature classes to retrieve feature data, the precision of the data through zoom levels, and how to transform features and render them into tiles.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/LayerObject" - } - } - } - }, - "LayerObject": { - "description": "Layer object for tileset configuration.", - "type": "object", - "required": [ - "features", - "minZoom", - "maxZoom" - ], - "properties": { - "features": { - "description": "Specifies the feature classes and filters.", - "$ref": "#/definitions/Feature" - }, - "minZoom": { - "description": "The lowest zoom level for the layer to build.", - "type": "integer", - "format": "int32" - }, - "maxZoom": { - "description": "The highest zoom level for the layer to build.", - "type": "integer", - "format": "int32" - } - } - }, - "Feature": { - "description": "Feature configuration for tileset configuration.", - "type": "object", - "required": [ - "featureClasses" - ], - "properties": { - "featureClasses": { - "description": "The list of feature classes that will be used to build the layer. The valid feature classes can be found in its ontology definition. For example, [Facility Ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology)", - "type": "array", - "items": { - "type": "string" - } - }, - "filter": { - "description": "Removes features that do not match a pattern. Refer to [MapLibre filter expression](https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#filter)", - "type": "object" - } - } - }, - "TilesetConfigurationValidationResult": { - "description": "Tileset configuration validation result.", - "type": "object", - "properties": { - "valid": { - "description": "Validation result.", - "type": "boolean" - }, - "warnings": { - "description": "The list of validation warnings.", - "type": "array", - "items": { - "$ref": "#/definitions/ValidationWarning" - } - }, - "errors": { - "description": "The list of validation errors.", - "type": "array", - "items": { - "$ref": "#/definitions/ValidationError" - } - } - } - }, - "ValidationError": { - "description": "Tileset configuration validation errors.", - "type": "object", - "properties": { - "code": { - "description": "Validation error code.", - "$ref": "#/definitions/TilesetConfigurationErrorCode" - }, - "message": { - "description": "Validation error message.", - "type": "string" - }, - "target": { - "description": "The target element for the validation error.", - "type": "string" - } - } - }, - "ValidationWarning": { - "description": "Tileset configuration validation errors.", - "type": "object", - "properties": { - "code": { - "description": "Validation warning code.", - "type": "string" - }, - "message": { - "description": "Validation warning message.", - "type": "string" - }, - "target": { - "description": "The target element for the validation warning.", - "type": "string" - } - } - }, - "TilesetConfigurationErrorCode": { - "description": "The possible error code for tileset configuration validation request.", - "type": "string", - "enum": [ - "DuplicateLayerNameFound", - "UndefinedFeatureClasses", - "DuplicateFeatureClassFound", - "CustomLayerNameNotSupported", - "CustomOntologyNotSupported" - ], - "x-ms-enum": { - "name": "ErrorCode", - "modelAsString": true, - "values": [ - { - "value": "DuplicateLayerNameFound", - "description": "The layer name should be unique." - }, - { - "value": "UndefinedFeatureClasses", - "description": "Feature class should be defined in ontology definition, and the feature class name is case sensitive." - }, - { - "value": "DuplicateFeatureClassFound", - "description": "Feature class name should be unique." - }, - { - "value": "CustomLayerNameNotSupported", - "description": "Custom layer name is not supported right now." - }, - { - "value": "CustomOntologyNotSupported", - "description": "Custom ontology is not supported right now, 'Facility-2.0' is the supported ontology." - } - ] - } - } - } -} diff --git a/swagger-specs/maps/data-plane/Data/preview/2.0/data.json b/swagger-specs/maps/data-plane/Data/preview/2.0/data.json new file mode 100644 index 000000000..8db63b9de --- /dev/null +++ b/swagger-specs/maps/data-plane/Data/preview/2.0/data.json @@ -0,0 +1,477 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Data Service", + "version": "2.0", + "description": "APIs for uploading map data to Azure Maps." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management](https://aka.ms/amauthdetails) API.\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see [Microsoft identity platform overview](/entra/identity-platform/v2-overview).", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "SharedKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", + "name": "subscription-key", + "in": "query" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "SharedKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "DataFormat": { + "name": "dataFormat", + "description": "Data format of the content being uploaded.", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "geojson", + "zip", + "dwgzippackage" + ], + "x-ms-enum": { + "name": "DataFormat", + "modelAsString": true, + "values": [ + { + "value": "geojson", + "description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format." + }, + { + "value": "zip", + "description": "Compressed data format." + }, + { + "name": "dwgZipPackage", + "value": "dwgzippackage", + "description": "ZIP package containing DWG file." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "UniqueDataId": { + "name": "udid", + "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload](/rest/api/maps/data/upload) call.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "UploadDataDescription": { + "name": "description", + "description": "The description to be given to the upload.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "DataUploadOperationId": { + "name": "operationId", + "type": "string", + "in": "path", + "description": "The ID to query the status for the data upload request.", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/mapData": { + "post": { + "summary": "Use to upload data content to an Azure Maps account.", + "description": "\n>\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\nThe `Data Upload` API is an HTTP `POST` request that allows the caller to upload data content to the Azure Maps service.\nYou can use this API in a scenario like uploading a collection of Geofences in `GeoJSON`format, for use in our [Azure Maps Geofencing Service](/rest/api/maps/spatial).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n\n## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. The `dataFormat` query parameter will contain the format for the data, the `dataSharingLevel` query parameter can contain the sharing level for the data. The `Content-Type` header will be set to the content type of the data.\n\nFor example, to upload a collection of geofences in `GeoJSON` format, set the request body to the geofence content. Set the `dataFormat` query parameter to _geojson_, and set the `Content-Type` header to either one of the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for uploading a simple Geofence represented as a circle geometry using a center point and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe Data Upload API performs a long-running operation.\n\n## Data Upload Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). Once the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. You can always use the [Data Delete](/rest/api/maps/data/delete) API to delete old/unused content and create space for new uploads.", + "operationId": "Data_Upload", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upload GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/Data_Upload.json" + } + }, + "consumes": [ + "application/json", + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/UploadDataDescription" + }, + { + "$ref": "#/parameters/DataFormat" + }, + { + "name": "UploadContent", + "in": "body", + "description": "The content to upload.", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "409": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/409StorageLimit" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "summary": "Use to fetch a list of all content previously uploaded using [Data Upload](/rest/api/maps/data/upload).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\nThe `Data List` API is an HTTP `GET` request that allows the caller to fetch a list of all content previously uploaded using the [Data Upload](/rest/api/maps/data/upload) API.\n\n### Submit List Request\n\nTo list all your map data content you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe Data List API returns the complete list of all data in `json` format. The response contains the following details for each data resource:\n\n > udid - The unique data id for the data resource.\n\n > location - The location of the data resource. Execute an HTTP `GET` request on this location to download the data.\n\n\nHere's a sample response returning the `udid` and `location` of 3 data resources: \n\n\n\n\n```json\n{\n \"mapDataList\": \n [\n {\n \"udid\": \"9a1288fa-1858-4a3b-b68d-13a8j5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 29920,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1339,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1650,\n \"uploadStatus\": \"Pending\"\n }]\n}\n```\n\n\n", + "operationId": "Data_List", + "x-ms-examples": { + "List all the previously uploaded data": { + "$ref": "./examples/Data_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "List data request completed successfully. The response body contains a list of all the previously uploaded data.", + "schema": { + "$ref": "#/definitions/MapDataListResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/mapData/{udid}": { + "put": { + "summary": "Use to update data content previously uploaded using [Data Upload](/rest/api/maps/data/upload).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\nThe `Data Update` API is an HTTP `PUT` request that allows the caller to update previously uploaded data content.\n\nYou can use this API in a scenario like adding or removing geofences to or from an existing collection of geofences. Geofences are uploaded using the [Data Upload](/rest/api/maps/data/upload) API, for use in the [Azure Maps Geofencing Service](/rest/api/maps/spatial).\n\nPlease note that the Update API will *replace* and *override* the existing data content.\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n\n## Submit Update Request\n\nTo update your content you will use a `PUT` request. The request body will contain the new data that will replace the existing data. The `Content-Type` header will be set to the content type of the data, and the path will contain the `udid` of the data to be update.\n\nFor example, to update a collection of geofences that were previously uploaded using the Upload API, place the new geofence content in the request body. Set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response. And set the `Content-Type` header to one of the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for updating a simple Geofence. It's represented as a circle geometry using a center point and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe previously uploaded geofence had a radius of 100m. The above request will update it to 500m.\n\nThe Data Update API performs a long-running operation.\n\n## Data Update Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). Once the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. You can always use the [Data Delete](/rest/api/maps/data/delete) API to delete old/unused content and create space for new uploads.", + "operationId": "Data_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Update previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/Data_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/UniqueDataId" + }, + { + "$ref": "#/parameters/UploadDataDescription" + }, + { + "name": "UpdateContent", + "in": "body", + "description": "The new content that will update/replace the previously uploaded content.", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "409": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/409StorageLimit" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "summary": "Use to download data previously uploaded using [Data Upload](/rest/api/maps/data/upload).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\nThe `Data Download` API is and HTTP `GET` request that allows the caller to download a previously uploaded data content.\n\nYou can use this API in a scenario like downloading an existing collection of geofences uploaded previously using the [Data Upload](/rest/api/maps/data/upload) API for use in our [Azure Maps Geofencing Service](/rest/api/maps/spatial).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n\n### Submit Download Request\n\nTo download your content you will use a `GET` request where the path will contain the `udid` of the data to download. Optionally, you can also pass in an `Accept` header to specify a preference for the `Content-Type` of the data response. \n\nFor example, to download a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response and set the `Accept` header to either one of the following media types: \n\n - `application/json`\n - `application/vnd.geo+json`\n - `application/octet-stream`\n\n\n### Download Data Response\n\nThe Download API will return an HTTP `200 OK` response if the data resource with the passed-in `udid` is found, where the response body will contain the content of the data resource.\n\nAn HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found.\n\nHere's a sample response body for a simple geofence represented in `GeoJSON` uploaded previously using the Upload API:\n\n\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```", + "operationId": "Data_Download", + "x-ms-examples": { + "Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/Data_Download.json" + } + }, + "produces": [ + "application/json", + "application/vnd.geo+json", + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/UniqueDataId" + } + ], + "responses": { + "200": { + "description": "Data download request completed successfully. The response body will contain the content for the passed in `udid`.", + "schema": { + "type": "file" + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the Download API response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "summary": "Use to delete data previously uploaded using [Data Upload](/rest/api/maps/data/upload).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\nThe `Data Delete` API is an HTTP `DELETE` request that allows the caller to delete a previously uploaded data content.\n\nYou can use this API in a scenario like removing geofences previously uploaded using the [Data Upload](/rest/api/maps/data/upload) API for use in the [Azure Maps Geofencing Service](/rest/api/maps/spatial). You can also use this API to delete old/unused uploaded content and create space for new content.\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `udid` of the data to delete.\n\nFor example, to delete a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response. \n\n\n### Delete Data Response\n\nThe Data Delete API returns an HTTP `204 No Content` response with an empty body, if the data resource was deleted successfully.\n\nAn HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found.", + "operationId": "Data_Delete", + "x-ms-examples": { + "Delete previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/Data_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/UniqueDataId" + } + ], + "responses": { + "204": { + "description": "Data delete request completed successfully. The content for `udid` was deleted on the server." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/mapData/operations/{operationId}": { + "get": { + "summary": "Use to check the status of a [Data Upload](/rest/api/maps/data/upload) request and get the `udid` value once completed.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Data service retirement**\n>\n> The Azure Maps Data service (both [v1](/rest/api/maps/data?view=rest-maps-1.0) and [v2](/rest/api/maps/data)) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps [Data Registry](/rest/api/maps/data-registry) service by 9/16/24. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n The `Get Operation` API is an HTTP `GET` request that allows the caller to check the status of a [Data Upload](/rest/api/maps/data/upload) operation and get the `udid` value once completed. This path will be obtained from a call to POST /mapData. While in progress, an HTTP 200 response code will be returned with no extra headers - followed by an HTTP 200 response code with a `Resource-Location` header once successfully completed. \n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details.\n\n", + "operationId": "Data_GetOperation", + "x-ms-examples": { + "Get the status of an operation which is still running": { + "$ref": "./examples/Data_GetOperationStillRunning.json" + }, + "Get the status of an operation which has finished successfully": { + "$ref": "./examples/Data_GetOperation.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/DataUploadOperationId" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "MapDataListResult": { + "description": "The response model for the Data List API. Returns a list of all the previously uploaded data.", + "type": "object", + "properties": { + "mapDataList": { + "description": "A list of all the previously uploaded data.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MapData" + } + } + } + }, + "DataFormat": { + "description": "Data format of the uploaded content.", + "type": "string", + "readOnly": true, + "enum": [ + "geojson", + "zip", + "dwgzippackage" + ], + "x-ms-enum": { + "name": "DataFormat", + "modelAsString": true, + "values": [ + { + "value": "geojson", + "description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format." + }, + { + "value": "zip", + "description": "Compressed data format." + }, + { + "name": "dwgZipPackage", + "value": "dwgzippackage", + "description": "ZIP package containing DWG file." + } + ] + } + }, + "UploadStatus": { + "description": "The current upload status of the content.", + "type": "string", + "readOnly": true, + "enum": [ + "Pending", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "UploadStatus", + "values": [ + { + "value": "Pending", + "description": "Upload is processing" + }, + { + "value": "Completed", + "description": "Upload validation and processing completed" + }, + { + "value": "Failed", + "description": "Upload validation and/or processing failure" + } + ] + } + }, + "MapData": { + "description": "Detail information for the data.", + "type": "object", + "properties": { + "udid": { + "description": "The unique data id for the data.", + "type": "string", + "readOnly": true + }, + "location": { + "x-ms-client-name": "locationURL", + "description": "The location of the data. Execute an HTTP `GET` request on this location to download the data.", + "type": "string", + "format": "uri", + "readOnly": true + }, + "sizeInBytes": { + "description": "The size of the content in bytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "uploadStatus": { + "$ref": "#/definitions/UploadStatus" + }, + "dataFormat": { + "$ref": "#/definitions/DataFormat" + }, + "description": { + "description": "The current description.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/swagger-specs/maps/data-plane/DataRegistry/stable/2023-06-01/dataregistry.json b/swagger-specs/maps/data-plane/DataRegistry/stable/2023-06-01/dataregistry.json index 1ad1c954b..407c244c8 100644 --- a/swagger-specs/maps/data-plane/DataRegistry/stable/2023-06-01/dataregistry.json +++ b/swagger-specs/maps/data-plane/DataRegistry/stable/2023-06-01/dataregistry.json @@ -27,7 +27,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -99,7 +99,8 @@ "paths": { "/dataRegistries": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `List` request returns an array containing all data registries previously registered using the [Register or Replace API](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit List Request\n\nTo list all your data registries, issue a `GET` request with no additional parameters.\n\n## List Response\n\nThe `List` request returns an array of data registries in `JSON` format in the body of the response.", + "summary": "Use to get a list of all data registries in the Azure Maps account.", + "description": "\n\nThe `List` API is an HTTP `GET` request that returns an array containing all data registries previously registered using the [Register or Replace API](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit List Request\n\nTo list all your data registries, issue a `GET` request with no additional parameters.\n\n## List Response\n\nThe `List` request returns an array of data registries in `JSON` format in the body of the response.", "operationId": "DataRegistry_List", "x-ms-examples": { "List all previously registered data registries": { @@ -139,7 +140,8 @@ }, "/dataRegistries/{udid}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `Get Data Registry` request returns the data registry information, as an [AzureBlob](#azureblob) object in JSON format, in the body of the response along with the HTTP status code of 200 when successful. If Azure Maps cannot access the underlying content or the integrity check fails, the `status` is set to `Failed` and error is returned.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Get Data Registry Request\n\nA data registry `GET` request returns details of the requested data registry, as determined by the specified `udid`. The details are returned in the body of the response in JSON format.", + "summary": "Use to get the specified data registry information.", + "description": "\n\nThe `Get Data Registry` API is an HTTP `GET` request that returns data registry information, as an [AzureBlob](#azureblob) object in JSON format, in the body of the response, along with the HTTP status code 200, when successful. If Azure Maps cannot access the underlying content or the integrity check fails, the `status` is set to `Failed` and an error is returned.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Get Data Registry Request\n\nA data registry `GET` request returns details of the requested data registry, as determined by the specified `udid`. The details are returned in the body of the response in JSON format.", "operationId": "DataRegistry_GetDataRegistry", "x-ms-examples": { "Get the data registry of a completed udid": { @@ -183,7 +185,8 @@ } }, "put": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `Register` request is used to register data in an Azure Storage Account with an Azure Maps account. The maximum file size that can be registered is one gigabyte.\n\nThis is useful in scenarios like registering a collection of Geofences in `GeoJSON` format for use in [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or registering a set of DWG design files as a zipped [Drawing Package](https://docs.microsoft.com/azure/azure-maps/drawing-requirements) for use in the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Register or Replace Request\n\nThe `Register` and `Replace` requests are both long-running operations that contain an [AzureBlob](#azureblob) JSON object in the body of the request that defines the data registry details.", + "summary": "Use to register data stored in an Azure Storage Account with an Azure Maps account.", + "description": "\n\nThe `Register` API is an HTTP `PUT` request used to register the data in an Azure Storage Account with an Azure Maps account. The maximum file size that can be registered is one gigabyte.\n\nThis is useful in scenarios like registering a collection of Geofences in `GeoJSON` format for use in [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or registering a set of DWG design files as a zipped [Drawing Package](https://docs.microsoft.com/azure/azure-maps/drawing-requirements) for use in the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Register or Replace Request\n\nThe `Register` and `Replace` requests are both long-running operations that contain an [AzureBlob](#azureblob) JSON object in the body of the request that defines the data registry details.", "operationId": "DataRegistry_RegisterOrReplace", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -266,7 +269,8 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `Unregister` request removes a data registry without deleting the underlying content frm the Azure storage account.\n\nUseful in scenarios like unregistering geofence files previously registered using the [Register or Replace API](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace) for use in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or unregistering a compressed (ZIP) file containing DWG design files used by the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Unregister Request\n\nUse an HTTP `DELETE` request with the `udid` of the data registry to unregister.\n\n## Unregister Response\n\nThe `Unregister` request returns a HTTP '204 No Content' response with an empty body, if the data registry was deleted successfully.", + "summary": "Use to unregister data stored in an Azure Storage Account that is registered with an Azure Maps account.", + "description": "\n\nThe `Unregister` API is an HTTP `DELETE` request that removes a data registry without deleting the underlying content from the Azure storage account.\n\nUseful in scenarios like unregistering geofence files previously registered using the [Register or Replace](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace) API for use in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or unregistering a compressed (ZIP) file containing DWG design files used by the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Unregister Request\n\nUse an HTTP `DELETE` request with the `udid` of the data registry to unregister.\n\n## Unregister Response\n\nThe `Unregister` request returns a HTTP '204 No Content' response with an empty body, if the data registry was deleted successfully.", "operationId": "DataRegistry_Unregister", "x-ms-examples": { "Unregister a data registry without deleting the underlying contents": { @@ -306,7 +310,8 @@ }, "/dataRegistries/operations/{operationId}": { "get": { - "description": "The HTTP `GET` request used to get the status of a [data register or replace](/rest/api/maps/data-registry/register-or-replace) request is returned in the header of the register or replace response as the value of the `Operation-Location` key. While in progress, a HTTP `200 OK` response will be returned with `Retry-After` header - followed by a HTTP `200 OK` with no extra header once completed.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n", + "summary": "Use to check the status of the [data register or replace](/rest/api/maps/data-registry/register-or-replace) request.", + "description": "The `Get Operation` API is an HTTP `GET` request used to get the status of a [data register or replace](/rest/api/maps/data-registry/register-or-replace) request is returned in the header of the register or replace response as the value of the `Operation-Location` key. While in progress, a HTTP `200 OK` response will be returned with `Retry-After` header - followed by a HTTP `200 OK` with no extra header once completed.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n", "operationId": "DataRegistry_GetOperation", "x-ms-examples": { "Get the status of an operation that is still running": { diff --git a/swagger-specs/maps/data-plane/Geolocation/preview/1.0/geolocation.json b/swagger-specs/maps/data-plane/Geolocation/preview/1.0/geolocation.json index 7f6a1fbc8..39a52b4f6 100644 --- a/swagger-specs/maps/data-plane/Geolocation/preview/1.0/geolocation.json +++ b/swagger-specs/maps/data-plane/Geolocation/preview/1.0/geolocation.json @@ -18,7 +18,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -64,7 +64,8 @@ "paths": { "/geolocation/ip/{format}": { "get": { - "description": "\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis service will return the ISO country code for the provided IP address. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from.", + "summary": "Use to get the ISO country code for a given IP address", + "description": "\n\nThe `Get IP To Location` API is an HTTP `GET` request that, given an IP address, returns the ISO country code from which that IP address is located. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from.", "operationId": "Geolocation_GetIPToLocation", "x-ms-client-name": "GetLocation", "x-ms-examples": { diff --git a/swagger-specs/maps/data-plane/Microsoft.Maps/Data/preview/2.0/data.json b/swagger-specs/maps/data-plane/Microsoft.Maps/Data/preview/2.0/data.json deleted file mode 100644 index ba39bf814..000000000 --- a/swagger-specs/maps/data-plane/Microsoft.Maps/Data/preview/2.0/data.json +++ /dev/null @@ -1,748 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Data Service", - "version": "2.0", - "description": "APIs for uploading map data to Azure Maps." - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "parameters": { - "GeographicResourceLocation": { - "name": "geography", - "description": "This parameter specifies where the Azure Maps Creator resource is located. Valid values are us and eu.", - "in": "path", - "required": true, - "type": "string", - "default": "us", - "enum": [ - "us", - "eu" - ], - "x-ms-enum": { - "name": "GeographicResourceLocation", - "modelAsString": true, - "values": [ - { - "value": "us", - "description": "Used to access an Azure Maps Creator resource in the United States" - }, - { - "value": "eu", - "description": "Used to access an Azure Maps Creator resource in Europe" - } - ] - }, - "x-ms-parameter-location": "client" - }, - "ClientId": { - "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", - "type": "string", - "in": "header", - "required": false, - "x-ms-parameter-location": "client" - }, - "SubscriptionKey": { - "name": "subscription-key", - "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", - "type": "string", - "in": "query", - "required": false, - "x-ms-parameter-location": "client" - }, - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API. Current version is 2.0", - "type": "string", - "in": "query", - "required": true, - "default": "2.0", - "x-ms-parameter-location": "client" - }, - "JsonFormat": { - "name": "format", - "description": "Desired format of the response. Only `json` format is supported.", - "type": "string", - "in": "path", - "required": true, - "enum": [ - "json" - ], - "x-ms-enum": { - "name": "JsonFormat", - "modelAsString": true, - "values": [ - { - "value": "json", - "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" - } - ] - }, - "x-ms-parameter-location": "method" - }, - "UploadDataFormat": { - "name": "dataFormat", - "description": "Data format of the content being uploaded.", - "type": "string", - "in": "query", - "required": true, - "enum": [ - "geojson", - "zip", - "dwgzippackage" - ], - "x-ms-enum": { - "name": "UploadDataFormat", - "modelAsString": true, - "values": [ - { - "value": "geojson", - "description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format." - }, - { - "value": "zip", - "description": "Compressed data format." - }, - { - "value": "dwgzippackage", - "description": "" - } - ] - }, - "x-ms-parameter-location": "method" - }, - "Udid": { - "name": "udid", - "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) call.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "Description": { - "name": "description", - "description": "The description to be given to the upload.", - "type": "string", - "in": "query", - "required": false, - "x-ms-parameter-location": "method" - }, - "DataUploadOperationId": { - "name": "operationId", - "type": "string", - "in": "path", - "description": "The ID to query the status for the data upload request.", - "required": true, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/mapData": { - "post": { - "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Upload API allows the caller to upload data content to the Azure Maps service.\nYou can use this API in a scenario like uploading a collection of Geofences in `GeoJSON` \nformat, for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\n## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. The `Content-Type` header will be set to the content type of the \ndata.\n\nFor example, to upload a collection of geofences in `GeoJSON` format, set the request body to the geofence \ncontent. Set the `dataFormat` query parameter to _geojson_, and set the `Content-Type` header to either one \nof the following media types:\n\n- `application/json` if `dataFormat` is `JSON`\n- `application/vnd.geo+json` if `dataFormat` is `geoJSON` \n- `application/octet-stream` if `dataFormat` is `zip`\n\nHere's a sample request body for uploading a simple Geofence represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe Data Upload API performs a \nlong-running operation.\n\n## Data Upload Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data-v2/delete-preview) to \ndelete old/unused content and create space for new uploads.", - "operationId": "Data_UploadPreview", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Upload GeoJSON data containing geometries that represent a collection of geofences": { - "$ref": "./examples/Upload.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ClientId" - }, - { - "$ref": "#/parameters/SubscriptionKey" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/Description" - }, - { - "$ref": "#/parameters/UploadDataFormat" - }, - { - "name": "UploadContent", - "in": "body", - "description": "The content to upload.", - "required": true, - "schema": { - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "Data upload failed. The uploaded content did not satisfy all the validation checks. The response body contains all the errors that were encountered.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "202": { - "description": "Request Accepted: The request has been accepted for processing. Please use the URL in the Operation-Location Header to obtain status.", - "headers": { - "Operation-Location": { - "type": "string", - "description": "New URL to check for the results of the long-running operation." - } - } - }, - "400": { - "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "403": { - "description": "Permission, capacity, or authentication issues.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "404": { - "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "500": { - "description": "An error occurred while processing the request. Please try again later.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - } - } - }, - "get": { - "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch a list of all content uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview). \n\n\n### Submit List Request\n\nTo list all your map data content you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe Data List API returns the complete list of all data in `json` format. The response contains the following details for each data resource:\n\n > udid - The unique data id for the data resource.\n\n > location - The location of the data resource. Execute a HTTP `GET` on this location to download the data.\n\n\nHere's a sample response returning the `udid` and `location` of 3 data resources: \n\n
\n\n```json\n{\n \"mapDataList\": \n [\n {\n \"udid\": \"9a1288fa-1858-4a3b-b68d-13a8j5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0\",\n \"created\": \"2021-04-05T18:41:15+00:00\",\n \"updated\": \"2021-04-05T18:41:26+00:00\",\n \"sizeInBytes\": 29920,\n \"uploadStatus\": \"Completed\",\n \"description\": \"Sample Building\",\n \"dataFormat\": \"zip\"\n },\n {\n \"udid\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0\",\n \"created\": \"2021-06-09T12:42:17+00:00\",\n \"updated\": \"2021-06-09T12:42:19+00:00\",\n \"sizeInBytes\": 1339,\n \"uploadStatus\": \"Completed\",\n \"description\": \"Sample Lobby\",\n \"dataFormat\": \"zip\"\n },\n {\n \"udid\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0\",\n \"created\": \"2021-07-08T08:25:48+00:00\",\n \"updated\": \"2021-07-08T08:25:52+00:00\",\n \"sizeInBytes\": 1650,\n \"uploadStatus\": \"Pending\",\n \"description\": \"Sample Break Room\",\n \"dataFormat\": \"zip\"\n }]\n}\n```\n\n
", - "operationId": "Data_ListPreview", - "x-ms-examples": { - "List all the previously uploaded data": { - "$ref": "./examples/List.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ClientId" - }, - { - "$ref": "#/parameters/SubscriptionKey" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "List data request completed successfully. The response body contains a list of all the previously uploaded data.", - "schema": { - "$ref": "#/definitions/MapDataListResponse" - }, - "headers": { - "Content-Type": { - "type": "string", - "description": "The content-type for the Download API response." - } - } - }, - "400": { - "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "403": { - "description": "Permission, capacity, or authentication issues.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "404": { - "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "500": { - "description": "An error occurred while processing the request. Please try again later.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - } - } - } - }, - "/mapData/{udid}": { - "put": { - "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Update API allows the caller to update a previously uploaded data content.\n\nYou can use this API in a scenario like adding or removing geofences to or from an existing collection of geofences. \nGeofences are uploaded using the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload-preview), for \nuse in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\nPlease note that the Update API will *replace* and *override* the existing data content.\n\n## Submit Update Request\n\nTo update your content you will use a `PUT` request. The request body will contain the new data that will replace \nthe existing data. The `Content-Type` header will be set to the content type of the data, and the path will contain \nthe `udid` of the data to be update.\n\nFor example, to update a collection of geofences that were previously uploaded using the Upload API, place the new \ngeofence content in the request body. Set the `udid` parameter in the path to the `udid` of the data received \npreviously in the upload API response. And set the `Content-Type` header to one of the following media types:\n\n- `application/json` if `dataFormat` is `JSON`\n- `application/vnd.geo+json` if `dataFormat` is `geoJSON`\n- `application/octet-stream` if `dataFormat` is `zip`\n\nHere's a sample request body for updating a simple Geofence. It's represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe previously uploaded geofence had a radius of 100m. The above request will update it to 500m.\n\nThe Data Update API performs a \nlong-running operation.\n\n## Data Update Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data-v2/delete-preview) to \ndelete old/unused content and create space for new uploads.", - "operationId": "Data_UpdatePreview", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Update previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { - "$ref": "./examples/Update.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ClientId" - }, - { - "$ref": "#/parameters/SubscriptionKey" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/Udid" - }, - { - "$ref": "#/parameters/Description" - }, - { - "name": "UpdateContent", - "in": "body", - "description": "The new content that will update/replace the previously uploaded content.", - "required": true, - "schema": { - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "Data update failed. The uploaded content did not satisfy all the validation checks. The response body contains all the errors that were encountered.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "202": { - "description": "Request Accepted: The request has been accepted for processing. Please use the URL in the Operation-Location Header to obtain status.", - "headers": { - "Operation-Location": { - "type": "string", - "description": "New URL to check for the results of the long-running operation." - } - } - }, - "400": { - "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "403": { - "description": "Permission, capacity, or authentication issues.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "404": { - "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "500": { - "description": "An error occurred while processing the request. Please try again later.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - } - } - }, - "get": { - "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to download a previously uploaded data content.
\nYou can use this API in a scenario like downloading an existing collection of geofences uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). \n\n\n### Submit Download Request\n\nTo download your content you will use a `GET` request where the path will contain the `udid` of the data to download. Optionally, you can also pass in an `Accept` header to specify a preference for the `Content-Type` of the data response.
\nFor example, to download a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response and set the `Accept` header to either one of the following media types: \n \n - `application/json` if `dataFormat` is `JSON`\n - `application/vnd.geo+json` if `dataFormat` is `geoJSON`\n - `application/octet-stream` if `dataFormat` is `zip`\n\n\n### Download Data Response\n\nThe Download API will return a HTTP `200 OK` response if the data resource with the passed-in `udid` is found, where the response body will contain the content of the data resource.
\nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found.
\n\nHere's a sample response body for a simple geofence represented in `GeoJSON` uploaded previously using the Upload API:\n
\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```", - "operationId": "Data_DownloadPreview", - "x-ms-examples": { - "Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { - "$ref": "./examples/Download.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ClientId" - }, - { - "$ref": "#/parameters/SubscriptionKey" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/Udid" - } - ], - "responses": { - "200": { - "description": "Data download request completed successfully. The response body will contain the content for the passed in `udid`.", - "schema": { - "$ref": "#/definitions/MapDataDownloadResponse" - }, - "headers": { - "Content-Type": { - "type": "string", - "description": "The content-type for the Download API response." - } - } - }, - "400": { - "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "403": { - "description": "Permission, capacity, or authentication issues.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "404": { - "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "500": { - "description": "An error occurred while processing the request. Please try again later.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - } - } - }, - "delete": { - "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to delete a previously uploaded data content.
\nYou can use this API in a scenario like removing geofences previously uploaded using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). You can also use this API to delete old/unused uploaded content and create space for new content.\n\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `udid` of the data to delete.
\nFor example, to delete a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response. \n\n\n### Delete Data Response\n\nThe Data Delete API returns a HTTP `204 No Content` response with an empty body, if the data resource was deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found. ", - "operationId": "Data_DeletePreview", - "x-ms-examples": { - "Delete previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { - "$ref": "./examples/Delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ClientId" - }, - { - "$ref": "#/parameters/SubscriptionKey" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/Udid" - } - ], - "responses": { - "204": { - "description": "Data delete request completed successfully. The content for `udid` was deleted on the server." - }, - "400": { - "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "403": { - "description": "Permission, capacity, or authentication issues.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "404": { - "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - }, - "500": { - "description": "An error occurred while processing the request. Please try again later.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - } - } - } - }, - "/mapData/operations/{operationId}": { - "get": { - "description": "This path will be obtained from a call to POST /mapData. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once completed.", - "operationId": "Data_GetOperationPreview", - "x-ms-examples": { - "Get the status of an operation which is still running": { - "$ref": "./examples/GetOperationStillRunning.json" - }, - "Get the status of an operation which has finished successfully": { - "$ref": "./examples/GetOperation.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionKey" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/DataUploadOperationId" - } - ], - "responses": { - "200": { - "description": "The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result.", - "schema": { - "$ref": "#/definitions/LongRunningOperationResult" - } - }, - "400": { - "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", - "schema": { - "$ref": "#/definitions/ODataErrorResponse" - } - } - } - } - } - }, - "definitions": { - "ODataErrorResponse": { - "type": "object", - "description": "This response object is returned when an error occurs in the Azure Maps API.", - "properties": { - "error": { - "$ref": "#/definitions/ODataError" - } - } - }, - "ODataError": { - "type": "object", - "description": "This object is returned when an error occurs in the Azure Maps API.", - "properties": { - "code": { - "type": "string", - "readOnly": true, - "description": "The ODataError code." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "If available, a human-readable description of the error." - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/ODataError" - } - }, - "target": { - "type": "string", - "readOnly": true, - "description": "If available, the target causing the error." - } - } - }, - "LongRunningOperationResult": { - "description": "The response model for a Long-Running Operations API.", - "type": "object", - "properties": { - "operationId": { - "description": "The Id for this long-running operation.", - "type": "string" - }, - "status": { - "description": "The status state of the request.", - "type": "string", - "enum": [ - "NotStarted", - "Running", - "Failed", - "Succeeded" - ], - "x-ms-enum": { - "name": "type", - "modelAsString": true, - "values": [ - { - "value": "NotStarted", - "description": "The request has not started processing yet." - }, - { - "value": "Running", - "description": "The request has started processing." - }, - { - "value": "Failed", - "description": "The request has one or more failures." - }, - { - "value": "Succeeded", - "description": "The request has successfully completed." - } - ] - }, - "readOnly": true - }, - "created": { - "description": "The created timestamp.", - "type": "string", - "readOnly": true - }, - "error": { - "$ref": "#/definitions/ODataError" - }, - "warning": { - "$ref": "#/definitions/ODataError" - } - } - }, - "MapDataDownloadResponse": { - "description": "The response model for the Data Download API. The response body will contain the content for the passed in `udid`.", - "type": "object", - "properties": {} - }, - "MapDataListResponse": { - "description": "The response model for the Data List API. Returns a list of all the previously uploaded data.", - "type": "object", - "properties": { - "mapDataList": { - "description": "A list of all the previously uploaded data.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/MapDataDetailInfo" - } - } - } - }, - "MapDataDetailInfo": { - "description": "Detail information for the data.", - "type": "object", - "properties": { - "udid": { - "description": "The unique data id for the data.", - "type": "string", - "readOnly": true - }, - "location": { - "description": "The location of the data. Execute a HTTP `GET` on this location to download the data.", - "type": "string", - "readOnly": true - }, - "sizeInBytes": { - "description": "The size of the content in bytes.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "uploadStatus": { - "description": "The current upload status of the content.", - "type": "string", - "readOnly": true - }, - "dataFormat": { - "description": "The current data format.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The current description.", - "type": "string", - "readOnly": true - } - } - } - } -} diff --git a/swagger-specs/maps/data-plane/Render/stable/2022-08-01/render.json b/swagger-specs/maps/data-plane/Render/stable/2022-08-01/render.json index 27a3556b0..45020010e 100644 --- a/swagger-specs/maps/data-plane/Render/stable/2022-08-01/render.json +++ b/swagger-specs/maps/data-plane/Render/stable/2022-08-01/render.json @@ -18,7 +18,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -144,7 +144,7 @@ }, "TilesetId": { "name": "tilesetId", - "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", + "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", "type": "string", "in": "query", "required": true, @@ -272,7 +272,8 @@ "paths": { "/map/tile": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK.", + "summary": "Use to request map tiles in vector or raster format.", + "description": "**\n\nThe `Get Map Tiles` API is an HTTP `GET` request that allows users to request map tiles in vector or raster formats, typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control ([Web SDK](/azure/azure-maps/about-azure-maps#web-sdk)) and [Android SDK](/azure/azure-maps/about-azure-maps#android-sdk).", "operationId": "Render_GetMapTile", "x-ms-client-name": "GetMapTile", "x-ms-examples": { @@ -346,7 +347,8 @@ }, "/map/tileset": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Map Tileset API allows users to request metadata for a tileset.", + "summary": "Use to get metadata for a tileset.", + "description": "**\n\nThe `Get Map Tileset` API is an HTTP `GET` request allows users to request [metadata](#maptileset) for a tileset.", "operationId": "Render_GetMapTileset", "x-ms-examples": { "Successful Tileset Request": { @@ -382,7 +384,8 @@ }, "/map/attribution": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset.", + "summary": "Use to get map copyright attribution information.", + "description": "\n\nThe `Get Map Attribution` API is an HTTP `GET` request that returns map copyright attribution information for a section of a tileset as defined by the four bounding box coordinates and zoom level.", "operationId": "Render_GetMapAttribution", "x-ms-examples": { "Successful Attribution Request": { @@ -439,7 +442,8 @@ }, "/map/statetile": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid))", + "summary": "Use to get state tiles in vector format that can then be used to display feature state information in an indoor map.", + "description": "\n\nThe `Get Map State Tile` API is an HTTP `GET` request that fetches state tiles in vector format, typically to be integrated into the indoor maps module of a map control or SDK. The map control calls this API after dynamic styling is turned on. For more information, see [Zoom Levels and Tile Grid](/azure/azure-maps/zoom-levels-and-tile-grid).", "operationId": "Render_GetMapStateTile", "x-ms-examples": { "Successful State Tile Request": { @@ -497,7 +501,8 @@ }, "/map/copyright/caption/{format}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCopyrights API is designed to serve copyright information for Render Tile \nservice. In addition to basic copyright for the whole map, API is serving \nspecific groups of copyrights for some countries/regions.\n\nAs an alternative to copyrights for map request, one can receive captions\nfor displaying the map provider information on the map.", + "summary": "Use to get copyright information to use when rendering a tile.", + "description": "\n\nThe `Get Copyright Caption` API is an HTTP `GET` request designed to serve copyright information to be use in conjunction with tiles requested from the Render service. In addition to a basic copyright for the whole map, it can serve specific groups of copyrights for some countries/regions.\n\nAs an alternative to copyrights for map request, one can receive captions for displaying the map provider information on the map.", "operationId": "Render_GetCopyrightCaption", "x-ms-examples": { "Successful Copyright Caption Request": { @@ -530,7 +535,8 @@ }, "/map/static/{format}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following capabilities. \n\n- Specify multiple pushpin styles\n- Render circle, polyline and polygon geometry types.\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n

\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n

\n\n |Zoom Level | Max Lon Range | Max Lat Range|\n |:----------|:----------------|:-------------|\n |0 | 360.0 | 170.0 | \n |1 | 360.0 | 170.0 |\n |2 | 360.0 | 170.0 |\n |3 | 360.0 | 170.0 |\n |4 | 360.0 | 170.0 |\n |5 | 180.0 | 85.0 |\n |6 | 90.0 | 42.5 |\n |7 | 45.0 | 21.25 |\n |8 | 22.5 | 10.625 |\n |9 | 11.25 | 5.3125 |\n |10 | 5.625 | 2.62625 |\n |11 | 2.8125 | 1.328125 |\n |12 | 1.40625 | 0.6640625 |\n |13 | 0.703125 | 0.33203125 |\n |14 | 0.3515625 | 0.166015625 |\n |15 | 0.17578125 | 0.0830078125 | \n |16 | 0.087890625 | 0.0415039063 | \n |17 | 0.0439453125 | 0.0207519531 |\n |18 | 0.0219726563 | 0.0103759766 |\n |19 | 0.0109863281 | 0.0051879883 |\n |20 | 0.0054931641 | 0.0025939941 |", + "summary": "Use to render a user-defined, rectangular image containing a map section using a zoom level ranging from 0 to 20. ", + "description": "\n\nThe supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following capabilities. \n\n- Specify multiple pushpin styles\n- Render circle, polyline and polygon geometry types.\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n

\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n

\n\n |Zoom Level | Max Lon Range | Max Lat Range|\n |:----------|:----------------|:-------------|\n |0 | 360.0 | 170.0 | \n |1 | 360.0 | 170.0 |\n |2 | 360.0 | 170.0 |\n |3 | 360.0 | 170.0 |\n |4 | 360.0 | 170.0 |\n |5 | 180.0 | 85.0 |\n |6 | 90.0 | 42.5 |\n |7 | 45.0 | 21.25 |\n |8 | 22.5 | 10.625 |\n |9 | 11.25 | 5.3125 |\n |10 | 5.625 | 2.62625 |\n |11 | 2.8125 | 1.328125 |\n |12 | 1.40625 | 0.6640625 |\n |13 | 0.703125 | 0.33203125 |\n |14 | 0.3515625 | 0.166015625 |\n |15 | 0.17578125 | 0.0830078125 | \n |16 | 0.087890625 | 0.0415039063 | \n |17 | 0.0439453125 | 0.0207519531 |\n |18 | 0.0219726563 | 0.0103759766 |\n |19 | 0.0109863281 | 0.0051879883 |\n |20 | 0.0054931641 | 0.0025939941 |", "operationId": "Render_GetMapStaticImage", "x-ms-examples": { "Successful Static Image Request": { @@ -707,7 +713,8 @@ }, "/map/copyright/bounding/{format}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates", + "summary": "Use to get copyright information for the specified bounding box.", + "description": "\n\nBounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates", "operationId": "Render_GetCopyrightFromBoundingBox", "x-ms-examples": { "Successful BoundingBox Copyright Request": { @@ -749,7 +756,8 @@ }, "/map/copyright/tile/{format}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).", + "summary": "Use to get copyright information.", + "description": "\n\nIn addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).", "operationId": "Render_GetCopyrightForTile", "x-ms-examples": { "Successful Tile Copyright Request": { @@ -794,7 +802,8 @@ }, "/map/copyright/world/{format}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.", + "summary": "Use to get copyright information for for the world.", + "description": "\n\nIn addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.\nTo obtain the default copyright information for the whole world, do not specify a tile or bounding box.", "operationId": "Render_GetCopyrightForWorld", "x-ms-examples": { "Successful World Copyright Request": { diff --git a/swagger-specs/maps/data-plane/Route/preview/1.0/route.json b/swagger-specs/maps/data-plane/Route/preview/1.0/route.json index 8931e4622..d3ba2bceb 100644 --- a/swagger-specs/maps/data-plane/Route/preview/1.0/route.json +++ b/swagger-specs/maps/data-plane/Route/preview/1.0/route.json @@ -18,7 +18,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -63,7 +63,7 @@ "VehicleLoadType": { "name": "vehicleLoadType", "in": "query", - "description": "Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck.", + "description": "Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck.", "type": "string", "enum": [ "USHazmatClass1", @@ -238,7 +238,7 @@ "TravelMode": { "name": "travelMode", "in": "query", - "description": "The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be \"other\". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. In **calculateReachableRange** requests, the values bicycle and pedestrian must not be used.", + "description": "The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be \"other\". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas.", "type": "string", "enum": [ "car", @@ -290,10 +290,55 @@ }, "x-ms-parameter-location": "method" }, + "TravelModeRange": { + "name": "travelMode", + "in": "query", + "description": "The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be \"other\". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas.", + "type": "string", + "enum": [ + "car", + "truck", + "taxi", + "bus", + "van", + "motorcycle" + ], + "x-ms-enum": { + "name": "TravelMode", + "modelAsString": true, + "values": [ + { + "value": "car", + "description": "The returned routes are optimized for cars." + }, + { + "value": "truck", + "description": "The returned routes are optimized for commercial vehicles, like for trucks." + }, + { + "value": "taxi", + "description": "The returned routes are optimized for taxis. BETA functionality." + }, + { + "value": "bus", + "description": "The returned routes are optimized for buses, including the use of bus only lanes. BETA functionality." + }, + { + "value": "van", + "description": "The returned routes are optimized for vans. BETA functionality." + }, + { + "value": "motorcycle", + "description": "The returned routes are optimized for motorcycles. BETA functionality." + } + ] + }, + "x-ms-parameter-location": "method" + }, "RouteAvoidList": { "name": "avoid", "in": "query", - "description": "Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In calculateReachableRange requests, the value alreadyUsedRoads must not be used.", + "description": "Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Route Range requests, the value alreadyUsedRoads must not be used.", "type": "array", "collectionFormat": "multi", "items": { @@ -548,7 +593,7 @@ "DepartAt": { "name": "departAt", "in": "query", - "description": "The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime. When a time zone offset is not specified, it will be assumed to be that of the origin point. The departAt value must be in the future in the date-time format (1996-12-19T16:39:57-08:00).", + "description": "The date and time of departure from the origin point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified, it will be assumed to be that of the origin point.\n * Default value: now\n * Other value: `dateTime`\n\nExamples:\n * 2023-12-19T16:39:57\n * 2023-12-19T16:39:57-08:00\n\nThe `departAt` parameter cannot be used in conjunction with `arriveAt`.", "type": "string", "format": "date-time", "x-ms-parameter-location": "method" @@ -556,7 +601,7 @@ "ArriveAt": { "name": "arriveAt", "in": "query", - "description": "The date and time of arrival at the destination point. It must be specified as a dateTime. When a time zone offset is not specified it will be assumed to be that of the destination point. The arriveAt value must be in the future. The arriveAt parameter cannot be used in conjunction with departAt, minDeviationDistance or minDeviationTime.", + "description": "The date and time of arrival at the destination point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified it will be assumed to be that of the destination point.\n\nExamples:\n * 2023-12-19T16:39:57\n * 2023-12-19T16:39:57-08:00\n\nThe `arriveAt` parameter cannot be used in conjunction with `departAt`, `minDeviationDistance` or `minDeviationTime`.", "type": "string", "format": "date-time", "x-ms-parameter-location": "method" @@ -593,7 +638,7 @@ { "value": "country", "name": "Country", - "description": "Sections indicating which countries the route is in." + "description": "Sections indicating which countries/regions the route is in." }, { "value": "ferry", @@ -837,7 +882,8 @@ "paths": { "/route/matrix/{format}": { "post": { - "description": "\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using an asynchronous request.", + "description": "\n\nThe `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_PostRouteMatrix", "x-ms-client-name": "RequestRouteMatrix", "x-ms-long-running-operation": true, @@ -942,7 +988,8 @@ } }, "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nIf the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations.", + "description": "\n\nThe `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).\n\nFor every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nGET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nGET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix GET request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_GetRouteMatrix", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -982,7 +1029,8 @@ }, "/route/matrix/sync/{format}": { "post": { - "description": "\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using a synchronous request.", + "description": "\n\nThe `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_PostRouteMatrixSync", "x-ms-client-name": "RequestRouteMatrixSync", "x-ms-examples": { @@ -1089,7 +1137,8 @@ }, "/route/directions/{format}": { "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nReturns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nInformation returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.\n\nRouting service provides a set of parameters for a detailed description of vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.", + "summary": "Use to calculate a route between a specified origin and destination, passing through any specified waypoints.", + "description": "\n\nThe `Get Route Directions` API is an HTTP `GET` request that returns a route between an origin and a destination, passing through waypoints if specified. The route takes into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nInformation returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.\n\nRouting service provides a set of parameters for a detailed description of a vehicle-specific consumption model. For more information, see [Consumption Model](/azure/azure-maps/consumption-model).", "operationId": "Route_GetRouteDirections", "x-ms-examples": { "Successfully retrieve a route between an origin and a destination": { @@ -1260,7 +1309,8 @@ } }, "post": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nReturns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nInformation returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.\n\nRouting service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.", + "summary": "Use to calculate a route between a given origin and destination, passing through any specified waypoints.", + "description": "\n\nThe `Post Route Directions` API is an HTTP `POST` request that returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nInformation returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.\n\nRouting service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.", "operationId": "Route_PostRouteDirections", "x-ms-client-name": "GetRouteDirectionsWithAdditionalParameters", "x-ms-examples": { @@ -1443,7 +1493,8 @@ }, "/route/range/{format}": { "get": { - "description": "__Route Range (Isochrone) API__\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis service will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point.\n\nThe returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone.", + "summary": "Use to create a map that depicts the area accessible from a given point within a certain threshold based on time, distance or fuel capacity.", + "description": "\n\nThe `Get Route Range` (Isochrone) API is an HTTP `GET` request that will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point.\n\nThe returned polygon can be used for further processing such as [Search Inside Geometry](/rest/api/maps/search/post-search-inside-geometry) to search for POIs within the provided isochrone.", "operationId": "Route_GetRouteRange", "x-ms-examples": { "Successfully retrieve a set of locations that can be reached from the origin point based on various conditions": { @@ -1516,7 +1567,7 @@ "$ref": "#/parameters/RouteAvoidList" }, { - "$ref": "#/parameters/TravelMode" + "$ref": "#/parameters/TravelModeRange" }, { "$ref": "#/parameters/InclineLevel" @@ -1603,7 +1654,8 @@ }, "/route/directions/batch/{format}": { "post": { - "description": "**Route Directions Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n``` GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0 ```\nNote:- Please remember to add AUTH information (subscription-key/azure_auth - See [Security](#security)) to the _status URI_ before running it.
\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "summary": "Use to send a batch of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API in a single asynchronous request.", + "description": "\n\nThe `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).\n\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n```\nGET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} \n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Route_PostRouteDirectionsBatch", "x-ms-client-name": "RequestRouteDirectionsBatch", "x-ms-long-running-operation": true, @@ -1651,7 +1703,8 @@ } }, "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "summary": "Use to send a batch of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API in a single asynchronous request.", + "description": "\n\nThe `Get Route Directions Batch` API is an HTTP `GET` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single request. You can call `Get Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Route_GetRouteDirectionsBatch", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1691,7 +1744,8 @@ }, "/route/directions/batch/sync/{format}": { "post": { - "description": "**Route Directions Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "summary": "Use to send a batch of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API in a single synchronous request.", + "description": "\n\nThe `Post Route Directions Batch Sync` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single synchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a asynchronous request, see [Post Route Directions Batch](/rest/api/maps/route/post-route-directions-batch).\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Route_PostRouteDirectionsBatchSync", "x-ms-client-name": "RequestRouteDirectionsBatchSync", "x-ms-examples": { @@ -1750,14 +1804,14 @@ "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonGeometryCollection" }, "avoidVignette": { - "description": "This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g. \"AUS,CHE\". Toll roads with vignettes in countries not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**.", + "description": "This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries/regions in which all toll roads with vignettes are to be avoided, e.g. \"AUS,CHE\". Toll roads with vignettes in countries/regions not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**.", "type": "array", "items": { "type": "string" } }, "allowVignette": { - "description": "This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g. \"AUS,CHE\". Specifying **allowVignette** with some countries X is equivalent to specifying **avoidVignette** with all countries but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**.", + "description": "This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries/regions in which toll roads with vignettes are allowed, e.g. \"AUS,CHE\". Specifying **allowVignette** with some countries/regions X is equivalent to specifying **avoidVignette** with all countries/regions but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**.", "type": "array", "items": { "type": "string" @@ -2119,7 +2173,7 @@ "readOnly": true }, "stateCode": { - "description": "A subdivision (e.g., state) of the country, represented by the second part of an [ISO 3166-2](https://www.iso.org/standard/63546.html) code. This is only available for some countries like the US, Canada, and Mexico.", + "description": "A subdivision (e.g., state) of the country, represented by the second part of an [ISO 3166-2](https://www.iso.org/standard/63546.html) code. This is only available for some countries/regions like the US, Canada, and Mexico.", "type": "string", "readOnly": true }, @@ -2652,13 +2706,13 @@ } }, "DepartureTime": { - "description": "The estimated departure time for the route or leg.", + "description": "The estimated departure time for the route or leg. Time is in UTC.", "type": "string", "readOnly": true, "format": "date-time" }, "ArrivalTime": { - "description": "The estimated arrival time for the route or leg.", + "description": "The estimated arrival time for the route or leg. Time is in UTC.", "type": "string", "readOnly": true, "format": "date-time" @@ -2693,7 +2747,7 @@ { "value": "COUNTRY", "name": "Country", - "description": "Sections indicating which countries the route is in." + "description": "Sections indicating which countries/regions the route is in." }, { "value": "FERRY", diff --git a/swagger-specs/maps/data-plane/Search/stable/2023-06-01/search.json b/swagger-specs/maps/data-plane/Search/stable/2023-06-01/search.json index 87e0ff881..b3597b7e8 100644 --- a/swagger-specs/maps/data-plane/Search/stable/2023-06-01/search.json +++ b/swagger-specs/maps/data-plane/Search/stable/2023-06-01/search.json @@ -18,7 +18,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n> [!NOTE]\n> * This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n> * The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n> * The Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n> * Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n> * Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.\n\n", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n> [!NOTE]\n> * This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n> * The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n> * The Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n> * Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n> * For more information on Microsoft identity platform, see [Microsoft identity platform overview](/entra/identity-platform/v2-overview).\n\n", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -74,7 +74,7 @@ "Accept-Language": { "name": "Accept-Language", "in": "header", - "description": "Language in which search results should be returned. \n\nPlease refer to [Supported Languages](https://learn.microsoft.com/azure/azure-maps/supported-languages) for details.", + "description": "Language in which search results should be returned. \n\nPlease refer to [Supported Languages](/azure/azure-maps/supported-languages) for details.", "required": false, "type": "string", "x-ms-parameter-location": "client" @@ -120,7 +120,7 @@ "BoundaryResultType": { "name": "resultType", "in": "query", - "description": "The geopolitical concept to return a boundary for.", + "description": "The geopolitical concept to return a boundary for. If not specified, the default is `countryRegion` result type.", "required": false, "type": "string", "default": "countryRegion", @@ -191,7 +191,7 @@ "Resolution": { "name": "resolution", "in": "query", - "description": "Resolution determines the amount of points to send back.", + "description": "Resolution determines the amount of points to send back. If not specified, the default is medium resolution.", "required": false, "type": "string", "default": "medium", @@ -287,7 +287,8 @@ "paths": { "/geocode": { "get": { - "description": "**Geocoding**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nIn many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocoding endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No Point of Interest (POIs) will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.", + "summary": "Use to get longitude and latitude coordinates of a street address or name of a place.", + "description": "\n\nThe `Get Geocoding` API is an HTTP `GET` request that returns the longitude and latitude coordinates of the location being searched.\n\nIn many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocoding endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No Point of Interest (POIs) will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties and states. The response also returns detailed address properties such as street, postal code, municipality, and country/region information.", "operationId": "Search_GetGeocoding", "produces": [ "application/geo+json" @@ -333,7 +334,7 @@ { "name": "countryRegion", "in": "query", - "description": "Restrict the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR. This will limit the search to the specified region.\n\n**If query is given, should not use this parameter.**", + "description": "Signal for the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR./\n\n**If query is given, should not use this parameter.**", "required": false, "type": "string" }, @@ -406,7 +407,8 @@ }, "/geocode:batch": { "post": { - "description": "**Geocoding Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Geocoding Batch API sends batches of queries to [Geocoding API](https://docs.microsoft.com/rest/api/maps/search-v2/get-geocoding) using just a single API call. The API allows caller to batch up to **100** queries.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01\n```\n### POST Body for Batch Request\nTo send the _geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"addressLine\": \"One, Microsoft Way, Redmond, WA 98052\",\n \"top\": 2\n },\n {\n \"addressLine\": \"Pike Pl\",\n \"adminDistrict\": \"WA\",\n \"locality\": \"Seattle\",\n \"top\": 3\n }\n ]\n}\n```\n\nA _geocoding_ batchItem object can accept any of the supported _geocoding_ [URI parameters](https://docs.microsoft.com/rest/api/maps/search-v2/get-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`GeocodingResponse`](https://docs.microsoft.com/rest/api/maps/search-v2/get-geocoding#geocodingresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n", + "summary": "Use to send a batch of queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request.", + "description": "\n\nThe `Get Geocoding Batch` API is an HTTP `POST` request that sends batches of up to **100** queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request. \n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01\n```\n### POST Body for Batch Request\nTo send the _geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"addressLine\": \"One, Microsoft Way, Redmond, WA 98052\",\n \"top\": 2\n },\n {\n \"addressLine\": \"Pike Pl\",\n \"adminDistrict\": \"WA\",\n \"locality\": \"Seattle\",\n \"top\": 3\n }\n ]\n}\n```\n\nA _geocoding_ batchItem object can accept any of the supported _geocoding_ [URI parameters](/rest/api/maps/search/get-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`GeocodingResponse`](/rest/api/maps/search/get-geocoding#geocodingresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n", "operationId": "Search_GetGeocodingBatch", "x-ms-examples": { "A Geocoding Batch API call containing 2 Geocoding queries": { @@ -448,7 +450,8 @@ }, "/search/polygon": { "get": { - "description": "**Get Polygon**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nSupplies polygon data of a geographical area outline such as a city or a country region.", + "summary": "Use to get polygon data of a geographical area shape such as a city or a country region.", + "description": "\n\nThe `Get Polygon` API is an HTTP `GET` request that supplies polygon data of a geographical area outline such as a city or a country region.", "operationId": "Search_GetPolygon", "produces": [ "application/geo+json" @@ -508,7 +511,8 @@ }, "/reverseGeocode": { "get": { - "description": "**Reverse Geocoding**\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nTranslate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate.", + "summary": "Use to get a street address and location info from longitude and latitude coordinates.", + "description": "\n\nThe `Get Reverse Geocoding` API is an HTTP `GET` request used to translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Useful in tracking applications where you receive a GPS feed from the device or asset and wish to know the address associated with the coordinates. This endpoint will return address information for a given coordinate.", "operationId": "Search_GetReverseGeocoding", "produces": [ "application/geo+json" @@ -565,7 +569,8 @@ }, "/reverseGeocode:batch": { "post": { - "description": "**Reverse Geocoding Batch API**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nThe Reverse Geocoding Batch API sends batches of queries to [Reverse Geocoding API](https://docs.microsoft.com/rest/api/maps/search-v2/get-reverse-geocoding) using just a single API call. The API allows caller to batch up to **100** queries.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01\n```\n### POST Body for Batch Request\nTo send the _reverse geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _reverse geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"coordinates\": [-122.128275, 47.639429],\n \"resultTypes\": [\"Address\", \"PopulatedPlace\"]\n },\n {\n \"coordinates\": [-122.341979399674, 47.6095253501216]\n }\n ]\n}\n```\n\nA _reverse geocoding_ batchItem object can accept any of the supported _reverse geocoding_ [URI parameters](https://docs.microsoft.com/rest/api/maps/search-v2/get-reverse-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`GeocodingResponse`](https://docs.microsoft.com/rest/api/maps/search-v2/get-reverse-geocoding#geocodingresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n", + "summary": "Use to send a batch of queries to the [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API in a single request.", + "description": "\n\nThe `Get Reverse Geocoding Batch` API is an HTTP `POST` request that sends batches of up to **100** queries to [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API using a single request.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01\n```\n### POST Body for Batch Request\nTo send the _reverse geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _reverse geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"coordinates\": [-122.128275, 47.639429],\n \"resultTypes\": [\"Address\", \"PopulatedPlace\"]\n },\n {\n \"coordinates\": [-122.341979399674, 47.6095253501216]\n }\n ]\n}\n```\n\nA _reverse geocoding_ batchItem object can accept any of the supported _reverse geocoding_ [URI parameters](/rest/api/maps/search/get-reverse-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`GeocodingResponse`](/rest/api/maps/search/get-reverse-geocoding#geocodingresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n", "operationId": "Search_GetReverseGeocodingBatch", "x-ms-examples": { "A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries": { @@ -702,7 +707,7 @@ "type": "string" }, "countryRegion": { - "description": "Restrict the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR. This will limit the search to the specified region.\n\n**If query is given, should not use this parameter.**", + "description": "Signal for the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR./\n\n**If query is given, should not use this parameter.**", "type": "string" }, "bbox": { diff --git a/swagger-specs/maps/data-plane/Spatial/stable/2022-08-01/spatial.json b/swagger-specs/maps/data-plane/Spatial/stable/2022-08-01/spatial.json index 4ca166fc0..39ddfa41e 100644 --- a/swagger-specs/maps/data-plane/Spatial/stable/2022-08-01/spatial.json +++ b/swagger-specs/maps/data-plane/Spatial/stable/2022-08-01/spatial.json @@ -25,7 +25,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Microsoft Entra OAuth 2.0](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see [Microsoft identity platform overview](/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -94,7 +94,7 @@ "SpatialUploadUdid": { "name": "udid", "in": "query", - "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "description": "The unique id used when creating a [Data registry](/rest/api/maps/data-registry/register-or-replace) to upload a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive. For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", "required": true, "type": "string", "x-ms-parameter-location": "method" @@ -180,7 +180,8 @@ "paths": { "/spatial/geofence/{format}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Geofence Get API allows you to retrieve the proximity of a coordinate to a \ngeofence that has been uploaded to the Data service. You can use the \n[Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) to upload \na geofence or set of fences. See [Geofencing GeoJSON data](https://docs.microsoft.com/azure/azure-maps/geofence-geojson) \nfor more details on the geofence data format. To query the proximity of a coordinate, you supply the location of the object you are tracking as well\nas the ID for the fence or set of fences, and the response will contain information about\nthe distance from the outer edge of the geofence. A negative value signifies that the \ncoordinate is inside of the fence while a positive value means that it is outside of the\nfence.

This API can be used for a variety of scenarios that include things like asset \ntracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).\nTo test this API, you can upload the sample data from Post Geofence API examples(Request Body) via Data Upload API and replace the [udid] from the sample request below with the udid returned by Data Upload API.\n\n\n### Geofencing InnerError code\n\nIn geofencing response error contract, `innererror` is an object containing service specific information about the error. `code` is a property in `innererror` which can map to a specific geofencing error type. The table belows shows the code mapping between all the known client error type to the corresponding geofencing error `message`.\n\ninnererror.code | error.message\n---------------------------- | -------------------------------------- \nNullDeviceId | Device Id should not be null.\nNullUdid\t | Udid should not be null.\nUdidWrongFormat| Udid should be acquired from user data ingestion API.\nInvalidUserTime| Usertime is invalid.\nInvalidSearchBuffer| Searchbuffer is invalid.\nInvalidSearchRange| The value range of searchbuffer should be from 0 to 500 meters.\nInvalidLatLon| Lat and/or lon parameters are invalid.\nInvalidIsAsyncValue| The IsAsync parameter is invalid.\nInvalidModeValue| The mode parameter invalid.\nInvalidJson| Geofencing data is not a valid json file.\nNotSupportedGeoJson| Geofencing data can't be read as a Feature or FeatureCollections.\nInvalidGeoJson| Geofencing data is invalid.\nNoUserDataWithAccountOrSubscription| Can't find user geofencing data with provided account-id and/or subscription-id.\nNoUserDataWithUdid|\tCan't find user geofencing data with provided udid.", + "summary": "Use to get the proximity of a coordinate to a geofence.", + "description": "\n\nThe `Get Geofence` API is an HTTP `GET` request that retrieves the proximity of a coordinate to a geofence that has been uploaded to the Data registry. You upload a geofence or set of fences into an Azure Storage Account, then register it with your Azure Maps Account using the [Data registry](/rest/api/maps/data-registry/register-or-replace), for more information see [How to create data registry](/azure/azure-maps/how-to-create-data-registries). For more information on on the geofence data format, see [Geofencing GeoJSON data](/azure/azure-maps/geofence-geojson). To query the proximity of a coordinate, you supply the location of the object you are tracking as well as the ID for the fence or set of fences, and the response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.\n\nThis API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default). To test this API, you can upload the sample data from Post Geofence API examples (Request Body) using the Data registry service and replace the `{udid}` from the sample request below with the `udid` used to create the Data registry. For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n\n### Geofencing InnerError code\n\nIn geofencing response error contract, `innererror` is an object containing service specific information about the error. `code` is a property in `innererror` which can map to a specific geofencing error type. The table belows shows the code mapping between all the known client error type to the corresponding geofencing error `message`.\n\ninnererror.code | error.message\n---------------------------- | -------------------------------------- \nNullDeviceId | Device Id should not be null.\nNullUdid\t | Udid should not be null.\nUdidWrongFormat| Udid should be acquired from user data ingestion API.\nInvalidUserTime| Usertime is invalid.\nInvalidSearchBuffer| Searchbuffer is invalid.\nInvalidSearchRange| The value range of searchbuffer should be from 0 to 500 meters.\nInvalidLatLon| Lat and/or lon parameters are invalid.\nInvalidIsAsyncValue| The IsAsync parameter is invalid.\nInvalidModeValue| The mode parameter invalid.\nInvalidJson| Geofencing data is not a valid json file.\nNotSupportedGeoJson| Geofencing data can't be read as a Feature or FeatureCollections.\nInvalidGeoJson| Geofencing data is invalid.\nNoUserDataWithAccountOrSubscription| Can't find user geofencing data with provided account-id and/or subscription-id.\nNoUserDataWithUdid|\tCan't find user geofencing data with provided udid.", "operationId": "Spatial_GetGeofence", "x-ms-examples": { "GetGeofence": { @@ -265,7 +266,8 @@ } }, "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Geofence Post API allows you to retrieve the proximity of a coordinate to a provided geofence or set of fences. With POST call, you do not have to upload the fence data in advance, instead you supply the location of the object you are tracking in query parameters as well as the fence or set of fences data in post request body. See [Geofencing GeoJSON data](https://docs.microsoft.com/azure/azure-maps/geofence-geojson) for more details on the geofence data format. The response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.

This API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).", + "summary": "Use to get the proximity of a coordinate to a geofence.", + "description": "\n\nThe `Post Geofence` API is an HTTP `POST` request that retrieveS the proximity of a coordinate to a provided geofence or set of fences. With `POST` requests, you do not have to upload the fence data in advance, instead you supply the location of the object you are tracking in query parameters as well as the fence or set of fences data in post request body. For more information on on the geofence data format, see [Geofencing GeoJSON data](/azure/azure-maps/geofence-geojson). The response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.\n\nThis API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).", "operationId": "Spatial_PostGeofence", "x-ms-examples": { "PostGeofence": { @@ -351,7 +353,8 @@ }, "/spatial/buffer/{format}": { "post": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided.", + "summary": "Use to get a `FeatureCollection` where each feature is a buffer around the corresponding indexed feature of the input.", + "description": "\n\nThe `Post Buffer` API is an HTTP `POST` request that returns a `FeatureCollection` where each feature is a buffer around the corresponding indexed feature of the input. The buffer could be either on the outside or the inside of the provided feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the `FeatureCollection` input, or if only one distance is provided, then that distance is applied to every feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided.", "operationId": "Spatial_PostBuffer", "x-ms-examples": { "PostBuffer": { @@ -391,7 +394,8 @@ } }, "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input features are provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided. \n\nTo test this API, you can upload the sample data from [Post Buffer API](https://docs.microsoft.com/rest/api/maps/spatial/postbuffer#examples) examples(Request Body without distances array) via [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/rest/api/maps/spatial/getbuffer#examples) with the udid returned by Data Upload API.", + "summary": "Use to get a `FeatureCollection` where each feature is a buffer around the corresponding indexed feature of the input.", + "description": "\n\nThe `Get Buffer` API is an HTTP `GET` request that returns a `FeatureCollection` where each feature is a buffer around the corresponding indexed feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input features are provided by a GeoJSON file which is uploaded using the [Data registry API](/rest/api/maps/data-registry/register-or-replace) and referenced by a unique udid. The GeoJSON file may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided. \n\nTo test this API, you can upload the sample data from [Post Buffer API](/rest/api/maps/spatial/postbuffer#examples) examples (Request Body without distances array) using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and replace the `{udid}` in the following [sample request](/rest/api/maps/spatial/getbuffer#examples) with the `udid` used when creating the data registry. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", "operationId": "Spatial_GetBuffer", "x-ms-examples": { "GetBuffer": { @@ -434,7 +438,8 @@ }, "/spatial/closestPoint/{format}": { "post": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns the closest point between a base point and a given set of target points. The set of target points is provided by user data in post request body. The user data may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The algorithm does not take into account routing or traffic. The maximum number of points accepted is 100,000. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.", + "summary": "Use to get the closest point between a base point and a given set of target points.", + "description": "\n\nThe `Post Closest Point` API is an HTTP `POST` request that returns the closest point between a base point and a given set of target points. The set of target points is provided by user data in post request body. The user data may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The algorithm does not take into account routing or traffic. The maximum number of points accepted is 100,000. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.", "operationId": "Spatial_PostClosestPoint", "x-ms-examples": { "PostClosestPoint": { @@ -480,7 +485,8 @@ } }, "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns the closest point between a base point and a given set of points in the user uploaded data set identified by udid. The set of target points is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The maximum number of points accepted is 100,000. The algorithm does not take into account routing or traffic. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.\n\nTo test this API, you can upload the sample data from [Post Closest Point API](https://docs.microsoft.com/rest/api/maps/spatial/postclosestpoint#examples) examples(Request Body) via [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/rest/api/maps/spatial/getclosestpoint#examples) with the udid returned by Data Upload API.", + "summary": "Use to get the closest point between a base point and a given set of target points.", + "description": "\n\nThe `Get Closest Point` API is an HTTP `GET` request the closest point between a base point and a given set of points in the user uploaded data set identified by `udid`. The set of target points is provided by a GeoJSON file which is uploaded using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and referenced by a unique udid. The GeoJSON file may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The maximum number of points accepted is 100,000. The algorithm does not take into account routing or traffic. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.\n\nTo test this API, you can upload the sample data from [Post Closest Point API](/rest/api/maps/spatial/postclosestpoint#examples) examples (Request Body) using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and replace the `{udid}` from the [sample request below](/rest/api/maps/spatial/getclosestpoint#examples) with the `udid` used when creating the data registry. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", "operationId": "Spatial_GetClosestPoint", "x-ms-examples": { "GetClosestPoint": { @@ -528,7 +534,8 @@ }, "/spatial/pointInPolygon/{format}": { "post": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The user data may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries (referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.", + "summary": "Use to determine if a given a point is inside a set of polygons.", + "description": "\n\nThe `Post Point In Polygon` API is an HTTP `POST` request that returns a boolean value indicating whether a point is inside a set of polygons. The user data may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries (referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.", "operationId": "Spatial_PostPointInPolygon", "x-ms-examples": { "PostPointInPolygon": { @@ -568,7 +575,8 @@ } }, "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries(referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.\n\n \nTo test this API, you can upload the sample data from [Post Point In Polygon API](https://docs.microsoft.com/rest/api/maps/spatial/postpointinpolygon#examples) examples(Request Body) via [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/rest/api/maps/spatial/getpointinpolygon#examples) with the udid returned by Data Upload API.", + "summary": "Use to determine if a given a point is inside a set of polygons.", + "description": "\n\nThe `Get Point In Polygon` API is an HTTP `GET` request that returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons is provided by a GeoJSON file which is uploaded using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and referenced by a unique udid. The GeoJSON file may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries(referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.\n\n \nTo test this API, you can upload the sample data from [Post Point In Polygon API](/rest/api/maps/spatial/postpointinpolygon#examples) examples (Request Body) using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and replace the `{udid}` from the [sample request below](/rest/api/maps/spatial/getpointinpolygon#examples) with the `udid` used when creating the data registry. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", "operationId": "Spatial_GetPointInPolygon", "x-ms-examples": { "GetPointInPolygon": { @@ -610,7 +618,8 @@ }, "/spatial/greatCircleDistance/{format}": { "get": { - "description": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API will return the great-circle or shortest distance between two points on the surface of a sphere, measured along the surface of the sphere. This differs from calculating a straight line through the sphere's interior. This method is helpful for estimating travel distances for airplanes by calculating the shortest distance between airports.", + "summary": "Use to determine shortest distance between two points on the surface of a sphere.", + "description": "\n\nThe `Get Great Circle Distance` API is an HTTP `GET` request that returns the great-circle or shortest distance between two points on the surface of a sphere, measured along the surface of the sphere. This differs from calculating a straight line through the sphere's interior. This method is helpful for estimating travel distances for airplanes by calculating the shortest distance between airports.", "operationId": "Spatial_GetGreatCircleDistance", "x-ms-examples": { "GetGreatCircleDistance": { @@ -662,7 +671,7 @@ }, "udId": { "x-ms-client-name": "udid", - "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "description": "The unique id used when creating a [Data registry](/rest/api/maps/data-registry/register-or-replace) to upload a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive. For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", "type": "string", "readOnly": true }, diff --git a/swagger-specs/maps/data-plane/Timezone/preview/1.0/timezone.json b/swagger-specs/maps/data-plane/Timezone/preview/1.0/timezone.json index 41afb1145..a7d0d38b1 100644 --- a/swagger-specs/maps/data-plane/Timezone/preview/1.0/timezone.json +++ b/swagger-specs/maps/data-plane/Timezone/preview/1.0/timezone.json @@ -18,7 +18,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -63,7 +63,7 @@ "TimezoneAcceptLanguage": { "name": "Accept-Language", "in": "header", - "description": "Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in \"EN\". Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details.", + "description": "Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in \"EN\". Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.", "type": "string", "x-ms-parameter-location": "method" }, @@ -131,7 +131,8 @@ "paths": { "/timezone/byId/{format}": { "get": { - "description": "__Time Zone by Id__\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns current, historical, and future time zone information for the specified IANA time zone ID.", + "summary": "Use to get the current, historical, and future time zone information for the specified IANA time zone ID.", + "description": "\n\nThe `Get Timezone By ID` API is an HTTP `GET` request that returns current, historical, and future time zone information for the specified IANA time zone ID.", "operationId": "Timezone_GetTimezoneByID", "x-ms-examples": { "Successfully retrieve timezone by ID": { @@ -187,7 +188,8 @@ }, "/timezone/byCoordinates/{format}": { "get": { - "description": "__Time Zone by Coordinates__\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location.", + "summary": "Use to get the current, historical, and future time zone information for the specified latitude-longitude pair.", + "description": "\n\nThe `Get Timezone By Coordinates` API is an HTTP `GET` request that returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location.", "operationId": "Timezone_GetTimezoneByCoordinates", "x-ms-examples": { "Successfully retrieve timezone by coordinates": { @@ -250,7 +252,8 @@ }, "/timezone/enumWindows/{format}": { "get": { - "description": "__Windows Time Zones__\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns a full list of Windows Time Zone IDs.", + "summary": "Use to get the list of Windows Time Zone IDs.", + "description": "\n\nThe `Get Windows Time Zones` API is an HTTP `GET` request that returns a full list of Windows Time Zone IDs.", "operationId": "Timezone_GetTimezoneEnumWindows", "x-ms-client-name": "GetWindowsTimezoneIds", "x-ms-examples": { @@ -284,7 +287,8 @@ }, "/timezone/enumIana/{format}": { "get": { - "description": "__IANA Time Zones__\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns a full list of IANA time zone IDs. Updates to the IANA service will be reflected in the system within one day.", + "summary": "Use to get the list of IANA time zone IDs.", + "description": "\n\nThe `Get IANA Time Zones` API is an HTTP `GET` request that returns a full list of Internet Assigned Numbers Authority (IANA) time zone IDs. Updates to the IANA service are reflected in the system within one day.", "operationId": "Timezone_GetTimezoneEnumIANA", "x-ms-client-name": "GetIANATimezoneIds", "x-ms-examples": { @@ -318,7 +322,8 @@ }, "/timezone/ianaVersion/{format}": { "get": { - "description": "__Time Zone IANA Version__\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns the current IANA version number as Metadata.", + "summary": "Use to get the current IANA version number.", + "description": "\n\nThe `Get Time Zone IANA Version` API is an HTTP `GET` request that returns the current Internet Assigned Numbers Authority (IANA) version number as Metadata.", "operationId": "Timezone_GetTimezoneIANAVersion", "x-ms-client-name": "GetIANAVersion", "x-ms-examples": { @@ -352,7 +357,8 @@ }, "/timezone/windowsToIana/{format}": { "get": { - "description": "__Windows to IANA Time Zone__\n\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThis API returns a corresponding IANA ID, given a valid Windows Time Zone ID. Multiple IANA IDs may be returned for a single Windows ID. It is possible to narrow these results by adding an optional territory parameter.", + "summary": "Use to get the IANA ID.", + "description": "\n\nThe `Get Windows to IANA Time Zone` API is an HTTP `GET` request that returns a corresponding Internet Assigned Numbers Authority (IANA) ID, given a valid Windows Time Zone ID. Multiple IANA IDs may be returned for a single Windows ID. It is possible to narrow these results by adding an optional territory parameter.", "operationId": "Timezone_GetTimezoneWindowsToIANA", "x-ms-client-name": "ConvertWindowsTimezoneToIANA", "x-ms-examples": { @@ -403,15 +409,15 @@ "definitions": { "CountryRecord": { "type": "object", - "description": "A country record.", + "description": "A country/region record.", "properties": { "Name": { - "description": "Country Name", + "description": "country/region Name", "type": "string", "readOnly": true }, "Code": { - "description": "ISO-3166 2-letter country code for the country.", + "description": "ISO-3166 2-letter country/region code for the country/region.", "type": "string", "readOnly": true } @@ -567,7 +573,7 @@ "readOnly": true }, "Aliases": { - "description": "An array of time zone ID aliases.  Only returned when [options]=*zoneinfo* or *all*.\n\nNote: may be null.", + "description": "An array of time zone ID aliases. Only returned when [options]=*zoneinfo* or *all*.\n\nNote: may be null.", "type": "array", "readOnly": true, "items": { @@ -576,7 +582,7 @@ } }, "Countries": { - "description": "An array of country records. Only returned when [options]=*zoneinfo* or *all*.", + "description": "An array of country/region records. Only returned when [options]=*zoneinfo* or *all*.", "type": "array", "readOnly": true, "items": { diff --git a/swagger-specs/maps/data-plane/Traffic/preview/1.0/traffic.json b/swagger-specs/maps/data-plane/Traffic/preview/1.0/traffic.json index 82712a952..9da76880e 100644 --- a/swagger-specs/maps/data-plane/Traffic/preview/1.0/traffic.json +++ b/swagger-specs/maps/data-plane/Traffic/preview/1.0/traffic.json @@ -18,7 +18,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management](https://aka.ms/amauthdetails) API.\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -89,7 +89,7 @@ "RasterZoom": { "name": "zoom", "in": "query", - "description": "Zoom level for the desired tile. Zoom value must be in the range: 0-22 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "description": "Zoom level for the desired tile. Zoom value must be in the range: 0-22 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.", "required": true, "type": "integer", "format": "int32", @@ -98,7 +98,7 @@ "RasterVectorZoom": { "name": "zoom", "in": "query", - "description": "Zoom level for the desired tile. For _raster_ tiles, value must be in the range: 0-22 (inclusive). For _vector_ tiles, value must be in the range: 0-22 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "description": "Zoom level for the desired tile. For _raster_ tiles, value must be in the range: 0-22 (inclusive). For _vector_ tiles, value must be in the range: 0-22 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.", "required": true, "type": "integer", "format": "int32", @@ -108,7 +108,8 @@ "paths": { "/traffic/flow/tile/{format}": { "get": { - "description": "__Traffic Flow Tile__\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Azure Flow Tile API serves 256 x 256 pixel tiles showing traffic flow. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. The Flow tiles use colors to indicate either the speed of traffic on different road segments, or the difference between that speed and the free-flow speed on the road segment in question.", + "summary": "Use to get 256 x 256 pixel tiles showing traffic flow.", + "description": "\n\nThe `Traffic Flow Tile` API is an HTTP `GET` request that returns real-time information about traffic conditions in 256 x 256 pixel tiles that show traffic flow. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. The Flow tiles use colors to indicate either the speed of traffic on different road segments, or the difference between that speed and the free-flow speed on the road segment in question.", "operationId": "Traffic_GetTrafficFlowTile", "x-ms-examples": { "Request tile depicting the traffic flow": { @@ -209,7 +210,8 @@ }, "/traffic/flow/segment/{format}": { "get": { - "description": "__Traffic Flow Segment__\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis service provides information about the speeds and travel times of the road fragment closest to the given coordinates. It is designed to work alongside the Flow layer of the Render Service to support clickable flow data visualizations. With this API, the client side can connect any place in the map with flow data on the closest road and present it to the user.", + "summary": "Use to get information about the speeds and travel times of the specified section of road.", + "description": "\n\nThe `Traffic Flow Segment` API is an HTTP `GET` request that provides information about the speeds and travel times of the road fragment closest to the given coordinates. It is designed to work alongside the Flow layer of the [Render](/rest/api/maps/render) Service to support clickable flow data visualizations. With the `Traffic Flow Segment` API, the client side can connect any place in the map with flow data on the closest road and present it to the user.", "operationId": "Traffic_GetTrafficFlowSegment", "x-ms-examples": { "Request traffic flow segment information": { @@ -315,7 +317,8 @@ }, "/traffic/incident/tile/{format}": { "get": { - "description": "__Traffic Incident Tile__\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis service serves 256 x 256 pixel tiles showing traffic incidents. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. Traffic tiles render graphics to indicate traffic on the roads in the specified area.", + "summary": "Use to get 256 x 256 pixel tiles showing traffic incidents.", + "description": "\n\nThe `Traffic Incident Tile` API is an HTTP `GET` request that returns 256 x 256 pixel tiles showing traffic incidents. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. Traffic tiles render graphics to indicate traffic on the roads in the specified area.", "operationId": "Traffic_GetTrafficIncidentTile", "x-ms-examples": { "Request a tile depicting a traffic incident": { @@ -380,7 +383,7 @@ "name": "t", "x-ms-client-name": "trafficState", "in": "query", - "description": "Reference value for the state of traffic at a particular time, obtained from the Viewport API call, trafficModelId attribute in trafficState field. It is updated every minute, and is valid for two minutes before it times out. Use -1 to get the most recent traffic information. Default: most recent traffic information.", + "description": "Reference value for the state of traffic at a particular time, obtained from the Viewport API call, trafficModelId attribute in trafficState field. It is updated every minute, and is valid for two minutes before it times out. Use -1 to get the most recent traffic information. Default: most recent traffic information.", "type": "string" } ], @@ -414,7 +417,8 @@ }, "/traffic/incident/detail/{format}": { "get": { - "description": "__Traffic Incident Detail__ \n\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API provides information on traffic incidents inside a given bounding box, based on the current Traffic Model ID. The Traffic Model ID is available to grant synchronization of data between calls and API's. The Traffic Model ID is a key value for determining the currency of traffic incidents. It is updated every minute, and is valid for two minutes before it times out. It is used in rendering [incident tiles](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidenttile). It can be obtained from the [Viewport API](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidentviewport).", + "summary": "Use to get information on traffic incidents inside a given bounding box.", + "description": "\n\nThe `Traffic Incident Detail` API is an HTTP `GET` request that provides information on traffic incidents inside a given bounding box, based on the current [Traffic Model ID](#uri-parameters). The Traffic Model ID is available to grant synchronization of data between calls and API's. The Traffic Model ID is a key value for determining the currency of traffic incidents. It is updated every minute, and is valid for two minutes before it times out. It is used in rendering [incident tiles](https://docs.microsoft.com/rest/api/maps/traffic/gettrafficincidenttile). It can be obtained from the [Viewport](https://docs.microsoft.com/rest/api/maps/traffic/gettrafficincidentviewport) API.", "operationId": "Traffic_GetTrafficIncidentDetail", "x-ms-examples": { "Request information about a traffic incident": { @@ -434,7 +438,7 @@ { "name": "style", "in": "query", - "description": "The style that will be used to render the tile in Traffic [Incident Tile API](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidenttile). This will have an effect on the coordinates of traffic incidents in the reply.", + "description": "The style that will be used to render the tile in Traffic [Incident Tile](https://docs.microsoft.com/rest/api/maps/traffic/gettrafficincidenttile) API. This will have an effect on the coordinates of traffic incidents in the reply.", "required": true, "type": "string", "enum": [ @@ -493,14 +497,14 @@ { "name": "trafficmodelid", "in": "query", - "description": "Number referencing traffic model. This can be obtained from the [Viewport API](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidentviewport). It is updated every minute, and is valid for two minutes before it times out. If the wrong Traffic Model ID is specified, the correct one will be returned by the interface. A value of -1 will always invoke the most recent traffic model", + "description": "Number referencing traffic model. This can be obtained from the [Viewport](https://docs.microsoft.com/rest/api/maps/traffic/gettrafficincidentviewport) API. It is updated every minute, and is valid for two minutes before it times out. If the wrong Traffic Model ID is specified, the correct one will be returned by the interface. A value of -1 will always invoke the most recent traffic model", "required": true, "type": "string" }, { "name": "language", "in": "query", - "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the output language. Supported languages are ar, ca, cs, da, de, el, en, en-GB, en-US, es, et, fi, fr, he, hu, id, in*, it, lt, lv, nb, nl, no, pl, pt, ro, ru, sk, sv, th, tr, zh.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. When invalid language code is provided response is returned in English. When incident cause or description does not have translation, English description is returned.", + "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the output language. Supported languages are ar, ca, cs, da, de, el, en, en-GB, en-US, es, et, fi, fr, he, hu, id, in*, it, lt, lv, nb, nl, no, pl, pt, ro, ru, sk, sv, th, tr, zh.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. When invalid language code is provided response is returned in English. When incident cause or description does not have translation, English description is returned.", "type": "string" }, { @@ -579,7 +583,8 @@ }, "/traffic/incident/viewport/{format}": { "get": { - "description": "__Traffic Incident Viewport__\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API returns legal and technical information for the viewport described in the request. It should be called by client applications whenever the viewport changes (for instance, through zooming, panning, going to a location, or displaying a route). The request should contain the bounding box and zoom level of the viewport whose information is needed. The return will contain map version information, as well as the current Traffic Model ID and copyright IDs. The Traffic Model ID returned by the Viewport Description is used by other APIs to retrieve last traffic information for further processing.", + "summary": "Use to get legal and technical information for a viewport.", + "description": "\n\nThe `Traffic Incident Viewport` API is an HTTP `GET` request that returns legal and technical information for the viewport described in the request. It should be called by client applications whenever the viewport changes (for instance, through zooming, panning, going to a location, or displaying a route). The request should contain the bounding box and zoom level of the viewport whose information is needed. The return will contain map version information, as well as the current Traffic Model ID and copyright IDs. The Traffic Model ID returned by the Viewport Description is used by other APIs to retrieve last traffic information for further processing.", "operationId": "Traffic_GetTrafficIncidentViewport", "x-ms-examples": { "Request traffic incident information for the selected viewport": { @@ -707,7 +712,7 @@ "readOnly": true }, "confidence": { - "description": "The confidence is a measure of the quality of the provided travel time and speed. A value of 1 means full confidence, that the response contains the highest quality data. Lower values indicate the degree that the response may vary from the actual conditions on the road. Any value greater than 0.6 means the information was based on real-time probe input. A value of 0.5 means the reported speed is based on historical info. A value between 0.5 and 0.6 has a calculated weighted average between historical and live speeds.", + "description": "The confidence is a measure of the quality of the provided travel time and speed. A value of 1 means full confidence, that the response contains the highest quality data. Lower values indicate the degree that the response may vary from the actual conditions on the road. Any value greater than 0.6 means the information was based on real-time probe input. A value of 0.5 means the reported speed is based on historical info. A value between 0.5 and 0.6 has a calculated weighted average between historical and live speeds.", "type": "number", "readOnly": true }, diff --git a/swagger-specs/maps/data-plane/Weather/stable/1.1/weather.json b/swagger-specs/maps/data-plane/Weather/stable/1.1/weather.json index dc29f822a..884079234 100644 --- a/swagger-specs/maps/data-plane/Weather/stable/1.1/weather.json +++ b/swagger-specs/maps/data-plane/Weather/stable/1.1/weather.json @@ -17,7 +17,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management](https://aka.ms/amauthdetails) API.\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -259,7 +259,8 @@ "paths": { "/weather/forecast/hourly/{format}": { "get": { - "description": "**Get Hourly Forecast**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nRequest detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, humidity, wind, precipitation, and ultraviolet (UV) index.\n\nIn S0 you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). In S1 you can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days).", + "summary": "Use to get a detailed hourly weather forecast for up to 24 hours or a daily forecast for up to 10 days.", + "description": "\n\nThe `Get Hourly Forecast` API is an HTTP `GET` that Request detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, humidity, wind, precipitation, and ultraviolet (UV) index. For more information, see [Request hourly weather forecast data](/azure/azure-maps/how-to-request-weather-data#request-hourly-weather-forecast-data).\n\nIf you are using the Gen1 S0 pricing tier, you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). If you are using Gen1 S1 or Gen2 pricing tier, you can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days).", "operationId": "Weather_GetHourlyForecast", "x-ms-examples": { "Successfully retrieve detailed weather forecast by the hour": { @@ -307,7 +308,8 @@ }, "/weather/forecast/minute/{format}": { "get": { - "description": "**Get Minute Forecast**\n \n \n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Minute Forecast service returns minute-by-minute forecasts for a given location for the next 120 minutes. Users can request weather forecasts in the interval of 1, 5 and 15 minutes. The response will include details such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation intensity value (dBZ).", + "summary": "Use to get a minute-by-minute forecast for the next 120 minutes in intervals of 1, 5 and 15 minutes.", + "description": "\n\nThe `Get Minute Forecast` API is an HTTP `GET` request that returns minute-by-minute forecasts for a given location for the next 120 minutes. Users can request weather forecasts in intervals of 1, 5 and 15 minutes. The response will include details such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation intensity value (dBZ). For more information, see [Request minute-by-minute weather forecast data](/azure/azure-maps/how-to-request-weather-data#request-minute-by-minute-weather-forecast-data).", "operationId": "Weather_GetMinuteForecast", "x-ms-examples": { "Successfully retrieve minute-by-minute forecasts for a given location": { @@ -352,7 +354,8 @@ }, "/weather/forecast/quarterDay/{format}": { "get": { - "description": "**Get Quarter-Day Forecast**\n\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nService returns detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details such as temperature, humidity, wind, precipitation, and UV index are returned.", + "summary": "Use to get a Quarter-Day Forecast for the next 1, 5, 10, or 15 days.", + "description": "\n\nThe `Get Quarter-Day Forecast` API is an HTTP `GET` request that returns a detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details such as temperature, humidity, wind, precipitation, and UV index are returned.", "operationId": "Weather_GetQuarterDayForecast", "x-ms-examples": { "Successfully retrieve detailed weather forecast by a given location": { @@ -400,7 +403,8 @@ }, "/weather/currentConditions/{format}": { "get": { - "description": "**Get Current Conditions**\n \n \n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Current Conditions service returns detailed current weather conditions such as precipitation, temperature and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular location can be retrieved. The basic information returned with the response include details such as observation date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and temperature. Additional details such as RealFeel™ Temperature and UV index are also returned.", + "summary": "Use to get current weather conditions.", + "description": "\n\nThe `Get Current Conditions` API is an HTTP `GET` request that returns detailed current weather conditions such as precipitation, temperature and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular location can be retrieved. The basic information returned with The response includes details such as observation date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and temperature. Additional details such as RealFeel™ Temperature and UV index are also returned. For more information, see [Request real-time weather data](/azure/azure-maps/how-to-request-weather-data#request-real-time-weather-data)", "operationId": "Weather_GetCurrentConditions", "x-ms-examples": { "Successfully retrieve detailed current weather conditions for a given coordinate location": { @@ -454,7 +458,8 @@ }, "/weather/forecast/daily/{format}": { "get": { - "description": "**Get Daily Forecast**\n \n \n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe service returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, 25, or 45 days for a given coordinate location. The response include details such as temperature, wind, precipitation, air quality, and UV index.\n\nIn S0 you can request daily forecast for the next 1, 5, 10, and 15 days. In S1 you can also request daily forecast for the next 25 days, and 45 days.", + "summary": "Use to get a daily detailed weather forecast for the next 1, 5, 10, 15, 25, or 45 days.", + "description": "\n\nThe `Get Daily Forecast` API is an HTTP `GET` request that returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, 25, or 45 days for a given coordinate location. The response includes details such as temperature, wind, precipitation, air quality, and UV index. For more information, see [Request daily weather forecast data](/azure/azure-maps/how-to-request-weather-data#request-daily-weather-forecast-data).\n\n If you are using the Gen1 S0 pricing tier, you can request daily forecast for the next 1, 5, 10, and 15 days. If you are using Gen1 S1 or Gen2 pricing tier, you can also request daily forecast for the next 25 days, and 45 days.", "operationId": "Weather_GetDailyForecast", "x-ms-examples": { "Successfully retrieve detailed daily weather forecast for a given coordinate location": { @@ -502,7 +507,8 @@ }, "/weather/route/{format}": { "get": { - "description": "**Get Weather along route**\n \n \n **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n Weather along a route API returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, weather hazard assessments, and notifications along a route described as a sequence of waypoints. \n This includes a list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might be used to paint each portion of a route according to how safe it is for the driver. When submitting the waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. Data is updated every five minutes. \n \n The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows you to first request a route between an origin and a destination and use that as an input for Weather Along Route endpoint.\n \n In addition, the service supports scenarios to generate weather notifications for waypoints that experience an increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing the end product to display a heavy rain notification before the driver reaches that waypoint. \n The trigger for when to display the notification for a waypoint could be based, for example, on a [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the waypoint.\n\n The API covers all regions of the planet except latitudes above Greenland and Antarctica.", + "summary": "Use to get a locationally precise, up-to-the-minute forecast that includes weather hazard assessments and notifications along a route.", + "description": "\n\nThe `Get Weather Along Route` API is an HTTP `GET` request that returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, weather hazard assessments, and notifications along a route described as a sequence of waypoints. \n This includes a list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might be used to paint each portion of a route according to how safe it is for the driver. When submitting the waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. Data is updated every five minutes. \n \n The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows you to first request a route between an origin and a destination and use that as an input for Weather Along Route endpoint.\n \n In addition, the service supports scenarios to generate weather notifications for waypoints that experience an increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing the end product to display a heavy rain notification before the driver reaches that waypoint. \n The trigger for when to display the notification for a waypoint could be based, for example, on a [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the waypoint.\n\n The API covers all regions of the planet except latitudes above Greenland and Antarctica.", "operationId": "Weather_GetWeatherAlongRoute", "x-ms-examples": { "Successfully retrieve detailed weather casts along a route described as a sequence of waypoints": { @@ -545,10 +551,11 @@ }, "/weather/severe/alerts/{format}": { "get": { - "description": "**Get Severe Weather Alerts**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nSevere weather phenomenon can significantly impact our everyday life and business operations. For example, severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of refrigerated food products.  Azure Maps Severe Weather Alerts API returns the severe weather alerts that are available worldwide from both official Government Meteorological Agencies and leading global to regional weather alert providers. The service can return details such as alert type, category, level and detailed description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, heat waves or forest fires.", + "summary": "Use to get information about severe weather conditions such as hurricanes, thunderstorms, flooding, lightning, heat waves or forest fires for a given location.", + "description": "\n\nSevere weather phenomenon can significantly impact our everyday life and business operations. For example, severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of refrigerated food products. \n\n The `Get Severe Weather Alerts` API is an HTTP `GET` request that returns the severe weather alerts that are available worldwide from both official Government Meteorological Agencies and leading global to regional weather alert providers. The service can return details such as alert type, category, level and detailed description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, heat waves or forest fires. For more information, see [Request severe weather alerts](/azure-maps/how-to-request-weather-data#request-severe-weather-alerts)", "operationId": "Weather_GetSevereWeatherAlerts", "x-ms-examples": { - "Successfully retrieve severe weather alerts": { + "Successfully retrieve severe weather alerts": { "$ref": "./examples/GetSevereWeatherAlerts.json" } }, @@ -590,7 +597,8 @@ }, "/weather/indices/daily/{format}": { "get": { - "description": "**Get Daily Indices**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThere may be times when you want to know if the weather conditions are optimal for a specific activity, for example, for outdoor construction, indoor activities, running or farming including soil moisture information. Azure Maps Indices API returns index values that will guide end users to plan future activities. For example, a health mobile application can notify users that today is good weather for running or for other outdoors activities like for playing golf, and retail stores can optimize their digital marketing campaigns based on predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days starting from current day.", + "summary": "Use when you want to know if the weather conditions are optimal for a specific activity such as outdoor sporting activities, construction, or farming (results includes soil moisture information).", + "description": "\n\nThe `Get Daily Indices` API is an HTTP `GET` request returns index values that provide guidance to help when planning future activities. For example, a health mobile application can notify users that today is good weather for running or for other outdoors activities like playing golf or flying a kite. Retail stores can optimize their digital marketing campaigns based on predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days starting from current day.", "operationId": "Weather_GetDailyIndices", "x-ms-examples": { "Successfully retrieve daily indices values from current day": { @@ -621,13 +629,13 @@ }, { "name": "indexId", - "description": "Numeric index identifier that can be used for restricting returned results to the corresponding index type. Cannot be paired with `indexGroupId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported indices.", + "description": "Numeric index identifier that can be used for restricting returned results to the corresponding index type. Cannot be paired with `indexGroupId`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#index-ids-and-index-groups-ids) for details and to see the supported indices.", "in": "query", "type": "integer" }, { "name": "indexGroupId", - "description": "Numeric index group identifier that can be used for restricting returned results to the corresponding subset of indices (index group). Cannot be paired with `indexId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index groups.", + "description": "Numeric index group identifier that can be used for restricting returned results to the corresponding subset of indices (index group). Cannot be paired with `indexId`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#index-ids-and-index-groups-ids) for details and to see the supported index groups.", "in": "query", "type": "integer" } @@ -647,7 +655,8 @@ }, "/weather/tropical/storms/active/{format}": { "get": { - "description": "**Get Tropical Storm Active**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet all government-issued active tropical storms. Information about the tropical storms includes, government ID, basin ID, year of origin, name and if it is subtropical.", + "summary": "Use to get a list of the active tropical storms issued by national weather forecasting agencies.", + "description": "\n\nThe `Get Tropical Storm Active` API is an HTTP `GET` request that returns a list of all government-issued active tropical storms. Information about the tropical storms includes, government ID, basin ID, year of origin, name and if it is subtropical.", "operationId": "Weather_GetTropicalStormActive", "x-ms-examples": { "Get Tropical Storm Active": { @@ -680,7 +689,8 @@ }, "/weather/tropical/storms/{format}": { "get": { - "description": "**Get Tropical Storm Search**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nSearch government-issued tropical storms by year, basin ID, and government ID. Information about the tropical storms includes, government ID, basin ID, status, year, name and if it is subtropical.", + "summary": "Use to get a list of storms issued by national weather forecasting agencies.", + "description": "\n\nThe `Get Tropical Storm Search` API is an HTTP `GET` request that returns a list of government-issued tropical storms by year, basin ID, and government ID. Information about the tropical storms includes, government ID, basin ID, status, year, name and if it is subtropical.", "operationId": "Weather_GetTropicalStormSearch", "x-ms-client-name": "SearchTropicalStorm", "x-ms-examples": { @@ -726,7 +736,8 @@ }, "/weather/tropical/storms/forecasts/{format}": { "get": { - "description": "**Get Tropical Storm Forecasts**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet individual government-issued tropical storm forecasts. Information about the forecasted tropical storms includes, location, status, date the forecast was created, window, wind speed and wind radii.", + "summary": "Use to get a list of tropical storms forecasted by national weather forecasting agencies.", + "description": "\n\nThe `Get Tropical Storm Forecasts` API is an HTTP `GET` request that returns individual government-issued tropical storm forecasts. Information about the forecasted tropical storms includes, location, status, date the forecast was created, window, wind speed and wind radii.", "operationId": "Weather_GetTropicalStormForecast", "x-ms-examples": { "Get Tropical Storm Forecasts": { @@ -785,7 +796,8 @@ }, "/weather/tropical/storms/locations/{format}": { "get": { - "description": "**Get Tropical Storm Locations**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet location of individual government-issued tropical storms. Information about the tropical storms includes, location coordinates, geometry, basin ID, date, wind details and wind radii.", + "summary": "Use to get the location of tropical storms from individual national weather forecasting agencies.", + "description": "\n\nThe `Get Tropical Storm Locations` API is an HTTP `GET` request that returns the location of individual government-issued tropical storms. Information about the tropical storms includes, location coordinates, geometry, basin ID, date, wind details and wind radii.", "operationId": "Weather_GetTropicalStormLocations", "x-ms-examples": { "Get Tropical Storm Locations": { @@ -847,7 +859,8 @@ }, "/weather/airQuality/current/{format}": { "get": { - "description": "**Get Current Air Quality**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet detailed information about the concentration of pollutants and overall status for current air quality. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", + "summary": "Use to get current air quality information that includes potential risks and suggested precautions.", + "description": "\n\nThe `Get Current Air Quality` API is an HTTP `GET` request that returns detailed information about the concentration of pollutants and overall status for current air quality, including pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", "operationId": "Weather_GetCurrentAirQuality", "x-ms-examples": { "Get Current Air Quality": { @@ -889,7 +902,8 @@ }, "/weather/airQuality/forecasts/daily/{format}": { "get": { - "description": "**Get Air Quality Daily Forecasts**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet detailed information about the concentration of pollutants and overall status of forecasted daily air quality. The service can provide forecasted daily air quality information for the upcoming 1 to 7 days. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", + "summary": "Use to get daily air quality forecasts for the next one to seven days that include pollutant levels, potential risks and suggested precautions.", + "description": "\n\nThe `Get Air Quality Daily Forecasts` API is an HTTP `GET` request that returns detailed information about the concentration of pollutants and overall status of forecasted daily air quality. The service can provide forecasted daily air quality information for the upcoming 1 to 7 days, including pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", "operationId": "Weather_GetAirQualityDailyForecasts", "x-ms-examples": { "Get Daily Air Quality Forecasts": { @@ -986,7 +1000,8 @@ }, "/weather/airQuality/forecasts/hourly/{format}": { "get": { - "description": "**Get Air Quality Hourly Forecasts**\n\n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nGet detailed information about the concentration of pollutants and overall status for forecasted upcoming hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans of 1, 12, 24, 48, 72, and 96 hours. Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", + "summary": "Use to get hourly air quality forecasts for the next one to 96 hours that include pollutant levels, potential risks and suggested precautions.", + "description": "\n\nThe `Get Air Quality Hourly Forecasts` API is an HTTP `GET` request that returns detailed information about the concentration of pollutants and overall status for forecasted upcoming hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans of 1, 12, 24, 48, 72, and 96 hours, including pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.", "operationId": "Weather_GetAirQualityHourlyForecasts", "x-ms-examples": { "Get Hourly Air Quality Forecasts": { @@ -1080,7 +1095,8 @@ }, "/weather/historical/actuals/daily/{format}": { "get": { - "description": "**Get Daily Historical Actuals**\n \n \n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Daily Historical Actuals service returns climatology data such as past daily actual observed temperatures, precipitation, snowfall, snow depth and cooling/heating degree day information, for the day at a given coordinate location. The data is requested for a specified date range, up to 31 days in a single API request. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", + "summary": "Use to get climatology data such as past daily actual observed temperatures, precipitation, snowfall and snow depth.", + "description": "\n\nThe `Get Daily Historical Actuals` API is an HTTP `GET` request that returns climatology data such as past daily actual observed temperatures, precipitation, snowfall, snow depth and cooling/heating degree day information, for the day at a given coordinate location. The data is requested for a specified date range, up to 31 days in a single API request. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", "operationId": "Weather_GetDailyHistoricalActuals", "x-ms-examples": { "Successful Daily Historical Actuals Request": { @@ -1135,7 +1151,8 @@ }, "/weather/historical/records/daily/{format}": { "get": { - "description": "**Get Daily Historical Records**\n \n \n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Daily Historical Records service returns climatology data such as past daily record temperatures, precipitation and snowfall at a given coordinate location. Availability of records data will vary by location. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", + "summary": "Use to get climatology data such as past daily record temperatures, precipitation and snowfall at a given location.", + "description": "\n\nThe `Get Daily Historical Records` API is an HTTP `GET` request that returns climatology data such as past daily record temperatures, precipitation and snowfall at a given coordinate location. Availability of records data will vary by location. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", "operationId": "Weather_GetDailyHistoricalRecords", "x-ms-examples": { "Successful Daily Historical Records Request": { @@ -1190,7 +1207,8 @@ }, "/weather/historical/normals/daily/{format}": { "get": { - "description": "**Get Daily Historical Normals**\n \n \n**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nGet Daily Historical Normals service returns climatology data such as past daily normal temperatures, precipitation and cooling/heating degree day information for the day at a given coordinate location. Normals are a 30-year average for temperatures and precipitation for a specific location. As is standard practice in climatology, the 30-year average covers years 1991-2020, this data will be used for one decade and then will reset in the year 2030. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", + "summary": "Use to get climatology data such as past daily normal temperatures, precipitation and cooling/heating degree day information for a given location.", + "description": "\n\nThe `Get Daily Historical Normals` API is an HTTP `GET` request that returns climatology data such as past daily normal temperatures, precipitation and cooling/heating degree day information for the day at a given coordinate location. The historical normals are a 30-year average for temperatures and precipitation for a specific location. As is standard practice in climatology, the 30-year average covers years 1991-2020, this data will be used for one decade and then will reset in the year 2030. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", "operationId": "Weather_GetDailyHistoricalNormals", "x-ms-examples": { "Successful Daily Historical Normals Request": { @@ -1248,7 +1266,7 @@ "IconCode": { "type": "integer", "format": "int32", - "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details.", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons) for details.", "enum": [ 1, 2, @@ -1505,7 +1523,7 @@ "UnitType": { "type": "integer", "format": "int32", - "description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details.", + "description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unittype) for details.", "enum": [ 0, 1, @@ -2399,7 +2417,7 @@ }, "obstructionsToVisibility": { "type": "string", - "description": "Cause of limited visibility." + "description": "Cause of limited visibility.\n\nPossible values:\n\n- _A = heavy thunderstorm/hail_\n- _BD = blowing dust_\n- _BN = blowing sand_\n- _BS = blowing snow_\n- _D = dust_\n- _F = fog_\n- _GF = ground fog_\n- _HZ = haze_\n- _I = ice_\n- _IC = ice crystals_\n- _IF = ice fog_\n- _IP = ice pellets_\n- _IPW = ice pellets shower_\n- _K = smoke_\n- _L = drizzle_\n- _R = rain_\n- _RS = rain/snow_\n- _RW = rain shower_\n- _S = snow_\n- _SG = snow granules_\n- _SP = snow pellets_\n- _SW = snow shower_\n- _T = thunderstorm_\n- _UP = undefined precipitation_\n- _ZL = freezing drizzle_\n- _ZR = freezing rain_\n- _+ = heavy_\n- _- = light_" }, "cloudCover": { "type": "integer", @@ -3110,7 +3128,7 @@ "indexId": { "type": "integer", "format": "int32", - "description": "Numeric ID used to identify the specific index. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index IDs. For example, the index ID can support UI visualization scenarios." + "description": "Numeric ID used to identify the specific index. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#daily-index-range-sets) for details and to see the supported index IDs. For example, the index ID can support UI visualization scenarios." }, "dateTime": { "type": "string", @@ -3120,7 +3138,7 @@ "value": { "type": "number", "format": "float", - "description": "Index value. Ranges from 0.0 to 10.0. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported ranges." + "description": "Index value. Ranges from 0.0 to 10.0. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#daily-index-range-sets) for details and to see the supported ranges." }, "category": { "x-ms-client-name": "categoryDescription", @@ -3931,7 +3949,7 @@ "unitType": { "type": "integer", "format": "int32", - "description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + "description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#daily-index-range-sets) for details." }, "year": { "type": "integer", diff --git a/swagger-specs/maps/data-plane/api-set.json b/swagger-specs/maps/data-plane/api-set.json index a10a85426..3904d3e4f 100644 --- a/swagger-specs/maps/data-plane/api-set.json +++ b/swagger-specs/maps/data-plane/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Common/stable/2023-06-01/common.json", "Creator/stable/2023-07-01/alias.json", "Creator/stable/2023-07-01/dataset.json", "Creator/stable/2023-07-01/dwgconversion.json", "Creator/stable/2023-07-01/features.json", "Creator/stable/2023-07-01/featurestate.json", "Creator/stable/2023-07-01/mapconfiguration.json", "Creator/stable/2023-07-01/style.json", "Creator/stable/2023-07-01/tileset.json", "Microsoft.Maps/Data/preview/2.0/data.json", "DataRegistry/stable/2023-06-01/dataregistry.json", "Geolocation/preview/1.0/geolocation.json", "Render/stable/2022-08-01/render.json", "Route/preview/1.0/route.json", "Search/stable/2023-06-01/search.json", "Spatial/stable/2022-08-01/spatial.json", "Timezone/preview/1.0/timezone.json", "Traffic/preview/1.0/traffic.json", "Weather/stable/1.1/weather.json"], "name": "package-stable-2023-07-01"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Common/stable/2023-06-01/common.json", "DataRegistry/stable/2023-06-01/dataregistry.json", "Geolocation/preview/1.0/geolocation.json", "Data/preview/2.0/data.json", "Render/stable/2022-08-01/render.json", "Route/preview/1.0/route.json", "Search/stable/2023-06-01/search.json", "Spatial/stable/2022-08-01/spatial.json", "Timezone/preview/1.0/timezone.json", "Traffic/preview/1.0/traffic.json", "Weather/stable/1.1/weather.json"], "name": "package-stable-2023-06-01"} \ No newline at end of file diff --git a/swagger-specs/marketplacecatalog/resource-manager/Keys/api-set.json b/swagger-specs/marketplacecatalog/resource-manager/Keys/api-set.json new file mode 100644 index 000000000..8517233fc --- /dev/null +++ b/swagger-specs/marketplacecatalog/resource-manager/Keys/api-set.json @@ -0,0 +1 @@ +{"addition_input_file_paths": [], "input_files": ["stable/2023-01-01-preview/discoveryKeys.json"], "name": "package-2023-01-01-preview"} \ No newline at end of file diff --git a/swagger-specs/marketplacecatalog/resource-manager/Keys/stable/2023-01-01-preview/discoveryKeys.json b/swagger-specs/marketplacecatalog/resource-manager/Keys/stable/2023-01-01-preview/discoveryKeys.json new file mode 100644 index 000000000..d2c77da20 --- /dev/null +++ b/swagger-specs/marketplacecatalog/resource-manager/Keys/stable/2023-01-01-preview/discoveryKeys.json @@ -0,0 +1,247 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Marketplace Discovery API Keys Management", + "description": "This API is designed to streamline the process of generating designated keys for accessing all Marketplace Catalog APIs. By utilizing a simple POST operation, users can effortlessly generate a unique API key, granting access to Marketplace Catalog APIs from version 2023-01-01 and beyond.", + "version": "2023-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/keys/{apiKeyAlias}/create": { + "post": { + "tags": [ + "CreateApiKey" + ], + "summary": "Generates an API key, granting access to the full range of Marketplace Catalog APIs. Please note that this API is currently in a preview state and requires sign-up to the 'Discovery Api Key Early Access' preview feature using a valid Azure subscription. For more information on this process please see the documentation for Marketplace Catalog APIs [here](https://learn.microsoft.com/en-us/rest/api/marketplacecatalog/dataplane/products/get?view=rest-marketplacecatalog-dataplane-2023-05-01-preview&tabs=HTTP)", + "operationId": "CreateApiKey_Post", + "x-ms-examples": { + "Create_Key": { + "$ref": "./examples/CreateKey.json" + } + }, + "parameters": [ + { + "type": "string", + "name": "apiKeyAlias", + "in": "path", + "required": true, + "description": "Alias for new API Key. This alias must be unique and contain only alphanumeric characters separated by dashes." + }, + { + "type": "string", + "name": "x-ms-client-tenant-id", + "x-originalName": "tenantId", + "description": "The tenant associated with the subscription.", + "in": "header", + "required": true, + "x-nullable": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "x-nullable": false, + "description": "Returns the newly created API key.", + "schema": { + "$ref": "#/definitions/ApiKey" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/keys/{apiKeyAlias}/revoke": { + "post": { + "tags": [ + "RevokeApiKey" + ], + "summary": "Revokes an active API key. Please note that this API is currently in a preview state and requires sign-up to the 'Discovery Api Key Early Access' preview feature using a valid Azure subscription. For more information on this process please see the documentation for Marketplace Catalog APIs [here](https://learn.microsoft.com/en-us/rest/api/marketplacecatalog/dataplane/products/get?view=rest-marketplacecatalog-dataplane-2023-05-01-preview&tabs=HTTP)", + "operationId": "RevokeApiKey_Post", + "x-ms-examples": { + "Revoke_Key": { + "$ref": "./examples/RevokeKey.json" + } + }, + "parameters": [ + { + "type": "string", + "name": "apiKeyAlias", + "description": "The alias of your API key.", + "in": "path", + "required": true + }, + { + "type": "string", + "name": "x-ms-client-tenant-id", + "x-originalName": "tenantId", + "description": "The tenant associated with the subscription.", + "in": "header", + "required": true, + "x-nullable": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Indicates that the API key was successfully revoked." + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/keys": { + "get": { + "tags": [ + "GetApiKeys" + ], + "summary": "Retrieves a list of API keys associated with a selected subscription. Please note that this API is currently in a preview state and requires sign-up to the 'Discovery Api Key Early Access' preview feature using a valid Azure subscription. For more information on this process please see the documentation for Marketplace Catalog APIs [here](https://learn.microsoft.com/en-us/rest/api/marketplacecatalog/dataplane/products/get?view=rest-marketplacecatalog-dataplane-2023-05-01-preview&tabs=HTTP)", + "operationId": "GetApiKeys_List", + "x-ms-examples": { + "Get_Key": { + "$ref": "./examples/GetKeys.json" + } + }, + "parameters": [ + { + "type": "string", + "name": "x-ms-client-tenant-id", + "x-originalName": "tenantId", + "description": "The tenant associated with the subscription.", + "in": "header", + "required": true, + "x-nullable": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "x-nullable": false, + "description": "List of active keys that belong to the subscription.", + "schema": { + "$ref": "#/definitions/ApiKeys" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Marketplace/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Microsoft.Marketplace REST API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_Get": { + "$ref": "./examples/Operations_Get.json" + } + } + } + } + }, + "definitions": { + "ApiKeys": { + "type": "object", + "description": "List of ApiKey objects.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiKey" + } + }, + "nextLink": { + "description": "Next page of results.", + "type": "string" + } + } + }, + "ApiKey": { + "type": "object", + "description": "ApiKey object containing both the key and its alias.", + "properties": { + "keyAlias": { + "description": "The API key alias.", + "type": "string" + }, + "key": { + "description": "The API key to be used when calling relevant Discovery endpoints.", + "type": "string" + } + } + } + }, + "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" + } + } + } +} diff --git a/swagger-specs/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2023-03-15/migrate.json b/swagger-specs/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2023-03-15/migrate.json deleted file mode 100644 index 369a72f91..000000000 --- a/swagger-specs/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2023-03-15/migrate.json +++ /dev/null @@ -1,14482 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Migrate Assessment Service", - "version": "2023-03-15", - "description": "Azure Migrate Resource Provider management API.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "host": "management.azure.com", - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow.", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "tags": [ - { - "name": "Operations" - }, - { - "name": "AssessmentProjectsOperations" - }, - { - "name": "AssessmentProjectSummaryOperations" - }, - { - "name": "MachinesOperations" - }, - { - "name": "GroupsOperations" - }, - { - "name": "AssessmentsOperations" - }, - { - "name": "AssessmentOptionsOperations" - }, - { - "name": "AssessedMachinesOperations" - }, - { - "name": "HypervCollectorsOperations" - }, - { - "name": "VmwareCollectorsOperations" - }, - { - "name": "ServerCollectorsOperations" - }, - { - "name": "ImportCollectorsOperations" - }, - { - "name": "PrivateEndpointConnectionOperations" - }, - { - "name": "PrivateLinkResourceOperations" - }, - { - "name": "AvsAssessmentsOperations" - }, - { - "name": "AvsAssessmentOptionsOperations" - }, - { - "name": "AvsAssessedMachinesOperations" - }, - { - "name": "SqlAssessmentV2SummaryOperations" - }, - { - "name": "SqlAssessmentV2Operations" - }, - { - "name": "SqlAssessmentOptionsOperations" - }, - { - "name": "AssessedSqlMachinesOperations" - }, - { - "name": "AssessedSqlRecommendedEntityOperations" - }, - { - "name": "AssessedSqlInstanceV2Operations" - }, - { - "name": "AssessedSqlDatabaseV2Operations" - }, - { - "name": "SqlCollectorOperations" - } - ], - "paths": { - "/providers/Microsoft.Migrate/operations": { - "get": { - "operationId": "Operations_List", - "tags": [ - "Operations" - ], - "description": "List the operations for the provider", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Operations_List_MaximumSet_Gen": { - "$ref": "./examples/Operations_List_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Migrate/assessmentProjects": { - "get": { - "operationId": "AssessmentProjectsOperations_ListBySubscription", - "tags": [ - "AssessmentProjectsOperations" - ], - "description": "List AssessmentProject resources by subscription ID", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessmentProjectListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen": { - "$ref": "./examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects": { - "get": { - "operationId": "AssessmentProjectsOperations_ListByResourceGroup", - "tags": [ - "AssessmentProjectsOperations" - ], - "description": "List AssessmentProject resources by resource group", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessmentProjectListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen": { - "$ref": "./examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}": { - "get": { - "operationId": "AssessmentProjectsOperations_Get", - "tags": [ - "AssessmentProjectsOperations" - ], - "description": "Get a AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessmentProject" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AssessmentProjectsOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json" - } - } - }, - "put": { - "operationId": "AssessmentProjectsOperations_Create", - "tags": [ - "AssessmentProjectsOperations" - ], - "description": "Create a AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/AssessmentProject" - } - } - ], - "responses": { - "200": { - "description": "Resource 'AssessmentProject' update operation succeeded", - "schema": { - "$ref": "#/definitions/AssessmentProject" - } - }, - "201": { - "description": "Resource 'AssessmentProject' create operation succeeded", - "schema": { - "$ref": "#/definitions/AssessmentProject" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "AssessmentProjectsOperations_Create_MaximumSet_Gen": { - "$ref": "./examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json" - } - } - }, - "patch": { - "operationId": "AssessmentProjectsOperations_Update", - "tags": [ - "AssessmentProjectsOperations" - ], - "description": "Update a AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "properties", - "in": "body", - "description": "The resource properties to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AssessmentProjectUpdate" - } - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessmentProject" - } - }, - "202": { - "description": "Resource update request accepted.", - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "AssessmentProjectsOperations_Update_MaximumSet_Gen": { - "$ref": "./examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json" - } - } - }, - "delete": { - "operationId": "AssessmentProjectsOperations_Delete", - "tags": [ - "AssessmentProjectsOperations" - ], - "description": "Delete a AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AssessmentProjectsOperations_Delete_MaximumSet_Gen": { - "$ref": "./examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions": { - "get": { - "operationId": "AssessmentOptionsOperations_ListByAssessmentProject", - "tags": [ - "AssessmentOptionsOperations" - ], - "description": "List AssessmentOptions resources by AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessmentOptionsListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { - "$ref": "./examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions/{assessmentOptionsName}": { - "get": { - "operationId": "AssessmentOptionsOperations_Get", - "tags": [ - "AssessmentOptionsOperations" - ], - "description": "Get a AssessmentOptions", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentOptionsName", - "in": "path", - "description": " assessment options ARM name. Accepted value is 'default'", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessmentOptions" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AssessmentOptionsOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions": { - "get": { - "operationId": "AvsAssessmentOptionsOperations_ListByAssessmentProject", - "tags": [ - "AvsAssessmentOptionsOperations" - ], - "description": "List AvsAssessmentOptions resources by AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AvsAssessmentOptionsListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { - "$ref": "./examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions/{avsAssessmentOptionsName}": { - "get": { - "operationId": "AvsAssessmentOptionsOperations_Get", - "tags": [ - "AvsAssessmentOptionsOperations" - ], - "description": "Get a AvsAssessmentOptions", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "avsAssessmentOptionsName", - "in": "path", - "description": "AVS Assessment options ARM name. Accepted value is 'default'", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AvsAssessmentOptions" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AvsAssessmentOptionsOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups": { - "get": { - "operationId": "GroupsOperations_ListByAssessmentProject", - "tags": [ - "GroupsOperations" - ], - "description": "List Group resources by AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/GroupListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GroupsOperations_ListByAssessmentProject_MaximumSet_Gen": { - "$ref": "./examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}": { - "get": { - "operationId": "GroupsOperations_Get", - "tags": [ - "GroupsOperations" - ], - "description": "Get a Group", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/Group" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GroupsOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/GroupsOperations_Get_MaximumSet_Gen.json" - } - } - }, - "put": { - "operationId": "GroupsOperations_Create", - "tags": [ - "GroupsOperations" - ], - "description": "Create a Group", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/Group" - } - } - ], - "responses": { - "200": { - "description": "Resource 'Group' update operation succeeded", - "schema": { - "$ref": "#/definitions/Group" - } - }, - "201": { - "description": "Resource 'Group' create operation succeeded", - "schema": { - "$ref": "#/definitions/Group" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "GroupsOperations_Create_MaximumSet_Gen": { - "$ref": "./examples/GroupsOperations_Create_MaximumSet_Gen.json" - } - } - }, - "delete": { - "operationId": "GroupsOperations_Delete", - "tags": [ - "GroupsOperations" - ], - "description": "Delete a Group", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GroupsOperations_Delete_MaximumSet_Gen": { - "$ref": "./examples/GroupsOperations_Delete_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments": { - "get": { - "operationId": "AssessmentsOperations_ListByGroup", - "tags": [ - "AssessmentsOperations" - ], - "description": "List Assessment resources by Group", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessmentListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AssessmentsOperations_ListByGroup_MaximumSet_Gen": { - "$ref": "./examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}": { - "get": { - "operationId": "AssessmentsOperations_Get", - "tags": [ - "AssessmentsOperations" - ], - "description": "Get a Assessment", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "Machine Assessment ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/Assessment" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AssessmentsOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/AssessmentsOperations_Get_MaximumSet_Gen.json" - } - } - }, - "put": { - "operationId": "AssessmentsOperations_Create", - "tags": [ - "AssessmentsOperations" - ], - "description": "Create a Assessment", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "Machine Assessment ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/Assessment" - } - } - ], - "responses": { - "200": { - "description": "Resource 'Assessment' update operation succeeded", - "schema": { - "$ref": "#/definitions/Assessment" - } - }, - "201": { - "description": "Resource 'Assessment' create operation succeeded", - "schema": { - "$ref": "#/definitions/Assessment" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "AssessmentsOperations_Create_MaximumSet_Gen": { - "$ref": "./examples/AssessmentsOperations_Create_MaximumSet_Gen.json" - } - } - }, - "delete": { - "operationId": "AssessmentsOperations_Delete", - "tags": [ - "AssessmentsOperations" - ], - "description": "Delete a Assessment", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "Machine Assessment ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AssessmentsOperations_Delete_MaximumSet_Gen": { - "$ref": "./examples/AssessmentsOperations_Delete_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines": { - "get": { - "operationId": "AssessedMachinesOperations_ListByAssessment", - "tags": [ - "AssessedMachinesOperations" - ], - "description": "List AssessedMachine resources by Assessment", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "$filter", - "in": "query", - "description": "Filter query.", - "required": false, - "type": "string" - }, - { - "name": "pageSize", - "in": "query", - "description": "Optional parameter for page size.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "continuationToken", - "in": "query", - "description": "Optional parameter for continuation token.", - "required": false, - "type": "string" - }, - { - "name": "totalRecordCount", - "in": "query", - "description": "Total record count.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "Machine Assessment ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessedMachineListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen": { - "$ref": "./examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName}": { - "get": { - "operationId": "AssessedMachinesOperations_Get", - "tags": [ - "AssessedMachinesOperations" - ], - "description": "Get a AssessedMachine", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "Machine Assessment ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessedMachineName", - "in": "path", - "description": "Machine assessment Assessed Machine ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessedMachine" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AssessedMachinesOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/downloadUrl": { - "post": { - "operationId": "AssessmentsOperations_DownloadUrl", - "tags": [ - "AssessmentsOperations" - ], - "summary": "Get download URL for the assessment report.", - "description": "Get the URL for downloading the assessment in a report format.", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "Machine Assessment ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "body", - "in": "body", - "description": "The content of the action request", - "required": true, - "schema": { - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/DownloadUrl" - } - }, - "202": { - "description": "Resource operation accepted.", - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "AssessmentsOperations_DownloadUrl_MaximumSet_Gen": { - "$ref": "./examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments": { - "get": { - "operationId": "AvsAssessmentsOperations_ListByGroup", - "tags": [ - "AvsAssessmentsOperations" - ], - "description": "List AvsAssessment resources by Group", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AvsAssessmentListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen": { - "$ref": "./examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}": { - "get": { - "operationId": "AvsAssessmentsOperations_Get", - "tags": [ - "AvsAssessmentsOperations" - ], - "description": "Get a AvsAssessment", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "AVS Assessment ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AvsAssessment" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AvsAssessmentsOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json" - } - } - }, - "put": { - "operationId": "AvsAssessmentsOperations_Create", - "tags": [ - "AvsAssessmentsOperations" - ], - "description": "Create a AvsAssessment", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "AVS Assessment ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/AvsAssessment" - } - } - ], - "responses": { - "200": { - "description": "Resource 'AvsAssessment' update operation succeeded", - "schema": { - "$ref": "#/definitions/AvsAssessment" - } - }, - "201": { - "description": "Resource 'AvsAssessment' create operation succeeded", - "schema": { - "$ref": "#/definitions/AvsAssessment" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "AvsAssessmentsOperations_Create_MaximumSet_Gen": { - "$ref": "./examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json" - } - } - }, - "delete": { - "operationId": "AvsAssessmentsOperations_Delete", - "tags": [ - "AvsAssessmentsOperations" - ], - "description": "Delete a AvsAssessment", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "AVS Assessment ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AvsAssessmentsOperations_Delete_MaximumSet_Gen": { - "$ref": "./examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines": { - "get": { - "operationId": "AvsAssessedMachinesOperations_ListByAvsAssessment", - "tags": [ - "AvsAssessedMachinesOperations" - ], - "description": "List AvsAssessedMachine resources by AvsAssessment", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "$filter", - "in": "query", - "description": "Filter query.", - "required": false, - "type": "string" - }, - { - "name": "pageSize", - "in": "query", - "description": "Optional parameter for page size.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "continuationToken", - "in": "query", - "description": "Optional parameter for continuation token.", - "required": false, - "type": "string" - }, - { - "name": "totalRecordCount", - "in": "query", - "description": "Total record count.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "AVS Assessment ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AvsAssessedMachineListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen": { - "$ref": "./examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines/{avsAssessedMachineName}": { - "get": { - "operationId": "AvsAssessedMachinesOperations_Get", - "tags": [ - "AvsAssessedMachinesOperations" - ], - "description": "Get a AvsAssessedMachine", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "AVS Assessment ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "avsAssessedMachineName", - "in": "path", - "description": "AVS assessment Assessed Machine ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AvsAssessedMachine" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AvsAssessedMachinesOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/downloadUrl": { - "post": { - "operationId": "AvsAssessmentsOperations_DownloadUrl", - "tags": [ - "AvsAssessmentsOperations" - ], - "summary": "Get download URL for the assessment report.", - "description": "Get the URL for downloading the assessment in a report format.", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "AVS Assessment ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "body", - "in": "body", - "description": "The content of the action request", - "required": true, - "schema": { - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/DownloadUrl" - } - }, - "202": { - "description": "Resource operation accepted.", - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen": { - "$ref": "./examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments": { - "get": { - "operationId": "SqlAssessmentV2Operations_ListByGroup", - "tags": [ - "SqlAssessmentV2Operations" - ], - "description": "List SqlAssessmentV2 resources by Group", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/SqlAssessmentV2ListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen": { - "$ref": "./examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}": { - "get": { - "operationId": "SqlAssessmentV2Operations_Get", - "tags": [ - "SqlAssessmentV2Operations" - ], - "description": "Get a SqlAssessmentV2", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/SqlAssessmentV2" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "SqlAssessmentV2Operations_Get_MaximumSet_Gen": { - "$ref": "./examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json" - } - } - }, - "put": { - "operationId": "SqlAssessmentV2Operations_Create", - "tags": [ - "SqlAssessmentV2Operations" - ], - "description": "Create a SqlAssessmentV2", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/SqlAssessmentV2" - } - } - ], - "responses": { - "200": { - "description": "Resource 'SqlAssessmentV2' update operation succeeded", - "schema": { - "$ref": "#/definitions/SqlAssessmentV2" - } - }, - "201": { - "description": "Resource 'SqlAssessmentV2' create operation succeeded", - "schema": { - "$ref": "#/definitions/SqlAssessmentV2" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "SqlAssessmentV2Operations_Create_MaximumSet_Gen": { - "$ref": "./examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json" - } - } - }, - "delete": { - "operationId": "SqlAssessmentV2Operations_Delete", - "tags": [ - "SqlAssessmentV2Operations" - ], - "description": "Delete a SqlAssessmentV2", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "SqlAssessmentV2Operations_Delete_MaximumSet_Gen": { - "$ref": "./examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases": { - "get": { - "operationId": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", - "tags": [ - "AssessedSqlDatabaseV2Operations" - ], - "description": "List AssessedSqlDatabaseV2 resources by SqlAssessmentV2", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "$filter", - "in": "query", - "description": "Filter query.", - "required": false, - "type": "string" - }, - { - "name": "pageSize", - "in": "query", - "description": "Optional parameter for page size.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "continuationToken", - "in": "query", - "description": "Optional parameter for continuation token.", - "required": false, - "type": "string" - }, - { - "name": "totalRecordCount", - "in": "query", - "description": "Total record count.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessedSqlDatabaseV2ListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen": { - "$ref": "./examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases/{assessedSqlDatabaseName}": { - "get": { - "operationId": "AssessedSqlDatabaseV2Operations_Get", - "tags": [ - "AssessedSqlDatabaseV2Operations" - ], - "description": "Get a AssessedSqlDatabaseV2", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessedSqlDatabaseName", - "in": "path", - "description": "Sql assessment Assessed Databases ARM name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessedSqlDatabaseV2" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen": { - "$ref": "./examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances": { - "get": { - "operationId": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", - "tags": [ - "AssessedSqlInstanceV2Operations" - ], - "description": "List AssessedSqlInstanceV2 resources by SqlAssessmentV2", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "$filter", - "in": "query", - "description": "Filter query.", - "required": false, - "type": "string" - }, - { - "name": "pageSize", - "in": "query", - "description": "Optional parameter for page size.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "continuationToken", - "in": "query", - "description": "Optional parameter for continuation token.", - "required": false, - "type": "string" - }, - { - "name": "totalRecordCount", - "in": "query", - "description": "Total record count.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessedSqlInstanceV2ListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen": { - "$ref": "./examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances/{assessedSqlInstanceName}": { - "get": { - "operationId": "AssessedSqlInstanceV2Operations_Get", - "tags": [ - "AssessedSqlInstanceV2Operations" - ], - "description": "Get a AssessedSqlInstanceV2", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessedSqlInstanceName", - "in": "path", - "description": "Sql assessment Assessed Instance ARM name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessedSqlInstanceV2" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen": { - "$ref": "./examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines": { - "get": { - "operationId": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", - "tags": [ - "AssessedSqlMachinesOperations" - ], - "description": "List AssessedSqlMachine resources by SqlAssessmentV2", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "$filter", - "in": "query", - "description": "Filter query.", - "required": false, - "type": "string" - }, - { - "name": "pageSize", - "in": "query", - "description": "Optional parameter for page size.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "continuationToken", - "in": "query", - "description": "Optional parameter for continuation token.", - "required": false, - "type": "string" - }, - { - "name": "totalRecordCount", - "in": "query", - "description": "Total record count.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessedSqlMachineListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { - "$ref": "./examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines/{assessedSqlMachineName}": { - "get": { - "operationId": "AssessedSqlMachinesOperations_Get", - "tags": [ - "AssessedSqlMachinesOperations" - ], - "description": "Get a AssessedSqlMachine", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessedSqlMachineName", - "in": "path", - "description": "Sql assessment Assessed Machine ARM name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessedSqlMachine" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AssessedSqlMachinesOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/downloadUrl": { - "post": { - "operationId": "SqlAssessmentV2Operations_DownloadUrl", - "tags": [ - "SqlAssessmentV2Operations" - ], - "summary": "Get download URL for the assessment report.", - "description": "Get the URL for downloading the assessment in a report format.", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "body", - "in": "body", - "description": "The content of the action request", - "required": true, - "schema": { - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/DownloadUrl" - } - }, - "202": { - "description": "Resource operation accepted.", - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen": { - "$ref": "./examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities": { - "get": { - "operationId": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", - "tags": [ - "AssessedSqlRecommendedEntityOperations" - ], - "description": "List AssessedSqlRecommendedEntity resources by SqlAssessmentV2", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "$filter", - "in": "query", - "description": "Filter query.", - "required": false, - "type": "string" - }, - { - "name": "pageSize", - "in": "query", - "description": "Optional parameter for page size.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "continuationToken", - "in": "query", - "description": "Optional parameter for continuation token.", - "required": false, - "type": "string" - }, - { - "name": "totalRecordCount", - "in": "query", - "description": "Total record count.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessedSqlRecommendedEntityListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { - "$ref": "./examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities/{recommendedAssessedEntityName}": { - "get": { - "operationId": "AssessedSqlRecommendedEntityOperations_Get", - "tags": [ - "AssessedSqlRecommendedEntityOperations" - ], - "description": "Get a AssessedSqlRecommendedEntity", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "recommendedAssessedEntityName", - "in": "path", - "description": "Sql assessment Assessed Recommended Entity ARM name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessedSqlRecommendedEntity" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries": { - "get": { - "operationId": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", - "tags": [ - "SqlAssessmentV2SummaryOperations" - ], - "description": "List SqlAssessmentV2Summary resources by SqlAssessmentV2", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/SqlAssessmentV2SummaryListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { - "$ref": "./examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries/{summaryName}": { - "get": { - "operationId": "SqlAssessmentV2SummaryOperations_Get", - "tags": [ - "SqlAssessmentV2SummaryOperations" - ], - "description": "Get a SqlAssessmentV2Summary", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentName", - "in": "path", - "description": "SQL Assessment arm name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "summaryName", - "in": "path", - "description": "Gets the Name of the SQL Summary.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/SqlAssessmentV2Summary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/updateMachines": { - "post": { - "operationId": "GroupsOperations_UpdateMachines", - "tags": [ - "GroupsOperations" - ], - "summary": "Update machines in group.", - "description": "Update machines in group by adding or removing machines.", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "groupName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "body", - "in": "body", - "description": "The content of the action request", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateGroupBody" - } - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/Group" - } - }, - "202": { - "description": "Resource operation accepted.", - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "GroupsOperations_UpdateMachines_MaximumSet_Gen": { - "$ref": "./examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors": { - "get": { - "operationId": "HypervCollectorsOperations_ListByAssessmentProject", - "tags": [ - "HypervCollectorsOperations" - ], - "description": "List HypervCollector resources by AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/HypervCollectorListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { - "$ref": "./examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors/{hypervCollectorName}": { - "get": { - "operationId": "HypervCollectorsOperations_Get", - "tags": [ - "HypervCollectorsOperations" - ], - "description": "Get a HypervCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "hypervCollectorName", - "in": "path", - "description": "Hyper-V collector ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/HypervCollector" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "HypervCollectorsOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json" - } - } - }, - "put": { - "operationId": "HypervCollectorsOperations_Create", - "tags": [ - "HypervCollectorsOperations" - ], - "description": "Create a HypervCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "hypervCollectorName", - "in": "path", - "description": "Hyper-V collector ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/HypervCollector" - } - } - ], - "responses": { - "200": { - "description": "Resource 'HypervCollector' update operation succeeded", - "schema": { - "$ref": "#/definitions/HypervCollector" - } - }, - "201": { - "description": "Resource 'HypervCollector' create operation succeeded", - "schema": { - "$ref": "#/definitions/HypervCollector" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "HypervCollectorsOperations_Create_MaximumSet_Gen": { - "$ref": "./examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json" - } - } - }, - "delete": { - "operationId": "HypervCollectorsOperations_Delete", - "tags": [ - "HypervCollectorsOperations" - ], - "description": "Delete a HypervCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "hypervCollectorName", - "in": "path", - "description": "Hyper-V collector ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "HypervCollectorsOperations_Delete_MaximumSet_Gen": { - "$ref": "./examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors": { - "get": { - "operationId": "ImportCollectorsOperations_ListByAssessmentProject", - "tags": [ - "ImportCollectorsOperations" - ], - "description": "List ImportCollector resources by AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/ImportCollectorListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { - "$ref": "./examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors/{importCollectorName}": { - "get": { - "operationId": "ImportCollectorsOperations_Get", - "tags": [ - "ImportCollectorsOperations" - ], - "description": "Get a ImportCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "importCollectorName", - "in": "path", - "description": "Import collector ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/ImportCollector" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ImportCollectorsOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json" - } - } - }, - "put": { - "operationId": "ImportCollectorsOperations_Create", - "tags": [ - "ImportCollectorsOperations" - ], - "description": "Create a ImportCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "importCollectorName", - "in": "path", - "description": "Import collector ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/ImportCollector" - } - } - ], - "responses": { - "200": { - "description": "Resource 'ImportCollector' update operation succeeded", - "schema": { - "$ref": "#/definitions/ImportCollector" - } - }, - "201": { - "description": "Resource 'ImportCollector' create operation succeeded", - "schema": { - "$ref": "#/definitions/ImportCollector" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "ImportCollectorsOperations_Create_MaximumSet_Gen": { - "$ref": "./examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json" - } - } - }, - "delete": { - "operationId": "ImportCollectorsOperations_Delete", - "tags": [ - "ImportCollectorsOperations" - ], - "description": "Delete a ImportCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "importCollectorName", - "in": "path", - "description": "Import collector ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ImportCollectorsOperations_Delete_MaximumSet_Gen": { - "$ref": "./examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines": { - "get": { - "operationId": "MachinesOperations_ListByAssessmentProject", - "tags": [ - "MachinesOperations" - ], - "description": "List Machine resources by AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "$filter", - "in": "query", - "description": "Filter query.", - "required": false, - "type": "string" - }, - { - "name": "pageSize", - "in": "query", - "description": "Optional parameter for page size.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "continuationToken", - "in": "query", - "description": "Optional parameter for continuation token.", - "required": false, - "type": "string" - }, - { - "name": "totalRecordCount", - "in": "query", - "description": "Total record count.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/MachineListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "MachinesOperations_ListByAssessmentProject_MaximumSet_Gen": { - "$ref": "./examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines/{machineName}": { - "get": { - "operationId": "MachinesOperations_Get", - "tags": [ - "MachinesOperations" - ], - "description": "Get a Machine", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "machineName", - "in": "path", - "description": "Assessible Machine ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/Machine" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "MachinesOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/MachinesOperations_Get_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections": { - "get": { - "operationId": "PrivateEndpointConnectionOperations_ListByAssessmentProject", - "tags": [ - "PrivateEndpointConnectionOperations" - ], - "description": "List PrivateEndpointConnection resources by AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnectionListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen": { - "$ref": "./examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}": { - "get": { - "operationId": "PrivateEndpointConnectionOperations_Get", - "tags": [ - "PrivateEndpointConnectionOperations" - ], - "description": "Get a PrivateEndpointConnection", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "Private endpoint connection ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateEndpointConnectionOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json" - } - } - }, - "put": { - "operationId": "PrivateEndpointConnectionOperations_Update", - "tags": [ - "PrivateEndpointConnectionOperations" - ], - "description": "Create a PrivateEndpointConnection", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "Private endpoint connection ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - } - ], - "responses": { - "200": { - "description": "Resource 'PrivateEndpointConnection' update operation succeeded", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - }, - "201": { - "description": "Resource 'PrivateEndpointConnection' create operation succeeded", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "PrivateEndpointConnectionOperations_Update_MaximumSet_Gen": { - "$ref": "./examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json" - } - } - }, - "delete": { - "operationId": "PrivateEndpointConnectionOperations_Delete", - "tags": [ - "PrivateEndpointConnectionOperations" - ], - "description": "Delete a PrivateEndpointConnection", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "Private endpoint connection ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen": { - "$ref": "./examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources": { - "get": { - "operationId": "PrivateLinkResourceOperations_ListByAssessmentProject", - "tags": [ - "PrivateLinkResourceOperations" - ], - "description": "List PrivateLinkResource resources by AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/PrivateLinkResourceListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen": { - "$ref": "./examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources/{privateLinkResourceName}": { - "get": { - "operationId": "PrivateLinkResourceOperations_Get", - "tags": [ - "PrivateLinkResourceOperations" - ], - "description": "Get a PrivateLinkResource", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "privateLinkResourceName", - "in": "path", - "description": "Private link resource ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/PrivateLinkResource" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateLinkResourceOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary": { - "get": { - "operationId": "AssessmentProjectSummaryOperations_ListByAssessmentProject", - "tags": [ - "AssessmentProjectSummaryOperations" - ], - "description": "List AssessmentProjectSummary resources by AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessmentProjectSummaryListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen": { - "$ref": "./examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary/{projectSummaryName}": { - "get": { - "operationId": "AssessmentProjectSummaryOperations_Get", - "tags": [ - "AssessmentProjectSummaryOperations" - ], - "description": "Get a AssessmentProjectSummary", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "projectSummaryName", - "in": "path", - "description": "Group ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssessmentProjectSummary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AssessmentProjectSummaryOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors": { - "get": { - "operationId": "ServerCollectorsOperations_ListByAssessmentProject", - "tags": [ - "ServerCollectorsOperations" - ], - "description": "List ServerCollector resources by AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/ServerCollectorListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { - "$ref": "./examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors/{serverCollectorName}": { - "get": { - "operationId": "ServerCollectorsOperations_Get", - "tags": [ - "ServerCollectorsOperations" - ], - "description": "Get a ServerCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "serverCollectorName", - "in": "path", - "description": "Physical server collector ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/ServerCollector" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ServerCollectorsOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json" - } - } - }, - "put": { - "operationId": "ServerCollectorsOperations_Create", - "tags": [ - "ServerCollectorsOperations" - ], - "description": "Create a ServerCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "serverCollectorName", - "in": "path", - "description": "Physical server collector ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/ServerCollector" - } - } - ], - "responses": { - "200": { - "description": "Resource 'ServerCollector' update operation succeeded", - "schema": { - "$ref": "#/definitions/ServerCollector" - } - }, - "201": { - "description": "Resource 'ServerCollector' create operation succeeded", - "schema": { - "$ref": "#/definitions/ServerCollector" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "ServerCollectorsOperations_Create_MaximumSet_Gen": { - "$ref": "./examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json" - } - } - }, - "delete": { - "operationId": "ServerCollectorsOperations_Delete", - "tags": [ - "ServerCollectorsOperations" - ], - "description": "Delete a ServerCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "serverCollectorName", - "in": "path", - "description": "Physical server collector ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ServerCollectorsOperations_Delete_MaximumSet_Gen": { - "$ref": "./examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions": { - "get": { - "operationId": "SqlAssessmentOptionsOperations_ListByAssessmentProject", - "tags": [ - "SqlAssessmentOptionsOperations" - ], - "description": "List SqlAssessmentOptions resources by AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/SqlAssessmentOptionsListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { - "$ref": "./examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions/{assessmentOptionsName}": { - "get": { - "operationId": "SqlAssessmentOptionsOperations_Get", - "tags": [ - "SqlAssessmentOptionsOperations" - ], - "description": "Get a SqlAssessmentOptions", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "assessmentOptionsName", - "in": "path", - "description": "Sql assessment options ARM name. Accepted values is 'default'", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/SqlAssessmentOptions" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "SqlAssessmentOptionsOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors": { - "get": { - "operationId": "SqlCollectorOperations_ListByAssessmentProject", - "tags": [ - "SqlCollectorOperations" - ], - "description": "List SqlCollector resources by AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/SqlCollectorListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen": { - "$ref": "./examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}": { - "get": { - "operationId": "SqlCollectorOperations_Get", - "tags": [ - "SqlCollectorOperations" - ], - "description": "Get a SqlCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "collectorName", - "in": "path", - "description": "Sql collector ARM name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/SqlCollector" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "SqlCollectorOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/SqlCollectorOperations_Get_MaximumSet_Gen.json" - } - } - }, - "put": { - "operationId": "SqlCollectorOperations_Create", - "tags": [ - "SqlCollectorOperations" - ], - "description": "Create a SqlCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "collectorName", - "in": "path", - "description": "Sql collector ARM name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/SqlCollector" - } - } - ], - "responses": { - "200": { - "description": "Resource 'SqlCollector' update operation succeeded", - "schema": { - "$ref": "#/definitions/SqlCollector" - } - }, - "201": { - "description": "Resource 'SqlCollector' create operation succeeded", - "schema": { - "$ref": "#/definitions/SqlCollector" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "SqlCollectorOperations_Create_MaximumSet_Gen": { - "$ref": "./examples/SqlCollectorOperations_Create_MaximumSet_Gen.json" - } - } - }, - "delete": { - "operationId": "SqlCollectorOperations_Delete", - "tags": [ - "SqlCollectorOperations" - ], - "description": "Delete a SqlCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "collectorName", - "in": "path", - "description": "Sql collector ARM name.", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "SqlCollectorOperations_Delete_MaximumSet_Gen": { - "$ref": "./examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors": { - "get": { - "operationId": "VmwareCollectorsOperations_ListByAssessmentProject", - "tags": [ - "VmwareCollectorsOperations" - ], - "description": "List VmwareCollector resources by AssessmentProject", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/VmwareCollectorListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { - "$ref": "./examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors/{vmWareCollectorName}": { - "get": { - "operationId": "VmwareCollectorsOperations_Get", - "tags": [ - "VmwareCollectorsOperations" - ], - "description": "Get a VmwareCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "vmWareCollectorName", - "in": "path", - "description": "VMware collector ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/VmwareCollector" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "VmwareCollectorsOperations_Get_MaximumSet_Gen": { - "$ref": "./examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json" - } - } - }, - "put": { - "operationId": "VmwareCollectorsOperations_Create", - "tags": [ - "VmwareCollectorsOperations" - ], - "description": "Create a VmwareCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "vmWareCollectorName", - "in": "path", - "description": "VMware collector ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/VmwareCollector" - } - } - ], - "responses": { - "200": { - "description": "Resource 'VmwareCollector' update operation succeeded", - "schema": { - "$ref": "#/definitions/VmwareCollector" - } - }, - "201": { - "description": "Resource 'VmwareCollector' create operation succeeded", - "schema": { - "$ref": "#/definitions/VmwareCollector" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "VmwareCollectorsOperations_Create_MaximumSet_Gen": { - "$ref": "./examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json" - } - } - }, - "delete": { - "operationId": "VmwareCollectorsOperations_Delete", - "tags": [ - "VmwareCollectorsOperations" - ], - "description": "Delete a VmwareCollector", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "projectName", - "in": "path", - "description": "Assessment Project Name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - }, - { - "name": "vmWareCollectorName", - "in": "path", - "description": "VMware collector ARM name", - "required": true, - "type": "string", - "pattern": "^[^<>&:\\?/#]{1,260}$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "VmwareCollectorsOperations_Delete_MaximumSet_Gen": { - "$ref": "./examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json" - } - } - } - } - }, - "definitions": { - "ApiVersions": { - "type": "string", - "description": "Common API Versions for Assessment Project Tracked Resource.", - "enum": [ - "2019-10-01", - "2020-01-01", - "2020-05-01-preview", - "2022-02-02-preview", - "2023-03-03", - "2023-03-15", - "2023-04-01-preview", - "2023-07-07-preview" - ], - "x-ms-enum": { - "name": "ApiVersions", - "modelAsString": true, - "values": [ - { - "name": "v2019_10_01", - "value": "2019-10-01", - "description": "2019-10-01 API Version." - }, - { - "name": "v2020_01_01", - "value": "2020-01-01", - "description": "2020-01-01 API Version." - }, - { - "name": "v2020_05_01_preview", - "value": "2020-05-01-preview", - "description": "2020-05-01-preview API Version." - }, - { - "name": "v2022_02_02_preview", - "value": "2022-02-02-preview", - "description": "2022-02-02-preview API Version." - }, - { - "name": "v2023_03_03", - "value": "2023-03-03", - "description": "2023-03-03 API Version." - }, - { - "name": "v2023_03_15", - "value": "2023-03-15", - "description": "2023-03-15 API Version." - }, - { - "name": "v2023_04_01_preview", - "value": "2023-04-01-preview", - "description": "2023-04-01-preview API Version." - }, - { - "name": "v2023_07_07_preview", - "value": "2023-07-07-preview", - "description": "2023-07-07-preview API Version." - } - ] - } - }, - "AssessedDisk": { - "type": "object", - "properties": { - "suitability": { - "$ref": "#/definitions/CloudSuitability", - "description": "Gets the suitability." - }, - "suitabilityExplanation": { - "$ref": "#/definitions/AzureDiskSuitabilityExplanation", - "description": "Gets the suitability explanation." - }, - "suitabilityDetail": { - "$ref": "#/definitions/AzureDiskSuitabilityDetail", - "description": "Gets the suitability detail." - }, - "recommendedDiskSize": { - "$ref": "#/definitions/AzureDiskSize", - "description": "Gets the recommended disk size." - }, - "recommendedDiskType": { - "$ref": "#/definitions/AzureDiskType", - "description": "Gets the recommended disk type." - }, - "gigabytesForRecommendedDiskSize": { - "type": "integer", - "format": "int32", - "description": "Gets the recommended disk size." - }, - "recommendDiskThroughputInMbps": { - "type": "number", - "format": "float", - "description": "Gets the recommended disk throughput." - }, - "recommendedDiskIops": { - "type": "number", - "format": "float", - "description": "Gets the recommended disk iops." - }, - "monthlyStorageCost": { - "type": "number", - "format": "float", - "description": "Gets the monthly storage cost." - }, - "name": { - "type": "string", - "description": "Gets the name." - }, - "displayName": { - "type": "string", - "description": "Gets the machine display name." - }, - "gigabytesProvisioned": { - "type": "number", - "format": "float", - "description": "Gets the gigabytes provisioned." - }, - "megabytesPerSecondOfRead": { - "type": "number", - "format": "float", - "description": "Gets the megabytes per second of read." - }, - "megabytesPerSecondOfWrite": { - "type": "number", - "format": "float", - "description": "Gets the megabytes per second of write." - }, - "numberOfReadOperationsPerSecond": { - "type": "number", - "format": "float", - "description": "Gets the number of read operations per second." - }, - "numberOfWriteOperationsPerSecond": { - "type": "number", - "format": "float", - "description": "Gets the number of write operations per second." - } - } - }, - "AssessedDiskData": { - "type": "object", - "description": "Assessed Disk data. Used in Assessed SQL machine DTO.", - "properties": { - "suitability": { - "$ref": "#/definitions/CloudSuitability", - "description": "Gets the suitability." - }, - "suitabilityExplanation": { - "$ref": "#/definitions/AzureDiskSuitabilityExplanation", - "description": "Gets the suitability explanation." - }, - "suitabilityDetail": { - "$ref": "#/definitions/AzureDiskSuitabilityDetail", - "description": "Gets the suitability detail." - }, - "recommendedDiskSize": { - "$ref": "#/definitions/AzureDiskSize", - "description": "Gets the recommended disk size." - }, - "recommendedDiskType": { - "$ref": "#/definitions/AzureDiskType", - "description": "Gets the recommended disk type." - }, - "recommendedDiskSizeGigabytes": { - "type": "integer", - "format": "int32", - "description": "Gets the recommended disk size." - }, - "recommendDiskThroughputInMbps": { - "type": "number", - "format": "float", - "description": "Gets the recommended disk throughput." - }, - "recommendedDiskIops": { - "type": "number", - "format": "float", - "description": "Gets the recommended disk iops." - }, - "monthlyStorageCost": { - "type": "number", - "format": "float", - "description": "Gets the monthly storage cost." - }, - "name": { - "type": "string", - "description": "Gets the name." - }, - "displayName": { - "type": "string", - "description": "Gets the machine display name." - }, - "gigabytesProvisioned": { - "type": "number", - "format": "float", - "description": "Gets the gigabytes provisioned." - }, - "megabytesPerSecondOfRead": { - "type": "number", - "format": "float", - "description": "Gets the megabytes per second of read." - }, - "megabytesPerSecondOfWrite": { - "type": "number", - "format": "float", - "description": "Gets the megabytes per second of write." - }, - "numberOfReadOperationsPerSecond": { - "type": "number", - "format": "float", - "description": "Gets the number of read operations per second." - }, - "numberOfWriteOperationsPerSecond": { - "type": "number", - "format": "float", - "description": "Gets the number of write operations per second." - } - } - }, - "AssessedMachine": { - "type": "object", - "description": "Machine assessment Assessed Machine resource.", - "properties": { - "properties": { - "$ref": "#/definitions/AssessedMachineProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "AssessedMachineListResult": { - "type": "object", - "description": "The response of a AssessedMachine list operation.", - "properties": { - "value": { - "type": "array", - "description": "The AssessedMachine items on this page", - "items": { - "$ref": "#/definitions/AssessedMachine" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "AssessedMachineProperties": { - "type": "object", - "description": "Assessed machine properties class.", - "properties": { - "errors": { - "type": "array", - "description": "List of errors for this machine.", - "items": { - "$ref": "#/definitions/Error" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "disks": { - "type": "object", - "description": "Dictionary of disks attached to the machine. Key is ID of disk. Value is a disk object.", - "additionalProperties": { - "$ref": "#/definitions/AssessedDisk" - }, - "readOnly": true - }, - "monthlyUltraStorageCost": { - "type": "number", - "format": "float", - "description": "Monthly ultra storage cost.", - "readOnly": true - }, - "hostProcessor": { - "$ref": "#/definitions/ProcessorInfo", - "description": "Gets or sets the processor details of the host." - }, - "costComponents": { - "type": "array", - "description": "Gets or sets the collection of cost components.", - "items": { - "$ref": "#/definitions/CostComponent" - }, - "x-ms-identifiers": [] - }, - "productSupportStatus": { - "$ref": "#/definitions/ProductSupportStatus", - "description": "Gets the product support status related details.", - "readOnly": true - }, - "monthlyBandwidthCost": { - "type": "number", - "format": "float", - "description": "Monthly networking cost.", - "readOnly": true - }, - "monthlyStorageCost": { - "type": "number", - "format": "float", - "description": "Monthly storage cost.", - "readOnly": true - }, - "monthlyPremiumStorageCost": { - "type": "number", - "format": "float", - "description": "Monthly premium storage cost.", - "readOnly": true - }, - "monthlyStandardSsdStorageCost": { - "type": "number", - "format": "float", - "description": "Monthly standard SSD storage cost.", - "readOnly": true - }, - "networkAdapters": { - "type": "object", - "description": "List of Network Adapters that were assessed as part of this machine's\nassessment.", - "additionalProperties": { - "$ref": "#/definitions/AssessedNetworkAdapter" - }, - "readOnly": true - }, - "recommendedSize": { - "$ref": "#/definitions/AzureVmSize", - "description": "Recommended Azure Size for the machine.", - "readOnly": true - }, - "numberOfCoresForRecommendedSize": { - "type": "integer", - "format": "int32", - "description": "Number of cores for recommended size. Read Only.", - "readOnly": true - }, - "megabytesOfMemoryForRecommendedSize": { - "type": "number", - "format": "float", - "description": "Megabytes of memory for recommended size. Read Only.", - "readOnly": true - }, - "monthlyComputeCostForRecommendedSize": { - "type": "number", - "format": "float", - "description": "Monthly Compute cost calculated for Recommended size, for a 31-day month.", - "readOnly": true - }, - "suitabilityExplanation": { - "$ref": "#/definitions/AzureVmSuitabilityExplanation", - "description": "Gets the explanation if machine is not suitable for cloud.", - "readOnly": true - }, - "suitabilityDetail": { - "$ref": "#/definitions/AzureVmSuitabilityDetail", - "description": "Gets the details if machine is not suitable for cloud.", - "readOnly": true - }, - "type": { - "$ref": "#/definitions/AssessedMachineType", - "description": "Assessed machine type.", - "readOnly": true - }, - "bootType": { - "$ref": "#/definitions/MachineBootType", - "description": "Boot type of machine discovered in private data center.", - "readOnly": true - }, - "operatingSystemType": { - "type": "string", - "description": "Operating system as reported by datacenter management solution.", - "readOnly": true - }, - "operatingSystemName": { - "type": "string", - "description": "Operating system as reported by datacenter management solution.", - "readOnly": true - }, - "operatingSystemVersion": { - "type": "string", - "description": "Operating system version as reported by datacenter management solution.", - "readOnly": true - }, - "operatingSystemArchitecture": { - "$ref": "#/definitions/GuestOperatingSystemArchitecture", - "description": "Operating system architecture as reported by datacenter management solution.", - "readOnly": true - }, - "createdTimestamp": { - "type": "string", - "format": "date-time", - "description": "When was machine first created.", - "readOnly": true - }, - "updatedTimestamp": { - "type": "string", - "format": "date-time", - "description": "When was machine last updated.", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "Display Name of the Machine.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "Description for the machine.", - "readOnly": true - }, - "datacenterMachineArmId": { - "type": "string", - "description": "Data center machine ARM id.", - "readOnly": true - }, - "datacenterManagementServerArmId": { - "type": "string", - "description": "Data center management server ARM id.", - "readOnly": true - }, - "datacenterManagementServerName": { - "type": "string", - "description": "Data center management server name.", - "readOnly": true - }, - "megabytesOfMemory": { - "type": "number", - "format": "float", - "description": "Megabytes of memory found allocated for the machine in private data center.", - "readOnly": true - }, - "numberOfCores": { - "type": "integer", - "format": "int32", - "description": "Number of CPU cores found on the machine.", - "readOnly": true - }, - "confidenceRatingInPercentage": { - "type": "number", - "format": "float", - "description": "Confidence Rating in Percentage.", - "readOnly": true - }, - "percentageCoresUtilization": { - "type": "number", - "format": "float", - "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", - "readOnly": true - }, - "percentageMemoryUtilization": { - "type": "number", - "format": "float", - "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", - "readOnly": true - }, - "suitability": { - "$ref": "#/definitions/CloudSuitability", - "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", - "readOnly": true - } - } - }, - "AssessedMachineType": { - "type": "string", - "enum": [ - "Unknown", - "AssessedMachine", - "AvsAssessedMachine", - "SqlAssessedMachine" - ], - "x-ms-enum": { - "name": "AssessedMachineType", - "modelAsString": true - } - }, - "AssessedNetworkAdapter": { - "type": "object", - "description": "Assessed Network Adapter.", - "properties": { - "suitability": { - "$ref": "#/definitions/CloudSuitability", - "description": "Gets the suitability." - }, - "suitabilityDetail": { - "$ref": "#/definitions/AzureNetworkAdapterSuitabilityDetail", - "description": "Gets the suitability detail." - }, - "suitabilityExplanation": { - "$ref": "#/definitions/AzureNetworkAdapterSuitabilityExplanation", - "description": "Gets the suitability explanation." - }, - "monthlyBandwidthCosts": { - "type": "number", - "format": "float", - "description": "Gets the monthly bandwidth costs." - }, - "netGigabytesTransmittedPerMonth": { - "type": "number", - "format": "float", - "description": "Gets the net gigabytes transmitted per month." - }, - "displayName": { - "type": "string", - "description": "Gets the display name." - }, - "macAddress": { - "type": "string", - "description": "Gets the mac address." - }, - "ipAddresses": { - "type": "array", - "description": "Gets the ip addresses.", - "items": { - "type": "string" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "megabytesPerSecondReceived": { - "type": "number", - "format": "float", - "description": "Gets the megabytes per second received." - }, - "megabytesPerSecondTransmitted": { - "type": "number", - "format": "float", - "description": "Gets the megabytes per second transmitted." - } - } - }, - "AssessedSqlDatabaseV2": { - "type": "object", - "description": "Assessed SQL database web model class.", - "properties": { - "properties": { - "$ref": "#/definitions/AssessedSqlDatabaseV2Properties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "AssessedSqlDatabaseV2ListResult": { - "type": "object", - "description": "The response of a AssessedSqlDatabaseV2 list operation.", - "properties": { - "value": { - "type": "array", - "description": "The AssessedSqlDatabaseV2 items on this page", - "items": { - "$ref": "#/definitions/AssessedSqlDatabaseV2" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "AssessedSqlDatabaseV2Properties": { - "type": "object", - "description": "Assessed SQL database properties web model.", - "properties": { - "recommendedAzureSqlTargetType": { - "$ref": "#/definitions/TargetType", - "description": "Gets or sets the recommended azure SQL target type.", - "readOnly": true - }, - "recommendedSuitability": { - "$ref": "#/definitions/RecommendedSuitability", - "description": "Gets or sets the recommended azure SQL suitability.", - "readOnly": true - }, - "bufferCacheSizeInMB": { - "type": "number", - "format": "float", - "description": "Gets or sets the aggregated cache size of this database. This is a performance\ndata metric for this DB.", - "readOnly": true - }, - "productSupportStatus": { - "$ref": "#/definitions/ProductSupportStatus", - "description": "Gets the product support status related details.", - "readOnly": true - }, - "azureSqlMISuitabilityDetails": { - "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", - "description": "Gets or sets the azure SQL MI suitability details.", - "readOnly": true - }, - "azureSqlDBSuitabilityDetails": { - "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", - "description": "Gets or sets the azure SQL DB suitability details.", - "readOnly": true - }, - "isDatabaseHighlyAvailable": { - "type": "boolean", - "description": "Gets a value indicating whether the assessed SQL database is highly available\nor not.", - "readOnly": true - }, - "linkedAvailabilityGroupOverview": { - "$ref": "#/definitions/SqlAvailabilityGroupDataOverview", - "description": "Gets the linked availability group overview if the database being assessed is\nhighly available.", - "readOnly": true - }, - "machineArmId": { - "type": "string", - "description": "Machine arm id.", - "readOnly": true - }, - "assessedSqlInstanceArmId": { - "type": "string", - "description": "Assessed SQL instance arm id.", - "readOnly": true - }, - "machineName": { - "type": "string", - "description": "Machine display name.", - "readOnly": true - }, - "instanceName": { - "type": "string", - "description": "SQL instance name.", - "readOnly": true - }, - "databaseName": { - "type": "string", - "description": "SQL database name.", - "readOnly": true - }, - "databaseSizeInMB": { - "type": "number", - "format": "float", - "description": "SQL database size in megabytes.", - "readOnly": true - }, - "compatibilityLevel": { - "$ref": "#/definitions/CompatibilityLevel", - "description": "Database compatibility level.", - "readOnly": true - }, - "sqlDatabaseSdsArmId": { - "type": "string", - "description": "SQL database SDS arm id.", - "readOnly": true - }, - "percentageCoresUtilization": { - "type": "number", - "format": "float", - "description": "The percentage of the total number of cores being utilized by the SQL database.", - "readOnly": true - }, - "megabytesPerSecondOfRead": { - "type": "number", - "format": "float", - "description": "The read throughput of the SQL database.", - "readOnly": true - }, - "megabytesPerSecondOfWrite": { - "type": "number", - "format": "float", - "description": "The write throughput of the SQL database.", - "readOnly": true - }, - "numberOfReadOperationsPerSecond": { - "type": "number", - "format": "float", - "description": "The read operations per second of the SQL database.", - "readOnly": true - }, - "numberOfWriteOperationsPerSecond": { - "type": "number", - "format": "float", - "description": "The write operations per second of the SQL database.", - "readOnly": true - }, - "confidenceRatingInPercentage": { - "type": "number", - "format": "float", - "description": "Confidence Rating in Percentage.", - "readOnly": true - }, - "sizingCriterion": { - "$ref": "#/definitions/AssessmentSizingCriterion", - "description": "Assessment sizing criterion.", - "readOnly": true - }, - "createdTimestamp": { - "type": "string", - "format": "date-time", - "description": "When was assessed SQL database first created.", - "readOnly": true - }, - "updatedTimestamp": { - "type": "string", - "format": "date-time", - "description": "When was assessed SQL database last updated.", - "readOnly": true - } - } - }, - "AssessedSqlInstanceDatabaseSummary": { - "type": "object", - "description": "Assessed Sql Instance Database Summary.", - "properties": { - "numberOfUserDatabases": { - "type": "integer", - "format": "int32", - "description": "Gets the number of user databases." - }, - "totalDatabaseSizeInMB": { - "type": "number", - "format": "float", - "description": "Gets the total database size in MB." - }, - "largestDatabaseSizeInMB": { - "type": "number", - "format": "float", - "description": "Gets the largest database size in MB." - }, - "totalDiscoveredUserDatabases": { - "type": "integer", - "format": "int32", - "description": "Gets the total discovered user databases." - } - } - }, - "AssessedSqlInstanceDiskDetails": { - "type": "object", - "description": "Assessed Sql Instance Disk Details.", - "properties": { - "diskId": { - "type": "string", - "description": "Gets the disk id." - }, - "diskSizeInMB": { - "type": "number", - "format": "float", - "description": "Gets the disk size in mb." - }, - "megabytesPerSecondOfRead": { - "type": "number", - "format": "float", - "description": "Gets the megabytes per second of read." - }, - "megabytesPerSecondOfWrite": { - "type": "number", - "format": "float", - "description": "Gets the megabytes per second of write." - }, - "numberOfReadOperationsPerSecond": { - "type": "number", - "format": "float", - "description": "Gets the number of read operations per second." - }, - "numberOfWriteOperationsPerSecond": { - "type": "number", - "format": "float", - "description": "Gets the number of write operations per second." - } - } - }, - "AssessedSqlInstanceStorageDetails": { - "type": "object", - "description": "Assessed Sql Instance Storage Details.", - "properties": { - "storageType": { - "type": "string", - "description": "Gets the storage type." - }, - "diskSizeInMB": { - "type": "number", - "format": "float", - "description": "Gets the disk size in mb." - }, - "megabytesPerSecondOfRead": { - "type": "number", - "format": "float", - "description": "Gets the megabytes per second of read." - }, - "megabytesPerSecondOfWrite": { - "type": "number", - "format": "float", - "description": "Gets the megabytes per second of read." - }, - "numberOfReadOperationsPerSecond": { - "type": "number", - "format": "float", - "description": "Gets the number of read operations per second." - }, - "numberOfWriteOperationsPerSecond": { - "type": "number", - "format": "float", - "description": "Gets the number of write operations per second." - } - } - }, - "AssessedSqlInstanceSummary": { - "type": "object", - "description": "Assessed Sql Instance Summary.", - "properties": { - "instanceId": { - "type": "string", - "description": "Gets the instance id." - }, - "instanceName": { - "type": "string", - "description": "Gets the instance name." - }, - "sqlInstanceSdsArmId": { - "type": "string", - "description": "Gets the instance arm id." - }, - "sqlInstanceEntityId": { - "type": "string", - "description": "Gets the instance entity id." - }, - "sqlEdition": { - "type": "string", - "description": "Gets the Sql edition." - }, - "sqlVersion": { - "type": "string", - "description": "Gets the Sql version." - }, - "isClustered": { - "type": "boolean", - "description": "Gets whether Sql is clustered." - }, - "isHighAvailabilityEnabled": { - "type": "boolean", - "description": "Gets whether Sql is highly available." - }, - "sqlFciState": { - "$ref": "#/definitions/SqlFCIState", - "description": "Gets the Sql Fci state." - } - } - }, - "AssessedSqlInstanceV2": { - "type": "object", - "description": "Assessed SQL instance web model class.", - "properties": { - "properties": { - "$ref": "#/definitions/AssessedSqlInstanceV2Properties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "AssessedSqlInstanceV2ListResult": { - "type": "object", - "description": "The response of a AssessedSqlInstanceV2 list operation.", - "properties": { - "value": { - "type": "array", - "description": "The AssessedSqlInstanceV2 items on this page", - "items": { - "$ref": "#/definitions/AssessedSqlInstanceV2" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "AssessedSqlInstanceV2Properties": { - "type": "object", - "description": "Assessed SQL instance properties web model.", - "properties": { - "memoryInUseInMB": { - "type": "number", - "format": "float", - "description": "Gets or sets the memory used by SQL instance in megabytes.", - "readOnly": true - }, - "hasScanOccurred": { - "type": "boolean", - "description": "Gets or sets a value indicating whether SQL instance has been deep discovered.", - "readOnly": true - }, - "recommendedAzureSqlTargetType": { - "$ref": "#/definitions/TargetType", - "description": "Gets or sets the recommended azure SQL target type.", - "readOnly": true - }, - "recommendedSuitability": { - "$ref": "#/definitions/RecommendedSuitability", - "description": "Gets or sets the recommended azure SQL suitability.", - "readOnly": true - }, - "azureSqlMISuitabilityDetails": { - "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", - "description": "SQL instance azure SQL MI suitability details.", - "readOnly": true - }, - "azureSqlDBSuitabilityDetails": { - "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", - "description": "SQL instance azure SQL DB suitability details.", - "readOnly": true - }, - "azureSqlVMSuitabilityDetails": { - "$ref": "#/definitions/SqlAssessmentV2IaasSuitabilityData", - "description": "SQL instance azure SQL VM suitability details.", - "readOnly": true - }, - "storageTypeBasedDetails": { - "type": "array", - "description": "Gets the storage details.", - "items": { - "$ref": "#/definitions/AssessedSqlInstanceStorageDetails" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "productSupportStatus": { - "$ref": "#/definitions/ProductSupportStatus", - "description": "Gets the product support status related details.", - "readOnly": true - }, - "fciMetadata": { - "$ref": "#/definitions/SqlFCIMetadata", - "description": "Gets the FCI metadata if this instance represents an FCI instance.", - "readOnly": true - }, - "availabilityReplicaSummary": { - "$ref": "#/definitions/SqlAvailabilityReplicaSummary", - "description": "Gets the overview counts of availability replicas in the assessed instance, by\ncommit mode and read type.", - "readOnly": true - }, - "isClustered": { - "type": "boolean", - "description": "Gets a value indicating whether the SQL instance is clustered or not.", - "readOnly": true - }, - "isHighAvailabilityEnabled": { - "type": "boolean", - "description": "Gets a value indicating whether the high availability is enabled or not.", - "readOnly": true - }, - "recommendedTargetReasonings": { - "type": "array", - "description": "Gets the list of recommended target reasoning.", - "items": { - "$ref": "#/definitions/SqlRecommendationReasoning" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "machineArmId": { - "type": "string", - "description": "Machine arm id.", - "readOnly": true - }, - "machineName": { - "type": "string", - "description": "Machine display name.", - "readOnly": true - }, - "instanceName": { - "type": "string", - "description": "SQL instance name.", - "readOnly": true - }, - "sqlInstanceSdsArmId": { - "type": "string", - "description": "SQL instance SDS arm id.", - "readOnly": true - }, - "sqlEdition": { - "type": "string", - "description": "SQL instance edition.", - "readOnly": true - }, - "sqlVersion": { - "type": "string", - "description": "SQL instance version.", - "readOnly": true - }, - "numberOfCoresAllocated": { - "type": "integer", - "format": "int32", - "description": "Number of CPU cores assigned to the SQL instance.", - "readOnly": true - }, - "percentageCoresUtilization": { - "type": "number", - "format": "float", - "description": "The percentage of the total number of cores being utilized by the SQL instance.", - "readOnly": true - }, - "logicalDisks": { - "type": "array", - "description": "The logical disk details.", - "items": { - "$ref": "#/definitions/AssessedSqlInstanceDiskDetails" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "databaseSummary": { - "$ref": "#/definitions/AssessedSqlInstanceDatabaseSummary", - "description": "The databases summary.", - "readOnly": true - }, - "confidenceRatingInPercentage": { - "type": "number", - "format": "float", - "description": "Confidence Rating in Percentage.", - "readOnly": true - }, - "sizingCriterion": { - "$ref": "#/definitions/AssessmentSizingCriterion", - "description": "Assessment sizing criterion.", - "readOnly": true - }, - "createdTimestamp": { - "type": "string", - "format": "date-time", - "description": "When was assessed SQL instance first created.", - "readOnly": true - }, - "updatedTimestamp": { - "type": "string", - "format": "date-time", - "description": "When was assessed SQL instance last updated.", - "readOnly": true - } - } - }, - "AssessedSqlMachine": { - "type": "object", - "description": "SQL Assessment REST resource.", - "properties": { - "properties": { - "$ref": "#/definitions/AssessedSqlMachineProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "AssessedSqlMachineListResult": { - "type": "object", - "description": "The response of a AssessedSqlMachine list operation.", - "properties": { - "value": { - "type": "array", - "description": "The AssessedSqlMachine items on this page", - "items": { - "$ref": "#/definitions/AssessedSqlMachine" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "AssessedSqlMachineProperties": { - "type": "object", - "description": "Assessed SQL machine properties.", - "properties": { - "biosGuid": { - "type": "string", - "description": "Gets or sets the BIOS GUID for the machine.", - "readOnly": true - }, - "fqdn": { - "type": "string", - "description": "Gets or sets the FQDN for the machine.", - "readOnly": true - }, - "sqlInstances": { - "type": "array", - "description": "Gets the list of SQL instances discovered on the machine.", - "items": { - "$ref": "#/definitions/AssessedSqlInstanceSummary" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "suitabilityDetail": { - "$ref": "#/definitions/AzureVmSuitabilityDetail", - "description": "Gets or sets the detailed messages that were set on the machine during\nevaluation.", - "readOnly": true - }, - "suitabilityExplanation": { - "$ref": "#/definitions/AzureVmSuitabilityExplanation", - "description": "Gets or sets the explanation if machine is not suitable for cloud.", - "readOnly": true - }, - "recommendedVmSize": { - "$ref": "#/definitions/AzureVmSize", - "description": "Gets or sets the Recommended Azure Size for the machine.", - "readOnly": true - }, - "recommendedVmFamily": { - "$ref": "#/definitions/AzureVmFamily", - "description": "Gets or sets the Recommended Azure VM Family for the machine.", - "readOnly": true - }, - "productSupportStatus": { - "$ref": "#/definitions/ProductSupportStatus", - "description": "Gets the product support status related details.", - "readOnly": true - }, - "recommendedVmSizeNumberOfCores": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the Number of cores for recommended size.", - "readOnly": true - }, - "recommendedVmSizeMegabytesOfMemory": { - "type": "number", - "format": "float", - "description": "Gets or sets the Megabytes of memory for recommended size.", - "readOnly": true - }, - "monthlyComputeCost": { - "type": "number", - "format": "float", - "description": "Gets or sets the monthly compute cost calculated for recommended size.", - "readOnly": true - }, - "disks": { - "type": "object", - "description": "Gets the list of data disks that were assessed as part of this assessment.", - "additionalProperties": { - "$ref": "#/definitions/AssessedDiskData" - }, - "readOnly": true - }, - "networkAdapters": { - "type": "object", - "description": "Gets the list of network adapters that were assessed as part of this assessment.", - "additionalProperties": { - "$ref": "#/definitions/SqlAssessedNetworkAdapter" - }, - "readOnly": true - }, - "monthlyBandwidthCost": { - "type": "number", - "format": "float", - "description": "Gets or sets the monthly networking cost.", - "readOnly": true - }, - "monthlyStorageCost": { - "type": "number", - "format": "float", - "description": "Gets or sets the monthly total storage cost.", - "readOnly": true - }, - "costComponents": { - "type": "array", - "description": "Gets the collection of cost components.", - "items": { - "$ref": "#/definitions/CostComponent" - }, - "x-ms-identifiers": [] - }, - "securitySuitability": { - "$ref": "#/definitions/CloudSuitability", - "description": "Gets the suitability for Microsoft cloud defender.", - "readOnly": true - }, - "migrationGuidelines": { - "type": "array", - "description": "Gets the list of migration guidelines applicable.", - "items": { - "$ref": "#/definitions/SqlMigrationGuideline" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "bootType": { - "$ref": "#/definitions/MachineBootType", - "description": "Boot type of machine discovered in private data center.", - "readOnly": true - }, - "operatingSystemType": { - "type": "string", - "description": "Operating system as reported by datacenter management solution.", - "readOnly": true - }, - "operatingSystemName": { - "type": "string", - "description": "Operating system as reported by datacenter management solution.", - "readOnly": true - }, - "operatingSystemVersion": { - "type": "string", - "description": "Operating system version as reported by datacenter management solution.", - "readOnly": true - }, - "operatingSystemArchitecture": { - "$ref": "#/definitions/GuestOperatingSystemArchitecture", - "description": "Operating system architecture as reported by datacenter management solution.", - "readOnly": true - }, - "createdTimestamp": { - "type": "string", - "format": "date-time", - "description": "When was machine first created.", - "readOnly": true - }, - "updatedTimestamp": { - "type": "string", - "format": "date-time", - "description": "When was machine last updated.", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "Display Name of the Machine.", - "readOnly": true - }, - "type": { - "$ref": "#/definitions/AssessedMachineType", - "description": "Assessed machine type.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "Description for the machine.", - "readOnly": true - }, - "datacenterMachineArmId": { - "type": "string", - "description": "Data center machine ARM id.", - "readOnly": true - }, - "datacenterManagementServerArmId": { - "type": "string", - "description": "Data center management server ARM id.", - "readOnly": true - }, - "datacenterManagementServerName": { - "type": "string", - "description": "Data center management server name.", - "readOnly": true - }, - "megabytesOfMemory": { - "type": "number", - "format": "float", - "description": "Megabytes of memory found allocated for the machine in private data center.", - "readOnly": true - }, - "numberOfCores": { - "type": "integer", - "format": "int32", - "description": "Number of CPU cores found on the machine.", - "readOnly": true - }, - "confidenceRatingInPercentage": { - "type": "number", - "format": "float", - "description": "Confidence Rating in Percentage.", - "readOnly": true - }, - "percentageCoresUtilization": { - "type": "number", - "format": "float", - "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", - "readOnly": true - }, - "percentageMemoryUtilization": { - "type": "number", - "format": "float", - "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", - "readOnly": true - }, - "suitability": { - "$ref": "#/definitions/CloudSuitability", - "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", - "readOnly": true - }, - "sizingCriterion": { - "$ref": "#/definitions/AssessmentSizingCriterion", - "description": "Assessment sizing criterion.", - "readOnly": true - } - } - }, - "AssessedSqlRecommendedEntity": { - "type": "object", - "description": "SQL Assessment REST resource.", - "properties": { - "properties": { - "$ref": "#/definitions/AssessedSqlRecommendedEntityProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "AssessedSqlRecommendedEntityListResult": { - "type": "object", - "description": "The response of a AssessedSqlRecommendedEntity list operation.", - "properties": { - "value": { - "type": "array", - "description": "The AssessedSqlRecommendedEntity items on this page", - "items": { - "$ref": "#/definitions/AssessedSqlRecommendedEntity" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "AssessedSqlRecommendedEntityProperties": { - "type": "object", - "description": "Assessed SQL recommended entity properties.", - "properties": { - "machineName": { - "type": "string", - "description": "Gets or sets machine name.", - "readOnly": true - }, - "instanceName": { - "type": "string", - "description": "Gets or sets SQL instance name.", - "readOnly": true - }, - "productSupportStatus": { - "$ref": "#/definitions/ProductSupportStatus", - "description": "Gets the product support status related details.", - "readOnly": true - }, - "dbCount": { - "type": "integer", - "format": "int32", - "description": "Gets or sets assessed database count.", - "readOnly": true - }, - "discoveredDBCount": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the total discovered database count.", - "readOnly": true - }, - "hasScanOccurred": { - "type": "boolean", - "description": "Gets or sets a value indicating whether instance deep discovery has occurred or\nnot.", - "readOnly": true - }, - "recommendedAzureSqlTargetType": { - "$ref": "#/definitions/TargetType", - "description": "Gets or sets the recommended azure SQL target type.", - "readOnly": true - }, - "recommendedSuitability": { - "$ref": "#/definitions/RecommendedSuitability", - "description": "Gets or sets the recommended azure SQL suitability.", - "readOnly": true - }, - "azureSqlMISuitabilityDetails": { - "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", - "description": "SQL instance azure SQL MI suitability details.", - "readOnly": true - }, - "azureSqlDBSuitabilityDetails": { - "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", - "description": "SQL instance azure SQL DB suitability details.", - "readOnly": true - }, - "azureSqlVMSuitabilityDetails": { - "$ref": "#/definitions/SqlAssessmentV2IaasSuitabilityData", - "description": "SQL instance azure SQL VM suitability details.", - "readOnly": true - }, - "assessedSqlEntityArmId": { - "type": "string", - "description": "Gets or sets Arm id of assessed entity." - }, - "isClustered": { - "type": "boolean", - "description": "Gets or sets a value indicating whether the SQL instance is clustered or not.", - "readOnly": true - }, - "isHighAvailabilityEnabled": { - "type": "boolean", - "description": "Gets or sets a value indicating whether the high availability is enabled or not.", - "readOnly": true - }, - "sqlEdition": { - "type": "string", - "description": "Gets the SQL edition from the recommended entity if applicable.", - "readOnly": true - }, - "sqlVersion": { - "type": "string", - "description": "Gets the SQL version from the recommended entity if applicable.", - "readOnly": true - }, - "sizingCriterion": { - "$ref": "#/definitions/AssessmentSizingCriterion", - "description": "Assessment sizing criterion.", - "readOnly": true - } - } - }, - "Assessment": { - "type": "object", - "description": "Machine assessment resource.", - "properties": { - "properties": { - "$ref": "#/definitions/MachineAssessmentProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "AssessmentListResult": { - "type": "object", - "description": "The response of a Assessment list operation.", - "properties": { - "value": { - "type": "array", - "description": "The Assessment items on this page", - "items": { - "$ref": "#/definitions/Assessment" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "AssessmentOptions": { - "type": "object", - "description": "Assessment options resource.", - "properties": { - "properties": { - "$ref": "#/definitions/AssessmentOptionsProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "AssessmentOptionsListResult": { - "type": "object", - "description": "The response of a AssessmentOptions list operation.", - "properties": { - "value": { - "type": "array", - "description": "The AssessmentOptions items on this page", - "items": { - "$ref": "#/definitions/AssessmentOptions" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "AssessmentOptionsProperties": { - "type": "object", - "description": "Assessment options properties.", - "properties": { - "vmFamilies": { - "type": "array", - "description": "Dictionary of VM families grouped by vm family name describing the targeted\nazure locations of VM family and the category of the family.", - "items": { - "$ref": "#/definitions/VmFamilyOptions" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "reservedInstanceVmFamilies": { - "type": "array", - "description": "List of supported VM Families.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "reservedInstanceSupportedLocations": { - "type": "array", - "description": "List of supported Azure regions for reserved instances.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "reservedInstanceSupportedCurrencies": { - "type": "array", - "description": "List of supported currencies for reserved instances.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "reservedInstanceSupportedOffers": { - "type": "array", - "description": "List of supported Azure offer codes for reserved instances.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "ultraDiskVmFamilies": { - "type": "array", - "description": "Ultra disk related assessment options.", - "items": { - "$ref": "#/definitions/UltraDiskAssessmentOptions" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "premiumDiskVmFamilies": { - "type": "array", - "description": "List of VM Families that support premium disks for assessments.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "savingsPlanVmFamilies": { - "type": "array", - "description": "List of VM Families that support Savings plan offer for assessments.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "savingsPlanSupportedLocations": { - "type": "array", - "description": "List of Azure locations that support Savings plan offer for assessments.", - "items": { - "type": "string" - }, - "readOnly": true - } - } - }, - "AssessmentProject": { - "type": "object", - "description": "An Assessment project site resource.", - "properties": { - "properties": { - "$ref": "#/definitions/ProjectProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ] - }, - "AssessmentProjectListResult": { - "type": "object", - "description": "The response of a AssessmentProject list operation.", - "properties": { - "value": { - "type": "array", - "description": "The AssessmentProject items on this page", - "items": { - "$ref": "#/definitions/AssessmentProject" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "AssessmentProjectSummary": { - "type": "object", - "description": "Assessment project summary resource.", - "properties": { - "properties": { - "$ref": "#/definitions/AssessmentProjectSummaryProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "AssessmentProjectSummaryListResult": { - "type": "object", - "description": "The response of a AssessmentProjectSummary list operation.", - "properties": { - "value": { - "type": "array", - "description": "The AssessmentProjectSummary items on this page", - "items": { - "$ref": "#/definitions/AssessmentProjectSummary" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "AssessmentProjectSummaryProperties": { - "type": "object", - "description": "Assessment project summary properties class.", - "properties": { - "errorSummaryAffectedEntities": { - "type": "array", - "description": "Gets the Error summary by feature. Contains number of affected Entities per\nfeature.", - "items": { - "$ref": "#/definitions/ErrorSummary" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "numberOfPrivateEndpointConnections": { - "type": "integer", - "format": "int32", - "description": "Gets the number of private endpoint connections.", - "readOnly": true - }, - "numberOfGroups": { - "type": "integer", - "format": "int32", - "description": "Gets the number of groups created in this project.", - "readOnly": true - }, - "numberOfMachines": { - "type": "integer", - "format": "int32", - "description": "Gets the number of machines part of this project.", - "readOnly": true - }, - "numberOfImportMachines": { - "type": "integer", - "format": "int32", - "description": "Gets the number of import machines part of this project.", - "readOnly": true - }, - "numberOfAssessments": { - "type": "integer", - "format": "int32", - "description": "Gets the number of assessments created in this project.", - "readOnly": true - }, - "lastAssessmentTimestamp": { - "type": "string", - "format": "date-time", - "description": "Gets the last assessment timestamp.", - "readOnly": true - } - } - }, - "AssessmentProjectUpdate": { - "type": "object", - "description": "The type used for update operations of the AssessmentProject.", - "properties": { - "tags": { - "type": "object", - "description": "Resource tags.", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/AssessmentProjectUpdateProperties", - "x-ms-client-flatten": true - } - } - }, - "AssessmentProjectUpdateProperties": { - "type": "object", - "description": "The updatable properties of the AssessmentProject.", - "properties": { - "assessmentSolutionId": { - "type": "string", - "description": "Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects." - }, - "projectStatus": { - "$ref": "#/definitions/ProjectStatus", - "description": "Assessment project status." - }, - "customerWorkspaceId": { - "type": "string", - "description": "The ARM id of service map workspace created by customer." - }, - "customerWorkspaceLocation": { - "type": "string", - "description": "Location of service map workspace created by customer." - }, - "publicNetworkAccess": { - "type": "string", - "description": "This value can be set to 'enabled' to avoid breaking changes on existing\ncustomer resources and templates. If set to 'disabled', traffic over public\ninterface is not allowed, and private endpoint connections would be the\nexclusive access method." - }, - "customerStorageAccountArmId": { - "type": "string", - "description": "The ARM id of the storage account used for interactions when public access is\ndisabled." - }, - "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "The status of the last operation." - } - } - }, - "AssessmentSizingCriterion": { - "type": "string", - "description": "Assessment Sizing Criteria.", - "enum": [ - "PerformanceBased", - "AsOnPremises" - ], - "x-ms-enum": { - "name": "AssessmentSizingCriterion", - "modelAsString": true, - "values": [ - { - "name": "PerformanceBased", - "value": "PerformanceBased", - "description": "Performance Data based Sizing." - }, - { - "name": "AsOnPremises", - "value": "AsOnPremises", - "description": "As On Premises or Static Data based Sizing." - } - ] - } - }, - "AssessmentStage": { - "type": "string", - "enum": [ - "InProgress", - "UnderReview", - "Approved" - ], - "x-ms-enum": { - "name": "AssessmentStage", - "modelAsString": true - } - }, - "AssessmentStatus": { - "type": "string", - "description": "Assessment Status.", - "enum": [ - "Created", - "Updated", - "Running", - "Completed", - "Invalid", - "OutOfSync", - "OutDated", - "Deleted" - ], - "x-ms-enum": { - "name": "AssessmentStatus", - "modelAsString": true, - "values": [ - { - "name": "Created", - "value": "Created", - "description": "Assessment is Created." - }, - { - "name": "Updated", - "value": "Updated", - "description": "Assessment is Updated." - }, - { - "name": "Running", - "value": "Running", - "description": "Assessment is currently running." - }, - { - "name": "Completed", - "value": "Completed", - "description": "Assessment is Completed or Ready." - }, - { - "name": "Invalid", - "value": "Invalid", - "description": "Assessment is Failed i.e. it is now invalid." - }, - { - "name": "OutOfSync", - "value": "OutOfSync", - "description": "Assessment is Out of Sync." - }, - { - "name": "OutDated", - "value": "OutDated", - "description": "Assessment is Out Dated." - }, - { - "name": "Deleted", - "value": "Deleted", - "description": "Assessment is Deleted." - } - ] - } - }, - "AssessmentType": { - "type": "string", - "enum": [ - "Unknown", - "MachineAssessment", - "AvsAssessment", - "SqlAssessment", - "WebAppAssessment" - ], - "x-ms-enum": { - "name": "AssessmentType", - "modelAsString": true - } - }, - "AsyncCommitModeIntent": { - "type": "string", - "enum": [ - "None", - "HighAvailability", - "DisasterRecovery" - ], - "x-ms-enum": { - "name": "AsyncCommitModeIntent", - "modelAsString": true - } - }, - "AvsAssessedDisk": { - "type": "object", - "description": "AVS assessed disk web model class.", - "properties": { - "name": { - "type": "string", - "description": "Gets the ID of the disk.", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "Gets the display name of the disk.", - "readOnly": true - }, - "gigabytesProvisioned": { - "type": "number", - "format": "float", - "description": "Gigabytes Provisioned for a disk in private data center.", - "readOnly": true - }, - "megabytesPerSecondOfRead": { - "type": "number", - "format": "float", - "description": "Disk Read Throughput in MB/s.", - "readOnly": true - }, - "megabytesPerSecondOfWrite": { - "type": "number", - "format": "float", - "description": "Disk Write Throughput in MB/s.", - "readOnly": true - }, - "numberOfReadOperationsPerSecond": { - "type": "number", - "format": "float", - "description": "Read Operations per second.", - "readOnly": true - }, - "numberOfWriteOperationsPerSecond": { - "type": "number", - "format": "float", - "description": "Write Operations per second.", - "readOnly": true - } - } - }, - "AvsAssessedMachine": { - "type": "object", - "description": "AVS assessment Assessed Machine resource.", - "properties": { - "properties": { - "$ref": "#/definitions/AvsAssessedMachineProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "AvsAssessedMachineListResult": { - "type": "object", - "description": "The response of a AvsAssessedMachine list operation.", - "properties": { - "value": { - "type": "array", - "description": "The AvsAssessedMachine items on this page", - "items": { - "$ref": "#/definitions/AvsAssessedMachine" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "AvsAssessedMachineProperties": { - "type": "object", - "description": "AVS assessed machine properties web model.", - "properties": { - "errors": { - "type": "array", - "description": "List of errors for this machine.", - "items": { - "$ref": "#/definitions/Error" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "disks": { - "type": "object", - "description": "List of Disks that were assessed as part of this machine's assessment.", - "additionalProperties": { - "$ref": "#/definitions/AvsAssessedDisk" - }, - "readOnly": true - }, - "networkAdapters": { - "type": "object", - "description": "List of Network Adapters that were assessed as part of this machine's\nassessment.", - "additionalProperties": { - "$ref": "#/definitions/AvsAssessedNetworkAdapter" - }, - "readOnly": true - }, - "storageInUseGB": { - "type": "number", - "format": "float", - "description": "Gets the storage in use.", - "readOnly": true - }, - "suitabilityExplanation": { - "$ref": "#/definitions/AzureAvsVmSuitabilityExplanation", - "description": "Gets the explanation if machine is not suitable for cloud.", - "readOnly": true - }, - "suitabilityDetail": { - "$ref": "#/definitions/AzureAvsVmSuitabilityDetail", - "description": "Gets the details if machine is not suitable for cloud.", - "readOnly": true - }, - "type": { - "$ref": "#/definitions/AssessedMachineType", - "description": "Assessed machine type.", - "readOnly": true - }, - "bootType": { - "$ref": "#/definitions/MachineBootType", - "description": "Boot type of machine discovered in private data center.", - "readOnly": true - }, - "operatingSystemType": { - "type": "string", - "description": "Operating system as reported by datacenter management solution.", - "readOnly": true - }, - "operatingSystemName": { - "type": "string", - "description": "Operating system as reported by datacenter management solution.", - "readOnly": true - }, - "operatingSystemVersion": { - "type": "string", - "description": "Operating system version as reported by datacenter management solution.", - "readOnly": true - }, - "operatingSystemArchitecture": { - "$ref": "#/definitions/GuestOperatingSystemArchitecture", - "description": "Operating system architecture as reported by datacenter management solution.", - "readOnly": true - }, - "createdTimestamp": { - "type": "string", - "format": "date-time", - "description": "When was machine first created.", - "readOnly": true - }, - "updatedTimestamp": { - "type": "string", - "format": "date-time", - "description": "When was machine last updated.", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "Display Name of the Machine.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "Description for the machine.", - "readOnly": true - }, - "datacenterMachineArmId": { - "type": "string", - "description": "Data center machine ARM id.", - "readOnly": true - }, - "datacenterManagementServerArmId": { - "type": "string", - "description": "Data center management server ARM id.", - "readOnly": true - }, - "datacenterManagementServerName": { - "type": "string", - "description": "Data center management server name.", - "readOnly": true - }, - "megabytesOfMemory": { - "type": "number", - "format": "float", - "description": "Megabytes of memory found allocated for the machine in private data center.", - "readOnly": true - }, - "numberOfCores": { - "type": "integer", - "format": "int32", - "description": "Number of CPU cores found on the machine.", - "readOnly": true - }, - "confidenceRatingInPercentage": { - "type": "number", - "format": "float", - "description": "Confidence Rating in Percentage.", - "readOnly": true - }, - "percentageCoresUtilization": { - "type": "number", - "format": "float", - "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", - "readOnly": true - }, - "percentageMemoryUtilization": { - "type": "number", - "format": "float", - "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", - "readOnly": true - }, - "suitability": { - "$ref": "#/definitions/CloudSuitability", - "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", - "readOnly": true - } - } - }, - "AvsAssessedNetworkAdapter": { - "type": "object", - "description": "Second level object returned as part of AVS AssessedMachine REST resource.", - "properties": { - "macAddress": { - "type": "string", - "description": "Mac address of the NIC.", - "readOnly": true - }, - "ipAddresses": { - "type": "array", - "description": "IP V4 addresses for the machine.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "Gets the display name of the network adapter.", - "readOnly": true - }, - "megabytesPerSecondReceived": { - "type": "number", - "format": "float", - "description": "Gets the Received data for Network Adapter in MB/s.\n This value is\nthe percentile of historical data based on options selected in Assessment.", - "readOnly": true - }, - "megabytesPerSecondTransmitted": { - "type": "number", - "format": "float", - "description": "Gets the Transmitted data for Network Adapter in MB/s.\n This value\nis the percentile of historical data based on options selected in Assessment.", - "readOnly": true - } - } - }, - "AvsAssessment": { - "type": "object", - "description": "AVS assessment resource.", - "properties": { - "properties": { - "$ref": "#/definitions/AvsAssessmentProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "AvsAssessmentListResult": { - "type": "object", - "description": "The response of a AvsAssessment list operation.", - "properties": { - "value": { - "type": "array", - "description": "The AvsAssessment items on this page", - "items": { - "$ref": "#/definitions/AvsAssessment" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "AvsAssessmentOptions": { - "type": "object", - "description": "AVS Assessment options resource.", - "properties": { - "properties": { - "$ref": "#/definitions/AvsAssessmentOptionsProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "AvsAssessmentOptionsListResult": { - "type": "object", - "description": "The response of a AvsAssessmentOptions list operation.", - "properties": { - "value": { - "type": "array", - "description": "The AvsAssessmentOptions items on this page", - "items": { - "$ref": "#/definitions/AvsAssessmentOptions" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "AvsAssessmentOptionsProperties": { - "type": "object", - "description": "AVS Assessment options properties.", - "properties": { - "avsNodes": { - "type": "array", - "description": "AVS SKU Nodes.", - "items": { - "$ref": "#/definitions/AvsSkuOptions" - }, - "x-ms-identifiers": [] - }, - "failuresToTolerateAndRaidLevelValues": { - "type": "array", - "description": "FTT and Raid level values.", - "items": { - "$ref": "#/definitions/FttAndRaidLevel" - } - }, - "reservedInstanceAvsNodes": { - "type": "array", - "description": "List of AVS nodes for RI.", - "items": { - "$ref": "#/definitions/AzureAvsNodeType" - } - }, - "reservedInstanceSupportedLocations": { - "type": "array", - "description": "List of supported Azure regions for reserved instances.", - "items": { - "$ref": "#/definitions/AzureLocation" - } - }, - "reservedInstanceSupportedCurrencies": { - "type": "array", - "description": "List of supported currencies for reserved instances.", - "items": { - "$ref": "#/definitions/AzureCurrency" - } - }, - "reservedInstanceSupportedOffers": { - "type": "array", - "description": "List of supported Azure offer codes for reserved instances.", - "items": { - "$ref": "#/definitions/AzureOfferCode" - } - } - } - }, - "AvsAssessmentProperties": { - "type": "object", - "description": "Properties of the AVS assessment.", - "properties": { - "assessmentErrorSummary": { - "type": "object", - "description": "Gets the assessment error summary.\n This is the number of machines\naffected by each type of error in this assessment.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "failuresToTolerateAndRaidLevel": { - "$ref": "#/definitions/FttAndRaidLevel", - "description": "Failures to tolerate and RAID level in a common property." - }, - "vcpuOversubscription": { - "type": "number", - "format": "float", - "description": "VCPU over subscription." - }, - "nodeType": { - "$ref": "#/definitions/AzureAvsNodeType", - "description": "AVS node type." - }, - "reservedInstance": { - "$ref": "#/definitions/AzureReservedInstance", - "description": "Reserved instance." - }, - "totalMonthlyCost": { - "type": "number", - "format": "float", - "description": "Total monthly cost.", - "readOnly": true - }, - "suitability": { - "$ref": "#/definitions/CloudSuitability", - "description": "Gets or sets the Assessment cloud suitability.", - "readOnly": true - }, - "suitabilityExplanation": { - "$ref": "#/definitions/AzureAvsSuitabilityExplanation", - "description": "Gets or sets the Assessment suitability explanation.", - "readOnly": true - }, - "numberOfNodes": { - "type": "integer", - "format": "int32", - "description": "Recommended number of nodes.", - "readOnly": true - }, - "cpuUtilization": { - "type": "number", - "format": "float", - "description": "Predicted CPU utilization.", - "readOnly": true - }, - "ramUtilization": { - "type": "number", - "format": "float", - "description": "Predicted RAM utilization.", - "readOnly": true - }, - "storageUtilization": { - "type": "number", - "format": "float", - "description": "Predicted storage utilization.", - "readOnly": true - }, - "totalCpuCores": { - "type": "number", - "format": "float", - "description": "Predicted total CPU cores used.", - "readOnly": true - }, - "totalRamInGB": { - "type": "number", - "format": "float", - "description": "Predicted total RAM used in GB.", - "readOnly": true - }, - "totalStorageInGB": { - "type": "number", - "format": "float", - "description": "Predicted total Storage used in GB.", - "readOnly": true - }, - "numberOfMachines": { - "type": "integer", - "format": "int32", - "description": "Number of machines part of the assessment.", - "readOnly": true - }, - "suitabilitySummary": { - "type": "object", - "description": "Cloud suitability summary for all the machines in the assessment.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "memOvercommit": { - "type": "number", - "format": "float", - "description": "Memory overcommit." - }, - "dedupeCompression": { - "type": "number", - "format": "float", - "description": "De-duplication compression." - }, - "limitingFactor": { - "type": "string", - "description": "Limiting factor.", - "readOnly": true - }, - "isStretchClusterEnabled": { - "type": "boolean", - "description": "Is Stretch Cluster Enabled." - }, - "groupType": { - "$ref": "#/definitions/GroupType", - "description": "Gets the group type for the assessment.", - "readOnly": true - }, - "assessmentType": { - "$ref": "#/definitions/AssessmentType", - "description": "Assessment type of the assessment.", - "readOnly": true - }, - "azureLocation": { - "$ref": "#/definitions/AzureLocation", - "description": "Azure Location or Azure region where to which the machines will be migrated." - }, - "azureOfferCode": { - "$ref": "#/definitions/AzureOfferCode", - "description": "Azure Offer code according to which cost estimation is done." - }, - "currency": { - "$ref": "#/definitions/AzureCurrency", - "description": "Currency in which prices should be reported." - }, - "scalingFactor": { - "type": "number", - "format": "float", - "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." - }, - "percentile": { - "$ref": "#/definitions/Percentile", - "description": "Percentile of the utilization data values to be considered while assessing\nmachines." - }, - "timeRange": { - "$ref": "#/definitions/TimeRange", - "description": "Time Range for which the historic utilization data should be considered for\nassessment." - }, - "perfDataStartTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the start time to consider performance data for assessment." - }, - "perfDataEndTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the end time to consider performance data for assessment." - }, - "stage": { - "$ref": "#/definitions/AssessmentStage", - "description": "User configurable setting to display the Stage of Assessment.", - "readOnly": true - }, - "discountPercentage": { - "type": "number", - "format": "float", - "description": "Custom discount percentage." - }, - "sizingCriterion": { - "$ref": "#/definitions/AssessmentSizingCriterion", - "description": "Assessment sizing criterion." - }, - "confidenceRatingInPercentage": { - "type": "number", - "format": "float", - "description": "Confidence Rating in Percentage.", - "readOnly": true - }, - "pricesTimestamp": { - "type": "string", - "format": "date-time", - "description": "Time when the Azure Prices were queried. Date-Time represented in ISO-8601\nformat.", - "readOnly": true - }, - "createdTimestamp": { - "type": "string", - "format": "date-time", - "description": "Date and Time when assessment was created.", - "readOnly": true - }, - "updatedTimestamp": { - "type": "string", - "format": "date-time", - "description": "Date and Time when assessment was last updated.", - "readOnly": true - }, - "status": { - "$ref": "#/definitions/AssessmentStatus", - "description": "Whether assessment is in valid state and all machines have been assessed.", - "readOnly": true - }, - "schemaVersion": { - "type": "string", - "description": "Schema version.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/definitions/AzureResourceProperties" - } - ] - }, - "AvsSkuOptions": { - "type": "object", - "description": "AVS SKU specific options.", - "properties": { - "nodeType": { - "$ref": "#/definitions/AzureAvsNodeType", - "description": "AVS Node type." - }, - "targetLocations": { - "type": "array", - "description": "List of locations where this node type is available.", - "items": { - "$ref": "#/definitions/AzureLocation" - } - } - } - }, - "AzureAvsNodeType": { - "type": "string", - "enum": [ - "Unknown", - "AV36" - ], - "x-ms-enum": { - "name": "AzureAvsNodeType", - "modelAsString": true - } - }, - "AzureAvsSuitabilityExplanation": { - "type": "string", - "enum": [ - "Unknown", - "NotApplicable", - "UnsupportedLocationForSelectedNode" - ], - "x-ms-enum": { - "name": "AzureAvsSuitabilityExplanation", - "modelAsString": true - } - }, - "AzureAvsVmSuitabilityDetail": { - "type": "string", - "enum": [ - "None", - "PercentageOfCoresUtilizedMissing", - "PercentageOfMemoryUtilizedMissing", - "PercentageOfCoresUtilizedOutOfRange", - "PercentageOfMemoryUtilizedOutOfRange", - "PercentageOfStorageUtilizedOutOfRange" - ], - "x-ms-enum": { - "name": "AzureAvsVmSuitabilityDetail", - "modelAsString": true - } - }, - "AzureAvsVmSuitabilityExplanation": { - "type": "string", - "enum": [ - "Unknown", - "NotApplicable", - "IpV6NotSupported", - "UnsupportedOperatingSystem" - ], - "x-ms-enum": { - "name": "AzureAvsVmSuitabilityExplanation", - "modelAsString": true - } - }, - "AzureCurrency": { - "type": "string", - "description": "Currency for Azure.", - "enum": [ - "Unknown", - "USD", - "DKK", - "CAD", - "IDR", - "JPY", - "KRW", - "NZD", - "NOK", - "RUB", - "SAR", - "ZAR", - "SEK", - "TRY", - "GBP", - "MXN", - "MYR", - "INR", - "HKD", - "BRL", - "TWD", - "EUR", - "CHF", - "ARS", - "AUD", - "CNY" - ], - "x-ms-enum": { - "name": "AzureCurrency", - "modelAsString": true - } - }, - "AzureDiskSize": { - "type": "string", - "enum": [ - "Unknown", - "Standard_S4", - "Standard_S6", - "Standard_S10", - "Standard_S15", - "Standard_S20", - "Standard_S30", - "Standard_S40", - "Standard_S50", - "Standard_S60", - "Standard_S70", - "Standard_S80", - "Premium_P4", - "Premium_P6", - "Premium_P10", - "Premium_P15", - "Premium_P20", - "Premium_P30", - "Premium_P40", - "Premium_P50", - "Premium_P60", - "Premium_P70", - "Premium_P80", - "StandardSSD_E10", - "StandardSSD_E15", - "StandardSSD_E20", - "StandardSSD_E30", - "StandardSSD_E40", - "StandardSSD_E50", - "StandardSSD_E60", - "StandardSSD_E70", - "StandardSSD_E80", - "StandardSSD_E4", - "StandardSSD_E6", - "StandardSSD_E1", - "StandardSSD_E2", - "StandardSSD_E3", - "Premium_P1", - "Premium_P2", - "Premium_P3", - "Ultra", - "PremiumV2" - ], - "x-ms-enum": { - "name": "AzureDiskSize", - "modelAsString": true, - "values": [ - { - "name": "Unknown", - "value": "Unknown" - }, - { - "name": "StandardS4", - "value": "Standard_S4" - }, - { - "name": "StandardS6", - "value": "Standard_S6" - }, - { - "name": "StandardS10", - "value": "Standard_S10" - }, - { - "name": "StandardS15", - "value": "Standard_S15" - }, - { - "name": "StandardS20", - "value": "Standard_S20" - }, - { - "name": "StandardS30", - "value": "Standard_S30" - }, - { - "name": "StandardS40", - "value": "Standard_S40" - }, - { - "name": "StandardS50", - "value": "Standard_S50" - }, - { - "name": "StandardS60", - "value": "Standard_S60" - }, - { - "name": "StandardS70", - "value": "Standard_S70" - }, - { - "name": "StandardS80", - "value": "Standard_S80" - }, - { - "name": "PremiumP4", - "value": "Premium_P4" - }, - { - "name": "PremiumP6", - "value": "Premium_P6" - }, - { - "name": "PremiumP10", - "value": "Premium_P10" - }, - { - "name": "PremiumP15", - "value": "Premium_P15" - }, - { - "name": "PremiumP20", - "value": "Premium_P20" - }, - { - "name": "PremiumP30", - "value": "Premium_P30" - }, - { - "name": "PremiumP40", - "value": "Premium_P40" - }, - { - "name": "PremiumP50", - "value": "Premium_P50" - }, - { - "name": "PremiumP60", - "value": "Premium_P60" - }, - { - "name": "PremiumP70", - "value": "Premium_P70" - }, - { - "name": "PremiumP80", - "value": "Premium_P80" - }, - { - "name": "StandardSSDE10", - "value": "StandardSSD_E10" - }, - { - "name": "StandardSSDE15", - "value": "StandardSSD_E15" - }, - { - "name": "StandardSSDE20", - "value": "StandardSSD_E20" - }, - { - "name": "StandardSSDE30", - "value": "StandardSSD_E30" - }, - { - "name": "StandardSSDE40", - "value": "StandardSSD_E40" - }, - { - "name": "StandardSSDE50", - "value": "StandardSSD_E50" - }, - { - "name": "StandardSSDE60", - "value": "StandardSSD_E60" - }, - { - "name": "StandardSSDE70", - "value": "StandardSSD_E70" - }, - { - "name": "StandardSSDE80", - "value": "StandardSSD_E80" - }, - { - "name": "StandardSSDE4", - "value": "StandardSSD_E4" - }, - { - "name": "StandardSSDE6", - "value": "StandardSSD_E6" - }, - { - "name": "StandardSSDE1", - "value": "StandardSSD_E1" - }, - { - "name": "StandardSSDE2", - "value": "StandardSSD_E2" - }, - { - "name": "StandardSSDE3", - "value": "StandardSSD_E3" - }, - { - "name": "PremiumP1", - "value": "Premium_P1" - }, - { - "name": "PremiumP2", - "value": "Premium_P2" - }, - { - "name": "PremiumP3", - "value": "Premium_P3" - }, - { - "name": "Ultra", - "value": "Ultra" - }, - { - "name": "PremiumV2", - "value": "PremiumV2" - } - ] - } - }, - "AzureDiskSuitabilityDetail": { - "type": "string", - "enum": [ - "None", - "NumberOfReadOperationsPerSecondMissing", - "NumberOfWriteOperationsPerSecondMissing", - "MegabytesPerSecondOfReadMissing", - "MegabytesPerSecondOfWriteMissing", - "DiskGigabytesConsumedMissing", - "DiskGigabytesProvisionedMissing", - "NumberOfReadOperationsPerSecondOutOfRange", - "NumberOfWriteOperationsPerSecondOutOfRange", - "MegabytesPerSecondOfReadOutOfRange", - "MegabytesPerSecondOfWriteOutOfRange", - "DiskGigabytesConsumedOutOfRange", - "DiskGigabytesProvisionedOutOfRange" - ], - "x-ms-enum": { - "name": "AzureDiskSuitabilityDetail", - "modelAsString": true - } - }, - "AzureDiskSuitabilityExplanation": { - "type": "string", - "enum": [ - "Unknown", - "NotApplicable", - "DiskSizeGreaterThanSupported", - "NoSuitableDiskSizeForIops", - "NoSuitableDiskSizeForThroughput", - "NoDiskSizeFoundInSelectedLocation", - "NoDiskSizeFoundForSelectedRedundancy", - "InternalErrorOccurredForDiskEvaluation", - "NoEaPriceFoundForDiskSize" - ], - "x-ms-enum": { - "name": "AzureDiskSuitabilityExplanation", - "modelAsString": true - } - }, - "AzureDiskType": { - "type": "string", - "enum": [ - "Unknown", - "Standard", - "StandardSSD", - "Premium", - "StandardOrPremium", - "Ultra", - "PremiumV2" - ], - "x-ms-enum": { - "name": "AzureDiskType", - "modelAsString": true - } - }, - "AzureHybridUseBenefit": { - "type": "string", - "enum": [ - "Unknown", - "Yes", - "No" - ], - "x-ms-enum": { - "name": "AzureHybridUseBenefit", - "modelAsString": true - } - }, - "AzureLocation": { - "type": "string", - "description": "Location for Azure.", - "enum": [ - "Unknown", - "EastAsia", - "SoutheastAsia", - "AustraliaEast", - "AustraliaSoutheast", - "BrazilSouth", - "CanadaCentral", - "CanadaEast", - "WestEurope", - "NorthEurope", - "CentralIndia", - "SouthIndia", - "WestIndia", - "JapanEast", - "JapanWest", - "KoreaCentral", - "KoreaSouth", - "UkWest", - "UkSouth", - "NorthCentralUs", - "EastUs", - "WestUs2", - "SouthCentralUs", - "CentralUs", - "EastUs2", - "WestUs", - "WestCentralUs", - "GermanyCentral", - "GermanyNortheast", - "ChinaNorth", - "ChinaEast", - "USGovArizona", - "USGovTexas", - "USGovIowa", - "USGovVirginia", - "USDoDCentral", - "USDoDEast", - "FranceCentral", - "AustraliaCentral", - "SouthAfricaNorth", - "FranceSouth", - "AustraliaCentral2", - "SouthAfricaWest", - "GermanyNorth", - "GermanyWestCentral", - "NorwayEast", - "NorwayWest", - "ChinaEast2", - "ChinaNorth2", - "SwitzerlandNorth", - "SwitzerlandWest", - "UAENorth", - "UAECentral", - "UsNatEast", - "UsNatWest", - "UsSecEast", - "UsSecCentral", - "UsSecWest", - "SwedenCentral", - "QatarCentral" - ], - "x-ms-enum": { - "name": "AzureLocation", - "modelAsString": true - } - }, - "AzureManagedDiskSkuDTO": { - "type": "object", - "description": "Class representing an Azure Managed Disk SKU.", - "properties": { - "diskType": { - "$ref": "#/definitions/AzureManagedDiskSkuDTODiskType", - "description": "Gets the Type (\"tier\") of disk - e.g. standard, premium, ultra.", - "readOnly": true - }, - "diskSize": { - "$ref": "#/definitions/AzureDiskSize", - "description": "Gets the Size of the managed disk - e.g. P30, P40.", - "readOnly": true - }, - "diskRedundancy": { - "$ref": "#/definitions/AzureManagedDiskSkuDTODiskRedundancy", - "description": "Gets disk redundancy - e.g. LRS, ZRS.", - "readOnly": true - }, - "storageCost": { - "type": "number", - "format": "float", - "description": "Gets the managed disk storage cost.", - "readOnly": true - }, - "recommendedSizeInGib": { - "type": "number", - "format": "float", - "description": "Gets the recommended in GB of the managed disk.", - "readOnly": true - }, - "recommendedThroughputInMbps": { - "type": "number", - "format": "float", - "description": "Gets the recommended throughput in MBPS of the managed disk.", - "readOnly": true - }, - "recommendedIops": { - "type": "number", - "format": "float", - "description": "Gets the recommended IOPS of the managed disk.", - "readOnly": true - } - } - }, - "AzureManagedDiskSkuDTODiskRedundancy": { - "type": "string", - "enum": [ - "Unknown", - "LRS", - "ZRS" - ], - "x-ms-enum": { - "name": "AzureManagedDiskSkuDTODiskRedundancy", - "modelAsString": true - } - }, - "AzureManagedDiskSkuDTODiskType": { - "type": "string", - "enum": [ - "Unknown", - "Standard", - "StandardSSD", - "Premium", - "StandardOrPremium", - "Ultra", - "PremiumV2" - ], - "x-ms-enum": { - "name": "AzureManagedDiskSkuDTODiskType", - "modelAsString": true - } - }, - "AzureNetworkAdapterSuitabilityDetail": { - "type": "string", - "enum": [ - "None", - "MegabytesOfDataTransmittedMissing", - "MegabytesOfDataTransmittedOutOfRange", - "MegabytesOfDataRecievedMissing", - "MegabytesOfDataRecievedOutOfRange" - ], - "x-ms-enum": { - "name": "AzureNetworkAdapterSuitabilityDetail", - "modelAsString": true - } - }, - "AzureNetworkAdapterSuitabilityExplanation": { - "type": "string", - "enum": [ - "Unknown", - "NotApplicable", - "InternalErrorOccurred" - ], - "x-ms-enum": { - "name": "AzureNetworkAdapterSuitabilityExplanation", - "modelAsString": true - } - }, - "AzureOfferCode": { - "type": "string", - "enum": [ - "Unknown", - "MSAZR0003P", - "MSAZR0044P", - "MSAZR0059P", - "MSAZR0060P", - "MSAZR0062P", - "MSAZR0063P", - "MSAZR0064P", - "MSAZR0029P", - "MSAZR0022P", - "MSAZR0023P", - "MSAZR0148P", - "MSAZR0025P", - "MSAZR0036P", - "MSAZR0120P", - "MSAZR0121P", - "MSAZR0122P", - "MSAZR0123P", - "MSAZR0124P", - "MSAZR0125P", - "MSAZR0126P", - "MSAZR0127P", - "MSAZR0128P", - "MSAZR0129P", - "MSAZR0130P", - "MSAZR0111P", - "MSAZR0144P", - "MSAZR0149P", - "MSMCAZR0044P", - "MSMCAZR0059P", - "MSMCAZR0060P", - "MSMCAZR0063P", - "MSMCAZR0120P", - "MSMCAZR0121P", - "MSMCAZR0125P", - "MSMCAZR0128P", - "MSAZRDE0003P", - "MSAZRDE0044P", - "MSAZRUSGOV0003P", - "EA", - "MSAZR0243P", - "SavingsPlan1Year", - "SavingsPlan3Year" - ], - "x-ms-enum": { - "name": "AzureOfferCode", - "modelAsString": true, - "values": [ - { - "name": "Unknown", - "value": "Unknown" - }, - { - "name": "Msazr0003P", - "value": "MSAZR0003P" - }, - { - "name": "Msazr0044P", - "value": "MSAZR0044P" - }, - { - "name": "Msazr0059P", - "value": "MSAZR0059P" - }, - { - "name": "Msazr0060P", - "value": "MSAZR0060P" - }, - { - "name": "Msazr0062P", - "value": "MSAZR0062P" - }, - { - "name": "Msazr0063P", - "value": "MSAZR0063P" - }, - { - "name": "Msazr0064P", - "value": "MSAZR0064P" - }, - { - "name": "Msazr0029P", - "value": "MSAZR0029P" - }, - { - "name": "Msazr0022P", - "value": "MSAZR0022P" - }, - { - "name": "Msazr0023P", - "value": "MSAZR0023P" - }, - { - "name": "Msazr0148P", - "value": "MSAZR0148P" - }, - { - "name": "Msazr0025P", - "value": "MSAZR0025P" - }, - { - "name": "Msazr0036P", - "value": "MSAZR0036P" - }, - { - "name": "Msazr0120P", - "value": "MSAZR0120P" - }, - { - "name": "Msazr0121P", - "value": "MSAZR0121P" - }, - { - "name": "Msazr0122P", - "value": "MSAZR0122P" - }, - { - "name": "Msazr0123P", - "value": "MSAZR0123P" - }, - { - "name": "Msazr0124P", - "value": "MSAZR0124P" - }, - { - "name": "Msazr0125P", - "value": "MSAZR0125P" - }, - { - "name": "Msazr0126P", - "value": "MSAZR0126P" - }, - { - "name": "Msazr0127P", - "value": "MSAZR0127P" - }, - { - "name": "Msazr0128P", - "value": "MSAZR0128P" - }, - { - "name": "Msazr0129P", - "value": "MSAZR0129P" - }, - { - "name": "Msazr0130P", - "value": "MSAZR0130P" - }, - { - "name": "Msazr0111P", - "value": "MSAZR0111P" - }, - { - "name": "Msazr0144P", - "value": "MSAZR0144P" - }, - { - "name": "Msazr0149P", - "value": "MSAZR0149P" - }, - { - "name": "Msmcazr0044P", - "value": "MSMCAZR0044P" - }, - { - "name": "Msmcazr0059P", - "value": "MSMCAZR0059P" - }, - { - "name": "Msmcazr0060P", - "value": "MSMCAZR0060P" - }, - { - "name": "Msmcazr0063P", - "value": "MSMCAZR0063P" - }, - { - "name": "Msmcazr0120P", - "value": "MSMCAZR0120P" - }, - { - "name": "Msmcazr0121P", - "value": "MSMCAZR0121P" - }, - { - "name": "Msmcazr0125P", - "value": "MSMCAZR0125P" - }, - { - "name": "Msmcazr0128P", - "value": "MSMCAZR0128P" - }, - { - "name": "Msazrde0003P", - "value": "MSAZRDE0003P" - }, - { - "name": "Msazrde0044P", - "value": "MSAZRDE0044P" - }, - { - "name": "Msazrusgov0003P", - "value": "MSAZRUSGOV0003P" - }, - { - "name": "EA", - "value": "EA" - }, - { - "name": "Msazr0243P", - "value": "MSAZR0243P" - }, - { - "name": "SavingsPlan1Year", - "value": "SavingsPlan1Year" - }, - { - "name": "SavingsPlan3Year", - "value": "SavingsPlan3Year" - } - ] - } - }, - "AzurePricingTier": { - "type": "string", - "enum": [ - "Standard", - "Basic" - ], - "x-ms-enum": { - "name": "AzurePricingTier", - "modelAsString": true - } - }, - "AzureQuorumWitnessDTO": { - "type": "object", - "description": "Quorum Witness.", - "properties": { - "quorumWitnessType": { - "$ref": "#/definitions/AzureQuorumWitnessDTOQuorumWitnessType", - "description": "Gets quorum witness type.", - "readOnly": true - } - } - }, - "AzureQuorumWitnessDTOQuorumWitnessType": { - "type": "string", - "enum": [ - "Unknown", - "Cloud", - "Disk" - ], - "x-ms-enum": { - "name": "AzureQuorumWitnessDTOQuorumWitnessType", - "modelAsString": true - } - }, - "AzureReservedInstance": { - "type": "string", - "enum": [ - "None", - "RI1Year", - "RI3Year" - ], - "x-ms-enum": { - "name": "AzureReservedInstance", - "modelAsString": true - } - }, - "AzureResourceProperties": { - "type": "object", - "description": "Common properties for all azure tracked and proxy resources.", - "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "The status of the last operation." - } - } - }, - "AzureSecurityOfferingType": { - "type": "string", - "enum": [ - "NO", - "MDC" - ], - "x-ms-enum": { - "name": "AzureSecurityOfferingType", - "modelAsString": true - } - }, - "AzureSqlDataBaseType": { - "type": "string", - "enum": [ - "Unknown", - "Automatic", - "SingleDatabase", - "ElasticPool" - ], - "x-ms-enum": { - "name": "AzureSqlDataBaseType", - "modelAsString": true - } - }, - "AzureSqlIaasSkuDTO": { - "type": "object", - "description": "Class representing Azure SQL IAAS SKU.", - "properties": { - "virtualMachineSize": { - "$ref": "#/definitions/AzureVirtualMachineSkuDTO", - "description": "Gets the The Azure Compute Virtual Machine.", - "readOnly": true - }, - "dataDiskSizes": { - "type": "array", - "description": "Gets the The list of data disk sizes.", - "items": { - "$ref": "#/definitions/AzureManagedDiskSkuDTO" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "logDiskSizes": { - "type": "array", - "description": "Gets the The list of log disk sizes.", - "items": { - "$ref": "#/definitions/AzureManagedDiskSkuDTO" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "azureSqlTargetType": { - "$ref": "#/definitions/TargetType", - "description": "Gets the target type.", - "readOnly": true - } - } - }, - "AzureSqlInstanceType": { - "type": "string", - "enum": [ - "Unknown", - "Automatic", - "SingleInstance", - "InstancePools" - ], - "x-ms-enum": { - "name": "AzureSqlInstanceType", - "modelAsString": true - } - }, - "AzureSqlPaasSkuDTO": { - "type": "object", - "description": "Class representing Azure SQL PAAS SKU.", - "properties": { - "azureSqlServiceTier": { - "$ref": "#/definitions/AzureSqlServiceTier", - "description": "Gets the service tier.", - "readOnly": true - }, - "azureSqlComputeTier": { - "$ref": "#/definitions/ComputeTier", - "description": "Gets the compute tier.", - "readOnly": true - }, - "azureSqlHardwareGeneration": { - "$ref": "#/definitions/HardwareGeneration", - "description": "Gets the hardware generation.", - "readOnly": true - }, - "storageMaxSizeInMB": { - "type": "number", - "format": "float", - "description": "Gets the storage maximum size in megabytes.", - "readOnly": true - }, - "predictedDataSizeInMB": { - "type": "number", - "format": "float", - "description": "Gets the predicted data size in megabytes in the Azure SQL, will impact the\nbilling cost.", - "readOnly": true - }, - "predictedLogSizeInMB": { - "type": "number", - "format": "float", - "description": "Gets the predicted log size in megabytes in the Azure SQL, will impact the\nbilling cost.", - "readOnly": true - }, - "cores": { - "type": "integer", - "format": "int32", - "description": "Gets the number of cores.", - "readOnly": true - }, - "azureSqlTargetType": { - "$ref": "#/definitions/TargetType", - "description": "Gets the target type.", - "readOnly": true - } - } - }, - "AzureSqlPurchaseModel": { - "type": "string", - "enum": [ - "Unknown", - "VCore", - "DTU" - ], - "x-ms-enum": { - "name": "AzureSqlPurchaseModel", - "modelAsString": true - } - }, - "AzureSqlServiceTier": { - "type": "string", - "enum": [ - "Unknown", - "Automatic", - "GeneralPurpose", - "BusinessCritical", - "HyperScale" - ], - "x-ms-enum": { - "name": "AzureSqlServiceTier", - "modelAsString": true - } - }, - "AzureStorageRedundancy": { - "type": "string", - "enum": [ - "Unknown", - "LocallyRedundant", - "ZoneRedundant", - "GeoRedundant", - "ReadAccessGeoRedundant" - ], - "x-ms-enum": { - "name": "AzureStorageRedundancy", - "modelAsString": true - } - }, - "AzureVirtualMachineSkuDTO": { - "type": "object", - "description": "Azure Virtual Machine SKU.", - "properties": { - "azureVmFamily": { - "$ref": "#/definitions/AzureVmFamily", - "description": "Gets the Virtual Machine Family, for example : standardMSFamily.", - "readOnly": true - }, - "cores": { - "type": "integer", - "format": "int32", - "description": "Gets the Compute Size in vCores.", - "readOnly": true - }, - "azureSkuName": { - "$ref": "#/definitions/AzureVmSize", - "description": "Gets the Virtual Machine SKU name,: E.g. : Standard_F16s.", - "readOnly": true - }, - "availableCores": { - "type": "integer", - "format": "int32", - "description": "Gets the Available vCores. This can be less than the vCores in the Constrained\nvCPU VM Sizes.", - "readOnly": true - }, - "maxNetworkInterfaces": { - "type": "integer", - "format": "int32", - "description": "Gets the Max network interfaces.", - "readOnly": true - } - } - }, - "AzureVmFamily": { - "type": "string", - "enum": [ - "Unknown", - "Basic_A0_A4", - "Standard_A0_A7", - "Standard_A8_A11", - "Av2_series", - "D_series", - "Dv2_series", - "DS_series", - "DSv2_series", - "F_series", - "Fs_series", - "G_series", - "GS_series", - "H_series", - "Ls_series", - "Dsv3_series", - "Dv3_series", - "Fsv2_series", - "Ev3_series", - "Esv3_series", - "M_series", - "DC_Series", - "Lsv2_series", - "Ev4_series", - "Esv4_series", - "Edv4_series", - "Edsv4_series", - "Dv4_series", - "Dsv4_series", - "Ddv4_series", - "Ddsv4_series", - "Easv4_series", - "Dasv4_series", - "Mv2_series", - "Eav4_series", - "Dav4_series", - "Msv2_series", - "Mdsv2_series", - "Dv5_series", - "Dsv5_series", - "Ddv5_series", - "Ddsv5_series", - "Dasv5_series", - "Dadsv5_series", - "Ev5_series", - "Esv5_series", - "Edv5_series", - "Edsv5_series", - "Easv5_series", - "Eadsv5_series", - "Ebsv5_series", - "Ebdsv5_series" - ], - "x-ms-enum": { - "name": "AzureVmFamily", - "modelAsString": true, - "values": [ - { - "name": "Unknown", - "value": "Unknown" - }, - { - "name": "BasicA0A4", - "value": "Basic_A0_A4" - }, - { - "name": "StandardA0A7", - "value": "Standard_A0_A7" - }, - { - "name": "StandardA8A11", - "value": "Standard_A8_A11" - }, - { - "name": "Av2Series", - "value": "Av2_series" - }, - { - "name": "DSeries", - "value": "D_series" - }, - { - "name": "Dv2Series", - "value": "Dv2_series" - }, - { - "name": "DSSeries", - "value": "DS_series" - }, - { - "name": "DSv2Series", - "value": "DSv2_series" - }, - { - "name": "FSeries", - "value": "F_series" - }, - { - "name": "FsSeries", - "value": "Fs_series" - }, - { - "name": "GSeries", - "value": "G_series" - }, - { - "name": "GSSeries", - "value": "GS_series" - }, - { - "name": "HSeries", - "value": "H_series" - }, - { - "name": "LsSeries", - "value": "Ls_series" - }, - { - "name": "Dsv3Series", - "value": "Dsv3_series" - }, - { - "name": "Dv3Series", - "value": "Dv3_series" - }, - { - "name": "Fsv2Series", - "value": "Fsv2_series" - }, - { - "name": "Ev3Series", - "value": "Ev3_series" - }, - { - "name": "Esv3Series", - "value": "Esv3_series" - }, - { - "name": "MSeries", - "value": "M_series" - }, - { - "name": "DCSeries", - "value": "DC_Series" - }, - { - "name": "Lsv2Series", - "value": "Lsv2_series" - }, - { - "name": "Ev4Series", - "value": "Ev4_series" - }, - { - "name": "Esv4Series", - "value": "Esv4_series" - }, - { - "name": "Edv4Series", - "value": "Edv4_series" - }, - { - "name": "Edsv4Series", - "value": "Edsv4_series" - }, - { - "name": "Dv4Series", - "value": "Dv4_series" - }, - { - "name": "Dsv4Series", - "value": "Dsv4_series" - }, - { - "name": "Ddv4Series", - "value": "Ddv4_series" - }, - { - "name": "Ddsv4Series", - "value": "Ddsv4_series" - }, - { - "name": "Easv4Series", - "value": "Easv4_series" - }, - { - "name": "Dasv4Series", - "value": "Dasv4_series" - }, - { - "name": "Mv2Series", - "value": "Mv2_series" - }, - { - "name": "Eav4Series", - "value": "Eav4_series" - }, - { - "name": "Dav4Series", - "value": "Dav4_series" - }, - { - "name": "Msv2Series", - "value": "Msv2_series" - }, - { - "name": "Mdsv2Series", - "value": "Mdsv2_series" - }, - { - "name": "Dv5Series", - "value": "Dv5_series" - }, - { - "name": "Dsv5Series", - "value": "Dsv5_series" - }, - { - "name": "Ddv5Series", - "value": "Ddv5_series" - }, - { - "name": "Ddsv5Series", - "value": "Ddsv5_series" - }, - { - "name": "Dasv5Series", - "value": "Dasv5_series" - }, - { - "name": "Dadsv5Series", - "value": "Dadsv5_series" - }, - { - "name": "Ev5Series", - "value": "Ev5_series" - }, - { - "name": "Esv5Series", - "value": "Esv5_series" - }, - { - "name": "Edv5Series", - "value": "Edv5_series" - }, - { - "name": "Edsv5Series", - "value": "Edsv5_series" - }, - { - "name": "Easv5Series", - "value": "Easv5_series" - }, - { - "name": "Eadsv5Series", - "value": "Eadsv5_series" - }, - { - "name": "Ebsv5Series", - "value": "Ebsv5_series" - }, - { - "name": "Ebdsv5Series", - "value": "Ebdsv5_series" - } - ] - } - }, - "AzureVmSize": { - "type": "string", - "enum": [ - "Unknown", - "Basic_A0", - "Basic_A1", - "Basic_A2", - "Basic_A3", - "Basic_A4", - "Standard_A0", - "Standard_A1", - "Standard_A2", - "Standard_A3", - "Standard_A4", - "Standard_A5", - "Standard_A6", - "Standard_A7", - "Standard_A8", - "Standard_A9", - "Standard_A10", - "Standard_A11", - "Standard_A1_v2", - "Standard_A2_v2", - "Standard_A4_v2", - "Standard_A8_v2", - "Standard_A2m_v2", - "Standard_A4m_v2", - "Standard_A8m_v2", - "Standard_D1", - "Standard_D2", - "Standard_D3", - "Standard_D4", - "Standard_D11", - "Standard_D12", - "Standard_D13", - "Standard_D14", - "Standard_D1_v2", - "Standard_D2_v2", - "Standard_D3_v2", - "Standard_D4_v2", - "Standard_D5_v2", - "Standard_D11_v2", - "Standard_D12_v2", - "Standard_D13_v2", - "Standard_D14_v2", - "Standard_D15_v2", - "Standard_DS1", - "Standard_DS2", - "Standard_DS3", - "Standard_DS4", - "Standard_DS11", - "Standard_DS12", - "Standard_DS13", - "Standard_DS14", - "Standard_DS1_v2", - "Standard_DS2_v2", - "Standard_DS3_v2", - "Standard_DS4_v2", - "Standard_DS5_v2", - "Standard_DS11_v2", - "Standard_DS12_v2", - "Standard_DS13_v2", - "Standard_DS14_v2", - "Standard_DS15_v2", - "Standard_F1", - "Standard_F2", - "Standard_F4", - "Standard_F8", - "Standard_F16", - "Standard_F1s", - "Standard_F2s", - "Standard_F4s", - "Standard_F8s", - "Standard_F16s", - "Standard_G1", - "Standard_G2", - "Standard_G3", - "Standard_G4", - "Standard_G5", - "Standard_GS1", - "Standard_GS2", - "Standard_GS3", - "Standard_GS4", - "Standard_GS5", - "Standard_H8", - "Standard_H16", - "Standard_H8m", - "Standard_H16m", - "Standard_H16r", - "Standard_H16mr", - "Standard_L4s", - "Standard_L8s", - "Standard_L16s", - "Standard_L32s", - "Standard_D2s_v3", - "Standard_D4s_v3", - "Standard_D8s_v3", - "Standard_D16s_v3", - "Standard_D32s_v3", - "Standard_D64s_v3", - "Standard_D2_v3", - "Standard_D4_v3", - "Standard_D8_v3", - "Standard_D16_v3", - "Standard_D32_v3", - "Standard_D64_v3", - "Standard_F2s_v2", - "Standard_F4s_v2", - "Standard_F8s_v2", - "Standard_F16s_v2", - "Standard_F32s_v2", - "Standard_F64s_v2", - "Standard_F72s_v2", - "Standard_E2_v3", - "Standard_E4_v3", - "Standard_E8_v3", - "Standard_E16_v3", - "Standard_E32_v3", - "Standard_E64_v3", - "Standard_E2s_v3", - "Standard_E4s_v3", - "Standard_E8s_v3", - "Standard_E16s_v3", - "Standard_E32s_v3", - "Standard_E64s_v3", - "Standard_M64s", - "Standard_M64ms", - "Standard_M128s", - "Standard_M128ms", - "Standard_DC2s", - "Standard_DC4s", - "Standard_E20_v3", - "Standard_E20s_v3", - "Standard_E64i_v3", - "Standard_E64is_v3", - "Standard_M8ms", - "Standard_M16ms", - "Standard_M32ls", - "Standard_M32ms", - "Standard_M32ts", - "Standard_M64", - "Standard_M64ls", - "Standard_M64m", - "Standard_M128", - "Standard_M128m", - "Standard_L8s_v2", - "Standard_L16s_v2", - "Standard_L32s_v2", - "Standard_L48s_v2", - "Standard_L64s_v2", - "Standard_L80s_v2", - "Standard_D2_v4", - "Standard_D4_v4", - "Standard_D8_v4", - "Standard_D16_v4", - "Standard_D32_v4", - "Standard_D48_v4", - "Standard_D64_v4", - "Standard_D2s_v4", - "Standard_D4s_v4", - "Standard_D8s_v4", - "Standard_D16s_v4", - "Standard_D32s_v4", - "Standard_D48s_v4", - "Standard_D64s_v4", - "Standard_D2d_v4", - "Standard_D4d_v4", - "Standard_D8d_v4", - "Standard_D16d_v4", - "Standard_D32d_v4", - "Standard_D48d_v4", - "Standard_D64d_v4", - "Standard_D2ds_v4", - "Standard_D4ds_v4", - "Standard_D8ds_v4", - "Standard_D16ds_v4", - "Standard_D32ds_v4", - "Standard_D48ds_v4", - "Standard_D64ds_v4", - "Standard_E2_v4", - "Standard_E4_v4", - "Standard_E8_v4", - "Standard_E16_v4", - "Standard_E20_v4", - "Standard_E32_v4", - "Standard_E48_v4", - "Standard_E64_v4", - "Standard_E2s_v4", - "Standard_E4s_v4", - "Standard_E8s_v4", - "Standard_E16s_v4", - "Standard_E20s_v4", - "Standard_E32s_v4", - "Standard_E48s_v4", - "Standard_E64s_v4", - "Standard_E2d_v4", - "Standard_E4d_v4", - "Standard_E8d_v4", - "Standard_E16d_v4", - "Standard_E20d_v4", - "Standard_E32d_v4", - "Standard_E48d_v4", - "Standard_E64d_v4", - "Standard_E2ds_v4", - "Standard_E4ds_v4", - "Standard_E8ds_v4", - "Standard_E16ds_v4", - "Standard_E20ds_v4", - "Standard_E32ds_v4", - "Standard_E48ds_v4", - "Standard_E64ds_v4", - "Standard_E2as_v4", - "Standard_E4as_v4", - "Standard_E8as_v4", - "Standard_E16as_v4", - "Standard_E20as_v4", - "Standard_E32as_v4", - "Standard_E48as_v4", - "Standard_E64as_v4", - "Standard_E96as_v4", - "Standard_D2as_v4", - "Standard_D4as_v4", - "Standard_D8as_v4", - "Standard_D16as_v4", - "Standard_D32as_v4", - "Standard_D48as_v4", - "Standard_D64as_v4", - "Standard_D96as_v4", - "Standard_M208ms_v2", - "Standard_M208s_v2", - "Standard_M416ms_v2", - "Standard_M416s_v2", - "Standard_F48s_v2", - "Standard_E48_v3", - "Standard_E48s_v3", - "Standard_E80is_v4", - "Standard_E80ids_v4", - "Standard_E2a_v4", - "Standard_E4a_v4", - "Standard_E8a_v4", - "Standard_E16a_v4", - "Standard_E20a_v4", - "Standard_E32a_v4", - "Standard_E48a_v4", - "Standard_E64a_v4", - "Standard_E96a_v4", - "Standard_D2a_v4", - "Standard_D4a_v4", - "Standard_D8a_v4", - "Standard_D16a_v4", - "Standard_D32a_v4", - "Standard_D48a_v4", - "Standard_D64a_v4", - "Standard_D96a_v4", - "Standard_M32ms_v2", - "Standard_M64s_v2", - "Standard_M64ms_v2", - "Standard_M128s_v2", - "Standard_M128ms_v2", - "Standard_M192is_v2", - "Standard_M192ims_v2", - "Standard_M32dms_v2", - "Standard_M64ds_v2", - "Standard_M64dms_v2", - "Standard_M128ds_v2", - "Standard_M128dms_v2", - "Standard_M192ids_v2", - "Standard_M192idms_v2", - "Standard_D2_v5", - "Standard_D4_v5", - "Standard_D8_v5", - "Standard_D16_v5", - "Standard_D32_v5", - "Standard_D48_v5", - "Standard_D64_v5", - "Standard_D96_v5", - "Standard_D2s_v5", - "Standard_D4s_v5", - "Standard_D8s_v5", - "Standard_D16s_v5", - "Standard_D32s_v5", - "Standard_D48s_v5", - "Standard_D64s_v5", - "Standard_D96s_v5", - "Standard_D2d_v5", - "Standard_D4d_v5", - "Standard_D8d_v5", - "Standard_D16d_v5", - "Standard_D32d_v5", - "Standard_D48d_v5", - "Standard_D64d_v5", - "Standard_D96d_v5", - "Standard_D2ds_v5", - "Standard_D4ds_v5", - "Standard_D8ds_v5", - "Standard_D16ds_v5", - "Standard_D32ds_v5", - "Standard_D48ds_v5", - "Standard_D64ds_v5", - "Standard_D96ds_v5", - "Standard_D2as_v5", - "Standard_D4as_v5", - "Standard_D8as_v5", - "Standard_D16as_v5", - "Standard_D32as_v5", - "Standard_D48as_v5", - "Standard_D64as_v5", - "Standard_D96as_v5", - "Standard_D2ads_v5", - "Standard_D4ads_v5", - "Standard_D8ads_v5", - "Standard_D16ads_v5", - "Standard_D32ads_v5", - "Standard_D48ads_v5", - "Standard_D64ads_v5", - "Standard_D96ads_v5", - "Standard_E2_v5", - "Standard_E4_v5", - "Standard_E8_v5", - "Standard_E16_v5", - "Standard_E20_v5", - "Standard_E32_v5", - "Standard_E48_v5", - "Standard_E64_v5", - "Standard_E96_v5", - "Standard_E104i_v5", - "Standard_E2s_v5", - "Standard_E4s_v5", - "Standard_E8s_v5", - "Standard_E16s_v5", - "Standard_E20s_v5", - "Standard_E32s_v5", - "Standard_E48s_v5", - "Standard_E64s_v5", - "Standard_E96s_v5", - "Standard_E104is_v5", - "Standard_E2d_v5", - "Standard_E4d_v5", - "Standard_E8d_v5", - "Standard_E16d_v5", - "Standard_E20d_v5", - "Standard_E32d_v5", - "Standard_E48d_v5", - "Standard_E64d_v5", - "Standard_E96d_v5", - "Standard_E104id_v5", - "Standard_E2ds_v5", - "Standard_E4ds_v5", - "Standard_E8ds_v5", - "Standard_E16ds_v5", - "Standard_E20ds_v5", - "Standard_E32ds_v5", - "Standard_E48ds_v5", - "Standard_E64ds_v5", - "Standard_E96ds_v5", - "Standard_E104ids_v5", - "Standard_E2as_v5", - "Standard_E4as_v5", - "Standard_E8as_v5", - "Standard_E16as_v5", - "Standard_E20as_v5", - "Standard_E32as_v5", - "Standard_E48as_v5", - "Standard_E64as_v5", - "Standard_E96as_v5", - "Standard_E2ads_v5", - "Standard_E4ads_v5", - "Standard_E8ads_v5", - "Standard_E16ads_v5", - "Standard_E20ads_v5", - "Standard_E32ads_v5", - "Standard_E48ads_v5", - "Standard_E64ads_v5", - "Standard_E96ads_v5", - "Standard_M8_2ms", - "Standard_M8_4ms", - "Standard_M16_4ms", - "Standard_M16_8ms", - "Standard_M32_8ms", - "Standard_M32_16ms", - "Standard_M64_32ms", - "Standard_M64_16ms", - "Standard_M128_64ms", - "Standard_M128_32ms", - "Standard_E4_2s_v3", - "Standard_E8_4s_v3", - "Standard_E8_2s_v3", - "Standard_E16_8s_v3", - "Standard_E16_4s_v3", - "Standard_E32_16s_v3", - "Standard_E32_8s_v3", - "Standard_E64_32s_v3", - "Standard_E64_16s_v3", - "Standard_E4_2s_v4", - "Standard_E8_4s_v4", - "Standard_E8_2s_v4", - "Standard_E16_8s_v4", - "Standard_E16_4s_v4", - "Standard_E32_16s_v4", - "Standard_E32_8s_v4", - "Standard_E64_32s_v4", - "Standard_E64_16s_v4", - "Standard_E4_2ds_v4", - "Standard_E8_4ds_v4", - "Standard_E8_2ds_v4", - "Standard_E16_8ds_v4", - "Standard_E16_4ds_v4", - "Standard_E32_16ds_v4", - "Standard_E32_8ds_v4", - "Standard_E64_32ds_v4", - "Standard_E64_16ds_v4", - "Standard_E4_2as_v4", - "Standard_E8_4as_v4", - "Standard_E8_2as_v4", - "Standard_E16_8as_v4", - "Standard_E16_4as_v4", - "Standard_E32_16as_v4", - "Standard_E32_8as_v4", - "Standard_E64_32as_v4", - "Standard_E64_16as_v4", - "Standard_E96_48as_v4", - "Standard_E96_24as_v4", - "Standard_E4_2ads_v5", - "Standard_E8_4ads_v5", - "Standard_E8_2ads_v5", - "Standard_E16_8ads_v5", - "Standard_E16_4ads_v5", - "Standard_E32_16ads_v5", - "Standard_E32_8ads_v5", - "Standard_E64_32ads_v5", - "Standard_E64_16ads_v5", - "Standard_E96_48ads_v5", - "Standard_E96_24ads_v5", - "Standard_E4_2s_v5", - "Standard_E8_4s_v5", - "Standard_E8_2s_v5", - "Standard_E16_8s_v5", - "Standard_E16_4s_v5", - "Standard_E32_16s_v5", - "Standard_E32_8s_v5", - "Standard_E64_32s_v5", - "Standard_E64_16s_v5", - "Standard_E96_48s_v5", - "Standard_E96_24s_v5", - "Standard_E4_2ds_v5", - "Standard_E8_4ds_v5", - "Standard_E8_2ds_v5", - "Standard_E16_8ds_v5", - "Standard_E16_4ds_v5", - "Standard_E32_16ds_v5", - "Standard_E32_8ds_v5", - "Standard_E64_32ds_v5", - "Standard_E64_16ds_v5", - "Standard_E96_48ds_v5", - "Standard_E96_24ds_v5", - "Standard_E4_2as_v5", - "Standard_E8_4as_v5", - "Standard_E8_2as_v5", - "Standard_E16_8as_v5", - "Standard_E16_4as_v5", - "Standard_E32_16as_v5", - "Standard_E32_8as_v5", - "Standard_E64_32as_v5", - "Standard_E64_16as_v5", - "Standard_E96_48as_v5", - "Standard_E96_24as_v5", - "Standard_GS4_8", - "Standard_GS4_4", - "Standard_GS5_16", - "Standard_GS5_8", - "Standard_DS11_1_v2", - "Standard_DS12_2_v2", - "Standard_DS12_1_v2", - "Standard_DS13_4_v2", - "Standard_DS13_2_v2", - "Standard_DS14_8_v2", - "Standard_DS14_4_v2", - "Standard_M416_208s_v2", - "Standard_M416_208ms_v2", - "Standard_E2bs_v5", - "Standard_E4bs_v5", - "Standard_E8bs_v5", - "Standard_E16bs_v5", - "Standard_E32bs_v5", - "Standard_E48bs_v5", - "Standard_E64bs_v5", - "Standard_E2bds_v5", - "Standard_E4bds_v5", - "Standard_E8bds_v5", - "Standard_E16bds_v5", - "Standard_E32bds_v5", - "Standard_E48bds_v5", - "Standard_E64bds_v5" - ], - "x-ms-enum": { - "name": "AzureVmSize", - "modelAsString": true, - "values": [ - { - "name": "Unknown", - "value": "Unknown" - }, - { - "name": "BasicA0", - "value": "Basic_A0" - }, - { - "name": "BasicA1", - "value": "Basic_A1" - }, - { - "name": "BasicA2", - "value": "Basic_A2" - }, - { - "name": "BasicA3", - "value": "Basic_A3" - }, - { - "name": "BasicA4", - "value": "Basic_A4" - }, - { - "name": "StandardA0", - "value": "Standard_A0" - }, - { - "name": "StandardA1", - "value": "Standard_A1" - }, - { - "name": "StandardA2", - "value": "Standard_A2" - }, - { - "name": "StandardA3", - "value": "Standard_A3" - }, - { - "name": "StandardA4", - "value": "Standard_A4" - }, - { - "name": "StandardA5", - "value": "Standard_A5" - }, - { - "name": "StandardA6", - "value": "Standard_A6" - }, - { - "name": "StandardA7", - "value": "Standard_A7" - }, - { - "name": "StandardA8", - "value": "Standard_A8" - }, - { - "name": "StandardA9", - "value": "Standard_A9" - }, - { - "name": "StandardA10", - "value": "Standard_A10" - }, - { - "name": "StandardA11", - "value": "Standard_A11" - }, - { - "name": "StandardA1V2", - "value": "Standard_A1_v2" - }, - { - "name": "StandardA2V2", - "value": "Standard_A2_v2" - }, - { - "name": "StandardA4V2", - "value": "Standard_A4_v2" - }, - { - "name": "StandardA8V2", - "value": "Standard_A8_v2" - }, - { - "name": "StandardA2MV2", - "value": "Standard_A2m_v2" - }, - { - "name": "StandardA4MV2", - "value": "Standard_A4m_v2" - }, - { - "name": "StandardA8MV2", - "value": "Standard_A8m_v2" - }, - { - "name": "StandardD1", - "value": "Standard_D1" - }, - { - "name": "StandardD2", - "value": "Standard_D2" - }, - { - "name": "StandardD3", - "value": "Standard_D3" - }, - { - "name": "StandardD4", - "value": "Standard_D4" - }, - { - "name": "StandardD11", - "value": "Standard_D11" - }, - { - "name": "StandardD12", - "value": "Standard_D12" - }, - { - "name": "StandardD13", - "value": "Standard_D13" - }, - { - "name": "StandardD14", - "value": "Standard_D14" - }, - { - "name": "StandardD1V2", - "value": "Standard_D1_v2" - }, - { - "name": "StandardD2V2", - "value": "Standard_D2_v2" - }, - { - "name": "StandardD3V2", - "value": "Standard_D3_v2" - }, - { - "name": "StandardD4V2", - "value": "Standard_D4_v2" - }, - { - "name": "StandardD5V2", - "value": "Standard_D5_v2" - }, - { - "name": "StandardD11V2", - "value": "Standard_D11_v2" - }, - { - "name": "StandardD12V2", - "value": "Standard_D12_v2" - }, - { - "name": "StandardD13V2", - "value": "Standard_D13_v2" - }, - { - "name": "StandardD14V2", - "value": "Standard_D14_v2" - }, - { - "name": "StandardD15V2", - "value": "Standard_D15_v2" - }, - { - "name": "StandardDS1", - "value": "Standard_DS1" - }, - { - "name": "StandardDS2", - "value": "Standard_DS2" - }, - { - "name": "StandardDS3", - "value": "Standard_DS3" - }, - { - "name": "StandardDS4", - "value": "Standard_DS4" - }, - { - "name": "StandardDS11", - "value": "Standard_DS11" - }, - { - "name": "StandardDS12", - "value": "Standard_DS12" - }, - { - "name": "StandardDS13", - "value": "Standard_DS13" - }, - { - "name": "StandardDS14", - "value": "Standard_DS14" - }, - { - "name": "StandardDS1V2", - "value": "Standard_DS1_v2" - }, - { - "name": "StandardDS2V2", - "value": "Standard_DS2_v2" - }, - { - "name": "StandardDS3V2", - "value": "Standard_DS3_v2" - }, - { - "name": "StandardDS4V2", - "value": "Standard_DS4_v2" - }, - { - "name": "StandardDS5V2", - "value": "Standard_DS5_v2" - }, - { - "name": "StandardDS11V2", - "value": "Standard_DS11_v2" - }, - { - "name": "StandardDS12V2", - "value": "Standard_DS12_v2" - }, - { - "name": "StandardDS13V2", - "value": "Standard_DS13_v2" - }, - { - "name": "StandardDS14V2", - "value": "Standard_DS14_v2" - }, - { - "name": "StandardDS15V2", - "value": "Standard_DS15_v2" - }, - { - "name": "StandardF1", - "value": "Standard_F1" - }, - { - "name": "StandardF2", - "value": "Standard_F2" - }, - { - "name": "StandardF4", - "value": "Standard_F4" - }, - { - "name": "StandardF8", - "value": "Standard_F8" - }, - { - "name": "StandardF16", - "value": "Standard_F16" - }, - { - "name": "StandardF1S", - "value": "Standard_F1s" - }, - { - "name": "StandardF2S", - "value": "Standard_F2s" - }, - { - "name": "StandardF4S", - "value": "Standard_F4s" - }, - { - "name": "StandardF8S", - "value": "Standard_F8s" - }, - { - "name": "StandardF16S", - "value": "Standard_F16s" - }, - { - "name": "StandardG1", - "value": "Standard_G1" - }, - { - "name": "StandardG2", - "value": "Standard_G2" - }, - { - "name": "StandardG3", - "value": "Standard_G3" - }, - { - "name": "StandardG4", - "value": "Standard_G4" - }, - { - "name": "StandardG5", - "value": "Standard_G5" - }, - { - "name": "StandardGS1", - "value": "Standard_GS1" - }, - { - "name": "StandardGS2", - "value": "Standard_GS2" - }, - { - "name": "StandardGS3", - "value": "Standard_GS3" - }, - { - "name": "StandardGS4", - "value": "Standard_GS4" - }, - { - "name": "StandardGS5", - "value": "Standard_GS5" - }, - { - "name": "StandardH8", - "value": "Standard_H8" - }, - { - "name": "StandardH16", - "value": "Standard_H16" - }, - { - "name": "StandardH8M", - "value": "Standard_H8m" - }, - { - "name": "StandardH16M", - "value": "Standard_H16m" - }, - { - "name": "StandardH16R", - "value": "Standard_H16r" - }, - { - "name": "StandardH16Mr", - "value": "Standard_H16mr" - }, - { - "name": "StandardL4S", - "value": "Standard_L4s" - }, - { - "name": "StandardL8S", - "value": "Standard_L8s" - }, - { - "name": "StandardL16S", - "value": "Standard_L16s" - }, - { - "name": "StandardL32S", - "value": "Standard_L32s" - }, - { - "name": "StandardD2SV3", - "value": "Standard_D2s_v3" - }, - { - "name": "StandardD4SV3", - "value": "Standard_D4s_v3" - }, - { - "name": "StandardD8SV3", - "value": "Standard_D8s_v3" - }, - { - "name": "StandardD16SV3", - "value": "Standard_D16s_v3" - }, - { - "name": "StandardD32SV3", - "value": "Standard_D32s_v3" - }, - { - "name": "StandardD64SV3", - "value": "Standard_D64s_v3" - }, - { - "name": "StandardD2V3", - "value": "Standard_D2_v3" - }, - { - "name": "StandardD4V3", - "value": "Standard_D4_v3" - }, - { - "name": "StandardD8V3", - "value": "Standard_D8_v3" - }, - { - "name": "StandardD16V3", - "value": "Standard_D16_v3" - }, - { - "name": "StandardD32V3", - "value": "Standard_D32_v3" - }, - { - "name": "StandardD64V3", - "value": "Standard_D64_v3" - }, - { - "name": "StandardF2SV2", - "value": "Standard_F2s_v2" - }, - { - "name": "StandardF4SV2", - "value": "Standard_F4s_v2" - }, - { - "name": "StandardF8SV2", - "value": "Standard_F8s_v2" - }, - { - "name": "StandardF16SV2", - "value": "Standard_F16s_v2" - }, - { - "name": "StandardF32SV2", - "value": "Standard_F32s_v2" - }, - { - "name": "StandardF64SV2", - "value": "Standard_F64s_v2" - }, - { - "name": "StandardF72SV2", - "value": "Standard_F72s_v2" - }, - { - "name": "StandardE2V3", - "value": "Standard_E2_v3" - }, - { - "name": "StandardE4V3", - "value": "Standard_E4_v3" - }, - { - "name": "StandardE8V3", - "value": "Standard_E8_v3" - }, - { - "name": "StandardE16V3", - "value": "Standard_E16_v3" - }, - { - "name": "StandardE32V3", - "value": "Standard_E32_v3" - }, - { - "name": "StandardE64V3", - "value": "Standard_E64_v3" - }, - { - "name": "StandardE2SV3", - "value": "Standard_E2s_v3" - }, - { - "name": "StandardE4SV3", - "value": "Standard_E4s_v3" - }, - { - "name": "StandardE8SV3", - "value": "Standard_E8s_v3" - }, - { - "name": "StandardE16SV3", - "value": "Standard_E16s_v3" - }, - { - "name": "StandardE32SV3", - "value": "Standard_E32s_v3" - }, - { - "name": "StandardE64SV3", - "value": "Standard_E64s_v3" - }, - { - "name": "StandardM64S", - "value": "Standard_M64s" - }, - { - "name": "StandardM64Ms", - "value": "Standard_M64ms" - }, - { - "name": "StandardM128S", - "value": "Standard_M128s" - }, - { - "name": "StandardM128Ms", - "value": "Standard_M128ms" - }, - { - "name": "StandardDC2S", - "value": "Standard_DC2s" - }, - { - "name": "StandardDC4S", - "value": "Standard_DC4s" - }, - { - "name": "StandardE20V3", - "value": "Standard_E20_v3" - }, - { - "name": "StandardE20SV3", - "value": "Standard_E20s_v3" - }, - { - "name": "StandardE64IV3", - "value": "Standard_E64i_v3" - }, - { - "name": "StandardE64IsV3", - "value": "Standard_E64is_v3" - }, - { - "name": "StandardM8Ms", - "value": "Standard_M8ms" - }, - { - "name": "StandardM16Ms", - "value": "Standard_M16ms" - }, - { - "name": "StandardM32Ls", - "value": "Standard_M32ls" - }, - { - "name": "StandardM32Ms", - "value": "Standard_M32ms" - }, - { - "name": "StandardM32Ts", - "value": "Standard_M32ts" - }, - { - "name": "StandardM64", - "value": "Standard_M64" - }, - { - "name": "StandardM64Ls", - "value": "Standard_M64ls" - }, - { - "name": "StandardM64M", - "value": "Standard_M64m" - }, - { - "name": "StandardM128", - "value": "Standard_M128" - }, - { - "name": "StandardM128M", - "value": "Standard_M128m" - }, - { - "name": "StandardL8SV2", - "value": "Standard_L8s_v2" - }, - { - "name": "StandardL16SV2", - "value": "Standard_L16s_v2" - }, - { - "name": "StandardL32SV2", - "value": "Standard_L32s_v2" - }, - { - "name": "StandardL48SV2", - "value": "Standard_L48s_v2" - }, - { - "name": "StandardL64SV2", - "value": "Standard_L64s_v2" - }, - { - "name": "StandardL80SV2", - "value": "Standard_L80s_v2" - }, - { - "name": "StandardD2V4", - "value": "Standard_D2_v4" - }, - { - "name": "StandardD4V4", - "value": "Standard_D4_v4" - }, - { - "name": "StandardD8V4", - "value": "Standard_D8_v4" - }, - { - "name": "StandardD16V4", - "value": "Standard_D16_v4" - }, - { - "name": "StandardD32V4", - "value": "Standard_D32_v4" - }, - { - "name": "StandardD48V4", - "value": "Standard_D48_v4" - }, - { - "name": "StandardD64V4", - "value": "Standard_D64_v4" - }, - { - "name": "StandardD2SV4", - "value": "Standard_D2s_v4" - }, - { - "name": "StandardD4SV4", - "value": "Standard_D4s_v4" - }, - { - "name": "StandardD8SV4", - "value": "Standard_D8s_v4" - }, - { - "name": "StandardD16SV4", - "value": "Standard_D16s_v4" - }, - { - "name": "StandardD32SV4", - "value": "Standard_D32s_v4" - }, - { - "name": "StandardD48SV4", - "value": "Standard_D48s_v4" - }, - { - "name": "StandardD64SV4", - "value": "Standard_D64s_v4" - }, - { - "name": "StandardD2DV4", - "value": "Standard_D2d_v4" - }, - { - "name": "StandardD4DV4", - "value": "Standard_D4d_v4" - }, - { - "name": "StandardD8DV4", - "value": "Standard_D8d_v4" - }, - { - "name": "StandardD16DV4", - "value": "Standard_D16d_v4" - }, - { - "name": "StandardD32DV4", - "value": "Standard_D32d_v4" - }, - { - "name": "StandardD48DV4", - "value": "Standard_D48d_v4" - }, - { - "name": "StandardD64DV4", - "value": "Standard_D64d_v4" - }, - { - "name": "StandardD2DsV4", - "value": "Standard_D2ds_v4" - }, - { - "name": "StandardD4DsV4", - "value": "Standard_D4ds_v4" - }, - { - "name": "StandardD8DsV4", - "value": "Standard_D8ds_v4" - }, - { - "name": "StandardD16DsV4", - "value": "Standard_D16ds_v4" - }, - { - "name": "StandardD32DsV4", - "value": "Standard_D32ds_v4" - }, - { - "name": "StandardD48DsV4", - "value": "Standard_D48ds_v4" - }, - { - "name": "StandardD64DsV4", - "value": "Standard_D64ds_v4" - }, - { - "name": "StandardE2V4", - "value": "Standard_E2_v4" - }, - { - "name": "StandardE4V4", - "value": "Standard_E4_v4" - }, - { - "name": "StandardE8V4", - "value": "Standard_E8_v4" - }, - { - "name": "StandardE16V4", - "value": "Standard_E16_v4" - }, - { - "name": "StandardE20V4", - "value": "Standard_E20_v4" - }, - { - "name": "StandardE32V4", - "value": "Standard_E32_v4" - }, - { - "name": "StandardE48V4", - "value": "Standard_E48_v4" - }, - { - "name": "StandardE64V4", - "value": "Standard_E64_v4" - }, - { - "name": "StandardE2SV4", - "value": "Standard_E2s_v4" - }, - { - "name": "StandardE4SV4", - "value": "Standard_E4s_v4" - }, - { - "name": "StandardE8SV4", - "value": "Standard_E8s_v4" - }, - { - "name": "StandardE16SV4", - "value": "Standard_E16s_v4" - }, - { - "name": "StandardE20SV4", - "value": "Standard_E20s_v4" - }, - { - "name": "StandardE32SV4", - "value": "Standard_E32s_v4" - }, - { - "name": "StandardE48SV4", - "value": "Standard_E48s_v4" - }, - { - "name": "StandardE64SV4", - "value": "Standard_E64s_v4" - }, - { - "name": "StandardE2DV4", - "value": "Standard_E2d_v4" - }, - { - "name": "StandardE4DV4", - "value": "Standard_E4d_v4" - }, - { - "name": "StandardE8DV4", - "value": "Standard_E8d_v4" - }, - { - "name": "StandardE16DV4", - "value": "Standard_E16d_v4" - }, - { - "name": "StandardE20DV4", - "value": "Standard_E20d_v4" - }, - { - "name": "StandardE32DV4", - "value": "Standard_E32d_v4" - }, - { - "name": "StandardE48DV4", - "value": "Standard_E48d_v4" - }, - { - "name": "StandardE64DV4", - "value": "Standard_E64d_v4" - }, - { - "name": "StandardE2DsV4", - "value": "Standard_E2ds_v4" - }, - { - "name": "StandardE4DsV4", - "value": "Standard_E4ds_v4" - }, - { - "name": "StandardE8DsV4", - "value": "Standard_E8ds_v4" - }, - { - "name": "StandardE16DsV4", - "value": "Standard_E16ds_v4" - }, - { - "name": "StandardE20DsV4", - "value": "Standard_E20ds_v4" - }, - { - "name": "StandardE32DsV4", - "value": "Standard_E32ds_v4" - }, - { - "name": "StandardE48DsV4", - "value": "Standard_E48ds_v4" - }, - { - "name": "StandardE64DsV4", - "value": "Standard_E64ds_v4" - }, - { - "name": "StandardE2AsV4", - "value": "Standard_E2as_v4" - }, - { - "name": "StandardE4AsV4", - "value": "Standard_E4as_v4" - }, - { - "name": "StandardE8AsV4", - "value": "Standard_E8as_v4" - }, - { - "name": "StandardE16AsV4", - "value": "Standard_E16as_v4" - }, - { - "name": "StandardE20AsV4", - "value": "Standard_E20as_v4" - }, - { - "name": "StandardE32AsV4", - "value": "Standard_E32as_v4" - }, - { - "name": "StandardE48AsV4", - "value": "Standard_E48as_v4" - }, - { - "name": "StandardE64AsV4", - "value": "Standard_E64as_v4" - }, - { - "name": "StandardE96AsV4", - "value": "Standard_E96as_v4" - }, - { - "name": "StandardD2AsV4", - "value": "Standard_D2as_v4" - }, - { - "name": "StandardD4AsV4", - "value": "Standard_D4as_v4" - }, - { - "name": "StandardD8AsV4", - "value": "Standard_D8as_v4" - }, - { - "name": "StandardD16AsV4", - "value": "Standard_D16as_v4" - }, - { - "name": "StandardD32AsV4", - "value": "Standard_D32as_v4" - }, - { - "name": "StandardD48AsV4", - "value": "Standard_D48as_v4" - }, - { - "name": "StandardD64AsV4", - "value": "Standard_D64as_v4" - }, - { - "name": "StandardD96AsV4", - "value": "Standard_D96as_v4" - }, - { - "name": "StandardM208MsV2", - "value": "Standard_M208ms_v2" - }, - { - "name": "StandardM208SV2", - "value": "Standard_M208s_v2" - }, - { - "name": "StandardM416MsV2", - "value": "Standard_M416ms_v2" - }, - { - "name": "StandardM416SV2", - "value": "Standard_M416s_v2" - }, - { - "name": "StandardF48SV2", - "value": "Standard_F48s_v2" - }, - { - "name": "StandardE48V3", - "value": "Standard_E48_v3" - }, - { - "name": "StandardE48SV3", - "value": "Standard_E48s_v3" - }, - { - "name": "StandardE80IsV4", - "value": "Standard_E80is_v4" - }, - { - "name": "StandardE80IdsV4", - "value": "Standard_E80ids_v4" - }, - { - "name": "StandardE2AV4", - "value": "Standard_E2a_v4" - }, - { - "name": "StandardE4AV4", - "value": "Standard_E4a_v4" - }, - { - "name": "StandardE8AV4", - "value": "Standard_E8a_v4" - }, - { - "name": "StandardE16AV4", - "value": "Standard_E16a_v4" - }, - { - "name": "StandardE20AV4", - "value": "Standard_E20a_v4" - }, - { - "name": "StandardE32AV4", - "value": "Standard_E32a_v4" - }, - { - "name": "StandardE48AV4", - "value": "Standard_E48a_v4" - }, - { - "name": "StandardE64AV4", - "value": "Standard_E64a_v4" - }, - { - "name": "StandardE96AV4", - "value": "Standard_E96a_v4" - }, - { - "name": "StandardD2AV4", - "value": "Standard_D2a_v4" - }, - { - "name": "StandardD4AV4", - "value": "Standard_D4a_v4" - }, - { - "name": "StandardD8AV4", - "value": "Standard_D8a_v4" - }, - { - "name": "StandardD16AV4", - "value": "Standard_D16a_v4" - }, - { - "name": "StandardD32AV4", - "value": "Standard_D32a_v4" - }, - { - "name": "StandardD48AV4", - "value": "Standard_D48a_v4" - }, - { - "name": "StandardD64AV4", - "value": "Standard_D64a_v4" - }, - { - "name": "StandardD96AV4", - "value": "Standard_D96a_v4" - }, - { - "name": "StandardM32MsV2", - "value": "Standard_M32ms_v2" - }, - { - "name": "StandardM64SV2", - "value": "Standard_M64s_v2" - }, - { - "name": "StandardM64MsV2", - "value": "Standard_M64ms_v2" - }, - { - "name": "StandardM128SV2", - "value": "Standard_M128s_v2" - }, - { - "name": "StandardM128MsV2", - "value": "Standard_M128ms_v2" - }, - { - "name": "StandardM192IsV2", - "value": "Standard_M192is_v2" - }, - { - "name": "StandardM192ImsV2", - "value": "Standard_M192ims_v2" - }, - { - "name": "StandardM32DmsV2", - "value": "Standard_M32dms_v2" - }, - { - "name": "StandardM64DsV2", - "value": "Standard_M64ds_v2" - }, - { - "name": "StandardM64DmsV2", - "value": "Standard_M64dms_v2" - }, - { - "name": "StandardM128DsV2", - "value": "Standard_M128ds_v2" - }, - { - "name": "StandardM128DmsV2", - "value": "Standard_M128dms_v2" - }, - { - "name": "StandardM192IdsV2", - "value": "Standard_M192ids_v2" - }, - { - "name": "StandardM192IdmsV2", - "value": "Standard_M192idms_v2" - }, - { - "name": "StandardD2V5", - "value": "Standard_D2_v5" - }, - { - "name": "StandardD4V5", - "value": "Standard_D4_v5" - }, - { - "name": "StandardD8V5", - "value": "Standard_D8_v5" - }, - { - "name": "StandardD16V5", - "value": "Standard_D16_v5" - }, - { - "name": "StandardD32V5", - "value": "Standard_D32_v5" - }, - { - "name": "StandardD48V5", - "value": "Standard_D48_v5" - }, - { - "name": "StandardD64V5", - "value": "Standard_D64_v5" - }, - { - "name": "StandardD96V5", - "value": "Standard_D96_v5" - }, - { - "name": "StandardD2SV5", - "value": "Standard_D2s_v5" - }, - { - "name": "StandardD4SV5", - "value": "Standard_D4s_v5" - }, - { - "name": "StandardD8SV5", - "value": "Standard_D8s_v5" - }, - { - "name": "StandardD16SV5", - "value": "Standard_D16s_v5" - }, - { - "name": "StandardD32SV5", - "value": "Standard_D32s_v5" - }, - { - "name": "StandardD48SV5", - "value": "Standard_D48s_v5" - }, - { - "name": "StandardD64SV5", - "value": "Standard_D64s_v5" - }, - { - "name": "StandardD96SV5", - "value": "Standard_D96s_v5" - }, - { - "name": "StandardD2DV5", - "value": "Standard_D2d_v5" - }, - { - "name": "StandardD4DV5", - "value": "Standard_D4d_v5" - }, - { - "name": "StandardD8DV5", - "value": "Standard_D8d_v5" - }, - { - "name": "StandardD16DV5", - "value": "Standard_D16d_v5" - }, - { - "name": "StandardD32DV5", - "value": "Standard_D32d_v5" - }, - { - "name": "StandardD48DV5", - "value": "Standard_D48d_v5" - }, - { - "name": "StandardD64DV5", - "value": "Standard_D64d_v5" - }, - { - "name": "StandardD96DV5", - "value": "Standard_D96d_v5" - }, - { - "name": "StandardD2DsV5", - "value": "Standard_D2ds_v5" - }, - { - "name": "StandardD4DsV5", - "value": "Standard_D4ds_v5" - }, - { - "name": "StandardD8DsV5", - "value": "Standard_D8ds_v5" - }, - { - "name": "StandardD16DsV5", - "value": "Standard_D16ds_v5" - }, - { - "name": "StandardD32DsV5", - "value": "Standard_D32ds_v5" - }, - { - "name": "StandardD48DsV5", - "value": "Standard_D48ds_v5" - }, - { - "name": "StandardD64DsV5", - "value": "Standard_D64ds_v5" - }, - { - "name": "StandardD96DsV5", - "value": "Standard_D96ds_v5" - }, - { - "name": "StandardD2AsV5", - "value": "Standard_D2as_v5" - }, - { - "name": "StandardD4AsV5", - "value": "Standard_D4as_v5" - }, - { - "name": "StandardD8AsV5", - "value": "Standard_D8as_v5" - }, - { - "name": "StandardD16AsV5", - "value": "Standard_D16as_v5" - }, - { - "name": "StandardD32AsV5", - "value": "Standard_D32as_v5" - }, - { - "name": "StandardD48AsV5", - "value": "Standard_D48as_v5" - }, - { - "name": "StandardD64AsV5", - "value": "Standard_D64as_v5" - }, - { - "name": "StandardD96AsV5", - "value": "Standard_D96as_v5" - }, - { - "name": "StandardD2AdsV5", - "value": "Standard_D2ads_v5" - }, - { - "name": "StandardD4AdsV5", - "value": "Standard_D4ads_v5" - }, - { - "name": "StandardD8AdsV5", - "value": "Standard_D8ads_v5" - }, - { - "name": "StandardD16AdsV5", - "value": "Standard_D16ads_v5" - }, - { - "name": "StandardD32AdsV5", - "value": "Standard_D32ads_v5" - }, - { - "name": "StandardD48AdsV5", - "value": "Standard_D48ads_v5" - }, - { - "name": "StandardD64AdsV5", - "value": "Standard_D64ads_v5" - }, - { - "name": "StandardD96AdsV5", - "value": "Standard_D96ads_v5" - }, - { - "name": "StandardE2V5", - "value": "Standard_E2_v5" - }, - { - "name": "StandardE4V5", - "value": "Standard_E4_v5" - }, - { - "name": "StandardE8V5", - "value": "Standard_E8_v5" - }, - { - "name": "StandardE16V5", - "value": "Standard_E16_v5" - }, - { - "name": "StandardE20V5", - "value": "Standard_E20_v5" - }, - { - "name": "StandardE32V5", - "value": "Standard_E32_v5" - }, - { - "name": "StandardE48V5", - "value": "Standard_E48_v5" - }, - { - "name": "StandardE64V5", - "value": "Standard_E64_v5" - }, - { - "name": "StandardE96V5", - "value": "Standard_E96_v5" - }, - { - "name": "StandardE104IV5", - "value": "Standard_E104i_v5" - }, - { - "name": "StandardE2SV5", - "value": "Standard_E2s_v5" - }, - { - "name": "StandardE4SV5", - "value": "Standard_E4s_v5" - }, - { - "name": "StandardE8SV5", - "value": "Standard_E8s_v5" - }, - { - "name": "StandardE16SV5", - "value": "Standard_E16s_v5" - }, - { - "name": "StandardE20SV5", - "value": "Standard_E20s_v5" - }, - { - "name": "StandardE32SV5", - "value": "Standard_E32s_v5" - }, - { - "name": "StandardE48SV5", - "value": "Standard_E48s_v5" - }, - { - "name": "StandardE64SV5", - "value": "Standard_E64s_v5" - }, - { - "name": "StandardE96SV5", - "value": "Standard_E96s_v5" - }, - { - "name": "StandardE104IsV5", - "value": "Standard_E104is_v5" - }, - { - "name": "StandardE2DV5", - "value": "Standard_E2d_v5" - }, - { - "name": "StandardE4DV5", - "value": "Standard_E4d_v5" - }, - { - "name": "StandardE8DV5", - "value": "Standard_E8d_v5" - }, - { - "name": "StandardE16DV5", - "value": "Standard_E16d_v5" - }, - { - "name": "StandardE20DV5", - "value": "Standard_E20d_v5" - }, - { - "name": "StandardE32DV5", - "value": "Standard_E32d_v5" - }, - { - "name": "StandardE48DV5", - "value": "Standard_E48d_v5" - }, - { - "name": "StandardE64DV5", - "value": "Standard_E64d_v5" - }, - { - "name": "StandardE96DV5", - "value": "Standard_E96d_v5" - }, - { - "name": "StandardE104IdV5", - "value": "Standard_E104id_v5" - }, - { - "name": "StandardE2DsV5", - "value": "Standard_E2ds_v5" - }, - { - "name": "StandardE4DsV5", - "value": "Standard_E4ds_v5" - }, - { - "name": "StandardE8DsV5", - "value": "Standard_E8ds_v5" - }, - { - "name": "StandardE16DsV5", - "value": "Standard_E16ds_v5" - }, - { - "name": "StandardE20DsV5", - "value": "Standard_E20ds_v5" - }, - { - "name": "StandardE32DsV5", - "value": "Standard_E32ds_v5" - }, - { - "name": "StandardE48DsV5", - "value": "Standard_E48ds_v5" - }, - { - "name": "StandardE64DsV5", - "value": "Standard_E64ds_v5" - }, - { - "name": "StandardE96DsV5", - "value": "Standard_E96ds_v5" - }, - { - "name": "StandardE104IdsV5", - "value": "Standard_E104ids_v5" - }, - { - "name": "StandardE2AsV5", - "value": "Standard_E2as_v5" - }, - { - "name": "StandardE4AsV5", - "value": "Standard_E4as_v5" - }, - { - "name": "StandardE8AsV5", - "value": "Standard_E8as_v5" - }, - { - "name": "StandardE16AsV5", - "value": "Standard_E16as_v5" - }, - { - "name": "StandardE20AsV5", - "value": "Standard_E20as_v5" - }, - { - "name": "StandardE32AsV5", - "value": "Standard_E32as_v5" - }, - { - "name": "StandardE48AsV5", - "value": "Standard_E48as_v5" - }, - { - "name": "StandardE64AsV5", - "value": "Standard_E64as_v5" - }, - { - "name": "StandardE96AsV5", - "value": "Standard_E96as_v5" - }, - { - "name": "StandardE2AdsV5", - "value": "Standard_E2ads_v5" - }, - { - "name": "StandardE4AdsV5", - "value": "Standard_E4ads_v5" - }, - { - "name": "StandardE8AdsV5", - "value": "Standard_E8ads_v5" - }, - { - "name": "StandardE16AdsV5", - "value": "Standard_E16ads_v5" - }, - { - "name": "StandardE20AdsV5", - "value": "Standard_E20ads_v5" - }, - { - "name": "StandardE32AdsV5", - "value": "Standard_E32ads_v5" - }, - { - "name": "StandardE48AdsV5", - "value": "Standard_E48ads_v5" - }, - { - "name": "StandardE64AdsV5", - "value": "Standard_E64ads_v5" - }, - { - "name": "StandardE96AdsV5", - "value": "Standard_E96ads_v5" - }, - { - "name": "StandardM82Ms", - "value": "Standard_M8_2ms" - }, - { - "name": "StandardM84Ms", - "value": "Standard_M8_4ms" - }, - { - "name": "StandardM164Ms", - "value": "Standard_M16_4ms" - }, - { - "name": "StandardM168Ms", - "value": "Standard_M16_8ms" - }, - { - "name": "StandardM328Ms", - "value": "Standard_M32_8ms" - }, - { - "name": "StandardM3216Ms", - "value": "Standard_M32_16ms" - }, - { - "name": "StandardM6432Ms", - "value": "Standard_M64_32ms" - }, - { - "name": "StandardM6416Ms", - "value": "Standard_M64_16ms" - }, - { - "name": "StandardM12864Ms", - "value": "Standard_M128_64ms" - }, - { - "name": "StandardM12832Ms", - "value": "Standard_M128_32ms" - }, - { - "name": "StandardE42SV3", - "value": "Standard_E4_2s_v3" - }, - { - "name": "StandardE84SV3", - "value": "Standard_E8_4s_v3" - }, - { - "name": "StandardE82SV3", - "value": "Standard_E8_2s_v3" - }, - { - "name": "StandardE168SV3", - "value": "Standard_E16_8s_v3" - }, - { - "name": "StandardE164SV3", - "value": "Standard_E16_4s_v3" - }, - { - "name": "StandardE3216SV3", - "value": "Standard_E32_16s_v3" - }, - { - "name": "StandardE328SV3", - "value": "Standard_E32_8s_v3" - }, - { - "name": "StandardE6432SV3", - "value": "Standard_E64_32s_v3" - }, - { - "name": "StandardE6416SV3", - "value": "Standard_E64_16s_v3" - }, - { - "name": "StandardE42SV4", - "value": "Standard_E4_2s_v4" - }, - { - "name": "StandardE84SV4", - "value": "Standard_E8_4s_v4" - }, - { - "name": "StandardE82SV4", - "value": "Standard_E8_2s_v4" - }, - { - "name": "StandardE168SV4", - "value": "Standard_E16_8s_v4" - }, - { - "name": "StandardE164SV4", - "value": "Standard_E16_4s_v4" - }, - { - "name": "StandardE3216SV4", - "value": "Standard_E32_16s_v4" - }, - { - "name": "StandardE328SV4", - "value": "Standard_E32_8s_v4" - }, - { - "name": "StandardE6432SV4", - "value": "Standard_E64_32s_v4" - }, - { - "name": "StandardE6416SV4", - "value": "Standard_E64_16s_v4" - }, - { - "name": "StandardE42DsV4", - "value": "Standard_E4_2ds_v4" - }, - { - "name": "StandardE84DsV4", - "value": "Standard_E8_4ds_v4" - }, - { - "name": "StandardE82DsV4", - "value": "Standard_E8_2ds_v4" - }, - { - "name": "StandardE168DsV4", - "value": "Standard_E16_8ds_v4" - }, - { - "name": "StandardE164DsV4", - "value": "Standard_E16_4ds_v4" - }, - { - "name": "StandardE3216DsV4", - "value": "Standard_E32_16ds_v4" - }, - { - "name": "StandardE328DsV4", - "value": "Standard_E32_8ds_v4" - }, - { - "name": "StandardE6432DsV4", - "value": "Standard_E64_32ds_v4" - }, - { - "name": "StandardE6416DsV4", - "value": "Standard_E64_16ds_v4" - }, - { - "name": "StandardE42AsV4", - "value": "Standard_E4_2as_v4" - }, - { - "name": "StandardE84AsV4", - "value": "Standard_E8_4as_v4" - }, - { - "name": "StandardE82AsV4", - "value": "Standard_E8_2as_v4" - }, - { - "name": "StandardE168AsV4", - "value": "Standard_E16_8as_v4" - }, - { - "name": "StandardE164AsV4", - "value": "Standard_E16_4as_v4" - }, - { - "name": "StandardE3216AsV4", - "value": "Standard_E32_16as_v4" - }, - { - "name": "StandardE328AsV4", - "value": "Standard_E32_8as_v4" - }, - { - "name": "StandardE6432AsV4", - "value": "Standard_E64_32as_v4" - }, - { - "name": "StandardE6416AsV4", - "value": "Standard_E64_16as_v4" - }, - { - "name": "StandardE9648AsV4", - "value": "Standard_E96_48as_v4" - }, - { - "name": "StandardE9624AsV4", - "value": "Standard_E96_24as_v4" - }, - { - "name": "StandardE42AdsV5", - "value": "Standard_E4_2ads_v5" - }, - { - "name": "StandardE84AdsV5", - "value": "Standard_E8_4ads_v5" - }, - { - "name": "StandardE82AdsV5", - "value": "Standard_E8_2ads_v5" - }, - { - "name": "StandardE168AdsV5", - "value": "Standard_E16_8ads_v5" - }, - { - "name": "StandardE164AdsV5", - "value": "Standard_E16_4ads_v5" - }, - { - "name": "StandardE3216AdsV5", - "value": "Standard_E32_16ads_v5" - }, - { - "name": "StandardE328AdsV5", - "value": "Standard_E32_8ads_v5" - }, - { - "name": "StandardE6432AdsV5", - "value": "Standard_E64_32ads_v5" - }, - { - "name": "StandardE6416AdsV5", - "value": "Standard_E64_16ads_v5" - }, - { - "name": "StandardE9648AdsV5", - "value": "Standard_E96_48ads_v5" - }, - { - "name": "StandardE9624AdsV5", - "value": "Standard_E96_24ads_v5" - }, - { - "name": "StandardE42SV5", - "value": "Standard_E4_2s_v5" - }, - { - "name": "StandardE84SV5", - "value": "Standard_E8_4s_v5" - }, - { - "name": "StandardE82SV5", - "value": "Standard_E8_2s_v5" - }, - { - "name": "StandardE168SV5", - "value": "Standard_E16_8s_v5" - }, - { - "name": "StandardE164SV5", - "value": "Standard_E16_4s_v5" - }, - { - "name": "StandardE3216SV5", - "value": "Standard_E32_16s_v5" - }, - { - "name": "StandardE328SV5", - "value": "Standard_E32_8s_v5" - }, - { - "name": "StandardE6432SV5", - "value": "Standard_E64_32s_v5" - }, - { - "name": "StandardE6416SV5", - "value": "Standard_E64_16s_v5" - }, - { - "name": "StandardE9648SV5", - "value": "Standard_E96_48s_v5" - }, - { - "name": "StandardE9624SV5", - "value": "Standard_E96_24s_v5" - }, - { - "name": "StandardE42DsV5", - "value": "Standard_E4_2ds_v5" - }, - { - "name": "StandardE84DsV5", - "value": "Standard_E8_4ds_v5" - }, - { - "name": "StandardE82DsV5", - "value": "Standard_E8_2ds_v5" - }, - { - "name": "StandardE168DsV5", - "value": "Standard_E16_8ds_v5" - }, - { - "name": "StandardE164DsV5", - "value": "Standard_E16_4ds_v5" - }, - { - "name": "StandardE3216DsV5", - "value": "Standard_E32_16ds_v5" - }, - { - "name": "StandardE328DsV5", - "value": "Standard_E32_8ds_v5" - }, - { - "name": "StandardE6432DsV5", - "value": "Standard_E64_32ds_v5" - }, - { - "name": "StandardE6416DsV5", - "value": "Standard_E64_16ds_v5" - }, - { - "name": "StandardE9648DsV5", - "value": "Standard_E96_48ds_v5" - }, - { - "name": "StandardE9624DsV5", - "value": "Standard_E96_24ds_v5" - }, - { - "name": "StandardE42AsV5", - "value": "Standard_E4_2as_v5" - }, - { - "name": "StandardE84AsV5", - "value": "Standard_E8_4as_v5" - }, - { - "name": "StandardE82AsV5", - "value": "Standard_E8_2as_v5" - }, - { - "name": "StandardE168AsV5", - "value": "Standard_E16_8as_v5" - }, - { - "name": "StandardE164AsV5", - "value": "Standard_E16_4as_v5" - }, - { - "name": "StandardE3216AsV5", - "value": "Standard_E32_16as_v5" - }, - { - "name": "StandardE328AsV5", - "value": "Standard_E32_8as_v5" - }, - { - "name": "StandardE6432AsV5", - "value": "Standard_E64_32as_v5" - }, - { - "name": "StandardE6416AsV5", - "value": "Standard_E64_16as_v5" - }, - { - "name": "StandardE9648AsV5", - "value": "Standard_E96_48as_v5" - }, - { - "name": "StandardE9624AsV5", - "value": "Standard_E96_24as_v5" - }, - { - "name": "StandardGS48", - "value": "Standard_GS4_8" - }, - { - "name": "StandardGS44", - "value": "Standard_GS4_4" - }, - { - "name": "StandardGS516", - "value": "Standard_GS5_16" - }, - { - "name": "StandardGS58", - "value": "Standard_GS5_8" - }, - { - "name": "StandardDS111V2", - "value": "Standard_DS11_1_v2" - }, - { - "name": "StandardDS122V2", - "value": "Standard_DS12_2_v2" - }, - { - "name": "StandardDS121V2", - "value": "Standard_DS12_1_v2" - }, - { - "name": "StandardDS134V2", - "value": "Standard_DS13_4_v2" - }, - { - "name": "StandardDS132V2", - "value": "Standard_DS13_2_v2" - }, - { - "name": "StandardDS148V2", - "value": "Standard_DS14_8_v2" - }, - { - "name": "StandardDS144V2", - "value": "Standard_DS14_4_v2" - }, - { - "name": "StandardM416208SV2", - "value": "Standard_M416_208s_v2" - }, - { - "name": "StandardM416208MsV2", - "value": "Standard_M416_208ms_v2" - }, - { - "name": "StandardE2BsV5", - "value": "Standard_E2bs_v5" - }, - { - "name": "StandardE4BsV5", - "value": "Standard_E4bs_v5" - }, - { - "name": "StandardE8BsV5", - "value": "Standard_E8bs_v5" - }, - { - "name": "StandardE16BsV5", - "value": "Standard_E16bs_v5" - }, - { - "name": "StandardE32BsV5", - "value": "Standard_E32bs_v5" - }, - { - "name": "StandardE48BsV5", - "value": "Standard_E48bs_v5" - }, - { - "name": "StandardE64BsV5", - "value": "Standard_E64bs_v5" - }, - { - "name": "StandardE2BdsV5", - "value": "Standard_E2bds_v5" - }, - { - "name": "StandardE4BdsV5", - "value": "Standard_E4bds_v5" - }, - { - "name": "StandardE8BdsV5", - "value": "Standard_E8bds_v5" - }, - { - "name": "StandardE16BdsV5", - "value": "Standard_E16bds_v5" - }, - { - "name": "StandardE32BdsV5", - "value": "Standard_E32bds_v5" - }, - { - "name": "StandardE48BdsV5", - "value": "Standard_E48bds_v5" - }, - { - "name": "StandardE64BdsV5", - "value": "Standard_E64bds_v5" - } - ] - } - }, - "AzureVmSuitabilityDetail": { - "type": "string", - "enum": [ - "None", - "RecommendedSizeHasLessNetworkAdapters", - "CannotReportComputeCost", - "CannotReportStorageCost", - "CannotReportBandwidthCosts", - "PercentageOfCoresUtilizedMissing", - "PercentageOfMemoryUtilizedMissing", - "PercentageOfCoresUtilizedOutOfRange", - "PercentageOfMemoryUtilizedOutOfRange" - ], - "x-ms-enum": { - "name": "AzureVmSuitabilityDetail", - "modelAsString": true - } - }, - "AzureVmSuitabilityExplanation": { - "type": "string", - "enum": [ - "Unknown", - "NotApplicable", - "GuestOperatingSystemArchitectureNotSupported", - "GuestOperatingSystemNotSupported", - "BootTypeNotSupported", - "MoreDisksThanSupported", - "NoSuitableVmSizeFound", - "OneOrMoreDisksNotSuitable", - "OneOrMoreAdaptersNotSuitable", - "InternalErrorOccurredDuringComputeEvaluation", - "InternalErrorOccurredDuringStorageEvaluation", - "InternalErrorOccurredDuringNetworkEvaluation", - "NoVmSizeSupportsStoragePerformance", - "NoVmSizeSupportsNetworkPerformance", - "NoVmSizeForSelectedPricingTier", - "NoVmSizeForSelectedAzureLocation", - "CheckRedHatLinuxVersion", - "CheckOpenSuseLinuxVersion", - "CheckWindowsServer2008R2Version", - "CheckCentOsVersion", - "CheckDebianLinuxVersion", - "CheckSuseLinuxVersion", - "CheckOracleLinuxVersion", - "CheckUbuntuLinuxVersion", - "CheckCoreOsLinuxVersion", - "WindowsServerVersionConditionallySupported", - "NoGuestOperatingSystemConditionallySupported", - "WindowsClientVersionsConditionallySupported", - "BootTypeUnknown", - "GuestOperatingSystemUnknown", - "WindowsServerVersionsSupportedWithCaveat", - "WindowsOSNoLongerUnderMSSupport", - "EndorsedWithConditionsLinuxDistributions", - "UnendorsedLinuxDistributions", - "NoVmSizeForStandardPricingTier", - "NoVmSizeForBasicPricingTier", - "NoVmSizeInSelectedFamilyFound", - "NoEaPriceFoundForVmSize", - "NoVmSizeFoundForOfferCurrencyReservedInstance" - ], - "x-ms-enum": { - "name": "AzureVmSuitabilityExplanation", - "modelAsString": true - } - }, - "CloudSuitability": { - "type": "string", - "description": "Cloud Suitability for Azure.", - "enum": [ - "Unknown", - "NotSuitable", - "Suitable", - "ConditionallySuitable", - "ReadinessUnknown" - ], - "x-ms-enum": { - "name": "CloudSuitability", - "modelAsString": true, - "values": [ - { - "name": "Unknown", - "value": "Unknown", - "description": "Unknown. Indicates missing data." - }, - { - "name": "NotSuitable", - "value": "NotSuitable", - "description": "Not Suitable for Azure." - }, - { - "name": "Suitable", - "value": "Suitable", - "description": "Suitable for Azure." - }, - { - "name": "ConditionallySuitable", - "value": "ConditionallySuitable", - "description": "Conditionally Suitable for Azure." - }, - { - "name": "ReadinessUnknown", - "value": "ReadinessUnknown", - "description": "Unknown Readiness for Azure." - } - ] - } - }, - "CollectorAgentPropertiesBase": { - "type": "object", - "description": "Collector agent property class.", - "properties": { - "id": { - "type": "string", - "description": "Gets the collector agent id." - }, - "version": { - "type": "string", - "description": "Gets the collector agent version." - }, - "lastHeartbeatUtc": { - "type": "string", - "format": "date-time", - "description": "Gets the collector last heartbeat time." - }, - "spnDetails": { - "$ref": "#/definitions/CollectorAgentSpnPropertiesBase", - "description": "Gets or sets the SPN details." - } - } - }, - "CollectorAgentSpnPropertiesBase": { - "type": "object", - "description": "Collector agent SPN details class.", - "properties": { - "authority": { - "type": "string", - "description": "Gets the AAD authority endpoint." - }, - "applicationId": { - "type": "string", - "description": "Gets the AAD application id." - }, - "audience": { - "type": "string", - "description": "Gets the AAD audience url." - }, - "objectId": { - "type": "string", - "description": "Gets the object id of the AAD application." - }, - "tenantId": { - "type": "string", - "description": "Gets the tenant id of the AAD application." - } - } - }, - "CollectorPropertiesBase": { - "type": "object", - "description": "Collector properties class.", - "properties": { - "discoverySiteId": { - "type": "string", - "description": "Gets the discovery site id." - }, - "createdTimestamp": { - "type": "string", - "format": "date-time", - "description": "Gets the Timestamp when collector was created.", - "readOnly": true - }, - "updatedTimestamp": { - "type": "string", - "format": "date-time", - "description": "Timestamp when collector was last updated.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/definitions/AzureResourceProperties" - } - ] - }, - "CollectorPropertiesBaseWithAgent": { - "type": "object", - "description": "Collector properties class.", - "properties": { - "agentProperties": { - "$ref": "#/definitions/CollectorAgentPropertiesBase", - "description": "Gets or sets the collector agent properties." - }, - "discoverySiteId": { - "type": "string", - "description": "Gets the discovery site id." - }, - "createdTimestamp": { - "type": "string", - "format": "date-time", - "description": "Gets the Timestamp when collector was created.", - "readOnly": true - }, - "updatedTimestamp": { - "type": "string", - "format": "date-time", - "description": "Timestamp when collector was last updated.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/definitions/AzureResourceProperties" - } - ] - }, - "CompatibilityLevel": { - "type": "string", - "enum": [ - "Unknown", - "CompatLevel80", - "CompatLevel90", - "CompatLevel100", - "CompatLevel110", - "CompatLevel120", - "CompatLevel130", - "CompatLevel140", - "CompatLevel150" - ], - "x-ms-enum": { - "name": "CompatibilityLevel", - "modelAsString": true - } - }, - "ComputeTier": { - "type": "string", - "enum": [ - "Unknown", - "Automatic", - "Provisioned", - "Serverless" - ], - "x-ms-enum": { - "name": "ComputeTier", - "modelAsString": true - } - }, - "CostComponent": { - "type": "object", - "description": "Class to represent the component of the cost.", - "properties": { - "name": { - "$ref": "#/definitions/CostComponentName", - "description": "Gets the name of the component.", - "readOnly": true - }, - "value": { - "type": "number", - "format": "float", - "description": "The value of the component." - }, - "description": { - "type": "string", - "description": "The textual description of the component." - } - } - }, - "CostComponentName": { - "type": "string", - "description": "Enum to represent component name.", - "enum": [ - "Unknown", - "MonthlyAzureHybridCostSavings", - "MonthlySecurityCost", - "MonthlyPremiumV2StorageCost" - ], - "x-ms-enum": { - "name": "CostComponentName", - "modelAsString": true - } - }, - "Disk": { - "type": "object", - "description": "A disk discovered on a machine.", - "properties": { - "gigabytesAllocated": { - "type": "number", - "format": "float", - "description": "Gigabytes of storage provisioned for this disk.", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "User friendly name of the disk.", - "readOnly": true - } - } - }, - "DownloadUrl": { - "type": "object", - "description": "Data model of Download URL for assessment report.", - "properties": { - "assessmentReportUrl": { - "type": "string", - "description": "Hyperlink to download report.", - "readOnly": true - }, - "expirationTime": { - "type": "string", - "format": "date-time", - "description": "Expiry date of download url.", - "readOnly": true - } - }, - "required": [ - "assessmentReportUrl", - "expirationTime" - ] - }, - "EntityUptime": { - "type": "object", - "description": "Entity Uptime.", - "properties": { - "daysPerMonth": { - "type": "integer", - "format": "int32", - "description": "Gets the days per month." - }, - "hoursPerDay": { - "type": "integer", - "format": "int32", - "description": "Gets the hours per day." - } - } - }, - "EnvironmentType": { - "type": "string", - "enum": [ - "Production", - "Test" - ], - "x-ms-enum": { - "name": "EnvironmentType", - "modelAsString": true - } - }, - "Error": { - "type": "object", - "description": "Error web model class.", - "properties": { - "id": { - "type": "integer", - "format": "int32", - "description": "Gets the error ID.", - "readOnly": true - }, - "code": { - "type": "string", - "description": "Gets the error code.", - "readOnly": true - }, - "runAsAccountId": { - "type": "string", - "description": "Gets the Run as account ID.", - "readOnly": true - }, - "applianceName": { - "type": "string", - "description": "Gets the Appliance name.", - "readOnly": true - }, - "message": { - "type": "string", - "description": "Gets the error message.", - "readOnly": true - }, - "summaryMessage": { - "type": "string", - "description": "Gets the error summary message.", - "readOnly": true - }, - "agentScenario": { - "type": "string", - "description": "Gets the agent scenario where this error occurred.", - "readOnly": true - }, - "possibleCauses": { - "type": "string", - "description": "Gets the error possible causes.", - "readOnly": true - }, - "recommendedAction": { - "type": "string", - "description": "Gets the recommended action for the error.", - "readOnly": true - }, - "severity": { - "type": "string", - "description": "Gets the error severity.", - "readOnly": true - }, - "messageParameters": { - "type": "object", - "description": "Gets the error message parameters.", - "additionalProperties": { - "type": "string" - }, - "readOnly": true - }, - "updatedTimeStamp": { - "type": "string", - "format": "date-time", - "description": "Gets the time stamp when the error was updated.", - "readOnly": true - }, - "impactedAssessmentType": { - "type": "string", - "description": "Gets the type of assessment impacted by this error.", - "readOnly": true - } - } - }, - "ErrorSummary": { - "type": "object", - "description": "Error summary containing affected entities for each type of assessment.", - "properties": { - "assessmentType": { - "$ref": "#/definitions/AssessmentType", - "description": "Gets the assessment type.", - "readOnly": true - }, - "count": { - "type": "integer", - "format": "int32", - "description": "Gets the affected entity count.", - "readOnly": true - } - } - }, - "FttAndRaidLevel": { - "type": "string", - "enum": [ - "Unknown", - "Ftt1Raid1", - "Ftt1Raid5", - "Ftt2Raid1", - "Ftt2Raid6", - "Ftt3Raid1" - ], - "x-ms-enum": { - "name": "FttAndRaidLevel", - "modelAsString": true - } - }, - "Group": { - "type": "object", - "description": "Group resource.", - "properties": { - "properties": { - "$ref": "#/definitions/GroupProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "GroupBodyProperties": { - "type": "object", - "description": "Body properties of group update.", - "properties": { - "operationType": { - "$ref": "#/definitions/GroupUpdateOperation", - "description": "Whether to add or remove the machines." - }, - "machines": { - "type": "array", - "description": "List of machine names that are part of this group.", - "items": { - "type": "string" - } - } - } - }, - "GroupListResult": { - "type": "object", - "description": "The response of a Group list operation.", - "properties": { - "value": { - "type": "array", - "description": "The Group items on this page", - "items": { - "$ref": "#/definitions/Group" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "GroupProperties": { - "type": "object", - "description": "Properties of group resource.", - "properties": { - "groupStatus": { - "$ref": "#/definitions/GroupStatus", - "description": "Whether the group has been created and is valid.", - "readOnly": true - }, - "machineCount": { - "type": "integer", - "format": "int32", - "description": "Number of machines part of this group.", - "readOnly": true - }, - "assessments": { - "type": "array", - "description": "List of References to Assessments created on this group.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "supportedAssessmentTypes": { - "type": "array", - "description": "List of assessment types supported on this group.", - "items": { - "$ref": "#/definitions/AssessmentType" - } - }, - "areAssessmentsRunning": { - "type": "boolean", - "description": "If the assessments are in running state.", - "readOnly": true - }, - "createdTimestamp": { - "type": "string", - "format": "date-time", - "description": "Time when this group was created. Date-Time represented in ISO-8601 format.", - "readOnly": true - }, - "updatedTimestamp": { - "type": "string", - "format": "date-time", - "description": "Time when this group was last updated. Date-Time represented in ISO-8601 format.", - "readOnly": true - }, - "groupType": { - "$ref": "#/definitions/GroupType", - "description": "The type of group.", - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "#/definitions/AzureResourceProperties" - } - ] - }, - "GroupStatus": { - "type": "string", - "enum": [ - "Created", - "Updated", - "Running", - "Completed", - "Invalid" - ], - "x-ms-enum": { - "name": "GroupStatus", - "modelAsString": true - } - }, - "GroupType": { - "type": "string", - "enum": [ - "Default", - "Import" - ], - "x-ms-enum": { - "name": "GroupType", - "modelAsString": true - } - }, - "GroupUpdateOperation": { - "type": "string", - "enum": [ - "Add", - "Remove" - ], - "x-ms-enum": { - "name": "GroupUpdateOperation", - "modelAsString": true - } - }, - "GuestOperatingSystemArchitecture": { - "type": "string", - "enum": [ - "Unknown", - "X86", - "X64" - ], - "x-ms-enum": { - "name": "GuestOperatingSystemArchitecture", - "modelAsString": true - } - }, - "HardwareGeneration": { - "type": "string", - "enum": [ - "Unknown", - "Automatic", - "Gen5", - "Fsv2_series", - "M_series", - "DC_series" - ], - "x-ms-enum": { - "name": "HardwareGeneration", - "modelAsString": true, - "values": [ - { - "name": "Unknown", - "value": "Unknown" - }, - { - "name": "Automatic", - "value": "Automatic" - }, - { - "name": "Gen5", - "value": "Gen5" - }, - { - "name": "Fsv2Series", - "value": "Fsv2_series" - }, - { - "name": "MSeries", - "value": "M_series" - }, - { - "name": "DCSeries", - "value": "DC_series" - } - ] - } - }, - "HypervCollector": { - "type": "object", - "description": "Hyper-V collector resource.", - "properties": { - "properties": { - "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "HypervCollectorListResult": { - "type": "object", - "description": "The response of a HypervCollector list operation.", - "properties": { - "value": { - "type": "array", - "description": "The HypervCollector items on this page", - "items": { - "$ref": "#/definitions/HypervCollector" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "ImpactedAssessmentObject": { - "type": "object", - "description": "Class representing the impacted objects.", - "properties": { - "objectName": { - "type": "string", - "description": "Gets the object name.", - "readOnly": true - }, - "objectType": { - "type": "string", - "description": "Gets the object type.", - "readOnly": true - } - } - }, - "ImportCollector": { - "type": "object", - "description": "Import collector resource.", - "properties": { - "properties": { - "$ref": "#/definitions/CollectorPropertiesBase", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "ImportCollectorListResult": { - "type": "object", - "description": "The response of a ImportCollector list operation.", - "properties": { - "value": { - "type": "array", - "description": "The ImportCollector items on this page", - "items": { - "$ref": "#/definitions/ImportCollector" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "Machine": { - "type": "object", - "description": "Machine resource.", - "properties": { - "properties": { - "$ref": "#/definitions/MachineProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "MachineAssessmentProperties": { - "type": "object", - "description": "Properties of an assessment.", - "properties": { - "assessmentErrorSummary": { - "type": "object", - "description": "Gets or sets the assessment error summary.\n This is the number of\nmachines affected by each type of error in this assessment.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "monthlyUltraStorageCost": { - "type": "number", - "format": "float", - "description": "Gets or sets the aggregate ultra storage cost for all machines in the\nassessment.", - "readOnly": true - }, - "costComponents": { - "type": "array", - "description": "Gets the collection of cost components.", - "items": { - "$ref": "#/definitions/CostComponent" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "eaSubscriptionId": { - "type": "string", - "description": "Gets or sets enterprise agreement subscription id." - }, - "azurePricingTier": { - "$ref": "#/definitions/AzurePricingTier", - "description": "Gets or sets Azure Pricing Tier - Free, Basic, etc." - }, - "azureStorageRedundancy": { - "$ref": "#/definitions/AzureStorageRedundancy", - "description": "Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage." - }, - "reservedInstance": { - "$ref": "#/definitions/AzureReservedInstance", - "description": "Gets or sets the Azure Reserved Instance - 1-Year, 3-Year." - }, - "azureHybridUseBenefit": { - "$ref": "#/definitions/AzureHybridUseBenefit", - "description": "Gets or sets the user configurable setting to display the azure hybrid use\nbenefit." - }, - "azureDiskTypes": { - "type": "array", - "description": "Gets or sets the azure storage type. Premium, Standard etc.", - "items": { - "$ref": "#/definitions/AzureDiskType" - } - }, - "azureVmFamilies": { - "type": "array", - "description": "Gets or sets the Azure VM families.", - "items": { - "$ref": "#/definitions/AzureVmFamily" - } - }, - "distributionBySupportStatus": { - "type": "object", - "description": "Gets the distribution of sqlInstances by support status.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "distributionByServicePackInsight": { - "type": "object", - "description": "Gets the distribution distribution of sqlInstances by service pack insight.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "distributionByOsName": { - "type": "object", - "description": "Gets the distribution by os name.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "monthlyComputeCost": { - "type": "number", - "format": "float", - "description": "Gets or sets the aggregate Compute Cost for all machines in the assessment.", - "readOnly": true - }, - "monthlyBandwidthCost": { - "type": "number", - "format": "float", - "description": "Gets or sets the aggregate Bandwidth Cost for all machines in the assessment.", - "readOnly": true - }, - "monthlyStorageCost": { - "type": "number", - "format": "float", - "description": "Gets or sets the aggregate Storage Cost for all machines in the assessment.", - "readOnly": true - }, - "monthlyPremiumStorageCost": { - "type": "number", - "format": "float", - "description": "Gets or sets the aggregate premium storage cost for all machines in the\nassessment.", - "readOnly": true - }, - "monthlyStandardSsdStorageCost": { - "type": "number", - "format": "float", - "description": "Gets or sets the aggregate standard SSD storage cost for all the machines in\nthe assessment.", - "readOnly": true - }, - "suitabilitySummary": { - "type": "object", - "description": "Gets or sets the Cloud suitability summary for all the machines in the\nassessment.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "numberOfMachines": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the Number of machines part of the assessment.", - "readOnly": true - }, - "vmUptime": { - "$ref": "#/definitions/VmUptime", - "description": "Gets or sets the duration for which the VMs are up in the on-premises\nenvironment." - }, - "groupType": { - "$ref": "#/definitions/GroupType", - "description": "Gets the group type for the assessment.", - "readOnly": true - }, - "assessmentType": { - "$ref": "#/definitions/AssessmentType", - "description": "Assessment type of the assessment.", - "readOnly": true - }, - "azureLocation": { - "type": "string", - "description": "Azure Location or Azure region where to which the machines will be migrated." - }, - "azureOfferCode": { - "$ref": "#/definitions/AzureOfferCode", - "description": "Azure Offer Code." - }, - "currency": { - "$ref": "#/definitions/AzureCurrency", - "description": "Currency in which prices should be reported." - }, - "scalingFactor": { - "type": "number", - "format": "float", - "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." - }, - "percentile": { - "$ref": "#/definitions/Percentile", - "description": "Percentile of the utilization data values to be considered while assessing\nmachines." - }, - "timeRange": { - "$ref": "#/definitions/TimeRange", - "description": "Time Range for which the historic utilization data should be considered for\nassessment." - }, - "perfDataStartTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the start time to consider performance data for assessment." - }, - "perfDataEndTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the end time to consider performance data for assessment." - }, - "stage": { - "$ref": "#/definitions/AssessmentStage", - "description": "User configurable setting to display the Stage of Assessment.", - "readOnly": true - }, - "discountPercentage": { - "type": "number", - "format": "float", - "description": "Custom discount percentage." - }, - "sizingCriterion": { - "$ref": "#/definitions/AssessmentSizingCriterion", - "description": "Assessment sizing criterion." - }, - "confidenceRatingInPercentage": { - "type": "number", - "format": "float", - "description": "Confidence Rating in Percentage.", - "readOnly": true - }, - "pricesTimestamp": { - "type": "string", - "format": "date-time", - "description": "Last time when rates were queried.", - "readOnly": true - }, - "createdTimestamp": { - "type": "string", - "format": "date-time", - "description": "Date and Time when assessment was created.", - "readOnly": true - }, - "updatedTimestamp": { - "type": "string", - "format": "date-time", - "description": "Date and Time when assessment was last updated.", - "readOnly": true - }, - "status": { - "$ref": "#/definitions/AssessmentStatus", - "description": "Whether assessment is in valid state and all machines have been assessed.", - "readOnly": true - }, - "schemaVersion": { - "type": "string", - "description": "Schema version.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/definitions/AzureResourceProperties" - } - ] - }, - "MachineBootType": { - "type": "string", - "enum": [ - "Unknown", - "EFI", - "BIOS", - "NotSpecified" - ], - "x-ms-enum": { - "name": "MachineBootType", - "modelAsString": true, - "values": [ - { - "name": "Unknown", - "value": "Unknown" - }, - { - "name": "EFI", - "value": "EFI" - }, - { - "name": "Bios", - "value": "BIOS" - }, - { - "name": "NotSpecified", - "value": "NotSpecified" - } - ] - } - }, - "MachineListResult": { - "type": "object", - "description": "The response of a Machine list operation.", - "properties": { - "value": { - "type": "array", - "description": "The Machine items on this page", - "items": { - "$ref": "#/definitions/Machine" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "MachineProperties": { - "type": "object", - "description": "Properties of a machine.", - "properties": { - "workloadSummary": { - "$ref": "#/definitions/WorkloadSummary", - "description": "Gets or sets workload summary.", - "readOnly": true - }, - "errors": { - "type": "array", - "description": "List of errors for this machine.", - "items": { - "$ref": "#/definitions/Error" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "hostProcessor": { - "$ref": "#/definitions/ProcessorInfo", - "description": "Gets Processor details of the host.", - "readOnly": true - }, - "productSupportStatus": { - "$ref": "#/definitions/ProductSupportStatus", - "description": "Gets the product support status related details.", - "readOnly": true - }, - "discoveryMachineArmId": { - "type": "string", - "description": "Site id of machine discovered in private data center.", - "readOnly": true - }, - "datacenterManagementServerArmId": { - "type": "string", - "description": "The data center management server ARM Id for the machine.", - "readOnly": true - }, - "datacenterManagementServerName": { - "type": "string", - "description": "The data center management server name for the machine.", - "readOnly": true - }, - "bootType": { - "$ref": "#/definitions/MachineBootType", - "description": "Boot type of machine discovered in private data center.", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "Display Name of the Machine.", - "readOnly": true - }, - "megabytesOfMemory": { - "type": "number", - "format": "float", - "description": "Megabytes of memory found allocated for the machine in private data center.", - "readOnly": true - }, - "numberOfCores": { - "type": "integer", - "format": "int32", - "description": "Number of CPU cores found on the machine.", - "readOnly": true - }, - "operatingSystemType": { - "type": "string", - "description": "Operating system as reported by datacenter management solution.", - "readOnly": true - }, - "operatingSystemName": { - "type": "string", - "description": "Operating system as reported by datacenter management solution.", - "readOnly": true - }, - "operatingSystemVersion": { - "type": "string", - "description": "Operating system version as reported by datacenter management solution.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "Description for the machine.", - "readOnly": true - }, - "createdTimestamp": { - "type": "string", - "format": "date-time", - "description": "When was machine first created.", - "readOnly": true - }, - "disks": { - "type": "object", - "description": "Disks attached to the machine discovered in private data center.", - "additionalProperties": { - "$ref": "#/definitions/Disk" - }, - "readOnly": true - }, - "groups": { - "type": "array", - "description": "Gets the References to the groups that this machine is member of.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "networkAdapters": { - "type": "object", - "description": "Network adapters attached to the machine discovered in private data center.", - "additionalProperties": { - "$ref": "#/definitions/NetworkAdapter" - }, - "readOnly": true - }, - "sqlInstances": { - "type": "array", - "description": "SQL instances discovered on the machine.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "webApplications": { - "type": "array", - "description": "Web applications discovered on the machine.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "updatedTimestamp": { - "type": "string", - "format": "date-time", - "description": "When was machine last updated.", - "readOnly": true - } - } - }, - "MigrationGuidelineContext": { - "type": "object", - "description": "Migration Guideline Context.", - "properties": { - "contextKey": { - "type": "string", - "description": "Gets the reasoning context key." - }, - "contextValue": { - "type": "string", - "description": "Gets the reasoning context value." - } - } - }, - "MultiSubnetIntent": { - "type": "string", - "enum": [ - "None", - "HighAvailability", - "DisasterRecovery" - ], - "x-ms-enum": { - "name": "MultiSubnetIntent", - "modelAsString": true - } - }, - "NetworkAdapter": { - "type": "object", - "description": "A network adapter discovered on a machine.", - "properties": { - "macAddress": { - "type": "string", - "description": "MAC Address of the network adapter.", - "readOnly": true - }, - "ipAddresses": { - "type": "array", - "description": "List of IP Addresses on the network adapter.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "User friendly name of the network adapter.", - "readOnly": true - } - } - }, - "OptimizationLogic": { - "type": "string", - "enum": [ - "MinimizeCost", - "ModernizeToPaaS", - "ModernizeToAzureSqlMi", - "ModernizeToAzureSqlDb" - ], - "x-ms-enum": { - "name": "OptimizationLogic", - "modelAsString": true - } - }, - "OsLicense": { - "type": "string", - "enum": [ - "Unknown", - "Yes", - "No" - ], - "x-ms-enum": { - "name": "OsLicense", - "modelAsString": true - } - }, - "Percentile": { - "type": "string", - "enum": [ - "Percentile50", - "Percentile90", - "Percentile95", - "Percentile99" - ], - "x-ms-enum": { - "name": "Percentile", - "modelAsString": true - } - }, - "PrivateEndpointConnection": { - "type": "object", - "description": "Private endpoint connection resource.", - "properties": { - "properties": { - "$ref": "../../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "PrivateEndpointConnectionListResult": { - "type": "object", - "description": "The response of a PrivateEndpointConnection list operation.", - "properties": { - "value": { - "type": "array", - "description": "The PrivateEndpointConnection items on this page", - "items": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PrivateLinkResource": { - "type": "object", - "description": "Private link resource.", - "properties": { - "properties": { - "$ref": "../../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateLinkResourceProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "PrivateLinkResourceListResult": { - "type": "object", - "description": "The response of a PrivateLinkResource list operation.", - "properties": { - "value": { - "type": "array", - "description": "The PrivateLinkResource items on this page", - "items": { - "$ref": "#/definitions/PrivateLinkResource" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "ProcessorInfo": { - "type": "object", - "description": "Represents a information \\ details of a processor.", - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name \\ model of a processor." - }, - "numberOfSockets": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the number of sockets." - }, - "numberOfCoresPerSocket": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the number of cores in a socket." - } - } - }, - "ProductSupportStatus": { - "type": "object", - "description": "Class to represent the Product Support Status.", - "properties": { - "currentVersion": { - "type": "string", - "description": "Gets or sets current version of ServicePack.", - "readOnly": true - }, - "servicePackStatus": { - "type": "string", - "description": "Gets or sets ServicePack of the product.", - "readOnly": true - }, - "esuStatus": { - "type": "string", - "description": "Gets or sets the Extended Security Update ESU status.", - "readOnly": true - }, - "supportStatus": { - "type": "string", - "description": "Gets or sets the support status of the product.", - "readOnly": true - }, - "eta": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the ETA.", - "readOnly": true - }, - "currentEsuYear": { - "type": "string", - "description": "Gets or sets the current ESU support year.", - "readOnly": true - }, - "mainstreamEndDate": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the main stream end date of the product.", - "readOnly": true - }, - "extendedSupportEndDate": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the extended support end date of the product.", - "readOnly": true - }, - "extendedSecurityUpdateYear1EndDate": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the extended security update year 1 end date of the product.", - "readOnly": true - }, - "extendedSecurityUpdateYear2EndDate": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the extended security update year 2 end date of the product.", - "readOnly": true - }, - "extendedSecurityUpdateYear3EndDate": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the extended security update year 3 end date of the product.", - "readOnly": true - } - } - }, - "ProjectProperties": { - "type": "object", - "description": "Properties of a project.", - "properties": { - "createdTimestamp": { - "type": "string", - "format": "date-time", - "description": "Time when this project was created. Date-Time represented in ISO-8601 format.", - "readOnly": true - }, - "updatedTimestamp": { - "type": "string", - "format": "date-time", - "description": "Time when this project was last updated. Date-Time represented in ISO-8601\nformat.", - "readOnly": true - }, - "serviceEndpoint": { - "type": "string", - "description": "Endpoint at which the collector agent can call agent REST API.", - "readOnly": true - }, - "assessmentSolutionId": { - "type": "string", - "description": "Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects." - }, - "projectStatus": { - "$ref": "#/definitions/ProjectStatus", - "description": "Assessment project status." - }, - "customerWorkspaceId": { - "type": "string", - "description": "The ARM id of service map workspace created by customer." - }, - "customerWorkspaceLocation": { - "type": "string", - "description": "Location of service map workspace created by customer." - }, - "publicNetworkAccess": { - "type": "string", - "description": "This value can be set to 'enabled' to avoid breaking changes on existing\ncustomer resources and templates. If set to 'disabled', traffic over public\ninterface is not allowed, and private endpoint connections would be the\nexclusive access method." - }, - "privateEndpointConnections": { - "type": "array", - "description": "The list of private endpoint connections to the project.", - "items": { - "$ref": "#/definitions/PrivateEndpointConnection" - }, - "readOnly": true - }, - "customerStorageAccountArmId": { - "type": "string", - "description": "The ARM id of the storage account used for interactions when public access is\ndisabled." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AzureResourceProperties" - } - ] - }, - "ProjectStatus": { - "type": "string", - "description": "Project Status.", - "enum": [ - "Active", - "Inactive" - ], - "x-ms-enum": { - "name": "ProjectStatus", - "modelAsString": true, - "values": [ - { - "name": "Active", - "value": "Active", - "description": "Active Status." - }, - { - "name": "Inactive", - "value": "Inactive", - "description": "Inactive Status." - } - ] - } - }, - "ProvisioningState": { - "type": "string", - "description": "The status of the current operation.", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "Provisioning", - "Updating", - "Deleting", - "Accepted" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true, - "values": [ - { - "name": "Succeeded", - "value": "Succeeded", - "description": "Resource has been created." - }, - { - "name": "Failed", - "value": "Failed", - "description": "Resource creation failed." - }, - { - "name": "Canceled", - "value": "Canceled", - "description": "Resource creation was canceled." - }, - { - "name": "Provisioning", - "value": "Provisioning", - "description": "Resource is being Provisioned." - }, - { - "name": "Updating", - "value": "Updating", - "description": "Resource is being Updated." - }, - { - "name": "Deleting", - "value": "Deleting", - "description": "Resource is being Deleted." - }, - { - "name": "Accepted", - "value": "Accepted", - "description": "Resource is being Accepted." - } - ] - } - }, - "RecommendedSuitability": { - "type": "string", - "enum": [ - "Unknown", - "SuitableForSqlDB", - "SuitableForSqlMI", - "SuitableForVM", - "PotentiallySuitableForVM", - "ReadinessUnknown", - "NotSuitable", - "SuitableForSqlVM", - "ConditionallySuitableForSqlDB", - "ConditionallySuitableForSqlMI", - "ConditionallySuitableForVM", - "ConditionallySuitableForSqlVM" - ], - "x-ms-enum": { - "name": "RecommendedSuitability", - "modelAsString": true - } - }, - "ResourceId": { - "type": "object", - "description": "ARM id for a resource.", - "properties": { - "id": { - "type": "string", - "description": "Gets the relative URL to get to this REST resource.", - "readOnly": true - } - } - }, - "ServerCollector": { - "type": "object", - "description": "Physical server collector resource.", - "properties": { - "properties": { - "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "ServerCollectorListResult": { - "type": "object", - "description": "The response of a ServerCollector list operation.", - "properties": { - "value": { - "type": "array", - "description": "The ServerCollector items on this page", - "items": { - "$ref": "#/definitions/ServerCollector" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "SharedResourcesDTO": { - "type": "object", - "description": "Shared Resources.", - "properties": { - "sharedDataDisks": { - "type": "array", - "description": "Gets the list of shared data disks.", - "items": { - "$ref": "#/definitions/AzureManagedDiskSkuDTO" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "sharedLogDisks": { - "type": "array", - "description": "Gets the list of shared log disks.", - "items": { - "$ref": "#/definitions/AzureManagedDiskSkuDTO" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "sharedTempDbDisks": { - "type": "array", - "description": "Gets the list of shared Temporary database disks.", - "items": { - "$ref": "#/definitions/AzureManagedDiskSkuDTO" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "numberOfMounts": { - "type": "integer", - "format": "int32", - "description": "Gets number of mounts of shared disks.", - "readOnly": true - }, - "quorumWitness": { - "$ref": "#/definitions/AzureQuorumWitnessDTO", - "description": "Gets quorum witness.", - "readOnly": true - } - } - }, - "SkuReplicationMode": { - "type": "string", - "enum": [ - "NotApplicable", - "ActiveGeoReplication", - "FailoverGroupInstance" - ], - "x-ms-enum": { - "name": "SkuReplicationMode", - "modelAsString": true - } - }, - "SqlAssessedNetworkAdapter": { - "type": "object", - "description": "SQL Assessed Network Adapter.", - "properties": { - "suitability": { - "$ref": "#/definitions/CloudSuitability", - "description": "Gets the suitability." - }, - "suitabilityDetail": { - "$ref": "#/definitions/AzureNetworkAdapterSuitabilityDetail", - "description": "Gets the suitability detail." - }, - "suitabilityExplanation": { - "$ref": "#/definitions/AzureNetworkAdapterSuitabilityExplanation", - "description": "Gets the suitability explanation." - }, - "monthlyBandwidthCosts": { - "type": "number", - "format": "float", - "description": "Gets the monthly bandwidth costs." - }, - "netGigabytesTransmittedPerMonth": { - "type": "number", - "format": "float", - "description": "Gets the net gigabytes transmitted per month." - }, - "name": { - "type": "string", - "description": "Gets the name." - }, - "displayName": { - "type": "string", - "description": "Gets the display name." - }, - "macAddress": { - "type": "string", - "description": "Gets the mac address." - }, - "ipAddresses": { - "type": "array", - "description": "Gets the ip addresses.", - "items": { - "type": "string" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "megabytesPerSecondReceived": { - "type": "number", - "format": "float", - "description": "Gets the megabytes per second received." - }, - "megabytesPerSecondTransmitted": { - "type": "number", - "format": "float", - "description": "Gets the megabytes per second transmitted." - } - } - }, - "SqlAssessmentMigrationIssue": { - "type": "object", - "description": "Class representing the SQL migration issues.", - "properties": { - "issueId": { - "type": "string", - "description": "Gets the issue id.", - "readOnly": true - }, - "issueCategory": { - "$ref": "#/definitions/SqlAssessmentMigrationIssueCategory", - "description": "Gets the issue category.", - "readOnly": true - }, - "impactedObjects": { - "type": "array", - "description": "Gets the list of impacted objects.", - "items": { - "$ref": "#/definitions/ImpactedAssessmentObject" - }, - "readOnly": true, - "x-ms-identifiers": [] - } - } - }, - "SqlAssessmentMigrationIssueCategory": { - "type": "string", - "enum": [ - "Issue", - "Warning", - "Internal" - ], - "x-ms-enum": { - "name": "SqlAssessmentMigrationIssueCategory", - "modelAsString": true - } - }, - "SqlAssessmentOptions": { - "type": "object", - "description": "SQL Assessment options web model object.", - "properties": { - "properties": { - "$ref": "#/definitions/SqlAssessmentOptionsProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "SqlAssessmentOptionsListResult": { - "type": "object", - "description": "The response of a SqlAssessmentOptions list operation.", - "properties": { - "value": { - "type": "array", - "description": "The SqlAssessmentOptions items on this page", - "items": { - "$ref": "#/definitions/SqlAssessmentOptions" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "SqlAssessmentOptionsProperties": { - "type": "object", - "description": "SQL Assessment options properties Web model object.", - "properties": { - "vmFamilies": { - "type": "array", - "description": "Gets the list of VM families.", - "items": { - "$ref": "#/definitions/VmFamilyOptions" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "reservedInstanceVmFamilies": { - "type": "array", - "description": "Gets the Reserved Instance VM Families list.", - "items": { - "$ref": "#/definitions/AzureVmFamily" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "premiumDiskVmFamilies": { - "type": "array", - "description": "Gets the Premium disk VM Families list.", - "items": { - "$ref": "#/definitions/AzureVmFamily" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "savingsPlanVmFamilies": { - "type": "array", - "description": "Gets or sets the Premium disk VM Families list.", - "items": { - "$ref": "#/definitions/AzureVmFamily" - }, - "x-ms-identifiers": [] - }, - "savingsPlanSupportedLocations": { - "type": "array", - "description": "Gets or sets the list of Azure locations supporting Saving Plans for IAAS.", - "items": { - "$ref": "#/definitions/AzureLocation" - }, - "x-ms-identifiers": [] - }, - "savingsPlanSupportedLocationsForPaas": { - "type": "array", - "description": "Gets or sets the list of Azure locations supporting Saving Plans for PAAS.", - "items": { - "$ref": "#/definitions/AzureLocation" - }, - "x-ms-identifiers": [] - }, - "reservedInstanceSupportedLocationsForIaas": { - "type": "array", - "description": "Gets or sets the list of Azure locations supporting Reserved Instances for IAAS.", - "items": { - "$ref": "#/definitions/AzureLocation" - }, - "x-ms-identifiers": [] - }, - "savingsPlanSupportedOffers": { - "type": "array", - "description": "Gets or sets the list of Azure Offers supporting Saving Plans.", - "items": { - "$ref": "#/definitions/AzureOfferCode" - }, - "x-ms-identifiers": [] - }, - "sqlSkus": { - "type": "array", - "description": "Gets or sets the list of SQL target SKU properties for dropdowns.", - "items": { - "$ref": "#/definitions/SqlPaaSTargetOptions" - }, - "x-ms-identifiers": [] - }, - "reservedInstanceSqlTargets": { - "type": "array", - "description": "Gets or sets the Reserved Instance SQL target types.", - "items": { - "$ref": "#/definitions/TargetType" - }, - "x-ms-identifiers": [] - }, - "reservedInstanceSupportedLocations": { - "type": "array", - "description": "Gets or sets the list of Azure locations supporting Reserved Instances.", - "items": { - "$ref": "#/definitions/AzureLocation" - }, - "x-ms-identifiers": [] - }, - "reservedInstanceSupportedCurrencies": { - "type": "array", - "description": "Gets or sets the list of currencies supported for Reserved Instances.", - "items": { - "$ref": "#/definitions/AzureCurrency" - }, - "x-ms-identifiers": [] - }, - "reservedInstanceSupportedOffers": { - "type": "array", - "description": "Gets or sets the list of offers supported for Reserved Instances.", - "items": { - "$ref": "#/definitions/AzureOfferCode" - }, - "x-ms-identifiers": [] - }, - "supportedOffers": { - "type": "array", - "description": "Gets or sets the list of offers supported for SQL assessments.", - "items": { - "$ref": "#/definitions/AzureOfferCode" - }, - "x-ms-identifiers": [] - } - } - }, - "SqlAssessmentV2": { - "type": "object", - "description": "SQL Assessment REST resource.", - "properties": { - "properties": { - "$ref": "#/definitions/SqlAssessmentV2Properties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "SqlAssessmentV2IaasSuitabilityData": { - "type": "object", - "description": "Class representing Azure SQL IAAS suitability details.", - "properties": { - "azureSqlSku": { - "$ref": "#/definitions/AzureSqlIaasSkuDTO", - "description": "Gets the azure SQL IAAS SKU.", - "readOnly": true - }, - "replicaAzureSqlSku": { - "type": "array", - "description": "Gets the replica azure SQL IAAS SKU.", - "items": { - "$ref": "#/definitions/AzureSqlIaasSkuDTO" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "sharedResources": { - "$ref": "#/definitions/SharedResourcesDTO", - "description": "Gets the shared resources.", - "readOnly": true - }, - "monthlyComputeCost": { - "type": "number", - "format": "float", - "description": "Gets the monthly compute cost.", - "readOnly": true - }, - "monthlyStorageCost": { - "type": "number", - "format": "float", - "description": "Gets the monthly storage cost.", - "readOnly": true - }, - "costComponents": { - "type": "array", - "description": "Gets the collection of cost components.", - "items": { - "$ref": "#/definitions/CostComponent" - }, - "x-ms-identifiers": [] - }, - "securitySuitability": { - "$ref": "#/definitions/CloudSuitability", - "description": "Gets the suitability for Microsoft cloud defender.", - "readOnly": true - }, - "shouldProvisionReplicas": { - "type": "boolean", - "description": "Gets a value indicating whether replicas should be provisioned.", - "readOnly": true - }, - "skuReplicationMode": { - "$ref": "#/definitions/SkuReplicationMode", - "description": "Gets the replication mode.", - "readOnly": true - }, - "migrationGuidelines": { - "type": "array", - "description": "Gets the list of migration guidelines applicable to this target.", - "items": { - "$ref": "#/definitions/SqlMigrationGuideline" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "recommendationReasonings": { - "type": "array", - "description": "Gets the list of SQL recommendation Reasoning.", - "items": { - "$ref": "#/definitions/SqlRecommendationReasoning" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "migrationTargetPlatform": { - "$ref": "#/definitions/TargetType", - "description": "Gets the migration target platform.", - "readOnly": true - }, - "suitability": { - "$ref": "#/definitions/CloudSuitability", - "description": "Gets the azure suitability.", - "readOnly": true - }, - "migrationIssues": { - "type": "array", - "description": "Gets the list of migrations issues.", - "items": { - "$ref": "#/definitions/SqlAssessmentMigrationIssue" - }, - "readOnly": true, - "x-ms-identifiers": [] - } - } - }, - "SqlAssessmentV2ListResult": { - "type": "object", - "description": "The response of a SqlAssessmentV2 list operation.", - "properties": { - "value": { - "type": "array", - "description": "The SqlAssessmentV2 items on this page", - "items": { - "$ref": "#/definitions/SqlAssessmentV2" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "SqlAssessmentV2PaasSuitabilityData": { - "type": "object", - "description": "Class representing Azure SQL PAAS suitability details.", - "properties": { - "azureSqlSku": { - "$ref": "#/definitions/AzureSqlPaasSkuDTO", - "description": "Gets the azure SQL PAAS SKU.", - "readOnly": true - }, - "replicaAzureSqlSku": { - "type": "array", - "description": "Gets the replica azure SQL PAAS SKU.", - "items": { - "$ref": "#/definitions/AzureSqlPaasSkuDTO" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "sharedResources": { - "$ref": "#/definitions/SharedResourcesDTO", - "description": "Gets the shared resources.", - "readOnly": true - }, - "monthlyComputeCost": { - "type": "number", - "format": "float", - "description": "Gets the monthly compute cost.", - "readOnly": true - }, - "monthlyStorageCost": { - "type": "number", - "format": "float", - "description": "Gets the monthly storage cost.", - "readOnly": true - }, - "costComponents": { - "type": "array", - "description": "Gets the collection of cost components.", - "items": { - "$ref": "#/definitions/CostComponent" - }, - "x-ms-identifiers": [] - }, - "securitySuitability": { - "$ref": "#/definitions/CloudSuitability", - "description": "Gets the suitability for Microsoft cloud defender.", - "readOnly": true - }, - "shouldProvisionReplicas": { - "type": "boolean", - "description": "Gets a value indicating whether replicas should be provisioned.", - "readOnly": true - }, - "skuReplicationMode": { - "$ref": "#/definitions/SkuReplicationMode", - "description": "Gets the replication mode.", - "readOnly": true - }, - "migrationGuidelines": { - "type": "array", - "description": "Gets the list of migration guidelines applicable to this target.", - "items": { - "$ref": "#/definitions/SqlMigrationGuideline" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "recommendationReasonings": { - "type": "array", - "description": "Gets the list of SQL recommendation Reasoning.", - "items": { - "$ref": "#/definitions/SqlRecommendationReasoning" - }, - "readOnly": true, - "x-ms-identifiers": [] - }, - "migrationTargetPlatform": { - "$ref": "#/definitions/TargetType", - "description": "Gets the migration target platform.", - "readOnly": true - }, - "suitability": { - "$ref": "#/definitions/CloudSuitability", - "description": "Gets the azure suitability.", - "readOnly": true - }, - "migrationIssues": { - "type": "array", - "description": "Gets the list of migrations issues.", - "items": { - "$ref": "#/definitions/SqlAssessmentMigrationIssue" - }, - "readOnly": true, - "x-ms-identifiers": [] - } - } - }, - "SqlAssessmentV2Properties": { - "type": "object", - "description": "SQL assessment properties class.", - "properties": { - "osLicense": { - "$ref": "#/definitions/OsLicense", - "description": "Gets or sets user configurable setting to display the azure hybrid use benefit." - }, - "environmentType": { - "$ref": "#/definitions/EnvironmentType", - "description": "Gets or sets user configurable setting to display the environment type." - }, - "entityUptime": { - "$ref": "#/definitions/EntityUptime", - "description": "Gets or sets the duration for which the entity (SQL, VMs) are up in the\non-premises environment." - }, - "optimizationLogic": { - "$ref": "#/definitions/OptimizationLogic", - "description": "Gets or sets SQL optimization logic." - }, - "reservedInstanceForVm": { - "$ref": "#/definitions/AzureReservedInstance", - "description": "Gets or sets azure reserved instance for VM." - }, - "azureOfferCodeForVm": { - "$ref": "#/definitions/AzureOfferCode", - "description": "Gets or sets Azure Offer Code for VM." - }, - "eaSubscriptionId": { - "type": "string", - "description": "Gets or sets the Enterprise agreement subscription id." - }, - "azureSqlManagedInstanceSettings": { - "$ref": "#/definitions/SqlMiSettings", - "description": "Gets or sets user configurable SQL managed instance settings." - }, - "azureSqlDatabaseSettings": { - "$ref": "#/definitions/SqlDbSettings", - "description": "Gets or sets user configurable SQL database settings." - }, - "azureSqlVmSettings": { - "$ref": "#/definitions/SqlVmSettings", - "description": "Gets or sets user configurable SQL VM settings." - }, - "multiSubnetIntent": { - "$ref": "#/definitions/MultiSubnetIntent", - "description": "Gets or sets user preference indicating intent of multi-subnet configuration." - }, - "asyncCommitModeIntent": { - "$ref": "#/definitions/AsyncCommitModeIntent", - "description": "Gets or sets user preference indicating intent of async commit mode." - }, - "isInternetAccessAvailable": { - "type": "boolean", - "description": "Gets or sets a value indicating whether internet access is available." - }, - "disasterRecoveryLocation": { - "$ref": "#/definitions/AzureLocation", - "description": "Gets or sets the Azure Location or Azure region where to which the machines\nwill be migrated." - }, - "enableHadrAssessment": { - "type": "boolean", - "description": "Gets or sets a value indicating whether HADR assessments needs to be created." - }, - "azureSecurityOfferingType": { - "$ref": "#/definitions/AzureSecurityOfferingType", - "description": "Gets or sets a value indicating azure security offering type." - }, - "reservedInstance": { - "$ref": "#/definitions/AzureReservedInstance", - "description": "Reserved instance." - }, - "sqlServerLicense": { - "$ref": "#/definitions/SqlServerLicense", - "description": "SQL server license." - }, - "groupType": { - "$ref": "#/definitions/GroupType", - "description": "Gets the group type for the assessment." - }, - "assessmentType": { - "$ref": "#/definitions/AssessmentType", - "description": "Assessment type of the assessment." - }, - "azureLocation": { - "type": "string", - "description": "Azure Location or Azure region where to which the machines will be migrated." - }, - "azureOfferCode": { - "$ref": "#/definitions/AzureOfferCode", - "description": "Azure Offer Code." - }, - "currency": { - "$ref": "#/definitions/AzureCurrency", - "description": "Currency in which prices should be reported." - }, - "scalingFactor": { - "type": "number", - "format": "float", - "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." - }, - "percentile": { - "$ref": "#/definitions/Percentile", - "description": "Percentile of the utilization data values to be considered while assessing\nmachines." - }, - "timeRange": { - "$ref": "#/definitions/TimeRange", - "description": "Time Range for which the historic utilization data should be considered for\nassessment." - }, - "perfDataStartTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the start time to consider performance data for assessment." - }, - "perfDataEndTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the end time to consider performance data for assessment." - }, - "stage": { - "$ref": "#/definitions/AssessmentStage", - "description": "User configurable setting to display the Stage of Assessment.", - "readOnly": true - }, - "discountPercentage": { - "type": "number", - "format": "float", - "description": "Custom discount percentage." - }, - "sizingCriterion": { - "$ref": "#/definitions/AssessmentSizingCriterion", - "description": "Assessment sizing criterion." - }, - "confidenceRatingInPercentage": { - "type": "number", - "format": "float", - "description": "Confidence Rating in Percentage." - }, - "pricesTimestamp": { - "type": "string", - "format": "date-time", - "description": "Last time when rates were queried.", - "readOnly": true - }, - "createdTimestamp": { - "type": "string", - "format": "date-time", - "description": "Date and Time when assessment was created.", - "readOnly": true - }, - "updatedTimestamp": { - "type": "string", - "format": "date-time", - "description": "Date and Time when assessment was last updated.", - "readOnly": true - }, - "status": { - "$ref": "#/definitions/AssessmentStatus", - "description": "Whether assessment is in valid state and all machines have been assessed.", - "readOnly": true - }, - "schemaVersion": { - "type": "string", - "description": "Schema version.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/definitions/AzureResourceProperties" - } - ] - }, - "SqlAssessmentV2Summary": { - "type": "object", - "description": "SQL Assessment REST resource.", - "properties": { - "properties": { - "$ref": "#/definitions/SqlAssessmentV2SummaryProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "SqlAssessmentV2SummaryData": { - "type": "object", - "description": "SQL Assessment V2 summary data.", - "properties": { - "suitabilitySummary": { - "type": "object", - "description": "Sql assessment summary data", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "monthlyComputeCost": { - "type": "number", - "format": "float", - "description": "Monthly compute cost", - "readOnly": true - }, - "monthlyStorageCost": { - "type": "number", - "format": "float", - "description": "Monthly storage cost", - "readOnly": true - }, - "monthlyLicenseCost": { - "type": "number", - "format": "float", - "description": "Monthly license cost", - "readOnly": true - }, - "confidenceScore": { - "type": "number", - "format": "float", - "description": "Confidence Rating", - "readOnly": true - }, - "monthlySecurityCost": { - "type": "number", - "format": "float", - "description": "Monthly security cost", - "readOnly": true - } - } - }, - "SqlAssessmentV2SummaryListResult": { - "type": "object", - "description": "The response of a SqlAssessmentV2Summary list operation.", - "properties": { - "value": { - "type": "array", - "description": "The SqlAssessmentV2Summary items on this page", - "items": { - "$ref": "#/definitions/SqlAssessmentV2Summary" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "SqlAssessmentV2SummaryProperties": { - "type": "object", - "description": "SQL Assessment V2 summary properties.", - "properties": { - "assessmentSummary": { - "type": "object", - "description": "Gets or sets the Assessment summary.", - "additionalProperties": { - "$ref": "#/definitions/SqlAssessmentV2SummaryData" - }, - "readOnly": true - }, - "distributionBySupportStatus": { - "type": "object", - "description": "Gets the distribution of sqlInstances by support status.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "distributionByServicePackInsight": { - "type": "object", - "description": "Gets the distribution distribution of sqlInstances by service pack insight.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "distributionBySqlVersion": { - "type": "object", - "description": "Gets the distribution of sqlInstances by sql version.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "distributionBySqlEdition": { - "type": "object", - "description": "Gets the distribution of sqlInstances by sql edition.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "instanceDistributionBySizingCriterion": { - "type": "object", - "description": "Gets the instance distribution by sizing criterion.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "databaseDistributionBySizingCriterion": { - "type": "object", - "description": "Gets the database distribution by sizing criterion.", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "readOnly": true - }, - "numberOfMachines": { - "type": "integer", - "format": "int32", - "description": "Number of machines part of the assessment.", - "readOnly": true - }, - "numberOfSqlInstances": { - "type": "integer", - "format": "int32", - "description": "Number of sql instances part of the assessment.", - "readOnly": true - }, - "numberOfSqlDatabases": { - "type": "integer", - "format": "int32", - "description": "Number of sql databases part of the assessment.", - "readOnly": true - }, - "numberOfFciInstances": { - "type": "integer", - "format": "int32", - "description": "Number of sql failover cluster instances part of the assessment.", - "readOnly": true - }, - "numberOfSqlAvailabilityGroups": { - "type": "integer", - "format": "int32", - "description": "Number of sql availability groups part of the assessment.", - "readOnly": true - } - } - }, - "SqlAvailabilityGroupDataOverview": { - "type": "object", - "description": "Assessed Sql Availability Group Data Overview.", - "properties": { - "availabilityGroupId": { - "type": "string", - "description": "Gets the availability group id." - }, - "availabilityGroupName": { - "type": "string", - "description": "Gets the availability group name." - }, - "sqlAvailabilityGroupSdsArmId": { - "type": "string", - "description": "Gets the availability group arm id." - }, - "sqlAvailabilityGroupEntityId": { - "type": "string", - "description": "Gets the availability group entity id." - }, - "sqlAvailabilityReplicaId": { - "type": "string", - "description": "Gets the availability replica id." - } - } - }, - "SqlAvailabilityReplicaSummary": { - "type": "object", - "description": "Assessed Sql Availability Replica Summary.", - "properties": { - "numberOfSynchronousReadReplicas": { - "type": "integer", - "format": "int32", - "description": "Gets the number Of synchronous read replicas." - }, - "numberOfSynchronousNonReadReplicas": { - "type": "integer", - "format": "int32", - "description": "Gets the number Of synchronous non read replicas." - }, - "numberOfAsynchronousReadReplicas": { - "type": "integer", - "format": "int32", - "description": "Gets the number Of asynchronous read replicas." - }, - "numberOfAsynchronousNonReadReplicas": { - "type": "integer", - "format": "int32", - "description": "Gets the number Of asynchronous non read replicas." - }, - "numberOfPrimaryReplicas": { - "type": "integer", - "format": "int32", - "description": "Gets the number Of primary replicas." - } - } - }, - "SqlCollector": { - "type": "object", - "description": "The SQL collector REST object.", - "properties": { - "properties": { - "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "SqlCollectorListResult": { - "type": "object", - "description": "The response of a SqlCollector list operation.", - "properties": { - "value": { - "type": "array", - "description": "The SqlCollector items on this page", - "items": { - "$ref": "#/definitions/SqlCollector" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "SqlDbSettings": { - "type": "object", - "description": "SQL database assessment settings.", - "properties": { - "azureSqlServiceTier": { - "$ref": "#/definitions/AzureSqlServiceTier", - "description": "Gets or sets the azure SQL service tier." - }, - "azureSqlDataBaseType": { - "$ref": "#/definitions/AzureSqlDataBaseType", - "description": "Gets or sets the azure PAAS SQL instance type." - }, - "azureSqlComputeTier": { - "$ref": "#/definitions/ComputeTier", - "description": "Gets or sets the azure SQL compute tier." - }, - "azureSqlPurchaseModel": { - "$ref": "#/definitions/AzureSqlPurchaseModel", - "description": "Gets or sets the azure SQL purchase model." - } - } - }, - "SqlFCIMetadata": { - "type": "object", - "description": "Sql fci meta data.", - "properties": { - "state": { - "$ref": "#/definitions/SqlFCIMetadataState", - "description": "Gets the Sql fci meta data state." - }, - "isMultiSubnet": { - "type": "boolean", - "description": "Gets whether fci is multi subnet." - }, - "fciSharedDiskCount": { - "type": "integer", - "format": "int32", - "description": "Gets the fci shared disk count." - } - } - }, - "SqlFCIMetadataState": { - "type": "string", - "enum": [ - "Unknown", - "Inherited", - "Initializing", - "Online", - "Offline", - "Failed", - "Pending", - "OnlinePending", - "OfflinePending" - ], - "x-ms-enum": { - "name": "SqlFCIMetadataState", - "modelAsString": true - } - }, - "SqlFCIState": { - "type": "string", - "enum": [ - "Unknown", - "Active", - "Passive", - "NotApplicable" - ], - "x-ms-enum": { - "name": "SqlFCIState", - "modelAsString": true - } - }, - "SqlMiSettings": { - "type": "object", - "description": "SQL managed instance assessment settings.", - "properties": { - "azureSqlServiceTier": { - "$ref": "#/definitions/AzureSqlServiceTier", - "description": "Gets or sets the azure SQL service tier." - }, - "azureSqlInstanceType": { - "$ref": "#/definitions/AzureSqlInstanceType", - "description": "Gets or sets the azure PAAS SQL instance type." - } - } - }, - "SqlMigrationGuideline": { - "type": "object", - "description": "Sql Migration Guideline.", - "properties": { - "guidelineId": { - "type": "string", - "description": "Gets the guideline id." - }, - "migrationGuidelineCategory": { - "$ref": "#/definitions/SqlMigrationGuidelineCategory", - "description": "Gets the migration guideline category." - }, - "migrationGuidelineContext": { - "type": "array", - "description": "Gets the migration guideline context.", - "items": { - "$ref": "#/definitions/MigrationGuidelineContext" - }, - "readOnly": true, - "x-ms-identifiers": [] - } - } - }, - "SqlMigrationGuidelineCategory": { - "type": "string", - "enum": [ - "Unknown", - "General", - "FailoverCluterInstanceGuideLine", - "AvailabilityGroupGuideline" - ], - "x-ms-enum": { - "name": "SqlMigrationGuidelineCategory", - "modelAsString": true - } - }, - "SqlPaaSTargetOptions": { - "type": "object", - "description": "SQL target options.", - "properties": { - "computeTier": { - "$ref": "#/definitions/ComputeTier", - "description": "Gets or sets the Azure SQL compute tier." - }, - "hardwareGeneration": { - "$ref": "#/definitions/HardwareGeneration", - "description": "Gets or sets the Azure SQL hardware generation." - }, - "targetType": { - "$ref": "#/definitions/TargetType", - "description": "Gets or sets the Azure SQL target type." - }, - "serviceTier": { - "$ref": "#/definitions/AzureSqlServiceTier", - "description": "Gets or sets the Azure SQL service tier." - }, - "targetLocations": { - "type": "array", - "description": "Gets or sets the target location.", - "items": { - "$ref": "#/definitions/AzureLocation" - }, - "x-ms-identifiers": [] - } - } - }, - "SqlRecommendationReasoning": { - "type": "object", - "description": "Class representing Azure SQL Recommendation Reasoning.", - "properties": { - "reasoningId": { - "type": "string", - "description": "Gets the reasoning id." - }, - "reasoningString": { - "type": "string", - "description": "Gets the reasoning status." - }, - "reasoningCategory": { - "type": "string", - "description": "Gets the reasoning category." - }, - "contextParameters": { - "type": "array", - "description": "Gets the Sql recommended reasoning parameters.", - "items": { - "$ref": "#/definitions/SqlRecommendationReasoningContext" - }, - "readOnly": true, - "x-ms-identifiers": [] - } - } - }, - "SqlRecommendationReasoningContext": { - "type": "object", - "description": "Class representing Azure SQL Recommendation Reasoning Context.", - "properties": { - "contextKey": { - "type": "string", - "description": "Gets the reasoning context key." - }, - "contextValue": { - "type": "string", - "description": "Gets the reasoning context value." - } - } - }, - "SqlServerLicense": { - "type": "string", - "enum": [ - "Unknown", - "Yes", - "No" - ], - "x-ms-enum": { - "name": "SqlServerLicense", - "modelAsString": true - } - }, - "SqlVmSettings": { - "type": "object", - "description": "SQL VM assessment settings.", - "properties": { - "instanceSeries": { - "type": "array", - "description": "Gets or sets the Azure VM families (calling instance series to keep it\nconsistent with other targets).", - "items": { - "$ref": "#/definitions/AzureVmFamily" - }, - "x-ms-identifiers": [] - } - } - }, - "TargetType": { - "type": "string", - "enum": [ - "Unknown", - "Recommended", - "AzureSqlDatabase", - "AzureSqlManagedInstance", - "AzureSqlVirtualMachine", - "AzureVirtualMachine" - ], - "x-ms-enum": { - "name": "TargetType", - "modelAsString": true - } - }, - "TimeRange": { - "type": "string", - "enum": [ - "Day", - "Week", - "Month", - "Custom" - ], - "x-ms-enum": { - "name": "TimeRange", - "modelAsString": true - } - }, - "UltraDiskAssessmentOptions": { - "type": "object", - "description": "Assessment options for Ultra disk type.", - "properties": { - "familyName": { - "type": "string", - "description": "Family name." - }, - "targetLocations": { - "type": "array", - "description": "List of locations where ultra disk is supported for this VMfamily.", - "items": { - "type": "string" - } - } - } - }, - "UpdateGroupBody": { - "type": "object", - "description": "Properties of group update.", - "properties": { - "eTag": { - "type": "string", - "description": "For optimistic concurrency control." - }, - "properties": { - "$ref": "#/definitions/GroupBodyProperties", - "description": "Properties of the group." - } - } - }, - "VmFamilyOptions": { - "type": "object", - "description": "VM family name, the list of targeted azure locations and the category of the\nfamily.", - "properties": { - "familyName": { - "type": "string", - "description": "Name of the VM family.", - "readOnly": true - }, - "targetLocations": { - "type": "array", - "description": "List of Azure regions.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "category": { - "type": "array", - "description": "Category of the VM family.", - "items": { - "type": "string" - }, - "readOnly": true - } - } - }, - "VmUptime": { - "type": "object", - "description": "Details on the total up-time for the VM.", - "properties": { - "daysPerMonth": { - "type": "integer", - "format": "int32", - "description": "Number of days in a month for VM uptime." - }, - "hoursPerDay": { - "type": "integer", - "format": "int32", - "description": "Number of hours per day for VM uptime." - } - } - }, - "VmwareCollector": { - "type": "object", - "description": "VMware collector resource.", - "properties": { - "properties": { - "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "VmwareCollectorListResult": { - "type": "object", - "description": "The response of a VmwareCollector list operation.", - "properties": { - "value": { - "type": "array", - "description": "The VmwareCollector items on this page", - "items": { - "$ref": "#/definitions/VmwareCollector" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "WorkloadSummary": { - "type": "object", - "description": "Workload summary.", - "properties": { - "oracleInstances": { - "type": "integer", - "format": "int32", - "description": "Gets or sets oracle databases." - }, - "springApps": { - "type": "integer", - "format": "int32", - "description": "Gets or sets oracle databases." - } - } - } - }, - "parameters": {} -} diff --git a/swagger-specs/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/migrate.json b/swagger-specs/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/migrate.json new file mode 100644 index 000000000..4480e87c9 --- /dev/null +++ b/swagger-specs/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/migrate.json @@ -0,0 +1,22827 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Migrate Discovery Service", + "version": "2023-06-06", + "description": "Azure OffAzure Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "HypervClusterController" + }, + { + "name": "SitesController" + }, + { + "name": "VmwareOperationsStatus" + }, + { + "name": "VmwarePropertiesController" + }, + { + "name": "WebAppPropertiesController" + }, + { + "name": "DependencyMapController" + }, + { + "name": "VmwareSoftwareInventoriesController" + }, + { + "name": "MachinesController" + }, + { + "name": "VcenterController" + }, + { + "name": "RunAsAccountsController" + }, + { + "name": "VmwareHostController" + }, + { + "name": "HypervJobsController" + }, + { + "name": "HypervDependencyMapController" + }, + { + "name": "HypervSitesController" + }, + { + "name": "HypervSites" + }, + { + "name": "HypervOperationsStatusController" + }, + { + "name": "HypervJobs" + }, + { + "name": "HypervHostController" + }, + { + "name": "HypervMachinesController" + }, + { + "name": "HypervSoftwareInventoriesController" + }, + { + "name": "HypervRunAsAccountsController" + }, + { + "name": "ServersController" + }, + { + "name": "ServerSoftwareInventoriesController" + }, + { + "name": "ServerSitesController" + }, + { + "name": "ServerOperationsStatusController" + }, + { + "name": "ServerDependencyMapController" + }, + { + "name": "ServerRunAsAccountsController" + }, + { + "name": "ServerJobsController" + }, + { + "name": "ImportJobsController" + }, + { + "name": "ImportMachinesController" + }, + { + "name": "ImportSitesController" + }, + { + "name": "MasterSitesController" + }, + { + "name": "MasterSitesOperationsStatusController" + }, + { + "name": "PrivateEndpointConnectionController" + }, + { + "name": "PrivateLinkResourcesController" + }, + { + "name": "SqlSitesController" + }, + { + "name": "WebAppSitesController" + }, + { + "name": "TomcatWebApplicationsController" + }, + { + "name": "TomcatWebServersController" + }, + { + "name": "IisWebApplicationsController" + }, + { + "name": "IisWebServersController" + }, + { + "name": "WebAppDiscoverySiteDataSourcesController" + }, + { + "name": "WebAppExtendedMachinesController" + }, + { + "name": "WebApplicationsController" + }, + { + "name": "WebAppRunAsAccountsController" + }, + { + "name": "WebServersController" + }, + { + "name": "SqlAvailabilityGroupsController" + }, + { + "name": "SqlServersController" + }, + { + "name": "SqlDatabasesController" + }, + { + "name": "SqlJobsController" + }, + { + "name": "SqlRunAsAccountsController" + }, + { + "name": "SqlDiscoverySiteDataSourceController" + }, + { + "name": "SqlOperationsStatusController" + } + ], + "paths": { + "/providers/Microsoft.OffAzure/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet_Gen": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/hypervSites": { + "get": { + "operationId": "HypervSites_ListBySubscription", + "tags": [ + "HypervSites" + ], + "summary": "Get all hyperv sites.", + "description": "Get all the hyperv sites in the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervSites_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/HypervSites_ListBySubscription_MaximumSet_Gen.json" + }, + "HypervSites_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/HypervSites_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/importSites": { + "get": { + "operationId": "ImportSitesController_ListBySubscription", + "tags": [ + "ImportSitesController" + ], + "description": "List ImportSite resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportSitesController_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_ListBySubscription_MaximumSet_Gen.json" + }, + "ImportSitesController_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/ImportSitesController_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/masterSites": { + "get": { + "operationId": "MasterSitesController_ListBySubscription", + "tags": [ + "MasterSitesController" + ], + "summary": "Get all the sites in the subscription.", + "description": "List MasterSite resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MasterSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MasterSitesController_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_ListBySubscription_MaximumSet_Gen.json" + }, + "MasterSitesController_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/MasterSitesController_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/serverSites": { + "get": { + "operationId": "ServerSitesController_ListBySubscription", + "tags": [ + "ServerSitesController" + ], + "description": "List ServerSiteResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerSitesController_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_ListBySubscription_MaximumSet_Gen.json" + }, + "ServerSitesController_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/vmwareSites": { + "get": { + "operationId": "SitesController_ListBySubscription", + "tags": [ + "SitesController" + ], + "summary": "Get all vmware sites.", + "description": "Get all the vmware sites in the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SitesController_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ListBySubscription_MaximumSet_Gen.json" + }, + "SitesController_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/SitesController_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites": { + "get": { + "operationId": "HypervSites_ListByResourceGroup", + "tags": [ + "HypervSites" + ], + "summary": "Get all hyperv sites.", + "description": "Get all the hyperv sites in the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervSites_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/HypervSites_ListByResourceGroup_MaximumSet_Gen.json" + }, + "HypervSites_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/HypervSites_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}": { + "get": { + "operationId": "HypervSitesController_Get", + "tags": [ + "HypervSitesController" + ], + "description": "Get a HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_Get_MaximumSet_Gen.json" + }, + "HypervSitesController_Get_MinimumSet_Gen": { + "$ref": "./examples/HypervSitesController_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "HypervSitesController_Create", + "tags": [ + "HypervSitesController" + ], + "description": "Create a HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervSite" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSite" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSite" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_Create_MaximumSet_Gen.json" + }, + "HypervSitesController_Create_MinimumSet_Gen": { + "$ref": "./examples/HypervSitesController_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "HypervSitesController_Update", + "tags": [ + "HypervSitesController" + ], + "description": "Update a HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervSiteUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_Update_MaximumSet_Gen.json" + }, + "HypervSitesController_Update_MinimumSet_Gen": { + "$ref": "./examples/HypervSitesController_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "HypervSitesController_Delete", + "tags": [ + "HypervSitesController" + ], + "description": "Delete a HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_Delete_MaximumSet_Gen.json" + }, + "HypervSitesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/HypervSitesController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clientGroupMembers": { + "post": { + "operationId": "HypervDependencyMapController_ClientGroupMembers", + "tags": [ + "HypervDependencyMapController" + ], + "description": "API to list client group members for the selected client group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsClientGroupMembersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervDependencyMapController_ClientGroupMembers_MaximumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_ClientGroupMembers_MaximumSet_Gen.json" + }, + "HypervDependencyMapController_ClientGroupMembers_MinimumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_ClientGroupMembers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters": { + "get": { + "operationId": "HypervClusterController_ListByHypervSite", + "tags": [ + "HypervClusterController" + ], + "description": "List HypervCluster resources by HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervClusterController_ListByHypervSite_MaximumSet_Gen": { + "$ref": "./examples/HypervClusterController_ListByHypervSite_MaximumSet_Gen.json" + }, + "HypervClusterController_ListByHypervSite_MinimumSet_Gen": { + "$ref": "./examples/HypervClusterController_ListByHypervSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters/{clusterName}": { + "get": { + "operationId": "HypervClusterController_GetCluster", + "tags": [ + "HypervClusterController" + ], + "description": "Method to get a Hyper-V cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "clusterName", + "in": "path", + "description": " Cluster ARM name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervClusterController_GetCluster_MaximumSet_Gen": { + "$ref": "./examples/HypervClusterController_GetCluster_MaximumSet_Gen.json" + }, + "HypervClusterController_GetCluster_MinimumSet_Gen": { + "$ref": "./examples/HypervClusterController_GetCluster_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "HypervClusterController_CreateCluster", + "tags": [ + "HypervClusterController" + ], + "description": "Method to create or update a Hyper-V cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "clusterName", + "in": "path", + "description": " Cluster ARM name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervCluster" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCluster" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCluster" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervClusterController_CreateCluster_MaximumSet_Gen": { + "$ref": "./examples/HypervClusterController_CreateCluster_MaximumSet_Gen.json" + }, + "HypervClusterController_CreateCluster_MinimumSet_Gen": { + "$ref": "./examples/HypervClusterController_CreateCluster_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "HypervClusterController_Delete", + "tags": [ + "HypervClusterController" + ], + "description": "Delete a HypervCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "clusterName", + "in": "path", + "description": " Cluster ARM name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervClusterController_Delete_MaximumSet_Gen": { + "$ref": "./examples/HypervClusterController_Delete_MaximumSet_Gen.json" + }, + "HypervClusterController_Delete_MinimumSet_Gen": { + "$ref": "./examples/HypervClusterController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/computeErrorSummary": { + "post": { + "operationId": "HypervSitesController_ComputeErrorSummary", + "tags": [ + "HypervSitesController" + ], + "description": "Method to get site error summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteErrorSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_ComputeErrorSummary_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_ComputeErrorSummary_MaximumSet_Gen.json" + }, + "HypervSitesController_ComputeErrorSummary_MinimumSet_Gen": { + "$ref": "./examples/HypervSitesController_ComputeErrorSummary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/computeusage": { + "post": { + "operationId": "HypervSitesController_Computeusage", + "tags": [ + "HypervSitesController" + ], + "description": "Get a hyperv site usage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_Computeusage_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_Computeusage_MaximumSet_Gen.json" + }, + "HypervSitesController_Computeusage_MinimumSet_Gen": { + "$ref": "./examples/HypervSitesController_Computeusage_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportApplications": { + "post": { + "operationId": "HypervSitesController_ExportApplications", + "tags": [ + "HypervSitesController" + ], + "description": "Method to generate report containing\r\n machine and the deep discovery of the application installed in the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervSitesController_ExportApplications_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_ExportApplications_MaximumSet_Gen.json" + }, + "HypervSitesController_ExportApplications_MinimumSet_Gen": { + "$ref": "./examples/HypervSitesController_ExportApplications_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportDependencies": { + "post": { + "operationId": "HypervDependencyMapController_ExportDependencies", + "tags": [ + "HypervDependencyMapController" + ], + "description": "API to generate report containing agentless dependencies.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "requestBody", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsExportDependenciesRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervDependencyMapController_ExportDependencies_MaximumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_ExportDependencies_MaximumSet_Gen.json" + }, + "HypervDependencyMapController_ExportDependencies_MinimumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_ExportDependencies_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportMachineErrors": { + "post": { + "operationId": "HypervSitesController_ExportMachineErrors", + "tags": [ + "HypervSitesController" + ], + "description": "Method to generate report containing \r\n machine and the errors encountered during guest discovery of the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ExportMachineErrorsRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervSitesController_ExportMachineErrors_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_ExportMachineErrors_MaximumSet_Gen.json" + }, + "HypervSitesController_ExportMachineErrors_MinimumSet_Gen": { + "$ref": "./examples/HypervSitesController_ExportMachineErrors_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/generateCoarseMap": { + "post": { + "operationId": "HypervDependencyMapController_GenerateCoarseMap", + "tags": [ + "HypervDependencyMapController" + ], + "description": "API to generate coarse map for the list of machines.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsScopeMapRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervDependencyMapController_GenerateCoarseMap_MaximumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json" + }, + "HypervDependencyMapController_GenerateCoarseMap_MinimumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_GenerateCoarseMap_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/generateDetailedMap": { + "post": { + "operationId": "HypervDependencyMapController_GenerateDetailedMap", + "tags": [ + "HypervDependencyMapController" + ], + "description": "API to generate detailed map for a selected machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsSingleMachineDetailedMapRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervDependencyMapController_GenerateDetailedMap_MaximumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json" + }, + "HypervDependencyMapController_GenerateDetailedMap_MinimumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_GenerateDetailedMap_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts": { + "get": { + "operationId": "HypervHostController_ListByHypervSite", + "tags": [ + "HypervHostController" + ], + "description": "List HypervHost resources by HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervHostListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervHostController_ListByHypervSite_MaximumSet_Gen": { + "$ref": "./examples/HypervHostController_ListByHypervSite_MaximumSet_Gen.json" + }, + "HypervHostController_ListByHypervSite_MinimumSet_Gen": { + "$ref": "./examples/HypervHostController_ListByHypervSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts/{hostName}": { + "get": { + "operationId": "HypervHostController_Get", + "tags": [ + "HypervHostController" + ], + "description": "Get a HypervHost", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "hostName", + "in": "path", + "description": " Host name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervHost" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervHostController_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervHostController_Get_MaximumSet_Gen.json" + }, + "HypervHostController_Get_MinimumSet_Gen": { + "$ref": "./examples/HypervHostController_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "HypervHostController_Create", + "tags": [ + "HypervHostController" + ], + "description": "Create a HypervHost", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "hostName", + "in": "path", + "description": " Host name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervHost" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervHost" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervHost" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervHostController_Create_MaximumSet_Gen": { + "$ref": "./examples/HypervHostController_Create_MaximumSet_Gen.json" + }, + "HypervHostController_Create_MinimumSet_Gen": { + "$ref": "./examples/HypervHostController_Create_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "HypervHostController_Delete", + "tags": [ + "HypervHostController" + ], + "description": "Delete a HypervHost", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "hostName", + "in": "path", + "description": " Host name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervHostController_Delete_MaximumSet_Gen": { + "$ref": "./examples/HypervHostController_Delete_MaximumSet_Gen.json" + }, + "HypervHostController_Delete_MinimumSet_Gen": { + "$ref": "./examples/HypervHostController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/jobs": { + "get": { + "operationId": "HypervJobs_ListByHypervSite", + "tags": [ + "HypervJobs" + ], + "description": "List HypervJob resources by HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervJobListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervJobs_ListByHypervSite_MaximumSet_Gen": { + "$ref": "./examples/HypervJobs_ListByHypervSite_MaximumSet_Gen.json" + }, + "HypervJobs_ListByHypervSite_MinimumSet_Gen": { + "$ref": "./examples/HypervJobs_ListByHypervSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/jobs/{jobName}": { + "get": { + "operationId": "HypervJobs_Get", + "tags": [ + "HypervJobs" + ], + "description": "Get a HypervJob", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": " Job name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervJobs_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervJobs_Get_MaximumSet_Gen.json" + }, + "HypervJobs_Get_MinimumSet_Gen": { + "$ref": "./examples/HypervJobs_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/listHealthSummary": { + "post": { + "operationId": "HypervSitesController_ListHealthSummary", + "tags": [ + "HypervSitesController" + ], + "description": "Method to get site health summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteHealthSummaryCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_ListHealthSummary_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_ListHealthSummary_MaximumSet_Gen.json" + }, + "HypervSitesController_ListHealthSummary_MinimumSet_Gen": { + "$ref": "./examples/HypervSitesController_ListHealthSummary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines": { + "get": { + "operationId": "HypervMachinesController_ListByHypervSite", + "tags": [ + "HypervMachinesController" + ], + "description": "List HypervMachine resources by HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervMachinesController_ListByHypervSite_MaximumSet_Gen": { + "$ref": "./examples/HypervMachinesController_ListByHypervSite_MaximumSet_Gen.json" + }, + "HypervMachinesController_ListByHypervSite_MinimumSet_Gen": { + "$ref": "./examples/HypervMachinesController_ListByHypervSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}": { + "get": { + "operationId": "HypervMachinesController_Get", + "tags": [ + "HypervMachinesController" + ], + "description": "Get a HypervMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " HypervMachine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervMachinesController_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervMachinesController_Get_MaximumSet_Gen.json" + }, + "HypervMachinesController_Get_MinimumSet_Gen": { + "$ref": "./examples/HypervMachinesController_Get_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "HypervMachinesController_Update", + "tags": [ + "HypervMachinesController" + ], + "description": "Update a HypervMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " HypervMachine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervMachineUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervMachinesController_Update_MaximumSet_Gen": { + "$ref": "./examples/HypervMachinesController_Update_MaximumSet_Gen.json" + }, + "HypervMachinesController_Update_MinimumSet_Gen": { + "$ref": "./examples/HypervMachinesController_Update_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}/softwareInventories/{default}": { + "get": { + "operationId": "HypervSoftwareInventoriesController_GetMachineSoftwareInventory", + "tags": [ + "HypervSoftwareInventoriesController" + ], + "description": "Method to get a machines software inventory like applications and roles.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " HypervMachine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "default", + "in": "path", + "description": "Default value.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "Default", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "default value." + } + ] + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervVmSoftwareInventory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen": { + "$ref": "./examples/HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json" + }, + "HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen": { + "$ref": "./examples/HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}/softwareinventories": { + "get": { + "operationId": "HypervSoftwareInventoriesController_ListByHypervMachine", + "tags": [ + "HypervSoftwareInventoriesController" + ], + "description": "List HypervVmSoftwareInventory resources by HypervMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " HypervMachine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervVmSoftwareInventoryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervSoftwareInventoriesController_ListByHypervMachine_MaximumSet_Gen": { + "$ref": "./examples/HypervSoftwareInventoriesController_ListByHypervMachine_MaximumSet_Gen.json" + }, + "HypervSoftwareInventoriesController_ListByHypervMachine_MinimumSet_Gen": { + "$ref": "./examples/HypervSoftwareInventoriesController_ListByHypervMachine_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/operationsStatus/{operationStatusName}": { + "get": { + "operationId": "HypervOperationsStatusController_GetHypervOperationsStatus", + "tags": [ + "HypervOperationsStatusController" + ], + "description": "Method to get operation status.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "operationStatusName", + "in": "path", + "description": "Operation status Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervOperationsStatusController_GetHypervOperationsStatus_MaximumSet_Gen": { + "$ref": "./examples/HypervOperationsStatusController_GetHypervOperationsStatus_MaximumSet_Gen.json" + }, + "HypervOperationsStatusController_GetHypervOperationsStatus_MinimumSet_Gen": { + "$ref": "./examples/HypervOperationsStatusController_GetHypervOperationsStatus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/runAsAccounts": { + "get": { + "operationId": "HypervRunAsAccountsController_ListByHypervSite", + "tags": [ + "HypervRunAsAccountsController" + ], + "description": "List HypervRunAsAccountResource resources by HypervSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervRunAsAccountResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervRunAsAccountsController_ListByHypervSite_MaximumSet_Gen": { + "$ref": "./examples/HypervRunAsAccountsController_ListByHypervSite_MaximumSet_Gen.json" + }, + "HypervRunAsAccountsController_ListByHypervSite_MinimumSet_Gen": { + "$ref": "./examples/HypervRunAsAccountsController_ListByHypervSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/runAsAccounts/{accountName}": { + "get": { + "operationId": "HypervRunAsAccountsController_Get", + "tags": [ + "HypervRunAsAccountsController" + ], + "description": "Get a HypervRunAsAccountResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "accountName", + "in": "path", + "description": " RunAsAccounts name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervRunAsAccountResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervRunAsAccountsController_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervRunAsAccountsController_Get_MaximumSet_Gen.json" + }, + "HypervRunAsAccountsController_Get_MinimumSet_Gen": { + "$ref": "./examples/HypervRunAsAccountsController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/serverGroupMembers": { + "post": { + "operationId": "HypervDependencyMapController_ServerGroupMembers", + "tags": [ + "HypervDependencyMapController" + ], + "description": "API to list server group members for the selected server group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsServerGroupMembersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervDependencyMapController_ServerGroupMembers_MaximumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_ServerGroupMembers_MaximumSet_Gen.json" + }, + "HypervDependencyMapController_ServerGroupMembers_MinimumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_ServerGroupMembers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/summary": { + "post": { + "operationId": "HypervSitesController_Summary", + "tags": [ + "HypervSitesController" + ], + "description": "Method to get site usage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervSitesController_Summary_MaximumSet_Gen": { + "$ref": "./examples/HypervSitesController_Summary_MaximumSet_Gen.json" + }, + "HypervSitesController_Summary_MinimumSet_Gen": { + "$ref": "./examples/HypervSitesController_Summary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/updateDependencyMapStatus": { + "post": { + "operationId": "HypervDependencyMapController_UpdateDependencyMapStatus", + "tags": [ + "HypervDependencyMapController" + ], + "description": "Method to enable disable dependency map status for machines\r\n in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMachineDepMapStatus" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervDependencyMapController_UpdateDependencyMapStatus_MaximumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_UpdateDependencyMapStatus_MaximumSet_Gen.json" + }, + "HypervDependencyMapController_UpdateDependencyMapStatus_MinimumSet_Gen": { + "$ref": "./examples/HypervDependencyMapController_UpdateDependencyMapStatus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/updateProperties": { + "post": { + "operationId": "HypervMachinesController_UpdateProperties", + "tags": [ + "HypervMachinesController" + ], + "description": "Method to update custom properties for HYPERV machines\r\n in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "metaData", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/MachineMetadataCollection" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervMachinesController_UpdateProperties_MaximumSet_Gen": { + "$ref": "./examples/HypervMachinesController_UpdateProperties_MaximumSet_Gen.json" + }, + "HypervMachinesController_UpdateProperties_MinimumSet_Gen": { + "$ref": "./examples/HypervMachinesController_UpdateProperties_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites": { + "get": { + "operationId": "ImportSitesController_ListByResourceGroup", + "tags": [ + "ImportSitesController" + ], + "description": "Get all import sites.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportSitesController_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_ListByResourceGroup_MaximumSet_Gen.json" + }, + "ImportSitesController_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/ImportSitesController_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}": { + "get": { + "operationId": "ImportSitesController_Get", + "tags": [ + "ImportSitesController" + ], + "description": "Get a ImportSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_Get_MaximumSet_Gen.json" + }, + "ImportSitesController_Get_MinimumSet_Gen": { + "$ref": "./examples/ImportSitesController_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ImportSitesController_Create", + "tags": [ + "ImportSitesController" + ], + "description": "Create a ImportSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportSite" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportSite" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportSite" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_Create_MaximumSet_Gen.json" + }, + "ImportSitesController_Create_MinimumSet_Gen": { + "$ref": "./examples/ImportSitesController_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "ImportSitesController_Update", + "tags": [ + "ImportSitesController" + ], + "description": "Update a ImportSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportSiteUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_Update_MaximumSet_Gen.json" + }, + "ImportSitesController_Update_MinimumSet_Gen": { + "$ref": "./examples/ImportSitesController_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ImportSitesController_Delete", + "tags": [ + "ImportSitesController" + ], + "description": "Delete a ImportSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_Delete_MaximumSet_Gen.json" + }, + "ImportSitesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/ImportSitesController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteImportedMachines": { + "post": { + "operationId": "ImportSitesController_DeleteImportedMachines", + "tags": [ + "ImportSitesController" + ], + "description": "Deletes the imported machines for site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SasUriResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_DeleteImportedMachines_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_DeleteImportedMachines_MaximumSet_Gen.json" + }, + "ImportSitesController_DeleteImportedMachines_MinimumSet_Gen": { + "$ref": "./examples/ImportSitesController_DeleteImportedMachines_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteJobs": { + "get": { + "operationId": "ImportJobsController_ListDeletejobs", + "tags": [ + "ImportJobsController" + ], + "description": "Method to get all delete import machines job for the given site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PagedDeleteImportMachinesJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportJobsController_ListDeletejobs_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_ListDeletejobs_MaximumSet_Gen.json" + }, + "ImportJobsController_ListDeletejobs_MinimumSet_Gen": { + "$ref": "./examples/ImportJobsController_ListDeletejobs_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteJobs/{jobName}": { + "get": { + "operationId": "ImportJobsController_GetDeletejob", + "tags": [ + "ImportJobsController" + ], + "description": "Gets the delete imported machines job with the given job name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": "Job Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeleteImportMachinesJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportJobsController_GetDeletejob_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_GetDeletejob_MaximumSet_Gen.json" + }, + "ImportJobsController_GetDeletejob_MinimumSet_Gen": { + "$ref": "./examples/ImportJobsController_GetDeletejob_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportJobs": { + "get": { + "operationId": "ImportJobsController_ListExportjobs", + "tags": [ + "ImportJobsController" + ], + "description": "Method to get all export import machines job for the given site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PagedExportImportedMachinesJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportJobsController_ListExportjobs_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_ListExportjobs_MaximumSet_Gen.json" + }, + "ImportJobsController_ListExportjobs_MinimumSet_Gen": { + "$ref": "./examples/ImportJobsController_ListExportjobs_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportJobs/{jobName}": { + "get": { + "operationId": "ImportJobsController_GetExportjob", + "tags": [ + "ImportJobsController" + ], + "description": "Gets the export imported machines job with the given job name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": "Job Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ExportImportedMachinesJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportJobsController_GetExportjob_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_GetExportjob_MaximumSet_Gen.json" + }, + "ImportJobsController_GetExportjob_MinimumSet_Gen": { + "$ref": "./examples/ImportJobsController_GetExportjob_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportUri": { + "post": { + "operationId": "ImportSitesController_ExportUri", + "tags": [ + "ImportSitesController" + ], + "description": "Method to export a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/SasUriResponse" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SasUriResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_ExportUri_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_ExportUri_MaximumSet_Gen.json" + }, + "ImportSitesController_ExportUri_MinimumSet_Gen": { + "$ref": "./examples/ImportSitesController_ExportUri_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importJobs": { + "get": { + "operationId": "ImportJobsController_ListImportjobs", + "tags": [ + "ImportJobsController" + ], + "description": "Method to get all import machines job for the given site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PagedImportMachinesJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportJobsController_ListImportjobs_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_ListImportjobs_MaximumSet_Gen.json" + }, + "ImportJobsController_ListImportjobs_MinimumSet_Gen": { + "$ref": "./examples/ImportJobsController_ListImportjobs_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importJobs/{jobName}": { + "get": { + "operationId": "ImportJobsController_GetImportjob", + "tags": [ + "ImportJobsController" + ], + "description": "Gets the import job with the given job name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": "Job Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportMachinesJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportJobsController_GetImportjob_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_GetImportjob_MaximumSet_Gen.json" + }, + "ImportJobsController_GetImportjob_MinimumSet_Gen": { + "$ref": "./examples/ImportJobsController_GetImportjob_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importUri": { + "post": { + "operationId": "ImportSitesController_ImportUri", + "tags": [ + "ImportSitesController" + ], + "description": "Method to import a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/SasUriResponse" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SasUriResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportSitesController_ImportUri_MaximumSet_Gen": { + "$ref": "./examples/ImportSitesController_ImportUri_MaximumSet_Gen.json" + }, + "ImportSitesController_ImportUri_MinimumSet_Gen": { + "$ref": "./examples/ImportSitesController_ImportUri_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/jobs": { + "get": { + "operationId": "ImportJobsController_ListByImportSite", + "tags": [ + "ImportJobsController" + ], + "description": "List ImportJob resources by ImportSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportJobListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportJobsController_ListByImportSite_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_ListByImportSite_MaximumSet_Gen.json" + }, + "ImportJobsController_ListByImportSite_MinimumSet_Gen": { + "$ref": "./examples/ImportJobsController_ListByImportSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/jobs/{jobName}": { + "get": { + "operationId": "ImportJobsController_Get", + "tags": [ + "ImportJobsController" + ], + "description": "Get a ImportJob", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": " Jobs name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportJobsController_Get_MaximumSet_Gen": { + "$ref": "./examples/ImportJobsController_Get_MaximumSet_Gen.json" + }, + "ImportJobsController_Get_MinimumSet_Gen": { + "$ref": "./examples/ImportJobsController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/machines": { + "get": { + "operationId": "ImportMachinesController_ListByImportSite", + "tags": [ + "ImportMachinesController" + ], + "description": "List ImportMachine resources by ImportSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportMachinesController_ListByImportSite_MaximumSet_Gen": { + "$ref": "./examples/ImportMachinesController_ListByImportSite_MaximumSet_Gen.json" + }, + "ImportMachinesController_ListByImportSite_MinimumSet_Gen": { + "$ref": "./examples/ImportMachinesController_ListByImportSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/machines/{machineName}": { + "get": { + "operationId": "ImportMachinesController_Get", + "tags": [ + "ImportMachinesController" + ], + "description": "Get a ImportMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportMachinesController_Get_MaximumSet_Gen": { + "$ref": "./examples/ImportMachinesController_Get_MaximumSet_Gen.json" + }, + "ImportMachinesController_Get_MinimumSet_Gen": { + "$ref": "./examples/ImportMachinesController_Get_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ImportMachinesController_Delete", + "tags": [ + "ImportMachinesController" + ], + "description": "Delete a ImportMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportMachinesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/ImportMachinesController_Delete_MaximumSet_Gen.json" + }, + "ImportMachinesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/ImportMachinesController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites": { + "get": { + "operationId": "MasterSitesController_ListByResourceGroup", + "tags": [ + "MasterSitesController" + ], + "summary": "Get all sites.", + "description": "Get all the sites in the resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MasterSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MasterSitesController_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_ListByResourceGroup_MaximumSet_Gen.json" + }, + "MasterSitesController_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/MasterSitesController_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}": { + "get": { + "operationId": "MasterSitesController_Get", + "tags": [ + "MasterSitesController" + ], + "summary": "Method to get a master site.", + "description": "Get a MasterSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MasterSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MasterSitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_Get_MaximumSet_Gen.json" + }, + "MasterSitesController_Get_MinimumSet_Gen": { + "$ref": "./examples/MasterSitesController_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "MasterSitesController_Create", + "tags": [ + "MasterSitesController" + ], + "description": "Method to create or update a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/MasterSite" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/MasterSite" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/MasterSite" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "MasterSitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_Create_MaximumSet_Gen.json" + }, + "MasterSitesController_Create_MinimumSet_Gen": { + "$ref": "./examples/MasterSitesController_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "MasterSitesController_Update", + "tags": [ + "MasterSitesController" + ], + "description": "Method to update an existing site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/MasterSiteUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MasterSite" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "MasterSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_Update_MaximumSet_Gen.json" + }, + "MasterSitesController_Update_MinimumSet_Gen": { + "$ref": "./examples/MasterSitesController_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "MasterSitesController_Delete", + "tags": [ + "MasterSitesController" + ], + "description": "Method to delete a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MasterSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_Delete_MaximumSet_Gen.json" + }, + "MasterSitesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/MasterSitesController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/errorSummary": { + "post": { + "operationId": "MasterSitesController_ErrorSummary", + "tags": [ + "MasterSitesController" + ], + "description": "Method to get error summary from master site for an appliance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ErrorSummaryRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteErrorSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MasterSitesController_ErrorSummary_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_ErrorSummary_MaximumSet_Gen.json" + }, + "MasterSitesController_ErrorSummary_MinimumSet_Gen": { + "$ref": "./examples/MasterSitesController_ErrorSummary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/operationsStatus/{operationStatusName}": { + "get": { + "operationId": "MasterSitesOperationsStatusController_GetVmwareOperationStatus", + "tags": [ + "MasterSitesOperationsStatusController" + ], + "description": "A operation status resource belonging to a master site resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "operationStatusName", + "in": "path", + "description": "Operation status Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MasterSitesOperationsStatusController_GetVmwareOperationStatus_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesOperationsStatusController_GetVmwareOperationStatus_MaximumSet_Gen.json" + }, + "MasterSitesOperationsStatusController_GetVmwareOperationStatus_MinimumSet_Gen": { + "$ref": "./examples/MasterSitesOperationsStatusController_GetVmwareOperationStatus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnectionController_ListByMasterSite", + "tags": [ + "PrivateEndpointConnectionController" + ], + "description": "Gets the private link resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateEndpointConnectionController_ListByMasterSite_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_ListByMasterSite_MaximumSet_Gen.json" + }, + "PrivateEndpointConnectionController_ListByMasterSite_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_ListByMasterSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections/{peConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnectionController_Get", + "tags": [ + "PrivateEndpointConnectionController" + ], + "description": "Gets the private link resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "peConnectionName", + "in": "path", + "description": " Private link resource name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionController_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_Get_MaximumSet_Gen.json" + }, + "PrivateEndpointConnectionController_Get_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnectionController_Create", + "tags": [ + "PrivateEndpointConnectionController" + ], + "description": "Gets the private link resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "peConnectionName", + "in": "path", + "description": " Private link resource name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionController_Create_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_Create_MaximumSet_Gen.json" + }, + "PrivateEndpointConnectionController_Create_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_Create_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "PrivateEndpointConnectionController_Delete", + "tags": [ + "PrivateEndpointConnectionController" + ], + "description": "Deletes the private link resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "peConnectionName", + "in": "path", + "description": " Private link resource name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionController_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_Delete_MaximumSet_Gen.json" + }, + "PrivateEndpointConnectionController_Delete_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResourcesController_ListByMasterSite", + "tags": [ + "PrivateLinkResourcesController" + ], + "description": "Gets the private link resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateLinkResourcesController_ListByMasterSite_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourcesController_ListByMasterSite_MaximumSet_Gen.json" + }, + "PrivateLinkResourcesController_ListByMasterSite_MinimumSet_Gen": { + "$ref": "./examples/PrivateLinkResourcesController_ListByMasterSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "operationId": "PrivateLinkResourcesController_Get", + "tags": [ + "PrivateLinkResourcesController" + ], + "description": "Gets the private link resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "description": "Private link resource name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResourcesController_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourcesController_Get_MaximumSet_Gen.json" + }, + "PrivateLinkResourcesController_Get_MinimumSet_Gen": { + "$ref": "./examples/PrivateLinkResourcesController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites": { + "get": { + "operationId": "SqlSitesController_ListByMasterSite", + "tags": [ + "SqlSitesController" + ], + "description": "Method to get all sites.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlSitesController_ListByMasterSite_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_ListByMasterSite_MaximumSet_Gen.json" + }, + "SqlSitesController_ListByMasterSite_MinimumSet_Gen": { + "$ref": "./examples/SqlSitesController_ListByMasterSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}": { + "get": { + "operationId": "SqlSitesController_Get", + "tags": [ + "SqlSitesController" + ], + "description": "Method to get a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlSitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_Get_MaximumSet_Gen.json" + }, + "SqlSitesController_Get_MinimumSet_Gen": { + "$ref": "./examples/SqlSitesController_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlSitesController_Create", + "tags": [ + "SqlSitesController" + ], + "description": "Method to create a SQL site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlSite" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlSite" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlSite" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlSitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_Create_MaximumSet_Gen.json" + }, + "SqlSitesController_Create_MinimumSet_Gen": { + "$ref": "./examples/SqlSitesController_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "SqlSitesController_Update", + "tags": [ + "SqlSitesController" + ], + "description": "Method to update an existing site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlSiteUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlSite" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_Update_MaximumSet_Gen.json" + }, + "SqlSitesController_Update_MinimumSet_Gen": { + "$ref": "./examples/SqlSitesController_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlSitesController_Delete", + "tags": [ + "SqlSitesController" + ], + "description": "Deletes the SQL site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_Delete_MaximumSet_Gen.json" + }, + "SqlSitesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/SqlSitesController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources": { + "get": { + "operationId": "SqlDiscoverySiteDataSourceController_ListBySqlSite", + "tags": [ + "SqlDiscoverySiteDataSourceController" + ], + "description": "List SqlDiscoverySiteDataSource resources by SqlSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDiscoverySiteDataSourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlDiscoverySiteDataSourceController_ListBySqlSite_MaximumSet_Gen": { + "$ref": "./examples/SqlDiscoverySiteDataSourceController_ListBySqlSite_MaximumSet_Gen.json" + }, + "SqlDiscoverySiteDataSourceController_ListBySqlSite_MinimumSet_Gen": { + "$ref": "./examples/SqlDiscoverySiteDataSourceController_ListBySqlSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}": { + "get": { + "operationId": "SqlDiscoverySiteDataSourceController_Get", + "tags": [ + "SqlDiscoverySiteDataSourceController" + ], + "description": "Get a SqlDiscoverySiteDataSource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "discoverySiteDataSourceName", + "in": "path", + "description": "SQL Discovery site data source name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDiscoverySiteDataSource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlDiscoverySiteDataSourceController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlDiscoverySiteDataSourceController_Get_MaximumSet_Gen.json" + }, + "SqlDiscoverySiteDataSourceController_Get_MinimumSet_Gen": { + "$ref": "./examples/SqlDiscoverySiteDataSourceController_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlDiscoverySiteDataSourceController_Create", + "tags": [ + "SqlDiscoverySiteDataSourceController" + ], + "description": "Create a SqlDiscoverySiteDataSource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "discoverySiteDataSourceName", + "in": "path", + "description": "SQL Discovery site data source name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlDiscoverySiteDataSource" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDiscoverySiteDataSource" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDiscoverySiteDataSource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlDiscoverySiteDataSourceController_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlDiscoverySiteDataSourceController_Create_MaximumSet_Gen.json" + }, + "SqlDiscoverySiteDataSourceController_Create_MinimumSet_Gen": { + "$ref": "./examples/SqlDiscoverySiteDataSourceController_Create_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlDiscoverySiteDataSourceController_Delete", + "tags": [ + "SqlDiscoverySiteDataSourceController" + ], + "description": "Delete a SqlDiscoverySiteDataSource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "discoverySiteDataSourceName", + "in": "path", + "description": "SQL Discovery site data source name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlDiscoverySiteDataSourceController_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlDiscoverySiteDataSourceController_Delete_MaximumSet_Gen.json" + }, + "SqlDiscoverySiteDataSourceController_Delete_MinimumSet_Gen": { + "$ref": "./examples/SqlDiscoverySiteDataSourceController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/errorSummary": { + "post": { + "operationId": "SqlSitesController_ErrorSummary", + "tags": [ + "SqlSitesController" + ], + "description": "Method to get error summary from SQL site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ErrorSummaryRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteErrorSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlSitesController_ErrorSummary_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_ErrorSummary_MaximumSet_Gen.json" + }, + "SqlSitesController_ErrorSummary_MinimumSet_Gen": { + "$ref": "./examples/SqlSitesController_ErrorSummary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/exportSqlServerErrors": { + "post": { + "operationId": "SqlSitesController_ExportSqlServerErrors", + "tags": [ + "SqlSitesController" + ], + "description": "Method to generate report containing SQL servers.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlSitesController_ExportSqlServerErrors_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_ExportSqlServerErrors_MaximumSet_Gen.json" + }, + "SqlSitesController_ExportSqlServerErrors_MinimumSet_Gen": { + "$ref": "./examples/SqlSitesController_ExportSqlServerErrors_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/exportSqlServers": { + "post": { + "operationId": "SqlSitesController_ExportSqlServers", + "tags": [ + "SqlSitesController" + ], + "description": "Method to generate report containing SQL servers.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ExportSqlServersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlSitesController_ExportSqlServers_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_ExportSqlServers_MaximumSet_Gen.json" + }, + "SqlSitesController_ExportSqlServers_MinimumSet_Gen": { + "$ref": "./examples/SqlSitesController_ExportSqlServers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/jobs": { + "get": { + "operationId": "SqlJobsController_ListBySqlSite", + "tags": [ + "SqlJobsController" + ], + "summary": "Gets the sql Jobs.", + "description": "List SqlJob resources by SqlSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlJobListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlJobsController_ListBySqlSite_MaximumSet_Gen": { + "$ref": "./examples/SqlJobsController_ListBySqlSite_MaximumSet_Gen.json" + }, + "SqlJobsController_ListBySqlSite_MinimumSet_Gen": { + "$ref": "./examples/SqlJobsController_ListBySqlSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/jobs/{jobName}": { + "get": { + "operationId": "SqlJobsController_Get", + "tags": [ + "SqlJobsController" + ], + "summary": "Gets the sql Job.", + "description": "Get a SqlJob", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": "SQL Job name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlJobsController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlJobsController_Get_MaximumSet_Gen.json" + }, + "SqlJobsController_Get_MinimumSet_Gen": { + "$ref": "./examples/SqlJobsController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/operationsStatus/{operationStatusName}": { + "get": { + "operationId": "SqlOperationsStatusController_GetSqlOperationStatus", + "tags": [ + "SqlOperationsStatusController" + ], + "description": "Method to get operation status.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "operationStatusName", + "in": "path", + "description": "Operation status Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlOperationsStatusController_GetSqlOperationStatus_MaximumSet_Gen": { + "$ref": "./examples/SqlOperationsStatusController_GetSqlOperationStatus_MaximumSet_Gen.json" + }, + "SqlOperationsStatusController_GetSqlOperationStatus_MinimumSet_Gen": { + "$ref": "./examples/SqlOperationsStatusController_GetSqlOperationStatus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/refresh": { + "post": { + "operationId": "SqlSitesController_Refresh", + "tags": [ + "SqlSitesController" + ], + "description": "Method to refresh a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/SqlSiteRefreshBody" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlSitesController_Refresh_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_Refresh_MaximumSet_Gen.json" + }, + "SqlSitesController_Refresh_MinimumSet_Gen": { + "$ref": "./examples/SqlSitesController_Refresh_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/runAsAccounts": { + "get": { + "operationId": "SqlRunAsAccountsController_ListBySqlSite", + "tags": [ + "SqlRunAsAccountsController" + ], + "description": "List SqlRunAsAccount resources by SqlSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRunAsAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlRunAsAccountsController_ListBySqlSite_MaximumSet_Gen": { + "$ref": "./examples/SqlRunAsAccountsController_ListBySqlSite_MaximumSet_Gen.json" + }, + "SqlRunAsAccountsController_ListBySqlSite_MinimumSet_Gen": { + "$ref": "./examples/SqlRunAsAccountsController_ListBySqlSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/runAsAccounts/{accountName}": { + "get": { + "operationId": "SqlRunAsAccountsController_Get", + "tags": [ + "SqlRunAsAccountsController" + ], + "description": "Get a SqlRunAsAccount", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "accountName", + "in": "path", + "description": "SQL RunAsAccounts name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRunAsAccount" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlRunAsAccountsController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlRunAsAccountsController_Get_MaximumSet_Gen.json" + }, + "SqlRunAsAccountsController_Get_MinimumSet_Gen": { + "$ref": "./examples/SqlRunAsAccountsController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlAvailabilityGroups": { + "get": { + "operationId": "SqlAvailabilityGroupsController_ListBySqlSite", + "tags": [ + "SqlAvailabilityGroupsController" + ], + "description": "Gets the sql availability groups.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAvailabilityGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAvailabilityGroupsController_ListBySqlSite_MaximumSet_Gen": { + "$ref": "./examples/SqlAvailabilityGroupsController_ListBySqlSite_MaximumSet_Gen.json" + }, + "SqlAvailabilityGroupsController_ListBySqlSite_MinimumSet_Gen": { + "$ref": "./examples/SqlAvailabilityGroupsController_ListBySqlSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlAvailabilityGroups/{sqlAvailabilityGroupName}": { + "get": { + "operationId": "SqlAvailabilityGroupsController_Get", + "tags": [ + "SqlAvailabilityGroupsController" + ], + "description": "Gets the sql availability group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlAvailabilityGroupName", + "in": "path", + "description": "SQL availability group name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAvailabilityGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAvailabilityGroupsController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAvailabilityGroupsController_Get_MaximumSet_Gen.json" + }, + "SqlAvailabilityGroupsController_Get_MinimumSet_Gen": { + "$ref": "./examples/SqlAvailabilityGroupsController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlDatabases": { + "get": { + "operationId": "SqlDatabasesController_ListBySqlSite", + "tags": [ + "SqlDatabasesController" + ], + "description": "Gets the sql Databases.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDatabaseV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlDatabasesController_ListBySqlSite_MaximumSet_Gen": { + "$ref": "./examples/SqlDatabasesController_ListBySqlSite_MaximumSet_Gen.json" + }, + "SqlDatabasesController_ListBySqlSite_MinimumSet_Gen": { + "$ref": "./examples/SqlDatabasesController_ListBySqlSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlDatabases/{sqlDatabaseName}": { + "get": { + "operationId": "SqlDatabasesController_Get", + "tags": [ + "SqlDatabasesController" + ], + "description": "Gets the sql Database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlDatabaseName", + "in": "path", + "description": "SQL Database name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDatabaseV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlDatabasesController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlDatabasesController_Get_MaximumSet_Gen.json" + }, + "SqlDatabasesController_Get_MinimumSet_Gen": { + "$ref": "./examples/SqlDatabasesController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers": { + "get": { + "operationId": "SqlServersController_ListBySqlSite", + "tags": [ + "SqlServersController" + ], + "description": "Gets the sql servers.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlServerV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlServersController_ListBySqlSite_MaximumSet_Gen": { + "$ref": "./examples/SqlServersController_ListBySqlSite_MaximumSet_Gen.json" + }, + "SqlServersController_ListBySqlSite_MinimumSet_Gen": { + "$ref": "./examples/SqlServersController_ListBySqlSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers/{sqlServerName}": { + "get": { + "operationId": "SqlServersController_Get", + "tags": [ + "SqlServersController" + ], + "description": "Gets the sql server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlServerName", + "in": "path", + "description": "SQL server name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlServerV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlServersController_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlServersController_Get_MaximumSet_Gen.json" + }, + "SqlServersController_Get_MinimumSet_Gen": { + "$ref": "./examples/SqlServersController_Get_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "SqlServersController_Update", + "tags": [ + "SqlServersController" + ], + "description": "Updates the sql server tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlServerName", + "in": "path", + "description": "SQL server name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerV2Update" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlServerV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlServersController_Update_MaximumSet_Gen": { + "$ref": "./examples/SqlServersController_Update_MaximumSet_Gen.json" + }, + "SqlServersController_Update_MinimumSet_Gen": { + "$ref": "./examples/SqlServersController_Update_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/summary": { + "post": { + "operationId": "SqlSitesController_Summary", + "tags": [ + "SqlSitesController" + ], + "description": "Method to get site usage/summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", + "description": "SQL site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlSitesController_Summary_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_Summary_MaximumSet_Gen.json" + }, + "SqlSitesController_Summary_MinimumSet_Gen": { + "$ref": "./examples/SqlSitesController_Summary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites": { + "get": { + "operationId": "WebAppSitesController_ListByMasterSite", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to get all sites.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppSitesController_ListByMasterSite_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_ListByMasterSite_MaximumSet_Gen.json" + }, + "WebAppSitesController_ListByMasterSite_MinimumSet_Gen": { + "$ref": "./examples/WebAppSitesController_ListByMasterSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}": { + "get": { + "operationId": "WebAppSitesController_Get", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to get a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppSitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Get_MaximumSet_Gen.json" + }, + "WebAppSitesController_Get_MinimumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppSitesController_Create", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to create a WebApp site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppSite" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSite" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSite" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppSitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Create_MaximumSet_Gen.json" + }, + "WebAppSitesController_Create_MinimumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "WebAppSitesController_Update", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to update an existing site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppSiteUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSite" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Update_MaximumSet_Gen.json" + }, + "WebAppSitesController_Update_MinimumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppSitesController_Delete", + "tags": [ + "WebAppSitesController" + ], + "description": "Deletes the WebApp site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Delete_MaximumSet_Gen.json" + }, + "WebAppSitesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources": { + "get": { + "operationId": "WebAppDiscoverySiteDataSourcesController_ListByWebAppSite", + "tags": [ + "WebAppDiscoverySiteDataSourcesController" + ], + "description": "Method to get all Web app data sources in site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiscoverySiteDataSourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppDiscoverySiteDataSourcesController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_ListByWebAppSite_MaximumSet_Gen.json" + }, + "WebAppDiscoverySiteDataSourcesController_ListByWebAppSite_MinimumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_ListByWebAppSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}": { + "get": { + "operationId": "WebAppDiscoverySiteDataSourcesController_Get", + "tags": [ + "WebAppDiscoverySiteDataSourcesController" + ], + "description": "Method to get a Web app data source in site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "discoverySiteDataSourceName", + "in": "path", + "description": "Data Source ARM name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiscoverySiteDataSource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppDiscoverySiteDataSourcesController_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Get_MaximumSet_Gen.json" + }, + "WebAppDiscoverySiteDataSourcesController_Get_MinimumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppDiscoverySiteDataSourcesController_Create", + "tags": [ + "WebAppDiscoverySiteDataSourcesController" + ], + "description": "Method to create or update a Web app data source in site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "discoverySiteDataSourceName", + "in": "path", + "description": "Data Source ARM name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DiscoverySiteDataSource" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiscoverySiteDataSource" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiscoverySiteDataSource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppDiscoverySiteDataSourcesController_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Create_MaximumSet_Gen.json" + }, + "WebAppDiscoverySiteDataSourcesController_Create_MinimumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Create_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppDiscoverySiteDataSourcesController_Delete", + "tags": [ + "WebAppDiscoverySiteDataSourcesController" + ], + "description": "Method to delete a Web app data source in site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "discoverySiteDataSourceName", + "in": "path", + "description": "Data Source ARM name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppDiscoverySiteDataSourcesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Delete_MaximumSet_Gen.json" + }, + "WebAppDiscoverySiteDataSourcesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/errorSummary": { + "post": { + "operationId": "WebAppSitesController_ErrorSummary", + "tags": [ + "WebAppSitesController" + ], + "description": "MMethod to get error summary from web app site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ErrorSummaryRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteErrorSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppSitesController_ErrorSummary_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_ErrorSummary_MaximumSet_Gen.json" + }, + "WebAppSitesController_ErrorSummary_MinimumSet_Gen": { + "$ref": "./examples/WebAppSitesController_ErrorSummary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/exportInventory": { + "post": { + "operationId": "WebAppSitesController_ExportInventory", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to generate report containing web app inventory.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ExportWebAppsRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppSitesController_ExportInventory_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_ExportInventory_MaximumSet_Gen.json" + }, + "WebAppSitesController_ExportInventory_MinimumSet_Gen": { + "$ref": "./examples/WebAppSitesController_ExportInventory_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/extendedMachines": { + "get": { + "operationId": "WebAppExtendedMachinesController_ListByWebAppSite", + "tags": [ + "WebAppExtendedMachinesController" + ], + "description": "Method to get all extended machines.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppExtendedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppExtendedMachinesController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/WebAppExtendedMachinesController_ListByWebAppSite_MaximumSet_Gen.json" + }, + "WebAppExtendedMachinesController_ListByWebAppSite_MinimumSet_Gen": { + "$ref": "./examples/WebAppExtendedMachinesController_ListByWebAppSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/extendedMachines/{extendedMachineName}": { + "get": { + "operationId": "WebAppExtendedMachinesController_Get", + "tags": [ + "WebAppExtendedMachinesController" + ], + "description": "Method to get a extended machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "extendedMachineName", + "in": "path", + "description": "Extended machine name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppExtendedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppExtendedMachinesController_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppExtendedMachinesController_Get_MaximumSet_Gen.json" + }, + "WebAppExtendedMachinesController_Get_MinimumSet_Gen": { + "$ref": "./examples/WebAppExtendedMachinesController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebApplications": { + "get": { + "operationId": "IisWebApplicationsController_ListByWebAppSite", + "tags": [ + "IisWebApplicationsController" + ], + "description": "Method to get all IIS web application.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IisWebApplicationsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "IisWebApplicationsController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/IisWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json" + }, + "IisWebApplicationsController_ListByWebAppSite_MinimumSet_Gen": { + "$ref": "./examples/IisWebApplicationsController_ListByWebAppSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebApplications/{webApplicationName}": { + "get": { + "operationId": "IisWebApplicationsController_Get", + "tags": [ + "IisWebApplicationsController" + ], + "description": "Method to get an IIS web application.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webApplicationName", + "in": "path", + "description": "Web application name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IisWebApplications" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IisWebApplicationsController_Get_MaximumSet_Gen": { + "$ref": "./examples/IisWebApplicationsController_Get_MaximumSet_Gen.json" + }, + "IisWebApplicationsController_Get_MinimumSet_Gen": { + "$ref": "./examples/IisWebApplicationsController_Get_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "IisWebApplicationsController_Update", + "tags": [ + "IisWebApplicationsController" + ], + "description": "Method to update tags on IIS web application.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webApplicationName", + "in": "path", + "description": "Web application name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/IisWebApplicationsUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IisWebApplications" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IisWebApplicationsController_Update_MaximumSet_Gen": { + "$ref": "./examples/IisWebApplicationsController_Update_MaximumSet_Gen.json" + }, + "IisWebApplicationsController_Update_MinimumSet_Gen": { + "$ref": "./examples/IisWebApplicationsController_Update_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebServers": { + "get": { + "operationId": "IisWebServersController_ListByWebAppSite", + "tags": [ + "IisWebServersController" + ], + "description": "Method to get all IIS web servers.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IisWebServersListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "IisWebServersController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/IisWebServersController_ListByWebAppSite_MaximumSet_Gen.json" + }, + "IisWebServersController_ListByWebAppSite_MinimumSet_Gen": { + "$ref": "./examples/IisWebServersController_ListByWebAppSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebServers/{webServerName}": { + "get": { + "operationId": "IisWebServersController_Get", + "tags": [ + "IisWebServersController" + ], + "description": "Method to get an IIS web server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webServerName", + "in": "path", + "description": "Web server name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IisWebServers" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IisWebServersController_Get_MaximumSet_Gen": { + "$ref": "./examples/IisWebServersController_Get_MaximumSet_Gen.json" + }, + "IisWebServersController_Get_MinimumSet_Gen": { + "$ref": "./examples/IisWebServersController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/refresh": { + "post": { + "operationId": "WebAppSitesController_Refresh", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to refresh a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ProxySiteRefreshBody" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppSitesController_Refresh_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Refresh_MaximumSet_Gen.json" + }, + "WebAppSitesController_Refresh_MinimumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Refresh_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/runasaccounts": { + "get": { + "operationId": "WebAppRunAsAccountsController_ListByWebAppSite", + "tags": [ + "WebAppRunAsAccountsController" + ], + "description": "Method to get all run as accounts.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppRunAsAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppRunAsAccountsController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/WebAppRunAsAccountsController_ListByWebAppSite_MaximumSet_Gen.json" + }, + "WebAppRunAsAccountsController_ListByWebAppSite_MinimumSet_Gen": { + "$ref": "./examples/WebAppRunAsAccountsController_ListByWebAppSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/runasaccounts/{accountName}": { + "get": { + "operationId": "WebAppRunAsAccountsController_Get", + "tags": [ + "WebAppRunAsAccountsController" + ], + "description": "Method to get run as account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "accountName", + "in": "path", + "description": "Run as account ARM name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppRunAsAccount" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppRunAsAccountsController_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppRunAsAccountsController_Get_MaximumSet_Gen.json" + }, + "WebAppRunAsAccountsController_Get_MinimumSet_Gen": { + "$ref": "./examples/WebAppRunAsAccountsController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/summary": { + "post": { + "operationId": "WebAppSitesController_Summary", + "tags": [ + "WebAppSitesController" + ], + "description": "Method to get site usage/summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppSitesController_Summary_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Summary_MaximumSet_Gen.json" + }, + "WebAppSitesController_Summary_MinimumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Summary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebApplications": { + "get": { + "operationId": "TomcatWebApplicationsController_ListByWebAppSite", + "tags": [ + "TomcatWebApplicationsController" + ], + "description": "Method to get all Tomcat web application.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TomcatWebApplicationsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TomcatWebApplicationsController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/TomcatWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json" + }, + "TomcatWebApplicationsController_ListByWebAppSite_MinimumSet_Gen": { + "$ref": "./examples/TomcatWebApplicationsController_ListByWebAppSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebApplications/{webApplicationName}": { + "get": { + "operationId": "TomcatWebApplicationsController_Get", + "tags": [ + "TomcatWebApplicationsController" + ], + "description": "Method to get an Tomcat web application.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webApplicationName", + "in": "path", + "description": "Web application name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TomcatWebApplications" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TomcatWebApplicationsController_Get_MaximumSet_Gen": { + "$ref": "./examples/TomcatWebApplicationsController_Get_MaximumSet_Gen.json" + }, + "TomcatWebApplicationsController_Get_MinimumSet_Gen": { + "$ref": "./examples/TomcatWebApplicationsController_Get_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "TomcatWebApplicationsController_Update", + "tags": [ + "TomcatWebApplicationsController" + ], + "description": "Updates the Tomcat web application tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webApplicationName", + "in": "path", + "description": "Web application name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/TomcatWebApplicationsUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TomcatWebApplications" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TomcatWebApplicationsController_Update_MaximumSet_Gen": { + "$ref": "./examples/TomcatWebApplicationsController_Update_MaximumSet_Gen.json" + }, + "TomcatWebApplicationsController_Update_MinimumSet_Gen": { + "$ref": "./examples/TomcatWebApplicationsController_Update_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebServers": { + "get": { + "operationId": "TomcatWebServersController_ListByWebAppSite", + "tags": [ + "TomcatWebServersController" + ], + "description": "Method to get all Tomcat web servers.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TomcatWebServersListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TomcatWebServersController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/TomcatWebServersController_ListByWebAppSite_MaximumSet_Gen.json" + }, + "TomcatWebServersController_ListByWebAppSite_MinimumSet_Gen": { + "$ref": "./examples/TomcatWebServersController_ListByWebAppSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebServers/{webServerName}": { + "get": { + "operationId": "TomcatWebServersController_Get", + "tags": [ + "TomcatWebServersController" + ], + "description": "Method to get an Tomcat web server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webServerName", + "in": "path", + "description": "Web server name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TomcatWebServers" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TomcatWebServersController_Get_MaximumSet_Gen": { + "$ref": "./examples/TomcatWebServersController_Get_MaximumSet_Gen.json" + }, + "TomcatWebServersController_Get_MinimumSet_Gen": { + "$ref": "./examples/TomcatWebServersController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/updateProperties": { + "post": { + "operationId": "WebAppPropertiesController_UpdateProperties", + "tags": [ + "WebAppPropertiesController" + ], + "description": "Method to update properties for web applications.\n in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppPropertiesCollection" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppPropertiesController_UpdateProperties_MaximumSet_Gen": { + "$ref": "./examples/WebAppPropertiesController_UpdateProperties_MaximumSet_Gen.json" + }, + "WebAppPropertiesController_UpdateProperties_MinimumSet_Gen": { + "$ref": "./examples/WebAppPropertiesController_UpdateProperties_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/webApplications": { + "get": { + "operationId": "WebApplicationsController_ListByWebAppSite", + "tags": [ + "WebApplicationsController" + ], + "description": "Method to get all IIS web applications.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebApplicationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebApplicationsController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/WebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json" + }, + "WebApplicationsController_ListByWebAppSite_MinimumSet_Gen": { + "$ref": "./examples/WebApplicationsController_ListByWebAppSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/webServers": { + "get": { + "operationId": "WebServersController_ListByWebAppSite", + "tags": [ + "WebServersController" + ], + "description": "Method to get all web servers.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "webAppSiteName", + "in": "path", + "description": "Web app site name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebServerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebServersController_ListByWebAppSite_MaximumSet_Gen": { + "$ref": "./examples/WebServersController_ListByWebAppSite_MaximumSet_Gen.json" + }, + "WebServersController_ListByWebAppSite_MinimumSet_Gen": { + "$ref": "./examples/WebServersController_ListByWebAppSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites": { + "get": { + "operationId": "ServerSitesController_ListByResourceGroup", + "tags": [ + "ServerSitesController" + ], + "description": "List ServerSiteResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerSitesController_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_ListByResourceGroup_MaximumSet_Gen.json" + }, + "ServerSitesController_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}": { + "get": { + "operationId": "ServerSitesController_Get", + "tags": [ + "ServerSitesController" + ], + "description": "Get a ServerSiteResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_Get_MaximumSet_Gen.json" + }, + "ServerSitesController_Get_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ServerSitesController_Create", + "tags": [ + "ServerSitesController" + ], + "description": "Create a ServerSiteResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSiteResource" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteResource" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteResource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerSitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_Create_MaximumSet_Gen.json" + }, + "ServerSitesController_Create_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "ServerSitesController_Update", + "tags": [ + "ServerSitesController" + ], + "description": "Update a ServerSiteResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSiteResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_Update_MaximumSet_Gen.json" + }, + "ServerSitesController_Update_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ServerSitesController_Delete", + "tags": [ + "ServerSitesController" + ], + "description": "Delete a ServerSiteResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_Delete_MaximumSet_Gen.json" + }, + "ServerSitesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/clientGroupMembers": { + "post": { + "operationId": "ServerDependencyMapController_ClientGroupMembers", + "tags": [ + "ServerDependencyMapController" + ], + "description": "API to list client group members for the selected client group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsClientGroupMembersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerDependencyMapController_ClientGroupMembers_MaximumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_ClientGroupMembers_MaximumSet_Gen.json" + }, + "ServerDependencyMapController_ClientGroupMembers_MinimumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_ClientGroupMembers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/computeErrorSummary": { + "post": { + "operationId": "ServerSitesController_ComputeErrorSummary", + "tags": [ + "ServerSitesController" + ], + "description": "Get the error summary for a server site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteErrorSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_ComputeErrorSummary_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_ComputeErrorSummary_MaximumSet_Gen.json" + }, + "ServerSitesController_ComputeErrorSummary_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_ComputeErrorSummary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/computeusage": { + "post": { + "operationId": "ServerSitesController_Computeusage", + "tags": [ + "ServerSitesController" + ], + "description": "Get a serve site usage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteUsageResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_Computeusage_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_Computeusage_MaximumSet_Gen.json" + }, + "ServerSitesController_Computeusage_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_Computeusage_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/exportApplications": { + "post": { + "operationId": "ServerSitesController_ExportApplications", + "tags": [ + "ServerSitesController" + ], + "description": "Method to generate report containing\r\n machine and the deep discovery of the application installed in the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerSitesController_ExportApplications_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_ExportApplications_MaximumSet_Gen.json" + }, + "ServerSitesController_ExportApplications_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_ExportApplications_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/exportDependencies": { + "post": { + "operationId": "ServerDependencyMapController_ExportDependencies", + "tags": [ + "ServerDependencyMapController" + ], + "description": "API to generate report containing agentless dependencies.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "requestBody", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsExportDependenciesRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerDependencyMapController_ExportDependencies_MaximumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_ExportDependencies_MaximumSet_Gen.json" + }, + "ServerDependencyMapController_ExportDependencies_MinimumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_ExportDependencies_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/exportMachineErrors": { + "post": { + "operationId": "ServerSitesController_ExportMachineErrors", + "tags": [ + "ServerSitesController" + ], + "description": "Method to generate report containing \r\n machine and the errors encountered during guest discovery of the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ExportMachineErrorsRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerSitesController_ExportMachineErrors_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_ExportMachineErrors_MaximumSet_Gen.json" + }, + "ServerSitesController_ExportMachineErrors_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_ExportMachineErrors_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/generateCoarseMap": { + "post": { + "operationId": "ServerDependencyMapController_GenerateCoarseMap", + "tags": [ + "ServerDependencyMapController" + ], + "description": "API to generate coarse map for the list of machines.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsScopeMapRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerDependencyMapController_GenerateCoarseMap_MaximumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json" + }, + "ServerDependencyMapController_GenerateCoarseMap_MinimumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_GenerateCoarseMap_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/generateDetailedMap": { + "post": { + "operationId": "ServerDependencyMapController_GenerateDetailedMap", + "tags": [ + "ServerDependencyMapController" + ], + "description": "API to generate detailed map for a selected machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsSingleMachineDetailedMapRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerDependencyMapController_GenerateDetailedMap_MaximumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json" + }, + "ServerDependencyMapController_GenerateDetailedMap_MinimumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_GenerateDetailedMap_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/jobs": { + "get": { + "operationId": "ServerJobsController_ListByServerSiteResource", + "tags": [ + "ServerJobsController" + ], + "description": "List ServerJob resources by ServerSiteResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerJobListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerJobsController_ListByServerSiteResource_MaximumSet_Gen": { + "$ref": "./examples/ServerJobsController_ListByServerSiteResource_MaximumSet_Gen.json" + }, + "ServerJobsController_ListByServerSiteResource_MinimumSet_Gen": { + "$ref": "./examples/ServerJobsController_ListByServerSiteResource_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/jobs/{jobName}": { + "get": { + "operationId": "ServerJobsController_Get", + "tags": [ + "ServerJobsController" + ], + "description": "Get a ServerJob", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": " Jobs name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerJobsController_Get_MaximumSet_Gen": { + "$ref": "./examples/ServerJobsController_Get_MaximumSet_Gen.json" + }, + "ServerJobsController_Get_MinimumSet_Gen": { + "$ref": "./examples/ServerJobsController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/listHealthSummary": { + "post": { + "operationId": "ServerSitesController_ListHealthSummary", + "tags": [ + "ServerSitesController" + ], + "description": "Method to get site health summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteHealthSummaryCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_ListHealthSummary_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_ListHealthSummary_MaximumSet_Gen.json" + }, + "ServerSitesController_ListHealthSummary_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_ListHealthSummary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines": { + "get": { + "operationId": "ServersController_ListByServerSiteResource", + "tags": [ + "ServersController" + ], + "description": "Get all machines in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "string" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServersController_ListByServerSiteResource_MaximumSet_Gen": { + "$ref": "./examples/ServersController_ListByServerSiteResource_MaximumSet_Gen.json" + }, + "ServersController_ListByServerSiteResource_MinimumSet_Gen": { + "$ref": "./examples/ServersController_ListByServerSiteResource_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}": { + "get": { + "operationId": "ServersController_GetMachine", + "tags": [ + "ServersController" + ], + "description": "Get a Server", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " A server machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServersController_GetMachine_MaximumSet_Gen": { + "$ref": "./examples/ServersController_GetMachine_MaximumSet_Gen.json" + }, + "ServersController_GetMachine_MinimumSet_Gen": { + "$ref": "./examples/ServersController_GetMachine_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "ServersController_UpdateMachine", + "tags": [ + "ServersController" + ], + "description": "Update a Server machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " A server machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServersController_UpdateMachine_MaximumSet_Gen": { + "$ref": "./examples/ServersController_UpdateMachine_MaximumSet_Gen.json" + }, + "ServersController_UpdateMachine_MinimumSet_Gen": { + "$ref": "./examples/ServersController_UpdateMachine_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ServersController_DeleteMachine", + "tags": [ + "ServersController" + ], + "description": "Delete a Server", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " A server machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServersController_DeleteMachine_MaximumSet_Gen": { + "$ref": "./examples/ServersController_DeleteMachine_MaximumSet_Gen.json" + }, + "ServersController_DeleteMachine_MinimumSet_Gen": { + "$ref": "./examples/ServersController_DeleteMachine_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}/softwareInventories/{default}": { + "get": { + "operationId": "ServerSoftwareInventoriesController_GetMachineSoftwareInventory", + "tags": [ + "ServerSoftwareInventoriesController" + ], + "description": "Method to get a machines software inventory like applications and roles.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " A server machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "default", + "in": "path", + "description": "Default value.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "Default", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "default value." + } + ] + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSoftwareInventory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen": { + "$ref": "./examples/ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json" + }, + "ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen": { + "$ref": "./examples/ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}/softwareinventories": { + "get": { + "operationId": "ServerSoftwareInventoriesController_ListByServer", + "tags": [ + "ServerSoftwareInventoriesController" + ], + "description": "List ServerSoftwareInventory resources by Server", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": " A server machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSoftwareInventoryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerSoftwareInventoriesController_ListByServer_MaximumSet_Gen": { + "$ref": "./examples/ServerSoftwareInventoriesController_ListByServer_MaximumSet_Gen.json" + }, + "ServerSoftwareInventoriesController_ListByServer_MinimumSet_Gen": { + "$ref": "./examples/ServerSoftwareInventoriesController_ListByServer_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/operationsStatus/{operationStatusName}": { + "get": { + "operationId": "ServerOperationsStatusController_GetServerSiteOperationsStatus", + "tags": [ + "ServerOperationsStatusController" + ], + "description": "A operation status resource belonging to a site resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "operationStatusName", + "in": "path", + "description": "Operation status Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerOperationsStatusController_GetServerSiteOperationsStatus_MaximumSet_Gen": { + "$ref": "./examples/ServerOperationsStatusController_GetServerSiteOperationsStatus_MaximumSet_Gen.json" + }, + "ServerOperationsStatusController_GetServerSiteOperationsStatus_MinimumSet_Gen": { + "$ref": "./examples/ServerOperationsStatusController_GetServerSiteOperationsStatus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/refreshSite": { + "post": { + "operationId": "ServerSitesController_RefreshSite", + "tags": [ + "ServerSitesController" + ], + "description": "Operation to refresh a site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerSitesController_RefreshSite_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_RefreshSite_MaximumSet_Gen.json" + }, + "ServerSitesController_RefreshSite_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_RefreshSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/runAsAccounts": { + "get": { + "operationId": "ServerRunAsAccountsController_ListByServerSiteResource", + "tags": [ + "ServerRunAsAccountsController" + ], + "description": "List ServerRunAsAccount resources by ServerSiteResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerRunAsAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerRunAsAccountsController_ListByServerSiteResource_MaximumSet_Gen": { + "$ref": "./examples/ServerRunAsAccountsController_ListByServerSiteResource_MaximumSet_Gen.json" + }, + "ServerRunAsAccountsController_ListByServerSiteResource_MinimumSet_Gen": { + "$ref": "./examples/ServerRunAsAccountsController_ListByServerSiteResource_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/runAsAccounts/{accountName}": { + "get": { + "operationId": "ServerRunAsAccountsController_Get", + "tags": [ + "ServerRunAsAccountsController" + ], + "description": "Get a ServerRunAsAccount", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "accountName", + "in": "path", + "description": " RunAsAccounts name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerRunAsAccount" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerRunAsAccountsController_Get_MaximumSet_Gen": { + "$ref": "./examples/ServerRunAsAccountsController_Get_MaximumSet_Gen.json" + }, + "ServerRunAsAccountsController_Get_MinimumSet_Gen": { + "$ref": "./examples/ServerRunAsAccountsController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/serverGroupMembers": { + "post": { + "operationId": "ServerDependencyMapController_ServerGroupMembers", + "tags": [ + "ServerDependencyMapController" + ], + "description": "API to list server group members for the selected server group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsServerGroupMembersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerDependencyMapController_ServerGroupMembers_MaximumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_ServerGroupMembers_MaximumSet_Gen.json" + }, + "ServerDependencyMapController_ServerGroupMembers_MinimumSet_Gen": { + "$ref": "./examples/ServerDependencyMapController_ServerGroupMembers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/summary": { + "post": { + "operationId": "ServerSitesController_Summary", + "tags": [ + "ServerSitesController" + ], + "description": "Method to get site usage.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerSitesController_Summary_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_Summary_MaximumSet_Gen.json" + }, + "ServerSitesController_Summary_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_Summary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/updateDependencyMapStatus": { + "post": { + "operationId": "ServerSitesController_UpdateDependencyMapStatus", + "tags": [ + "ServerSitesController" + ], + "description": "Method to enable disable dependency map status for machines\r\n in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMachineDepMapStatus" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerSitesController_UpdateDependencyMapStatus_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_UpdateDependencyMapStatus_MaximumSet_Gen.json" + }, + "ServerSitesController_UpdateDependencyMapStatus_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_UpdateDependencyMapStatus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/updateProperties": { + "post": { + "operationId": "ServerSitesController_UpdateProperties", + "tags": [ + "ServerSitesController" + ], + "description": "Operation to update custom properties for servers", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "metaData", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/MachineMetadataCollection" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerSitesController_UpdateProperties_MaximumSet_Gen": { + "$ref": "./examples/ServerSitesController_UpdateProperties_MaximumSet_Gen.json" + }, + "ServerSitesController_UpdateProperties_MinimumSet_Gen": { + "$ref": "./examples/ServerSitesController_UpdateProperties_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites": { + "get": { + "operationId": "SitesController_ListByResourceGroup", + "tags": [ + "SitesController" + ], + "summary": "Get all vmware sites.", + "description": "Get all the vmware sites in the resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SitesController_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ListByResourceGroup_MaximumSet_Gen.json" + }, + "SitesController_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/SitesController_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}": { + "get": { + "operationId": "SitesController_Get", + "tags": [ + "SitesController" + ], + "description": "Get a VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Get_MaximumSet_Gen.json" + }, + "SitesController_Get_MinimumSet_Gen": { + "$ref": "./examples/SitesController_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SitesController_Create", + "tags": [ + "SitesController" + ], + "description": "Create a VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VmwareSite" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSite" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSite" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Create_MaximumSet_Gen.json" + }, + "SitesController_Create_MinimumSet_Gen": { + "$ref": "./examples/SitesController_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "SitesController_Update", + "tags": [ + "SitesController" + ], + "description": "Update a VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VmwareSiteUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Update_MaximumSet_Gen.json" + }, + "SitesController_Update_MinimumSet_Gen": { + "$ref": "./examples/SitesController_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SitesController_Delete", + "tags": [ + "SitesController" + ], + "description": "Delete a VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Delete_MaximumSet_Gen.json" + }, + "SitesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/SitesController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/clientGroupMembers": { + "post": { + "operationId": "DependencyMapController_ClientGroupMembers", + "tags": [ + "DependencyMapController" + ], + "description": "API to list client group members for the selected client group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsClientGroupMembersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DependencyMapController_ClientGroupMembers_MaximumSet_Gen": { + "$ref": "./examples/DependencyMapController_ClientGroupMembers_MaximumSet_Gen.json" + }, + "DependencyMapController_ClientGroupMembers_MinimumSet_Gen": { + "$ref": "./examples/DependencyMapController_ClientGroupMembers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/computeErrorSummary": { + "post": { + "operationId": "SitesController_ComputeErrorSummary", + "tags": [ + "SitesController" + ], + "description": "Method to get site error summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteErrorSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_ComputeErrorSummary_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ComputeErrorSummary_MaximumSet_Gen.json" + }, + "SitesController_ComputeErrorSummary_MinimumSet_Gen": { + "$ref": "./examples/SitesController_ComputeErrorSummary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/computeusage": { + "post": { + "operationId": "SitesController_Computeusage", + "tags": [ + "SitesController" + ], + "description": "Method to get site error summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_Computeusage_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Computeusage_MaximumSet_Gen.json" + }, + "SitesController_Computeusage_MinimumSet_Gen": { + "$ref": "./examples/SitesController_Computeusage_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/exportApplications": { + "post": { + "operationId": "SitesController_ExportApplications", + "tags": [ + "SitesController" + ], + "description": "Method to generate report containing\r\n machine and the deep discovery of the application installed in the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SitesController_ExportApplications_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ExportApplications_MaximumSet_Gen.json" + }, + "SitesController_ExportApplications_MinimumSet_Gen": { + "$ref": "./examples/SitesController_ExportApplications_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/exportDependencies": { + "post": { + "operationId": "DependencyMapController_ExportDependencies", + "tags": [ + "DependencyMapController" + ], + "description": "API to generate report containing agentless dependencies.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "requestBody", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsExportDependenciesRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DependencyMapController_ExportDependencies_MaximumSet_Gen": { + "$ref": "./examples/DependencyMapController_ExportDependencies_MaximumSet_Gen.json" + }, + "DependencyMapController_ExportDependencies_MinimumSet_Gen": { + "$ref": "./examples/DependencyMapController_ExportDependencies_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/exportMachineErrors": { + "post": { + "operationId": "SitesController_ExportMachineErrors", + "tags": [ + "SitesController" + ], + "description": "Method to generate report containing \r\n machine and the errors encountered during guest discovery of the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ExportMachineErrorsRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SitesController_ExportMachineErrors_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ExportMachineErrors_MaximumSet_Gen.json" + }, + "SitesController_ExportMachineErrors_MinimumSet_Gen": { + "$ref": "./examples/SitesController_ExportMachineErrors_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/exportMachines": { + "post": { + "operationId": "SitesController_ExportMachines", + "tags": [ + "SitesController" + ], + "description": "Method to generate report containing \r\n machine and the deep discovery of the application installed in the machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ExportMachinesRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SitesController_ExportMachines_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ExportMachines_MaximumSet_Gen.json" + }, + "SitesController_ExportMachines_MinimumSet_Gen": { + "$ref": "./examples/SitesController_ExportMachines_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/generateCoarseMap": { + "post": { + "operationId": "DependencyMapController_GenerateCoarseMap", + "tags": [ + "DependencyMapController" + ], + "description": "API to generate coarse map for the list of machines.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsScopeMapRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DependencyMapController_GenerateCoarseMap_MaximumSet_Gen": { + "$ref": "./examples/DependencyMapController_GenerateCoarseMap_MaximumSet_Gen.json" + }, + "DependencyMapController_GenerateCoarseMap_MinimumSet_Gen": { + "$ref": "./examples/DependencyMapController_GenerateCoarseMap_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/generateDetailedMap": { + "post": { + "operationId": "DependencyMapController_GenerateDetailedMap", + "tags": [ + "DependencyMapController" + ], + "description": "API to generate detailed map for a selected machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsSingleMachineDetailedMapRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DependencyMapController_GenerateDetailedMap_MaximumSet_Gen": { + "$ref": "./examples/DependencyMapController_GenerateDetailedMap_MaximumSet_Gen.json" + }, + "DependencyMapController_GenerateDetailedMap_MinimumSet_Gen": { + "$ref": "./examples/DependencyMapController_GenerateDetailedMap_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/hosts": { + "get": { + "operationId": "VmwareHostController_ListByVmwareSite", + "tags": [ + "VmwareHostController" + ], + "description": "List VmwareHost resources by VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareHostListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VmwareHostController_ListByVmwareSite_MaximumSet_Gen": { + "$ref": "./examples/VmwareHostController_ListByVmwareSite_MaximumSet_Gen.json" + }, + "VmwareHostController_ListByVmwareSite_MinimumSet_Gen": { + "$ref": "./examples/VmwareHostController_ListByVmwareSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/hosts/{hostName}": { + "get": { + "operationId": "VmwareHostController_Get", + "tags": [ + "VmwareHostController" + ], + "description": "Get a VmwareHost", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "hostName", + "in": "path", + "description": " Hosts name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareHost" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareHostController_Get_MaximumSet_Gen": { + "$ref": "./examples/VmwareHostController_Get_MaximumSet_Gen.json" + }, + "VmwareHostController_Get_MinimumSet_Gen": { + "$ref": "./examples/VmwareHostController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/jobs": { + "get": { + "operationId": "HypervJobsController_ListByVmwareSite", + "tags": [ + "HypervJobsController" + ], + "description": "List VmwareJob resources by VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareJobListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervJobsController_ListByVmwareSite_MaximumSet_Gen": { + "$ref": "./examples/HypervJobsController_ListByVmwareSite_MaximumSet_Gen.json" + }, + "HypervJobsController_ListByVmwareSite_MinimumSet_Gen": { + "$ref": "./examples/HypervJobsController_ListByVmwareSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/jobs/{jobName}": { + "get": { + "operationId": "HypervJobsController_Get", + "tags": [ + "HypervJobsController" + ], + "description": "Get a VmwareJob", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobName", + "in": "path", + "description": " Jobs name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervJobsController_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervJobsController_Get_MaximumSet_Gen.json" + }, + "HypervJobsController_Get_MinimumSet_Gen": { + "$ref": "./examples/HypervJobsController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/listHealthSummary": { + "post": { + "operationId": "SitesController_ListHealthSummary", + "tags": [ + "SitesController" + ], + "description": "Method to get site health summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SiteHealthSummaryCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_ListHealthSummary_MaximumSet_Gen": { + "$ref": "./examples/SitesController_ListHealthSummary_MaximumSet_Gen.json" + }, + "SitesController_ListHealthSummary_MinimumSet_Gen": { + "$ref": "./examples/SitesController_ListHealthSummary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines": { + "get": { + "operationId": "MachinesController_ListByVmwareSite", + "tags": [ + "MachinesController" + ], + "description": "List MachineResource resources by VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "page size query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total count of machines in the given site.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MachineResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MachinesController_ListByVmwareSite_MaximumSet_Gen": { + "$ref": "./examples/MachinesController_ListByVmwareSite_MaximumSet_Gen.json" + }, + "MachinesController_ListByVmwareSite_MinimumSet_Gen": { + "$ref": "./examples/MachinesController_ListByVmwareSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}": { + "get": { + "operationId": "MachinesController_Get", + "tags": [ + "MachinesController" + ], + "description": "Get a MachineResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MachineResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MachinesController_Get_MaximumSet_Gen": { + "$ref": "./examples/MachinesController_Get_MaximumSet_Gen.json" + }, + "MachinesController_Get_MinimumSet_Gen": { + "$ref": "./examples/MachinesController_Get_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "MachinesController_Update", + "tags": [ + "MachinesController" + ], + "description": "Update a MachineResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/MachineResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MachineResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MachinesController_Update_MaximumSet_Gen": { + "$ref": "./examples/MachinesController_Update_MaximumSet_Gen.json" + }, + "MachinesController_Update_MinimumSet_Gen": { + "$ref": "./examples/MachinesController_Update_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/softwareInventories/{default}": { + "get": { + "operationId": "VmwareSoftwareInventoriesController_GetMachineSoftwareInventory", + "tags": [ + "VmwareSoftwareInventoriesController" + ], + "description": "Method to get a machines software inventory like applications and roles.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "default", + "in": "path", + "description": "Default value.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "Default", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "default value." + } + ] + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareMachineSoftwareInventory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen": { + "$ref": "./examples/VmwareSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json" + }, + "VmwareSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen": { + "$ref": "./examples/VmwareSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/softwareinventories": { + "get": { + "operationId": "VmwareSoftwareInventoriesController_ListByMachineResource", + "tags": [ + "VmwareSoftwareInventoriesController" + ], + "description": "List VmwareMachineSoftwareInventory resources by MachineResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareMachineSoftwareInventoryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen": { + "$ref": "./examples/VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen.json" + }, + "VmwareSoftwareInventoriesController_ListByMachineResource_MinimumSet_Gen": { + "$ref": "./examples/VmwareSoftwareInventoriesController_ListByMachineResource_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/start": { + "post": { + "operationId": "MachinesController_Start", + "tags": [ + "MachinesController" + ], + "description": "Method to start a machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "MachinesController_Start_MaximumSet_Gen": { + "$ref": "./examples/MachinesController_Start_MaximumSet_Gen.json" + }, + "MachinesController_Start_MinimumSet_Gen": { + "$ref": "./examples/MachinesController_Start_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/stop": { + "post": { + "operationId": "MachinesController_Stop", + "tags": [ + "MachinesController" + ], + "description": "Method to stop a machine.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "MachinesController_Stop_MaximumSet_Gen": { + "$ref": "./examples/MachinesController_Stop_MaximumSet_Gen.json" + }, + "MachinesController_Stop_MinimumSet_Gen": { + "$ref": "./examples/MachinesController_Stop_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/operationsStatus/{operationStatusName}": { + "get": { + "operationId": "VmwareOperationsStatus_GetVmwareOperationStatus", + "tags": [ + "VmwareOperationsStatus" + ], + "description": "A operation status resource belonging to a site resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "operationStatusName", + "in": "path", + "description": "Operation status Arm Name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareOperationsStatus_GetVmwareOperationStatus_MaximumSet_Gen": { + "$ref": "./examples/VmwareOperationsStatus_GetVmwareOperationStatus_MaximumSet_Gen.json" + }, + "VmwareOperationsStatus_GetVmwareOperationStatus_MinimumSet_Gen": { + "$ref": "./examples/VmwareOperationsStatus_GetVmwareOperationStatus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/runAsAccounts": { + "get": { + "operationId": "RunAsAccountsController_ListByVmwareSite", + "tags": [ + "RunAsAccountsController" + ], + "description": "List VmwareRunAsAccountResource resources by VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareRunAsAccountResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "RunAsAccountsController_ListByVmwareSite_MaximumSet_Gen": { + "$ref": "./examples/RunAsAccountsController_ListByVmwareSite_MaximumSet_Gen.json" + }, + "RunAsAccountsController_ListByVmwareSite_MinimumSet_Gen": { + "$ref": "./examples/RunAsAccountsController_ListByVmwareSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/runAsAccounts/{accountName}": { + "get": { + "operationId": "RunAsAccountsController_Get", + "tags": [ + "RunAsAccountsController" + ], + "description": "Get a VmwareRunAsAccountResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "accountName", + "in": "path", + "description": " RunAsAccounts name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareRunAsAccountResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RunAsAccountsController_Get_MaximumSet_Gen": { + "$ref": "./examples/RunAsAccountsController_Get_MaximumSet_Gen.json" + }, + "RunAsAccountsController_Get_MinimumSet_Gen": { + "$ref": "./examples/RunAsAccountsController_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/serverGroupMembers": { + "post": { + "operationId": "DependencyMapController_ServerGroupMembers", + "tags": [ + "DependencyMapController" + ], + "description": "API to list server group members for the selected server group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "mapRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsServerGroupMembersRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DependencyMapController_ServerGroupMembers_MaximumSet_Gen": { + "$ref": "./examples/DependencyMapController_ServerGroupMembers_MaximumSet_Gen.json" + }, + "DependencyMapController_ServerGroupMembers_MinimumSet_Gen": { + "$ref": "./examples/DependencyMapController_ServerGroupMembers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/summary": { + "post": { + "operationId": "SitesController_Summary", + "tags": [ + "SitesController" + ], + "description": "Method to get site usage/summary.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSiteUsage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_Summary_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Summary_MaximumSet_Gen.json" + }, + "SitesController_Summary_MinimumSet_Gen": { + "$ref": "./examples/SitesController_Summary_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateDependencyMapStatus": { + "post": { + "operationId": "VmwarePropertiesController_UpdateDependencyMapStatus", + "tags": [ + "VmwarePropertiesController" + ], + "description": "Method to enable disable dependency map status for machines\n in a\nsite.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "updateMachineDepMapStatus", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMachineDepMapStatus" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VmwarePropertiesController_UpdateDependencyMapStatus_MaximumSet_Gen": { + "$ref": "./examples/VmwarePropertiesController_UpdateDependencyMapStatus_MaximumSet_Gen.json" + }, + "VmwarePropertiesController_UpdateDependencyMapStatus_MinimumSet_Gen": { + "$ref": "./examples/VmwarePropertiesController_UpdateDependencyMapStatus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateProperties": { + "post": { + "operationId": "VmwarePropertiesController_UpdateProperties", + "tags": [ + "VmwarePropertiesController" + ], + "description": "Method to update properties for machines in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "metaData", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/MachineMetadataCollection" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VmwarePropertiesController_UpdateProperties_MaximumSet_Gen": { + "$ref": "./examples/VmwarePropertiesController_UpdateProperties_MaximumSet_Gen.json" + }, + "VmwarePropertiesController_UpdateProperties_MinimumSet_Gen": { + "$ref": "./examples/VmwarePropertiesController_UpdateProperties_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateRunAsAccount": { + "post": { + "operationId": "VmwarePropertiesController_UpdateRunAsAccount", + "tags": [ + "VmwarePropertiesController" + ], + "description": "Method to associate Run as account to machine\r\n in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "updateMachineRunAsAccount", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMachineRunAsAccount" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VmwarePropertiesController_UpdateRunAsAccount_MaximumSet_Gen": { + "$ref": "./examples/VmwarePropertiesController_UpdateRunAsAccount_MaximumSet_Gen.json" + }, + "VmwarePropertiesController_UpdateRunAsAccount_MinimumSet_Gen": { + "$ref": "./examples/VmwarePropertiesController_UpdateRunAsAccount_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateTags": { + "post": { + "operationId": "VmwarePropertiesController_UpdateTags", + "tags": [ + "VmwarePropertiesController" + ], + "description": "Method to associate Run as account to machine\r\n in a site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "updateMachineTags", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMachineTags" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "type": "object" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VmwarePropertiesController_UpdateTags_MaximumSet_Gen": { + "$ref": "./examples/VmwarePropertiesController_UpdateTags_MaximumSet_Gen.json" + }, + "VmwarePropertiesController_UpdateTags_MinimumSet_Gen": { + "$ref": "./examples/VmwarePropertiesController_UpdateTags_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters": { + "get": { + "operationId": "VcenterController_ListByVmwareSite", + "tags": [ + "VcenterController" + ], + "description": "List Vcenter resources by VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "filter", + "in": "query", + "description": "filter query", + "required": false, + "type": "string" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VcenterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VcenterController_ListByVmwareSite_MaximumSet_Gen": { + "$ref": "./examples/VcenterController_ListByVmwareSite_MaximumSet_Gen.json" + }, + "VcenterController_ListByVmwareSite_MinimumSet_Gen": { + "$ref": "./examples/VcenterController_ListByVmwareSite_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters/{vcenterName}": { + "get": { + "operationId": "VcenterController_Get", + "tags": [ + "VcenterController" + ], + "description": "Get a Vcenter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "vcenterName", + "in": "path", + "description": " VCenters name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Vcenter" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VcenterController_Get_MaximumSet_Gen": { + "$ref": "./examples/VcenterController_Get_MaximumSet_Gen.json" + }, + "VcenterController_Get_MinimumSet_Gen": { + "$ref": "./examples/VcenterController_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "VcenterController_Create", + "tags": [ + "VcenterController" + ], + "description": "Create a Vcenter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "vcenterName", + "in": "path", + "description": " VCenters name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Vcenter" + } + } + ], + "responses": { + "200": { + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/Vcenter" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Vcenter" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VcenterController_Create_MaximumSet_Gen": { + "$ref": "./examples/VcenterController_Create_MaximumSet_Gen.json" + }, + "VcenterController_Create_MinimumSet_Gen": { + "$ref": "./examples/VcenterController_Create_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "VcenterController_Delete", + "tags": [ + "VcenterController" + ], + "description": "Delete a Vcenter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "vcenterName", + "in": "path", + "description": " VCenters name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VcenterController_Delete_MaximumSet_Gen": { + "$ref": "./examples/VcenterController_Delete_MaximumSet_Gen.json" + }, + "VcenterController_Delete_MinimumSet_Gen": { + "$ref": "./examples/VcenterController_Delete_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "Application": { + "type": "object", + "description": "Application in the guest virtual machine.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets Name of the Application.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the Application.", + "readOnly": true + }, + "provider": { + "type": "string", + "description": "Gets or sets Provider of the Application.", + "readOnly": true + } + } + }, + "ApplicationDiscovery": { + "type": "object", + "description": "Contains data related application and roles discovery scope.", + "properties": { + "discoveryScopeStatus": { + "$ref": "#/definitions/ApplicationDiscoveryScopeStatus", + "description": "Gets discovery scope status.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets errors for discovery scope.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "hydratedRunAsAccountId": { + "type": "string", + "description": "Gets the run as account ID with which feature worked successfully.\n \nIt is discovered by the agent from the list of credentials.", + "readOnly": true + } + } + }, + "ApplicationDiscoveryScopeStatus": { + "type": "string", + "description": "Application Discovery Scope Status", + "enum": [ + "DiscoverySucceededAtleastOnce", + "DiscoveryFailed", + "RunAsAccountNotAssociated", + "DiscoveryNotStarted", + "DiscoveryInProgress", + "Disabled", + "DiscoveryPartiallySucceded", + "DiscoverySucceeded" + ], + "x-ms-enum": { + "name": "ApplicationDiscoveryScopeStatus", + "modelAsString": true, + "values": [ + { + "name": "DiscoverySucceededAtleastOnce", + "value": "DiscoverySucceededAtleastOnce", + "description": "DiscoverySucceededAtleastOnce value." + }, + { + "name": "DiscoveryFailed", + "value": "DiscoveryFailed", + "description": "DiscoveryFailed value." + }, + { + "name": "RunAsAccountNotAssociated", + "value": "RunAsAccountNotAssociated", + "description": "RunAsAccountNotAssociated value." + }, + { + "name": "DiscoveryNotStarted", + "value": "DiscoveryNotStarted", + "description": "DiscoveryNotStarted value." + }, + { + "name": "DiscoveryInProgress", + "value": "DiscoveryInProgress", + "description": "DiscoveryInProgress value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + }, + { + "name": "DiscoveryPartiallySucceded", + "value": "DiscoveryPartiallySucceded", + "description": "DiscoveryPartiallySucceded value." + }, + { + "name": "DiscoverySucceeded", + "value": "DiscoverySucceeded", + "description": "DiscoverySucceeded value." + } + ] + } + }, + "AppsAndRoles": { + "type": "object", + "description": "AppsAndRoles in the guest virtual machine.", + "properties": { + "applications": { + "type": "array", + "description": "Gets or sets Applications of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/Application" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "webApplications": { + "type": "array", + "description": "Gets or sets WebApplications of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/WebApplicationAppsAndRolesModel" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "features": { + "type": "array", + "description": "Gets or sets Features of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/Feature" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sqlServers": { + "type": "array", + "description": "Gets or sets SQLServers of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/SqlServerApplication" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharePointServers": { + "type": "array", + "description": "Gets or sets SharePointServers of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/SharePointServer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "systemCenters": { + "type": "array", + "description": "Gets or sets SystemCenters of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/SystemCenter" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "bizTalkServers": { + "type": "array", + "description": "Gets or sets BizTalkServers of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/BizTalkServer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "exchangeServers": { + "type": "array", + "description": "Gets or sets ExchangeServers of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/ExchangeServer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "otherDatabases": { + "type": "array", + "description": "Gets or sets OtherDatabaseServers of the AppsAndRoles.", + "items": { + "$ref": "#/definitions/OtherDatabase" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "Azure.ResourceManager.Object": { + "type": "object", + "description": "object model" + }, + "BizTalkServer": { + "type": "object", + "description": "BizTalkServer in the guest virtual machine.", + "properties": { + "productName": { + "type": "string", + "description": "Gets or sets ProductName of the BizTalkServer.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets or sets Status of the BizTalkServer.", + "readOnly": true + } + } + }, + "ConnectorUnit": { + "type": "object", + "description": "The connectors of the web server.", + "properties": { + "bindings": { + "type": "array", + "description": "Gets or sets the bindings for the connector.", + "items": { + "$ref": "#/definitions/FrontEndBinding" + }, + "x-ms-identifiers": [] + } + } + }, + "Default": { + "type": "string", + "description": "HealthError Details Source", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "Default", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "default value." + } + ] + } + }, + "DefaultValues": { + "type": "string", + "description": "HealthError Details Source", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "DefaultValues", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "default value." + } + ] + } + }, + "DeleteImportMachinesJob": { + "type": "object", + "description": "A host resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/DeleteImportedMachinesJobProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DeleteImportMachinesJobCollection": { + "type": "object", + "description": "Delete import machines job collection.", + "properties": { + "value": { + "type": "array", + "description": "Gets the list of jobs.", + "items": { + "$ref": "#/definitions/DeleteImportMachinesJob" + } + }, + "nextLink": { + "type": "string", + "description": "Gets the value of next link.", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "DeleteImportedMachinesJobProperties": { + "type": "object", + "description": "Delete Imported Machines Job Properties", + "properties": { + "blobName": { + "type": "string", + "description": "blob name" + }, + "errorSasUri": { + "type": "string", + "description": "error Sas Uri" + }, + "jobState": { + "$ref": "#/definitions/DeleteImportedMachinesJobPropertiesJobState", + "description": "job State" + }, + "numberOfMachinesDeleted": { + "type": "integer", + "format": "int32", + "description": "number Of Machines Deleted" + }, + "deletionConfirmation": { + "type": "boolean", + "description": "deletion Confirmation" + }, + "errors": { + "type": "array", + "description": "errors list", + "items": { + "type": "string" + }, + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets or sets the Job status." + }, + "startTime": { + "type": "string", + "description": "Gets or sets the Job start time." + }, + "endTime": { + "type": "string", + "description": "Gets or sets the Job end time." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the Display name." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "DeleteImportedMachinesJobPropertiesJobState": { + "type": "string", + "description": "Cosmos db Imported Machines JobEntity", + "enum": [ + "Unknown", + "Verified", + "VerifiedWithErrors", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "DeleteImportedMachinesJobPropertiesJobState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Verified", + "value": "Verified", + "description": "Verified value." + }, + { + "name": "VerifiedWithErrors", + "value": "VerifiedWithErrors", + "description": "VerifiedWithErrors value." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed value." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed value." + } + ] + } + }, + "DependencyMapDiscovery": { + "type": "object", + "description": "Contains data related dependency map discovery scope.", + "properties": { + "discoveryScopeStatus": { + "$ref": "#/definitions/DependencyMapDiscoveryScopeStatus", + "description": "Gets discovery scope status.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets errors for discovery scope.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "hydratedRunAsAccountId": { + "type": "string", + "description": "Gets the run as account ID with which feature worked successfully.\n \nIt is discovered by the agent from the list of credentials.", + "readOnly": true + } + } + }, + "DependencyMapDiscoveryScopeStatus": { + "type": "string", + "description": "DependencyMap DiscoveryScope Status", + "enum": [ + "DiscoverySucceededAtleastOnce", + "DiscoveryFailed", + "RunAsAccountNotAssociated", + "DiscoveryNotStarted", + "DiscoveryInProgress", + "Disabled", + "DiscoveryPartiallySucceded", + "DiscoverySucceeded" + ], + "x-ms-enum": { + "name": "DependencyMapDiscoveryScopeStatus", + "modelAsString": true, + "values": [ + { + "name": "DiscoverySucceededAtleastOnce", + "value": "DiscoverySucceededAtleastOnce", + "description": "DiscoverySucceededAtleastOnce value." + }, + { + "name": "DiscoveryFailed", + "value": "DiscoveryFailed", + "description": "DiscoveryFailed value." + }, + { + "name": "RunAsAccountNotAssociated", + "value": "RunAsAccountNotAssociated", + "description": "RunAsAccountNotAssociated value." + }, + { + "name": "DiscoveryNotStarted", + "value": "DiscoveryNotStarted", + "description": "DiscoveryNotStarted value." + }, + { + "name": "DiscoveryInProgress", + "value": "DiscoveryInProgress", + "description": "DiscoveryInProgress value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + }, + { + "name": "DiscoveryPartiallySucceded", + "value": "DiscoveryPartiallySucceded", + "description": "DiscoveryPartiallySucceded value." + }, + { + "name": "DiscoverySucceeded", + "value": "DiscoverySucceeded", + "description": "DiscoverySucceeded value." + } + ] + } + }, + "DependencyMapMachineInput": { + "type": "object", + "description": "Machine class.", + "properties": { + "machineId": { + "type": "string", + "description": "Gets or sets the ARM id of the machine." + }, + "isDependencyMapToBeEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether\n dependency mapping is to\nbe enabled or not." + } + } + }, + "DependencyMapServiceMapextensionsClientGroupMembersRequest": { + "type": "object", + "description": "DependencyMap ServiceMap extensions Client GroupMembers Request", + "properties": { + "machineId": { + "type": "string", + "description": "id of machine" + }, + "processGroupName": { + "type": "string", + "description": "process group name " + }, + "processName": { + "type": "string", + "description": "name of process" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "start time" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "end time" + }, + "filters": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsDependencyMapRequestFilters", + "description": "optional filters" + } + } + }, + "DependencyMapServiceMapextensionsDependencyMapRequestFilters": { + "type": "object", + "description": "DependencyMap Service Map extensions Dependency Map Request Filters", + "properties": { + "machineIds": { + "type": "array", + "description": "array of machine ids", + "items": { + "type": "string" + } + }, + "processIds": { + "type": "array", + "description": "array of process Ids", + "items": { + "type": "string" + } + } + } + }, + "DependencyMapServiceMapextensionsExportDependenciesRequest": { + "type": "object", + "description": "DependencyMap ServiceMap extensions ExportDependencies Request", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "start time" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "end time" + } + } + }, + "DependencyMapServiceMapextensionsScopeMapRequest": { + "type": "object", + "description": "DependencyMap ServiceMapextensions Scope MapRequest", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "start time" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "end time" + }, + "filters": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsDependencyMapRequestFilters", + "description": "optional filters" + } + } + }, + "DependencyMapServiceMapextensionsServerGroupMembersRequest": { + "type": "object", + "description": "DependencyMap ServiceMap extensions ServerGroup Members Request", + "properties": { + "serverPort": { + "type": "integer", + "format": "int32", + "description": "port of server" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "start time" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "end time" + }, + "filters": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsDependencyMapRequestFilters", + "description": "optional filters" + } + } + }, + "DependencyMapServiceMapextensionsSingleMachineDetailedMapRequest": { + "type": "object", + "description": "DependencyMap ServiceMap extensions SingleMachine DetailedMap Request", + "properties": { + "machineId": { + "type": "string", + "description": "id of machine" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "start time" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "end time" + }, + "filters": { + "$ref": "#/definitions/DependencyMapServiceMapextensionsDependencyMapRequestFilters", + "description": "optional filters" + } + } + }, + "DirectoryPath": { + "type": "object", + "description": "Second level entity for virtual directories.", + "properties": { + "virtual": { + "type": "string", + "description": "Gets or sets the virtual path for the directory." + }, + "physical": { + "type": "string", + "description": "Gets or sets the physical path of the directory on the web server." + } + } + }, + "DiscoveryScopeErrorSummary": { + "type": "object", + "description": "The site error summary model.", + "properties": { + "affectedResourceType": { + "type": "string", + "description": "Gets or sets the affected resource type." + }, + "affectedObjectsCount": { + "type": "integer", + "format": "int64", + "description": "Count of affected objects." + }, + "discoveryScope": { + "$ref": "#/definitions/DiscoveryScopes", + "description": "Gets or sets the count of affected objects." + } + }, + "required": [ + "affectedResourceType", + "affectedObjectsCount", + "discoveryScope" + ] + }, + "DiscoveryScopeStatus": { + "type": "string", + "description": "Discovery Scope.", + "enum": [ + "DiscoverySucceededAtleastOnce", + "DiscoveryFailed", + "RunAsAccountNotAssociated", + "DiscoveryNotStarted", + "DiscoveryInProgress", + "Disabled", + "DiscoveryPartiallySucceded", + "DiscoverySucceeded" + ], + "x-ms-enum": { + "name": "DiscoveryScopeStatus", + "modelAsString": true, + "values": [ + { + "name": "DiscoverySucceededAtleastOnce", + "value": "DiscoverySucceededAtleastOnce", + "description": "DiscoverySucceededAtleastOnce value." + }, + { + "name": "DiscoveryFailed", + "value": "DiscoveryFailed", + "description": "DiscoveryFailed value." + }, + { + "name": "RunAsAccountNotAssociated", + "value": "RunAsAccountNotAssociated", + "description": "RunAsAccountNotAssociated value." + }, + { + "name": "DiscoveryNotStarted", + "value": "DiscoveryNotStarted", + "description": "DiscoveryNotStarted value." + }, + { + "name": "DiscoveryInProgress", + "value": "DiscoveryInProgress", + "description": "DiscoveryInProgress value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + }, + { + "name": "DiscoveryPartiallySucceded", + "value": "DiscoveryPartiallySucceded", + "description": "DiscoveryPartiallySucceded value." + }, + { + "name": "DiscoverySucceeded", + "value": "DiscoverySucceeded", + "description": "DiscoverySucceeded value." + } + ] + } + }, + "DiscoveryScopes": { + "type": "string", + "description": "Discovery scopes", + "enum": [ + "AppsAndRoles", + "DependencyMap", + "StaticData", + "SQLServerConnectionInfo" + ], + "x-ms-enum": { + "name": "DiscoveryScopes", + "modelAsString": true, + "values": [ + { + "name": "AppsAndRoles", + "value": "AppsAndRoles", + "description": "AppsAndRoles value." + }, + { + "name": "DependencyMap", + "value": "DependencyMap", + "description": "DependencyMap value." + }, + { + "name": "StaticData", + "value": "StaticData", + "description": "StaticData value." + }, + { + "name": "SQLServerConnectionInfo", + "value": "SQLServerConnectionInfo", + "description": "SQLServerConnectionInfo value." + } + ] + } + }, + "DiscoverySiteDataSource": { + "type": "object", + "description": "Web app data source web model.", + "properties": { + "properties": { + "$ref": "#/definitions/DiscoverySiteDataSourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DiscoverySiteDataSourceListResult": { + "type": "object", + "description": "The response of a DiscoverySiteDataSource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DiscoverySiteDataSource items on this page", + "items": { + "$ref": "#/definitions/DiscoverySiteDataSource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DiscoverySiteDataSourceProperties": { + "type": "object", + "description": "Discovery site data source properties class.", + "properties": { + "discoverySiteId": { + "type": "string", + "description": "Gets or sets the discovery site Id." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "ErrorDetails": { + "type": "object", + "description": "Error contract returned when some exception occurs in Rest API.", + "properties": { + "code": { + "type": "string", + "description": "Gets the error code.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + }, + "possibleCauses": { + "type": "string", + "description": "Gets the possible causes of error.", + "readOnly": true + }, + "recommendedAction": { + "type": "string", + "description": "Gets the recommended action to resolve error.", + "readOnly": true + }, + "severity": { + "type": "string", + "description": "Gets the error severity.", + "readOnly": true + }, + "isAgentReportedError": { + "type": "boolean", + "description": "Gets a value indicating whether the error originated from a agent or not.", + "readOnly": true + }, + "agentErrorCode": { + "type": "string", + "description": "Gets the agent error code.", + "readOnly": true + }, + "agentErrorMessage": { + "type": "string", + "description": "Gets the error message from the agent.", + "readOnly": true + }, + "agentErrorPossibleCauses": { + "type": "string", + "description": "Gets possible causes for the agent error.", + "readOnly": true + }, + "agentErrorRecommendedAction": { + "type": "string", + "description": "Gets the recommended action for the agent error.", + "readOnly": true + } + } + }, + "ErrorSummaryRequest": { + "type": "object", + "description": "ErrorSummaryRequest body", + "properties": { + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + } + } + }, + "Errors": { + "type": "object", + "description": "The properties of a server machine tracked resource", + "properties": { + "message": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + }, + "messageParameters": { + "type": "object", + "description": "Gets the message parameters.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "applianceName": { + "type": "string", + "description": "Gets the appliance name.", + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32", + "description": "Gets the error ID.", + "readOnly": true + }, + "code": { + "type": "string", + "description": "Gets the error name.", + "readOnly": true + }, + "possibleCauses": { + "type": "string", + "description": "Gets the possible causes of error.", + "readOnly": true + }, + "recommendedAction": { + "type": "string", + "description": "Gets the recommended action to resolve error.", + "readOnly": true + }, + "severity": { + "type": "string", + "description": "Gets the error severity.", + "readOnly": true + }, + "summaryMessage": { + "type": "string", + "description": "Gets the error summary message.", + "readOnly": true + }, + "source": { + "$ref": "#/definitions/MicrosoftAzureFDSWebRoleHealthErrorDetailsSource", + "description": "Gets the error source.", + "readOnly": true + }, + "updatedTimeStamp": { + "type": "string", + "format": "date-time", + "description": "Gets the time stamp when the error was updated.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets run as account id used while performing discovery of entity.", + "readOnly": true + }, + "discoveryScope": { + "$ref": "#/definitions/HealthErrorDetailsDiscoveryScope", + "description": "Gets discovery scope for which error is encountered.", + "readOnly": true + } + } + }, + "ExchangeServer": { + "type": "object", + "description": "ExchangeServer in the guest virtual machine.", + "properties": { + "productName": { + "type": "string", + "description": "Gets or sets ProductName of the ExchangeServer.", + "readOnly": true + }, + "edition": { + "type": "string", + "description": "Gets or sets Edition of the ExchangeServer.", + "readOnly": true + }, + "roles": { + "type": "string", + "description": "Gets or sets Roles of the ExchangeServer.", + "readOnly": true + }, + "servicePack": { + "type": "string", + "description": "Gets or sets ServicePack of the ExchangeServer.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the ExchangeServer.", + "readOnly": true + } + } + }, + "ExportImportedMachinesJob": { + "type": "object", + "description": "Export machines job REST resource.", + "properties": { + "type": { + "type": "string", + "description": "Type name for export job.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ExportImportedMachinesJobEntityProperties", + "description": "Gets or sets the export machines job properties." + }, + "id": { + "type": "string", + "description": "Gets or sets the relative ARM name to get job." + }, + "name": { + "type": "string", + "description": "Gets or sets the Job ID." + }, + "status": { + "type": "string", + "description": "Gets or sets the Job status." + }, + "startTime": { + "type": "string", + "description": "Gets or sets the Job start time." + }, + "endTime": { + "type": "string", + "description": "Gets or sets the Job end time." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the Display name." + } + } + }, + "ExportImportedMachinesJobEntityProperties": { + "type": "object", + "description": " Export Imported Machines JobEntity Properties ", + "properties": { + "blobName": { + "type": "string", + "description": "blob name" + }, + "sasUri": { + "type": "string", + "description": "sas uri" + } + } + }, + "ExportMachineErrorsProperties": { + "type": "string", + "description": "Export Machine Errors Properties", + "enum": [ + "AppsAndRoles", + "DependencyMap", + "StaticData", + "SQLServerConnectionInfo" + ], + "x-ms-enum": { + "name": "ExportMachineErrorsProperties", + "modelAsString": true, + "values": [ + { + "name": "AppsAndRoles", + "value": "AppsAndRoles", + "description": "AppsAndRoles value." + }, + { + "name": "DependencyMap", + "value": "DependencyMap", + "description": "DependencyMap value." + }, + { + "name": "StaticData", + "value": "StaticData", + "description": "StaticData value." + }, + { + "name": "SQLServerConnectionInfo", + "value": "SQLServerConnectionInfo", + "description": "SQLServerConnectionInfo value." + } + ] + } + }, + "ExportMachineErrorsRequest": { + "type": "object", + "description": "The body of export machine errors request.", + "properties": { + "properties": { + "$ref": "#/definitions/RequestExportMachineErrorsProperties", + "description": "Gets or sets the properties." + } + } + }, + "ExportMachinesRequest": { + "type": "object", + "description": "ExportMachinesRequest body", + "properties": { + "filter": { + "type": "string", + "description": "filter options." + } + } + }, + "ExportSqlServersRequest": { + "type": "object", + "description": "ExportSqlServerRequest body", + "properties": { + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + }, + "filter": { + "type": "string", + "description": "filter options." + } + } + }, + "ExportWebAppsRequest": { + "type": "object", + "description": "ExportWebAppsRequest body", + "properties": { + "filter": { + "type": "string", + "description": "filter options." + } + } + }, + "FCIInstanceState": { + "type": "string", + "description": "fci instance state ", + "enum": [ + "Unknown", + "Inherited", + "Initializing", + "Online", + "Offline", + "Failed", + "Pending", + "OnlinePending", + "OfflinePending" + ], + "x-ms-enum": { + "name": "FCIInstanceState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Inherited", + "value": "Inherited", + "description": "Inherited value." + }, + { + "name": "Initializing", + "value": "Initializing", + "description": "Initializing value." + }, + { + "name": "Online", + "value": "Online", + "description": "Online value." + }, + { + "name": "Offline", + "value": "Offline", + "description": "Offline value." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed value." + }, + { + "name": "Pending", + "value": "Pending", + "description": "Pending value." + }, + { + "name": "OnlinePending", + "value": "OnlinePending", + "description": "OnlinePending value." + }, + { + "name": "OfflinePending", + "value": "OfflinePending", + "description": "OfflinePending value." + } + ] + } + }, + "Feature": { + "type": "object", + "description": "Feature in the guest virtual machine.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets Name of the Feature.", + "readOnly": true + }, + "featureType": { + "type": "string", + "description": "Gets or sets FeatureType of the Feature.", + "readOnly": true + }, + "parent": { + "type": "string", + "description": "Gets or sets Parent of the Feature.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets or sets Status of the Feature.", + "readOnly": true + } + } + }, + "FileMetaData": { + "type": "object", + "description": "File Metadata web model.", + "properties": { + "logicalName": { + "type": "string", + "description": "Gets or sets the logical name of the file." + }, + "physicalFullName": { + "type": "string", + "description": "Gets or sets the operating-system full path of the file." + }, + "fileType": { + "$ref": "#/definitions/FileType", + "description": "Gets or sets the database file type." + }, + "sizeInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets the size of the file in MB." + }, + "isMemoryOptimizedDataOptionEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether memory optimized data option is enabled." + } + } + }, + "FileType": { + "type": "string", + "description": "file type", + "enum": [ + "Rows", + "Log", + "Filestream", + "NotSupported", + "Fulltext" + ], + "x-ms-enum": { + "name": "FileType", + "modelAsString": true, + "values": [ + { + "name": "Rows", + "value": "Rows", + "description": "Rows value." + }, + { + "name": "Log", + "value": "Log", + "description": "Log value." + }, + { + "name": "Filestream", + "value": "Filestream", + "description": "Filestream value." + }, + { + "name": "NotSupported", + "value": "NotSupported", + "description": "NotSpecified value." + }, + { + "name": "Fulltext", + "value": "Fulltext", + "description": "Fulltext value." + } + ] + } + }, + "FrontEndBinding": { + "type": "object", + "description": "Frontend bindings for a web application.", + "properties": { + "protocol": { + "type": "string", + "description": "Gets or sets the Binding protocol." + }, + "hostName": { + "type": "string", + "description": "Gets or sets the Host name." + }, + "port": { + "type": "string", + "description": "Gets or sets the Port number." + }, + "ipAddress": { + "type": "string", + "description": "Gets or sets the IP Address." + } + } + }, + "GuestOsDetails": { + "type": "object", + "description": "Second level object. Data related to a machine's operating system. Serialized and stored as part of Machine Rest object. ", + "properties": { + "osType": { + "type": "string", + "description": "Gets or sets the type of the operating system." + }, + "osName": { + "type": "string", + "description": "Gets or sets the Name of the operating system." + }, + "osVersion": { + "type": "string", + "description": "Gets or sets the Version of the operating system." + }, + "osArchitecture": { + "type": "string", + "description": "Gets or sets the Architecture of the operating system." + } + } + }, + "HealthErrorDetails": { + "type": "object", + "description": "Error contract returned when some exception occurs in Rest API.", + "properties": { + "message": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + }, + "messageParameters": { + "type": "object", + "description": "Gets the message parameters.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "applianceName": { + "type": "string", + "description": "Gets the appliance name.", + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int64", + "description": "Gets the error ID.", + "readOnly": true + }, + "code": { + "type": "string", + "description": "Gets the error name.", + "readOnly": true + }, + "possibleCauses": { + "type": "string", + "description": "Gets the possible causes of error.", + "readOnly": true + }, + "recommendedAction": { + "type": "string", + "description": "Gets the recommended action to resolve error.", + "readOnly": true + }, + "severity": { + "type": "string", + "description": "Gets the error severity.", + "readOnly": true + }, + "summaryMessage": { + "type": "string", + "description": "Gets the error summary message.", + "readOnly": true + }, + "source": { + "$ref": "#/definitions/HealthErrorDetailsSource", + "description": "Gets the error source.", + "readOnly": true + }, + "updatedTimeStamp": { + "type": "string", + "format": "date-time", + "description": "Gets the time stamp when the error was updated.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets run as account id used while performing discovery of entity.", + "readOnly": true + }, + "discoveryScope": { + "$ref": "#/definitions/HealthErrorDetailsDiscoveryScope", + "description": "Gets discovery scope for which error is encountered.", + "readOnly": true + } + } + }, + "HealthErrorDetailsDiscoveryScope": { + "type": "string", + "description": "Gets discovery scope for which error is encountered.", + "enum": [ + "AppsAndRoles", + "DependencyMap", + "StaticData", + "SQLServerConnectionInfo", + "DiscoveryTargets" + ], + "x-ms-enum": { + "name": "HealthErrorDetailsDiscoveryScope", + "modelAsString": true, + "values": [ + { + "name": "AppsAndRoles", + "value": "AppsAndRoles", + "description": "AppsAndRoles value." + }, + { + "name": "DependencyMap", + "value": "DependencyMap", + "description": "DependencyMap value." + }, + { + "name": "StaticData", + "value": "StaticData", + "description": "StaticData value." + }, + { + "name": "SQLServerConnectionInfo", + "value": "SQLServerConnectionInfo", + "description": "SQLServerConnectionInfo value." + }, + { + "name": "DiscoveryTargets", + "value": "DiscoveryTargets", + "description": "DiscoveryTargets value." + } + ] + } + }, + "HealthErrorDetailsSource": { + "type": "string", + "description": "HealthError Details Source", + "enum": [ + "RefreshFabricLayout", + "RefreshFabricLayoutGuest", + "RefreshFabricLayoutDependencyMap" + ], + "x-ms-enum": { + "name": "HealthErrorDetailsSource", + "modelAsString": true, + "values": [ + { + "name": "RefreshFabricLayout", + "value": "RefreshFabricLayout", + "description": "RefreshFabricLayout value." + }, + { + "name": "RefreshFabricLayoutGuest", + "value": "RefreshFabricLayoutGuest", + "description": "RefreshFabricLayoutGuest value." + }, + { + "name": "RefreshFabricLayoutDependencyMap", + "value": "RefreshFabricLayoutDependencyMap", + "description": "RefreshFabricLayoutDependencyMap value." + } + ] + } + }, + "HighAvailability": { + "type": "string", + "description": "Value indicating whether the VM is highly available", + "enum": [ + "Unknown", + "No", + "Yes" + ], + "x-ms-enum": { + "name": "HighAvailability", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "No", + "value": "No", + "description": "No value." + }, + { + "name": "Yes", + "value": "Yes", + "description": "Yes value." + } + ] + } + }, + "HighAvailabilityValues": { + "type": "string", + "description": "Value indicating whether the VM is highly available", + "enum": [ + "Unknown", + "No", + "Yes" + ], + "x-ms-enum": { + "name": "HighAvailabilityValues", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "No", + "value": "No", + "description": "No value." + }, + { + "name": "Yes", + "value": "Yes", + "description": "Yes value." + } + ] + } + }, + "HypervCluster": { + "type": "object", + "description": "A cluster resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/HypervClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervClusterListResult": { + "type": "object", + "description": "The response of a HypervCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervCluster items on this page", + "items": { + "$ref": "#/definitions/HypervCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervClusterProperties": { + "type": "object", + "description": "The properties of Hyperv Cluster", + "properties": { + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking Hyper-V cluster creation.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the Hyper-V cluster.", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN/IPAddress of the Hyper-V cluster." + }, + "functionalLevel": { + "type": "integer", + "format": "int32", + "description": "Gets the functional level of the Hyper-V cluster.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets the status of the Hyper-V cluster.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets Run as account ID of the Hyper-V cluster." + }, + "hostFqdnList": { + "type": "array", + "description": "Gets or sets list of hosts (FQDN) currently being tracked by the cluster.", + "items": { + "type": "string" + } + }, + "errors": { + "type": "array", + "description": "Gets the errors.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "HypervDisk": { + "type": "object", + "description": "Second level object returned as part of Machine REST resource.", + "properties": { + "instanceId": { + "type": "string", + "description": "Id of the disk.", + "readOnly": true + }, + "vhdId": { + "type": "string", + "description": "VHD Id of the disk.", + "readOnly": true + }, + "maxSizeInBytes": { + "type": "integer", + "format": "int64", + "description": "Gets or sets Bytes allocated for the disk." + }, + "name": { + "type": "string", + "description": "Gets or sets Name of the disk." + }, + "diskType": { + "type": "string", + "description": "Gets or sets Type of the disk." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Gets or sets LUN of the disk." + }, + "path": { + "type": "string", + "description": "Gets or sets Path of the disk." + } + } + }, + "HypervHost": { + "type": "object", + "description": "A host resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/HypervHostProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervHostListResult": { + "type": "object", + "description": "The response of a HypervHost list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervHost items on this page", + "items": { + "$ref": "#/definitions/HypervHost" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervHostProperties": { + "type": "object", + "description": "The properties of Hyperv Host", + "properties": { + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking Hyper-V host creation.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the Hyper-V host.", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN/IPAddress of the Hyper-V host." + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the Hyper-V host." + }, + "version": { + "type": "string", + "description": "Gets the version of the Hyper-V host.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the errors.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "HypervJob": { + "type": "object", + "description": "A job resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervJobListResult": { + "type": "object", + "description": "The response of a HypervJob list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervJob items on this page", + "items": { + "$ref": "#/definitions/HypervJob" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervMachine": { + "type": "object", + "description": "A machine resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/HypervMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervMachineListResult": { + "type": "object", + "description": "The response of a HypervMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervMachine items on this page", + "items": { + "$ref": "#/definitions/HypervMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervMachineProperties": { + "type": "object", + "description": "The properties of AddressResource", + "properties": { + "instanceUuid": { + "type": "string", + "description": "On-premise Instance UUID of the machine.", + "readOnly": true + }, + "hostFqdn": { + "type": "string", + "description": "Host FQDN/IPAddress.", + "readOnly": true + }, + "hostId": { + "type": "string", + "description": "Host ARM ID.", + "readOnly": true + }, + "generation": { + "type": "integer", + "format": "int32", + "description": "Generation of the virtual machine.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "VM version.", + "readOnly": true + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "description": "Value indicating whether the VM is highly available.", + "readOnly": true + }, + "clusterFqdn": { + "type": "string", + "description": "Cluster FQDN/IPAddress.", + "readOnly": true + }, + "clusterId": { + "type": "string", + "description": "Cluster ARM ID.", + "readOnly": true + }, + "maxMemoryMb": { + "type": "integer", + "format": "int32", + "description": "Max memory of the virtual machine in MB.", + "readOnly": true + }, + "isDynamicMemoryEnabled": { + "type": "boolean", + "description": "Value indicating whether dynamic memory is enabled for the VM.", + "readOnly": true + }, + "disks": { + "type": "array", + "description": "Disks attached to the machine.", + "items": { + "$ref": "#/definitions/HypervDisk" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "networkAdapters": { + "type": "array", + "description": "Network adapters attached to the machine.", + "items": { + "$ref": "#/definitions/HypervNetworkAdapter" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "managementServerType": { + "type": "string", + "description": "Management server type captured as a string representation of the\n \n{Microsoft.Azure.FDS.WebRole.HyperVMachineBase.HyperVMachineBaseProperties.ManagementServerType}\nenumeration.", + "readOnly": true + }, + "secureBootTemplateId": { + "type": "string", + "description": "Gets or sets the SecureBootTemplateId setting of the VM.", + "readOnly": true + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether Secure boot is enabled for the VM.", + "readOnly": true + }, + "secureBootTemplate": { + "type": "string", + "description": "Gets or sets the SecureBootTemplateId setting of the VM.", + "readOnly": true + }, + "tpmEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether trusted platform module is enabled on\nthe VM.", + "readOnly": true + }, + "ksdEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether key storage device is enabled on the VM.", + "readOnly": true + }, + "shieldingRequested": { + "type": "boolean", + "description": "Gets or sets a value indicating whether shielding is enabled for the VM.", + "readOnly": true + }, + "dataProtectionRequested": { + "type": "boolean", + "description": "Gets or sets a value indicating whether data protection is requested for a VM.", + "readOnly": true + }, + "encryptStateAndVmMigrationTraffic": { + "type": "boolean", + "description": "Gets or sets a value indicating whether encryption of state and migration\ntraffic is enabled for the VM.", + "readOnly": true + }, + "virtualizationBasedSecurityOptOut": { + "type": "boolean", + "description": "Gets or sets a value indicating whether VM virtualization based security is\nenabled for the VM.", + "readOnly": true + }, + "powerStatus": { + "type": "string", + "description": "Gets the Machine power status.", + "readOnly": true + }, + "vmFqdn": { + "type": "string", + "description": "Gets the VM FQDN.", + "readOnly": true + }, + "vmConfigurationFileLocation": { + "type": "string", + "description": "Gets the Root location of the VM configuration file.", + "readOnly": true + }, + "firmware": { + "type": "string", + "description": "Gets or sets the firmware." + }, + "guestOsDetails": { + "$ref": "#/definitions/GuestOsDetails", + "description": "Operating System Details extracted from the guest bu executing script inside the guest VM. ", + "readOnly": true + }, + "numberOfApplications": { + "type": "integer", + "format": "int32", + "description": "Number of applications installed in the guest VM.", + "readOnly": true + }, + "guestDetailsDiscoveryTimestamp": { + "type": "string", + "format": "date-time", + "description": "The last time at which the Guest Details was discovered\n or the\nerror while discovering guest details based discovery\n of the\nmachine.", + "readOnly": true + }, + "isGuestDetailsDiscoveryInProgress": { + "type": "boolean", + "description": "Whether Refresh Fabric Layout Guest Details has been completed once.\n \n Portal will show discovery in progress, if this value is true.", + "readOnly": true + }, + "dependencyMapping": { + "type": "string", + "description": "Gets or sets if dependency mapping feature is enabled or not\n for\nthe VM.", + "readOnly": true + }, + "dependencyMappingStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets when dependency mapping collection is last started.", + "readOnly": true + }, + "dependencyMappingEndTime": { + "type": "string", + "description": "Gets or sets when dependency mapping collection was last disabled.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the machine." + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Errors for machine.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applicationDiscovery": { + "$ref": "#/definitions/ApplicationDiscovery", + "description": "Gets the data related to application discovery.", + "readOnly": true + }, + "dependencyMapDiscovery": { + "$ref": "#/definitions/DependencyMapDiscovery", + "description": "Gets the data related to dependency map discovery.", + "readOnly": true + }, + "staticDiscovery": { + "$ref": "#/definitions/StaticDiscovery", + "description": "Gets the data related to static discovery.", + "readOnly": true + }, + "sqlDiscovery": { + "$ref": "#/definitions/SqlDiscovery", + "description": "Gets the data related to SQL discovery.", + "readOnly": true + }, + "webAppDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to Web application discovery.", + "readOnly": true + }, + "oracleDiscovery": { + "$ref": "#/definitions/OracleDiscovery", + "description": "Gets the data related to Oracle discovery.", + "readOnly": true + }, + "springBootDiscovery": { + "$ref": "#/definitions/SpringBootDiscovery", + "description": "Gets the data related to SpringBoot discovery.", + "readOnly": true + }, + "iisDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to iis discovery.", + "readOnly": true + }, + "tomcatDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to tomcat discovery.", + "readOnly": true + }, + "appsAndRoles": { + "$ref": "#/definitions/AppsAndRoles", + "description": "Apps And Roles of the Server.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "double", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "displayName": { + "type": "string", + "description": "Gets the Display name of the machine.", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Value indicating whether VM is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the marking machine creation.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the resource.", + "additionalProperties": { + "type": "string" + } + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the machine.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "HypervMachineUpdate": { + "type": "object", + "description": "The type used for update operations of the HypervMachine.", + "properties": { + "properties": { + "$ref": "#/definitions/HypervMachineUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "HypervMachineUpdateProperties": { + "type": "object", + "description": "The updatable properties of the HypervMachine.", + "properties": { + "firmware": { + "type": "string", + "description": "Gets or sets the firmware." + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the machine." + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "double", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the resource.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "HypervNetworkAdapter": { + "type": "object", + "description": "Second level object represented in responses as part of Machine REST resource.", + "properties": { + "networkId": { + "type": "string", + "description": "Network Id.", + "readOnly": true + }, + "subnetName": { + "type": "string", + "description": "Name of the VM subnet within the virtual network the NIC is attached to.", + "readOnly": true + }, + "staticIpAddress": { + "type": "string", + "description": "Static IP address.", + "readOnly": true + }, + "nicType": { + "type": "string", + "description": "Mac address of the NIC.", + "readOnly": true + }, + "nicId": { + "type": "string", + "description": "Gets or sets the NIC Id." + }, + "macAddress": { + "type": "string", + "description": "Gets or sets Mac address of the NIC." + }, + "ipAddressList": { + "type": "array", + "description": "Gets IP addresses for the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "networkName": { + "type": "string", + "description": "Gets or sets Network Name." + }, + "ipAddressType": { + "type": "string", + "description": "Gets or sets Type of the IP address." + } + } + }, + "HypervOperationsStatusResource": { + "type": "object", + "description": "A cluster resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/HypervClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervRunAsAccountResource": { + "type": "object", + "description": "A machine resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RunAsAccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervRunAsAccountResourceListResult": { + "type": "object", + "description": "The response of a HypervRunAsAccountResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervRunAsAccountResource items on this page", + "items": { + "$ref": "#/definitions/HypervRunAsAccountResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervSite": { + "type": "object", + "description": "A HyperV SiteResource", + "properties": { + "properties": { + "$ref": "#/definitions/SiteProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "HypervSiteListResult": { + "type": "object", + "description": "The response of a HypervSite list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervSite items on this page", + "items": { + "$ref": "#/definitions/HypervSite" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervSiteUpdate": { + "type": "object", + "description": "The type used for update operations of the HypervSite.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/HypervSiteUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "HypervSiteUpdateProperties": { + "type": "object", + "description": "The updatable properties of the HypervSite.", + "properties": { + "servicePrincipalIdentityDetails": { + "$ref": "#/definitions/SiteSpnProperties", + "description": "Gets or sets the service principal identity details used by agent for\ncommunication\n to the service." + }, + "agentDetails": { + "$ref": "#/definitions/SiteAgentProperties", + "description": "Gets or sets the on-premises agent details." + }, + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + }, + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "HypervSiteUsage": { + "type": "object", + "description": "Hyper-V site usage.", + "properties": { + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of machines discovered in the site." + }, + "runAsAccountCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of run as accounts in the site." + }, + "hostCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of hosts part of the site." + }, + "clusterCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of clusters part of the site." + } + } + }, + "HypervVmSoftwareInventory": { + "type": "object", + "description": "HyperV VM software inventory REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineSoftwareInventoryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervVmSoftwareInventoryListResult": { + "type": "object", + "description": "The response of a HypervVmSoftwareInventory list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervVmSoftwareInventory items on this page", + "items": { + "$ref": "#/definitions/HypervVmSoftwareInventory" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IisApplicationUnit": { + "type": "object", + "description": "Second-level object for identification of application units in a web site\nhosted on IIS.", + "properties": { + "applicationPoolName": { + "type": "string", + "description": "Gets or sets the path of the directory." + }, + "managedPipelineMode": { + "type": "string", + "description": "Gets or sets the managed pipeline mode." + }, + "runtimeVersion": { + "type": "string", + "description": "Gets or sets the runtime version." + }, + "enable32BitApiOnWin64": { + "type": "boolean", + "description": "Gets or sets a value indicating whether 32 bit applications are allowed to run\non 64 bit." + }, + "path": { + "$ref": "#/definitions/DirectoryPath", + "description": "Gets or sets the path of the directory." + }, + "directories": { + "type": "array", + "description": "Gets or sets the list of directories.", + "items": { + "$ref": "#/definitions/DirectoryPath" + }, + "x-ms-identifiers": [] + } + } + }, + "IisVirtualApplicationUnit": { + "type": "object", + "description": "Second-level object for identification of virtual applications in a web site\nhosted on IIS.", + "properties": { + "isVirtualDirectory": { + "type": "boolean", + "description": "Gets a value indicating whether the application corresponds to a directory.", + "readOnly": true + }, + "path": { + "$ref": "#/definitions/DirectoryPath", + "description": "Gets or sets the path of the directory." + }, + "directories": { + "type": "array", + "description": "Gets or sets the list of directories.", + "items": { + "$ref": "#/definitions/DirectoryPath" + }, + "x-ms-identifiers": [] + } + } + }, + "IisWebApplicationProperties": { + "type": "object", + "description": "Class for web application properties.", + "properties": { + "applications": { + "type": "array", + "description": "Gets the list of application units for the web site.", + "items": { + "$ref": "#/definitions/IisApplicationUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "virtualApplications": { + "type": "array", + "description": "Gets the list of application units for the web site.", + "items": { + "$ref": "#/definitions/IisVirtualApplicationUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "webServerId": { + "type": "string", + "description": "Gets the web server id.", + "readOnly": true + }, + "webServerName": { + "type": "string", + "description": "Gets the web server name.", + "readOnly": true + }, + "machineArmIds": { + "type": "array", + "description": "Gets the list of machine ARM Ids on which the SQL server is deployed.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "virtualPath": { + "type": "string", + "description": "Gets the virtual path of the application.", + "readOnly": true + }, + "physicalPath": { + "type": "string", + "description": "Gets the physical path of the application.", + "readOnly": true + }, + "bindings": { + "type": "array", + "description": "Gets the front end bindings for the application.", + "items": { + "$ref": "#/definitions/FrontEndBinding" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "frameworks": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/WebApplicationFramework" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "configurations": { + "type": "array", + "description": "Gets the configuration.", + "items": { + "$ref": "#/definitions/WebApplicationConfigurationUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "directories": { + "type": "array", + "description": "Gets the directories.", + "items": { + "$ref": "#/definitions/WebApplicationDirectoryUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "displayName": { + "type": "string", + "description": "Gets the display name.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the resource.", + "additionalProperties": { + "type": "string" + } + }, + "staticFolders": { + "type": "array", + "description": "Static folders.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "machineDisplayName": { + "type": "string", + "description": "Machine display name", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Gets the server type.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hasErrors": { + "type": "boolean", + "description": "Gets a value indicating whether the WebApp has errors or not.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "IisWebApplications": { + "type": "object", + "description": "Web application REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/IisWebApplicationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "IisWebApplicationsListResult": { + "type": "object", + "description": "The response of a IisWebApplications list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IisWebApplications items on this page", + "items": { + "$ref": "#/definitions/IisWebApplications" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IisWebApplicationsUpdate": { + "type": "object", + "description": "The type used for update operations of the IisWebApplications.", + "properties": { + "properties": { + "$ref": "#/definitions/IisWebApplicationsUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "IisWebApplicationsUpdateProperties": { + "type": "object", + "description": "The updatable properties of the IisWebApplications.", + "properties": { + "tags": { + "type": "object", + "description": "Gets or sets tags on the resource.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "IisWebServerProperties": { + "type": "object", + "description": "Class for web server properties.", + "properties": { + "configurationLocation": { + "type": "string", + "description": "Gets the configuration location.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets the configuration location.", + "readOnly": true + }, + "machineIds": { + "type": "array", + "description": "Gets the list of machines.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "webApplications": { + "type": "array", + "description": "Gets the list of web applications.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name.", + "readOnly": true + }, + "serverFqdn": { + "type": "string", + "description": "Gets the server FQDN.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets the run as account id.", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Gets the server type.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hasErrors": { + "type": "boolean", + "description": "Gets a value indicating whether the WebApp has errors or not.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "IisWebServers": { + "type": "object", + "description": "Web server REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/IisWebServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "IisWebServersListResult": { + "type": "object", + "description": "The response of a IisWebServers list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IisWebServers items on this page", + "items": { + "$ref": "#/definitions/IisWebServers" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ImportJob": { + "type": "object", + "description": "A host resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ImportJobListResult": { + "type": "object", + "description": "The response of a ImportJob list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ImportJob items on this page", + "items": { + "$ref": "#/definitions/ImportJob" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ImportMachine": { + "type": "object", + "description": "An machine resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ImportMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ImportMachineListResult": { + "type": "object", + "description": "The response of a ImportMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ImportMachine items on this page", + "items": { + "$ref": "#/definitions/ImportMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ImportMachineProperties": { + "type": "object", + "description": "Class for machine properties.", + "properties": { + "firmware": { + "type": "string", + "description": "Firmware of the machine.", + "readOnly": true + }, + "percentageCpuUtilization": { + "type": "number", + "format": "float", + "description": "CPU utilization.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Memory utilization.", + "readOnly": true + }, + "numberOfDisks": { + "type": "integer", + "format": "int32", + "description": "Number of disks.", + "readOnly": true + }, + "totalDiskReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Total disk read operations per second.", + "readOnly": true + }, + "totalDiskWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Total disk write operations per second.", + "readOnly": true + }, + "totalDiskWriteThroughput": { + "type": "number", + "format": "float", + "description": "Total disk write throughput.", + "readOnly": true + }, + "totalDiskReadThroughput": { + "type": "number", + "format": "float", + "description": "Total disk read throughput.", + "readOnly": true + }, + "macAddress": { + "type": "string", + "description": "MAC Address.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "IP Addresses.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "machineId": { + "type": "string", + "description": "Machine ID.", + "readOnly": true + }, + "machineManagerId": { + "type": "string", + "description": "Machine manager ID.", + "readOnly": true + }, + "numberOfNetworkAdapters": { + "type": "integer", + "format": "int32", + "description": "Number of network adapters.", + "readOnly": true + }, + "networkInThroughput": { + "type": "number", + "format": "float", + "description": "Network in throughput.", + "readOnly": true + }, + "networkOutThroughput": { + "type": "number", + "format": "float", + "description": "Network out throughput.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Server type.", + "readOnly": true + }, + "hypervisor": { + "type": "string", + "description": "Fabric type.", + "readOnly": true + }, + "hypervisorVersionNumber": { + "type": "string", + "description": "Hypervisor version number.", + "readOnly": true + }, + "disks": { + "type": "array", + "description": "Disks attached to the machine.", + "items": { + "$ref": "#/definitions/WebRoleImportDisk" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "vmFqdn": { + "type": "string", + "description": "Server FQDN.", + "readOnly": true + }, + "storageInUseGb": { + "type": "number", + "format": "float", + "description": "Total storage in use.", + "readOnly": true + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "double", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/WebRoleOperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "displayName": { + "type": "string", + "description": "Gets the Display name of the machine.", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Value indicating whether VM is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the marking machine creation.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the machine.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "machine tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + }, + "required": [ + "tags" + ] + }, + "ImportMachinesJob": { + "type": "object", + "description": "Import machines Job REST Resource.", + "properties": { + "type": { + "type": "string", + "description": "Handled by resource provider. Type =\nMicrosoft.OffAzure/ImportSites/jobs/importJobs.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ImportMachinesJobProperties", + "description": "Gets or sets the import job properties." + }, + "id": { + "type": "string", + "description": "Gets or sets the relative ARM name to get job." + }, + "name": { + "type": "string", + "description": "Gets or sets the Job ID." + }, + "status": { + "type": "string", + "description": "Gets or sets the Job status." + }, + "startTime": { + "type": "string", + "description": "Gets or sets the Job start time." + }, + "endTime": { + "type": "string", + "description": "Gets or sets the Job end time." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the Display name." + } + } + }, + "ImportMachinesJobProperties": { + "type": "object", + "description": "ImportMachines JobProperties", + "properties": { + "blobName": { + "type": "string", + "description": "blob name" + }, + "blobSasUri": { + "type": "string", + "description": "blob sasUri" + }, + "jobResult": { + "$ref": "#/definitions/JobResult", + "description": "job Result" + }, + "numberOfMachinesImported": { + "type": "integer", + "format": "int32", + "description": "number Of Machines Imported" + }, + "blobCreationTimeStamp": { + "type": "string", + "format": "date-time", + "description": "blob Creation TimeStamp" + }, + "errorSummary": { + "$ref": "#/definitions/JobErrorSummary", + "description": "error summary" + } + } + }, + "ImportSite": { + "type": "object", + "description": "A ImportSite", + "properties": { + "properties": { + "$ref": "#/definitions/ImportSiteProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "ImportSiteListResult": { + "type": "object", + "description": "The response of a ImportSite list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ImportSite items on this page", + "items": { + "$ref": "#/definitions/ImportSite" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ImportSiteProperties": { + "type": "object", + "description": "The properties of ImportSiteResource", + "properties": { + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + }, + "masterSiteId": { + "type": "string", + "description": "Gets the Master Site this site is linked to.", + "readOnly": true + }, + "serviceEndpoint": { + "type": "string", + "description": "Gets the service endpoint.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "ImportSiteUpdate": { + "type": "object", + "description": "The type used for update operations of the ImportSite.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ImportSiteUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "ImportSiteUpdateProperties": { + "type": "object", + "description": "The updatable properties of the ImportSite.", + "properties": { + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "JobErrorSummary": { + "type": "object", + "description": "Job Error Summary", + "properties": { + "errors": { + "type": "array", + "description": "errors list", + "items": { + "type": "string" + } + }, + "errorCount": { + "type": "integer", + "format": "int32", + "description": "error count" + }, + "warningCount": { + "type": "integer", + "format": "int32", + "description": "warning Count" + } + } + }, + "JobProperties": { + "type": "object", + "description": "Job REST Resource.", + "properties": { + "status": { + "type": "string", + "description": "Gets operation status.", + "readOnly": true + }, + "startTime": { + "type": "string", + "description": "Gets operation start time.", + "readOnly": true + }, + "endTime": { + "type": "string", + "description": "Gets operation end time.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets or sets the display name of the Job.", + "readOnly": true + }, + "clientRequestId": { + "type": "string", + "description": "Gets the client request Id used in the operation execution context.", + "readOnly": true + }, + "activityId": { + "type": "string", + "description": "Gets the activity Id used in the operation execution context.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the errors.", + "items": { + "$ref": "#/definitions/ErrorDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "JobResult": { + "type": "string", + "description": "JobResultValues", + "enum": [ + "Unknown", + "Completed", + "CompletedWithWarnings", + "CompletedWithErrors", + "Failed", + "WaitingForBlobUpload", + "InProgress" + ], + "x-ms-enum": { + "name": "JobResult", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed value." + }, + { + "name": "CompletedWithWarnings", + "value": "CompletedWithWarnings", + "description": "CompletedWithWarnings value." + }, + { + "name": "CompletedWithErrors", + "value": "CompletedWithErrors", + "description": "CompletedWithErrors value." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed value." + }, + { + "name": "WaitingForBlobUpload", + "value": "WaitingForBlobUpload", + "description": "WaitingForBlobUpload value." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "InProgress value." + } + ] + } + }, + "MachineMetadata": { + "type": "object", + "description": "The properties of Machine MetaData", + "properties": { + "machineArmId": { + "type": "string", + "description": "arm id of the machine." + }, + "dependencyMapping": { + "type": "string", + "description": "value representing state of dependency mapping (enabled/disabled)." + }, + "tags": { + "type": "object", + "description": "machine tags", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "machineArmId", + "dependencyMapping", + "tags" + ] + }, + "MachineMetadataCollection": { + "type": "object", + "description": "The list of Machine MetaData.", + "properties": { + "value": { + "type": "array", + "description": "The list of Machine MetaData.", + "items": { + "$ref": "#/definitions/MachineMetadata" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "value" + ] + }, + "MachineResource": { + "type": "object", + "description": "An machine resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/VmwareMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "MachineResourceListResult": { + "type": "object", + "description": "The response of a MachineResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MachineResource items on this page", + "items": { + "$ref": "#/definitions/MachineResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MachineResourceUpdate": { + "type": "object", + "description": "The type used for update operations of the MachineResource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineResourceUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "MachineResourceUpdateProperties": { + "type": "object", + "description": "The updatable properties of the MachineResource.", + "properties": { + "firmware": { + "type": "string", + "description": "Gets or sets the firmware." + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the machine." + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "double", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the VMware machine.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MachineSoftwareInventoryProperties": { + "type": "object", + "description": "Class for machine software inventory properties.", + "properties": { + "appsAndRoles": { + "$ref": "#/definitions/AppsAndRoles", + "description": "Apps And Roles of the machine entity.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "MasterSite": { + "type": "object", + "description": "A MasterSite", + "properties": { + "properties": { + "$ref": "#/definitions/MasterSiteProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "MasterSiteListResult": { + "type": "object", + "description": "The response of a MasterSite list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MasterSite items on this page", + "items": { + "$ref": "#/definitions/MasterSite" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MasterSiteProperties": { + "type": "object", + "description": "Class for site properties.", + "properties": { + "publicNetworkAccess": { + "$ref": "#/definitions/MasterSitePropertiesPublicNetworkAccess", + "description": "Gets or sets the state of public network access." + }, + "allowMultipleSites": { + "type": "boolean", + "description": "Gets or sets a value indicating whether multiple sites per site type are\nallowed." + }, + "sites": { + "type": "array", + "description": "Gets or sets the sites that are a part of Master Site.\n The key\nshould contain the Site ARM name.", + "items": { + "type": "string" + } + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "Gets or sets a value for customer storage account ARM id." + }, + "privateEndpointConnections": { + "type": "array", + "description": "Gets the private endpoint connections.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "nestedSites": { + "type": "array", + "description": "Gets the nested sites under Master Site.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "MasterSitePropertiesPublicNetworkAccess": { + "type": "string", + "description": "PublicNetworkAccess", + "enum": [ + "NotSpecified", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "MasterSitePropertiesPublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "NotSpecified value." + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + } + ] + } + }, + "MasterSiteUpdate": { + "type": "object", + "description": "The type used for update operations of the MasterSite.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/MasterSiteUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "MasterSiteUpdateProperties": { + "type": "object", + "description": "The updatable properties of the MasterSite.", + "properties": { + "publicNetworkAccess": { + "$ref": "#/definitions/MasterSitePropertiesPublicNetworkAccess", + "description": "Gets or sets the state of public network access." + }, + "allowMultipleSites": { + "type": "boolean", + "description": "Gets or sets a value indicating whether multiple sites per site type are\nallowed." + }, + "sites": { + "type": "array", + "description": "Gets or sets the sites that are a part of Master Site.\n The key\nshould contain the Site ARM name.", + "items": { + "type": "string" + } + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "Gets or sets a value for customer storage account ARM id." + } + } + }, + "MicrosoftAzureFDSWebRoleHealthErrorDetailsSource": { + "type": "string", + "description": "HealthError Details Source", + "enum": [ + "RefreshFabricLayout", + "RefreshFabricLayoutGuest", + "RefreshFabricLayoutDependencyMap" + ], + "x-ms-enum": { + "name": "MicrosoftAzureFDSWebRoleHealthErrorDetailsSource", + "modelAsString": true, + "values": [ + { + "name": "RefreshFabricLayout", + "value": "RefreshFabricLayout", + "description": "RefreshFabricLayout value." + }, + { + "name": "RefreshFabricLayoutGuest", + "value": "RefreshFabricLayoutGuest", + "description": "RefreshFabricLayoutGuest value." + }, + { + "name": "RefreshFabricLayoutDependencyMap", + "value": "RefreshFabricLayoutDependencyMap", + "description": "RefreshFabricLayoutDependencyMap value." + } + ] + } + }, + "Object": { + "type": "object", + "description": "object model" + }, + "OperatingSystem": { + "type": "object", + "description": "Second level object returned as part of Machine REST resource.", + "properties": { + "osType": { + "type": "string", + "description": "Gets or sets the type of the operating system." + }, + "osName": { + "type": "string", + "description": "Gets or sets the Name of the operating system." + }, + "osVersion": { + "type": "string", + "description": "Gets or sets the Version of the operating system." + }, + "osArchitecture": { + "type": "string", + "description": "Gets or sets the Architecture of the operating system." + } + } + }, + "OperationStatus": { + "type": "object", + "description": "Operation status REST resource.", + "properties": { + "id": { + "type": "string", + "description": "Gets the Id.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Gets the operation name.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets the status of the operation. ARM expects the terminal status to be one\nof\n Succeeded/ Failed/ Canceled. All other values imply that the\noperation is still running.", + "readOnly": true + }, + "startTime": { + "type": "string", + "description": "Gets the start time.", + "readOnly": true + }, + "endTime": { + "type": "string", + "description": "Gets the start time.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/OperationStatusError", + "description": "Gets the error.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OperationStatusProperties", + "description": "Operation status properties", + "readOnly": true + } + } + }, + "OperationStatusError": { + "type": "object", + "description": "Class for operation status errors.", + "properties": { + "code": { + "type": "string", + "description": "Gets the error code.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + } + } + }, + "OperationStatusProperties": { + "type": "object", + "description": "Class for operation result properties.", + "properties": { + "result": { + "type": "string", + "description": "Gets or sets the result or output of the workflow." + } + } + }, + "OracleDiscovery": { + "type": "object", + "description": "Data related to a machine's Oracle discovery.", + "properties": { + "totalInstanceCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets number of successfully discovered instances." + }, + "totalDatabaseCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets number of successfully discovered databases." + }, + "shallowDiscoveryStatus": { + "$ref": "#/definitions/ShallowDiscoveryStatus", + "description": "Gets or sets status of partner shallow discovery." + }, + "discoveryScopeStatus": { + "$ref": "#/definitions/DiscoveryScopeStatus", + "description": "Gets or sets status of partner discovery." + } + } + }, + "OtherDatabase": { + "type": "object", + "description": "OtherDatabase in the guest virtual machine.", + "properties": { + "databaseType": { + "type": "string", + "description": "Gets or sets DatabaseType of the OtherDatabase.", + "readOnly": true + }, + "instance": { + "type": "string", + "description": "Gets or sets Instance of the OtherDatabase.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the OtherDatabase.", + "readOnly": true + } + } + }, + "PagedDeleteImportMachinesJob": { + "type": "object", + "description": "Paged collection of DeleteImportMachinesJob items", + "properties": { + "value": { + "type": "array", + "description": "The DeleteImportMachinesJob items on this page", + "items": { + "$ref": "#/definitions/DeleteImportMachinesJob" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items", + "readOnly": true + } + } + }, + "PagedExportImportedMachinesJob": { + "type": "object", + "description": "Paged collection of ExportImportedMachinesJob items", + "properties": { + "value": { + "type": "array", + "description": "The ExportImportedMachinesJob items on this page", + "items": { + "$ref": "#/definitions/ExportImportedMachinesJob" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items", + "readOnly": true + } + } + }, + "PagedImportMachinesJob": { + "type": "object", + "description": "Paged collection of ImportMachinesJob items", + "properties": { + "value": { + "type": "array", + "description": "The ImportMachinesJob items on this page", + "items": { + "$ref": "#/definitions/ImportMachinesJob" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items", + "readOnly": true + } + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "REST model used to encapsulate Private Link properties for tracked resources.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionPropertiesV2", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "The response of a PrivateEndpointConnection list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnection items on this page", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateEndpointConnectionPropertiesV2": { + "type": "object", + "description": "PrivateEndpointConnectionProperties V2", + "properties": { + "groupIds": { + "type": "array", + "description": "array of group ids", + "items": { + "type": "string" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/ResourceId", + "description": "private endpoints", + "readOnly": true + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "private endpoints connection state" + } + } + }, + "PrivateLinkResource": { + "type": "object", + "description": "REST model used to encapsulate Private Link properties for tracked resources.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "The response of a PrivateLinkResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateLinkResource items on this page", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateLinkResourceProperties": { + "type": "object", + "description": "private link resource properties model", + "properties": { + "requiredMembers": { + "type": "array", + "description": "required members", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "type": "array", + "description": "required zone names", + "items": { + "type": "string" + } + }, + "groupId": { + "type": "string", + "description": "group id" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "description": "Service Connection State", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStateStatus", + "description": "state status" + }, + "description": { + "type": "string", + "description": "description string" + }, + "actionsRequired": { + "type": "string", + "description": "actions required" + } + } + }, + "PrivateLinkServiceConnectionStateStatus": { + "type": "string", + "description": "PrivateLinkServiceConnectionState", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStateStatus", + "modelAsString": true, + "values": [ + { + "name": "Approved", + "value": "Approved", + "description": "Approved value." + }, + { + "name": "Pending", + "value": "Pending", + "description": "Pending value." + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "Rejected value." + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "Disconnected value." + } + ] + } + }, + "ProcessorInfo": { + "type": "object", + "description": "Processor Information.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name\\model of a processor." + }, + "numberOfSockets": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of sockets." + }, + "numberOfCoresPerSocket": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the total number of cores in a socket." + } + } + }, + "ProductSupportStatus": { + "type": "object", + "description": "product support status.", + "properties": { + "currentVersion": { + "type": "string", + "description": "current version." + }, + "esuStatus": { + "$ref": "#/definitions/esuStatus", + "description": "esu status." + }, + "supportStatus": { + "$ref": "#/definitions/supportStatus", + "description": "support status." + }, + "supportEndDate": { + "type": "string", + "format": "date-time", + "description": "support end date." + }, + "esuYear": { + "$ref": "#/definitions/esuYear", + "description": "esu year." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Created", + "Updated", + "Running", + "Completed", + "Failed", + "Succeeded", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Created", + "value": "Created", + "description": "Created value." + }, + { + "name": "Updated", + "value": "Updated", + "description": "Updated value." + }, + { + "name": "Running", + "value": "Running", + "description": "Running value." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed value." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed value." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Succeeded value." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Canceled value." + } + ] + } + }, + "ProxySiteRefreshBody": { + "type": "object", + "description": "Request body for Proxy site refresh action.", + "properties": { + "applianceName": { + "type": "string", + "description": "Gets or sets the appliance name of the agent in the site." + } + } + }, + "RequestExportMachineErrorsProperties": { + "type": "object", + "description": "The Properties class for export machine errors request body.", + "properties": { + "discoveryScope": { + "$ref": "#/definitions/ExportMachineErrorsProperties", + "description": "Gets or sets the discovery scope." + } + } + }, + "ResourceId": { + "type": "object", + "description": "PrivateEndpointModelsResourceId", + "properties": { + "id": { + "type": "string", + "description": "id name", + "readOnly": true + } + } + }, + "RunAsAccountMachineInput": { + "type": "object", + "description": "Machine class.", + "properties": { + "machineId": { + "type": "string", + "description": "Gets or sets the ARM id of the machine." + }, + "runAsAccountId": { + "type": "string", + "description": "run as AccountId" + } + } + }, + "RunAsAccountProperties": { + "type": "object", + "description": "Class for run as account properties.", + "properties": { + "displayName": { + "type": "string", + "description": "Display name of the run as account.", + "readOnly": true + }, + "credentialType": { + "type": "string", + "description": "Gets the credential type of the run as account.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Timestamp marking run as account creation.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Timestamp marking last updated on the run as account.", + "readOnly": true + }, + "applianceName": { + "type": "string", + "description": "Gets the appliance name of the run as account.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "SQLDiscoveryScopeStatus": { + "type": "string", + "description": "SQLDiscoveryScope Status", + "enum": [ + "DiscoverySucceededAtleastOnce", + "DiscoveryFailed", + "RunAsAccountNotAssociated", + "DiscoveryNotStarted", + "DiscoveryInProgress", + "Disabled", + "DiscoveryPartiallySucceded", + "DiscoverySucceeded" + ], + "x-ms-enum": { + "name": "SQLDiscoveryScopeStatus", + "modelAsString": true, + "values": [ + { + "name": "DiscoverySucceededAtleastOnce", + "value": "DiscoverySucceededAtleastOnce", + "description": "DiscoverySucceededAtleastOnce value." + }, + { + "name": "DiscoveryFailed", + "value": "DiscoveryFailed", + "description": "DiscoveryFailed value." + }, + { + "name": "RunAsAccountNotAssociated", + "value": "RunAsAccountNotAssociated", + "description": "RunAsAccountNotAssociated value." + }, + { + "name": "DiscoveryNotStarted", + "value": "DiscoveryNotStarted", + "description": "DiscoveryNotStarted value." + }, + { + "name": "DiscoveryInProgress", + "value": "DiscoveryInProgress", + "description": "DiscoveryInProgress value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + }, + { + "name": "DiscoveryPartiallySucceded", + "value": "DiscoveryPartiallySucceded", + "description": "DiscoveryPartiallySucceded value." + }, + { + "name": "DiscoverySucceeded", + "value": "DiscoverySucceeded", + "description": "DiscoverySucceeded value." + } + ] + } + }, + "SasUriResponse": { + "type": "object", + "description": "Import URI response class.", + "properties": { + "jobArmId": { + "type": "string", + "description": "Gets or sets the job ARM ID." + }, + "uri": { + "type": "string", + "description": "Gets or sets the SAS URI." + } + } + }, + "Server": { + "type": "object", + "description": "A machine resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ServerDisk": { + "type": "object", + "description": "Server disk details.", + "properties": { + "id": { + "type": "string", + "description": "Gets or sets Id of the disk." + }, + "generatedId": { + "type": "string", + "description": "Gets or sets generated Id of the disk." + }, + "maxSizeInBytes": { + "type": "integer", + "format": "int32", + "description": "Gets or sets Bytes allocated for the disk." + }, + "name": { + "type": "string", + "description": "Gets or sets Name of the disk." + }, + "diskType": { + "type": "string", + "description": "Gets or sets Type of the disk." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Gets or sets LUN of the disk." + }, + "path": { + "type": "string", + "description": "Gets or sets Path of the disk." + } + } + }, + "ServerJob": { + "type": "object", + "description": "A host resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ServerJobListResult": { + "type": "object", + "description": "The response of a ServerJob list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ServerJob items on this page", + "items": { + "$ref": "#/definitions/ServerJob" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServerListResult": { + "type": "object", + "description": "The response of a Server list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Server items on this page", + "items": { + "$ref": "#/definitions/Server" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServerNetworkAdapter": { + "type": "object", + "description": "Second level object represented in responses as part of Machine REST resource.", + "properties": { + "nicId": { + "type": "string", + "description": "Gets or sets the NIC Id." + }, + "macAddress": { + "type": "string", + "description": "Gets or sets Mac address of the NIC." + }, + "ipAddressList": { + "type": "array", + "description": "Gets IP addresses for the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "networkName": { + "type": "string", + "description": "Gets or sets Network Name." + }, + "ipAddressType": { + "type": "string", + "description": "Gets or sets Type of the IP address." + } + } + }, + "ServerProperties": { + "type": "object", + "description": "Server REST resource.", + "properties": { + "displayName": { + "type": "string", + "description": "Gets the Display name of the machine.\n For server entity hydrated\nFQDN is set as display name\n as the server id and server name are\nsame.", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN/IPAddress of the server." + }, + "networkAdapters": { + "type": "array", + "description": "Gets or sets the network adapters of the server.", + "items": { + "$ref": "#/definitions/ServerNetworkAdapter" + }, + "x-ms-identifiers": [] + }, + "hydratedFqdn": { + "type": "string", + "description": "Gets or sets the FQDN of machine which can be changed." + }, + "disks": { + "type": "array", + "description": "Gets or sets the disk details of server.", + "items": { + "$ref": "#/definitions/ServerDisk" + } + }, + "validationRequired": { + "type": "string", + "description": "Gets or sets the validation required for the machine." + }, + "processorInfo": { + "$ref": "#/definitions/ProcessorInfo", + "description": "Processor Info of the Server machine.", + "readOnly": true + }, + "firmware": { + "type": "string", + "description": "Gets or sets the firmware." + }, + "guestOsDetails": { + "$ref": "#/definitions/GuestOsDetails", + "description": "Operating System Details extracted from the guest\n bu executing\nscript inside the guest VM.", + "readOnly": true + }, + "numberOfApplications": { + "type": "integer", + "format": "int32", + "description": "Number of applications installed in the guest VM.", + "readOnly": true + }, + "guestDetailsDiscoveryTimestamp": { + "type": "string", + "format": "date-time", + "description": "The last time at which the Guest Details was discovered\n or the\nerror while discovering guest details based discovery\n of the\nmachine.", + "readOnly": true + }, + "isGuestDetailsDiscoveryInProgress": { + "type": "boolean", + "description": "Whether Refresh Fabric Layout Guest Details has been completed once.\n \n Portal will show discovery in progress, if this value is true.", + "readOnly": true + }, + "dependencyMapping": { + "type": "string", + "description": "Gets or sets if dependency mapping feature is enabled or not\n for\nthe VM.", + "readOnly": true + }, + "dependencyMappingStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets when dependency mapping collection is last started.", + "readOnly": true + }, + "dependencyMappingEndTime": { + "type": "string", + "description": "Gets or sets when dependency mapping collection was last disabled.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the machine." + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Errors for machine.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applicationDiscovery": { + "$ref": "#/definitions/ApplicationDiscovery", + "description": "Gets the data related to application discovery.", + "readOnly": true + }, + "dependencyMapDiscovery": { + "$ref": "#/definitions/DependencyMapDiscovery", + "description": "Gets the data related to dependency map discovery.", + "readOnly": true + }, + "staticDiscovery": { + "$ref": "#/definitions/StaticDiscovery", + "description": "Gets the data related to static discovery.", + "readOnly": true + }, + "sqlDiscovery": { + "$ref": "#/definitions/SqlDiscovery", + "description": "Gets the data related to SQL discovery.", + "readOnly": true + }, + "webAppDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to Web application discovery.", + "readOnly": true + }, + "oracleDiscovery": { + "$ref": "#/definitions/OracleDiscovery", + "description": "Gets the data related to Oracle discovery.", + "readOnly": true + }, + "springBootDiscovery": { + "$ref": "#/definitions/SpringBootDiscovery", + "description": "Gets the data related to SpringBoot discovery.", + "readOnly": true + }, + "iisDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to iis discovery.", + "readOnly": true + }, + "tomcatDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to tomcat discovery.", + "readOnly": true + }, + "appsAndRoles": { + "$ref": "#/definitions/AppsAndRoles", + "description": "Apps And Roles of the Server.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "isDeleted": { + "type": "boolean", + "description": "Value indicating whether VM is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the marking machine creation.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the Server machine.", + "additionalProperties": { + "$ref": "#/definitions/Azure.ResourceManager.Object" + } + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the machine.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the server resource." + } + } + }, + "ServerRunAsAccount": { + "type": "object", + "description": "A run as account resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RunAsAccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ServerRunAsAccountListResult": { + "type": "object", + "description": "The response of a ServerRunAsAccount list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ServerRunAsAccount items on this page", + "items": { + "$ref": "#/definitions/ServerRunAsAccount" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServerSiteResource": { + "type": "object", + "description": "A ServerSiteResource", + "properties": { + "properties": { + "$ref": "#/definitions/SitesProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "ServerSiteResourceListResult": { + "type": "object", + "description": "The response of a ServerSiteResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ServerSiteResource items on this page", + "items": { + "$ref": "#/definitions/ServerSiteResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServerSiteResourceUpdate": { + "type": "object", + "description": "The type used for update operations of the ServerSiteResource.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ServerSiteResourceUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "ServerSiteResourceUpdateProperties": { + "type": "object", + "description": "The updatable properties of the ServerSiteResource.", + "properties": { + "servicePrincipalIdentityDetails": { + "$ref": "#/definitions/SiteSpnProperties", + "description": "Gets or sets the service principal identity details used by agent for\ncommunication\n to the service." + }, + "agentDetails": { + "$ref": "#/definitions/SiteAgentProperties", + "description": "Gets or sets the on-premises agent details." + }, + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + }, + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + } + } + }, + "ServerSiteUsage": { + "type": "object", + "description": "Server site usage.", + "properties": { + "runAsAccountCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of run as accounts in the site." + }, + "serverCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of servers part of the site." + } + } + }, + "ServerSiteUsageResponse": { + "type": "object", + "description": "The properties of ServerSiteUsageResponse.", + "properties": { + "runAsAccounts": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of run as accounts in the site." + }, + "serverCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of servers part of the site." + } + }, + "required": [ + "runAsAccounts", + "serverCount" + ] + }, + "ServerSoftwareInventory": { + "type": "object", + "description": "An software inventory resource belonging to a server resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineSoftwareInventoryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ServerSoftwareInventoryListResult": { + "type": "object", + "description": "The response of a ServerSoftwareInventory list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ServerSoftwareInventory items on this page", + "items": { + "$ref": "#/definitions/ServerSoftwareInventory" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServerUpdate": { + "type": "object", + "description": "The type used for update operations of the Server.", + "properties": { + "properties": { + "$ref": "#/definitions/ServerUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "ServerUpdateProperties": { + "type": "object", + "description": "The updatable properties of the Server.", + "properties": { + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN/IPAddress of the server." + }, + "networkAdapters": { + "type": "array", + "description": "Gets or sets the network adapters of the server.", + "items": { + "$ref": "#/definitions/ServerNetworkAdapter" + }, + "x-ms-identifiers": [] + }, + "hydratedFqdn": { + "type": "string", + "description": "Gets or sets the FQDN of machine which can be changed." + }, + "disks": { + "type": "array", + "description": "Gets or sets the disk details of server.", + "items": { + "$ref": "#/definitions/ServerDisk" + } + }, + "validationRequired": { + "type": "string", + "description": "Gets or sets the validation required for the machine." + }, + "firmware": { + "type": "string", + "description": "Gets or sets the firmware." + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the machine." + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the Server machine.", + "additionalProperties": { + "$ref": "#/definitions/Azure.ResourceManager.Object" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the server resource." + } + } + }, + "ShallowDiscoveryStatus": { + "type": "string", + "description": "Shallow Discovery Status.", + "enum": [ + "DiscoverySucceededAtleastOnce", + "DiscoveryFailed", + "RunAsAccountNotAssociated", + "DiscoveryNotStarted", + "DiscoveryInProgress", + "Disabled", + "DiscoveryPartiallySucceded", + "DiscoverySucceeded" + ], + "x-ms-enum": { + "name": "ShallowDiscoveryStatus", + "modelAsString": true, + "values": [ + { + "name": "DiscoverySucceededAtleastOnce", + "value": "DiscoverySucceededAtleastOnce", + "description": "DiscoverySucceededAtleastOnce value." + }, + { + "name": "DiscoveryFailed", + "value": "DiscoveryFailed", + "description": "DiscoveryFailed value." + }, + { + "name": "RunAsAccountNotAssociated", + "value": "RunAsAccountNotAssociated", + "description": "RunAsAccountNotAssociated value." + }, + { + "name": "DiscoveryNotStarted", + "value": "DiscoveryNotStarted", + "description": "DiscoveryNotStarted value." + }, + { + "name": "DiscoveryInProgress", + "value": "DiscoveryInProgress", + "description": "DiscoveryInProgress value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + }, + { + "name": "DiscoveryPartiallySucceded", + "value": "DiscoveryPartiallySucceded", + "description": "DiscoveryPartiallySucceded value." + }, + { + "name": "DiscoverySucceeded", + "value": "DiscoverySucceeded", + "description": "DiscoverySucceeded value." + } + ] + } + }, + "SharePointServer": { + "type": "object", + "description": "SharePointServer in the guest virtual machine.", + "properties": { + "productName": { + "type": "string", + "description": "Gets or sets ProductName of the SharePointServer.", + "readOnly": true + }, + "isEnterprise": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the SharePointServer is Enterprise.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets or sets Status of the SharePointServer.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the SharePointServer.", + "readOnly": true + } + } + }, + "SiteAgentProperties": { + "type": "object", + "description": "Class for site agent properties.", + "properties": { + "id": { + "type": "string", + "description": "Gets the ID of the agent.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets the version of the agent.", + "readOnly": true + }, + "lastHeartBeatUtc": { + "type": "string", + "format": "date-time", + "description": "Gets the last heartbeat time of the agent in UTC.", + "readOnly": true + }, + "keyVaultUri": { + "type": "string", + "description": "Gets or sets the key vault URI." + }, + "keyVaultId": { + "type": "string", + "description": "Gets or sets the key vault ARM Id." + } + } + }, + "SiteApplianceProperties": { + "type": "object", + "description": "Class for site appliance properties.", + "properties": { + "servicePrincipalIdentityDetails": { + "$ref": "#/definitions/SiteSpnProperties", + "description": " Gets or sets the service principal identity details used by agent for communication to the service. " + }, + "agentDetails": { + "$ref": "#/definitions/SiteAgentProperties", + "description": "Gets or sets the on-premises agent details." + }, + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + } + } + }, + "SiteErrorSummary": { + "type": "object", + "description": "Site error summary.", + "properties": { + "applianceName": { + "type": "string", + "description": "Appliance Name." + }, + "discoveryScopeErrorSummaries": { + "$ref": "#/definitions/DiscoveryScopeErrorSummary", + "description": "Gets the error message." + }, + "nextLink": { + "type": "string", + "description": "The link to fetch more models." + } + }, + "required": [ + "applianceName", + "discoveryScopeErrorSummaries" + ] + }, + "SiteHealthSummary": { + "type": "object", + "description": "The properties of ServerSiteResource.", + "properties": { + "applianceName": { + "type": "string", + "description": "Gets the appliance name.", + "readOnly": true + }, + "errorMessage": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + }, + "summaryMessage": { + "type": "string", + "description": "Gets the summary message.", + "readOnly": true + }, + "errorId": { + "type": "integer", + "format": "int64", + "description": "Gets the error Id.", + "readOnly": true + }, + "errorCode": { + "type": "string", + "description": "Gets the error code.", + "readOnly": true + }, + "affectedObjectsCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the count of affected objects." + }, + "hitCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the hit count of the error." + }, + "severity": { + "type": "string", + "description": "Gets the severity of error.", + "readOnly": true + }, + "remediationGuidance": { + "type": "string", + "description": "Gets the remediation guidance.", + "readOnly": true + }, + "affectedResourceType": { + "type": "string", + "description": "Gets the affected resource type.", + "readOnly": true + }, + "affectedResources": { + "type": "array", + "description": "Gets or sets the affected resources.", + "items": { + "type": "string" + } + }, + "fabricLayoutUpdateSources": { + "type": "array", + "description": "Gets or sets sources of the exception.", + "items": { + "$ref": "#/definitions/SiteHealthSummaryFabricLayoutUpdateSourcesItem" + } + } + } + }, + "SiteHealthSummaryCollection": { + "type": "object", + "description": "Collection of SiteHealthSummary.", + "properties": { + "value": { + "type": "array", + "description": "Gets the list of SiteHealthSummary.", + "items": { + "$ref": "#/definitions/SiteHealthSummary" + }, + "x-ms-identifiers": [ + "applianceName" + ] + }, + "nextLink": { + "type": "string", + "description": "Gets the value of next link.", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "SiteHealthSummaryFabricLayoutUpdateSourcesItem": { + "type": "string", + "description": "SiteHealthSummary FabricLayout UpdateSources", + "enum": [ + "RefreshFabricLayout", + "RefreshFabricLayoutGuest", + "RefreshFabricLayoutDependencyMap" + ], + "x-ms-enum": { + "name": "SiteHealthSummaryFabricLayoutUpdateSourcesItem", + "modelAsString": true, + "values": [ + { + "name": "RefreshFabricLayout", + "value": "RefreshFabricLayout", + "description": "RefreshFabricLayout value." + }, + { + "name": "RefreshFabricLayoutGuest", + "value": "RefreshFabricLayoutGuest", + "description": "RefreshFabricLayoutGuest value." + }, + { + "name": "RefreshFabricLayoutDependencyMap", + "value": "RefreshFabricLayoutDependencyMap", + "description": "RefreshFabricLayoutDependencyMap value." + } + ] + } + }, + "SiteProperties": { + "type": "object", + "description": "The properties of VMwareSiteResource", + "properties": { + "masterSiteId": { + "type": "string", + "description": "Gets the Master Site this site is linked to.", + "readOnly": true + }, + "servicePrincipalIdentityDetails": { + "$ref": "#/definitions/SiteSpnProperties", + "description": "Gets or sets the service principal identity details used by agent for\ncommunication\n to the service." + }, + "agentDetails": { + "$ref": "#/definitions/SiteAgentProperties", + "description": "Gets or sets the on-premises agent details." + }, + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + }, + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + }, + "serviceEndpoint": { + "type": "string", + "description": "Gets the service endpoint.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "SiteSpnProperties": { + "type": "object", + "description": "Class for site properties.", + "properties": { + "tenantId": { + "type": "string", + "description": "Gets or sets the tenant Id for the service principal with which the\non-premise\n management/data plane components would communicate with\nour Azure services." + }, + "applicationId": { + "type": "string", + "description": "Gets or sets the application/client Id for the service principal with which\nthe\n on-premise management/data plane components would communicate\nwith our Azure \n services." + }, + "objectId": { + "type": "string", + "description": "Gets or sets the object Id of the service principal with which the on-premise\n\n management/data plane components would communicate with our Azure\nservices." + }, + "audience": { + "type": "string", + "description": "Gets or sets the intended audience for the service principal." + }, + "aadAuthority": { + "type": "string", + "description": "Gets or sets the AAD Authority URL which was used to request the token for\nthe\n service principal." + }, + "rawCertData": { + "type": "string", + "description": "Gets or sets the raw certificate data for building certificate expiry flows." + } + } + }, + "SitesProperties": { + "type": "object", + "description": "The properties of SiteResource", + "properties": { + "masterSiteId": { + "type": "string", + "description": "Gets the Master Site this site is linked to.", + "readOnly": true + }, + "servicePrincipalIdentityDetails": { + "$ref": "#/definitions/SiteSpnProperties", + "description": "Gets or sets the service principal identity details used by agent for\ncommunication\n to the service." + }, + "agentDetails": { + "$ref": "#/definitions/SiteAgentProperties", + "description": "Gets or sets the on-premises agent details." + }, + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + }, + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + }, + "serviceEndpoint": { + "type": "string", + "description": "Gets the service endpoint.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "SpringBootDiscovery": { + "type": "object", + "description": "Data related to a machine's spring boot discovery.", + "properties": { + "totalInstanceCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets number of successfully discovered instances." + }, + "totalApplicationCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets number of successfully discovered applications." + }, + "shallowDiscoveryStatus": { + "$ref": "#/definitions/ShallowDiscoveryStatus", + "description": "Gets or sets status of partner shallow discovery." + }, + "discoveryScopeStatus": { + "$ref": "#/definitions/DiscoveryScopeStatus", + "description": "Gets or sets status of partner discovery." + } + } + }, + "SqlAvailabilityGroup": { + "type": "object", + "description": "Class representing the web model of SQL Availability Group.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAvailabilityGroupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAvailabilityGroupListResult": { + "type": "object", + "description": "The response of a SqlAvailabilityGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAvailabilityGroup items on this page", + "items": { + "$ref": "#/definitions/SqlAvailabilityGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAvailabilityGroupProperties": { + "type": "object", + "description": "Class for SQL Server availability group properties.", + "properties": { + "availabilityGroupName": { + "type": "string", + "description": "Gets or sets the SQL Availability Group Name." + }, + "availabilityGroupType": { + "$ref": "#/definitions/SqlAvailabilityGroupPropertiesAvailabilityGroupType", + "description": "Gets or sets the type of availability group. Currently there are two types of AGs Traditional and Distributed. " + }, + "isMultiSubNet": { + "type": "boolean", + "description": "Gets or sets a value indicating whether AG is multi subnet or not." + }, + "clusterName": { + "type": "string", + "description": "Gets or sets the Cluster name where AG is hosted." + }, + "availabilityReplicas": { + "type": "array", + "description": "Gets the list of availability replica properties which together forms this availability group.", + "items": { + "$ref": "#/definitions/SqlAvailabilityReplicaProperties" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "parentReplicaOverviewList": { + "type": "array", + "description": "Gets the parent availability replica overview if any.\n This would be\nset with details of parent AG and AR for cases where this availability group is\na part of a distributed AG.\n Currently, we do not populate this\nsince discovery and linking of DAG(Distributed Availability Group) is not\nimplemented.", + "items": { + "$ref": "#/definitions/SqlAvailabilityReplicaOverview" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "isPartOfDistributedAvailabilityGroup": { + "type": "boolean", + "description": "Gets or sets a value indicating whether this Availability group is part of a\ndistributed AG." + }, + "isDeleted": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the entity is deleted." + }, + "createdTimestamp": { + "type": "string", + "description": "Gets or sets the marking machine creation." + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets or sets the timestamp marking last updated on the machine." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "SqlAvailabilityGroupPropertiesAvailabilityGroupType": { + "type": "string", + "description": "AvailabilityGroupType", + "enum": [ + "Unknown", + "Traditional", + "Distributed" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupPropertiesAvailabilityGroupType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Traditional", + "value": "Traditional", + "description": "Traditional value." + }, + { + "name": "Distributed", + "value": "Distributed", + "description": "Distributed value." + } + ] + } + }, + "SqlAvailabilityGroupReplicaInfo": { + "type": "object", + "description": "Class which represents the SQL availability replica properties of type AG.", + "properties": { + "clusterName": { + "type": "string", + "description": "Gets or sets the name of the cluster on which this replica is hosted." + }, + "availabilityGroupName": { + "type": "string", + "description": "Gets or sets the name of the availability replica." + }, + "availabilityGroupArmId": { + "type": "string", + "description": "Gets or sets the AG ARM ID which are part of this Replica." + } + } + }, + "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaCommitMode": { + "type": "string", + "description": "ReplicaCommitMode", + "enum": [ + "Unknown", + "Synchronous", + "Asynchronous" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaCommitMode", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Synchronous", + "value": "Synchronous", + "description": "Synchronous value." + }, + { + "name": "Asynchronous", + "value": "Asynchronous", + "description": "Asynchronous value." + } + ] + } + }, + "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaReadMode": { + "type": "string", + "description": "ReplicaReadMode", + "enum": [ + "Unknown", + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaReadMode", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "None", + "value": "None", + "description": "None value." + }, + { + "name": "ReadOnly", + "value": "ReadOnly", + "description": "ReadOnly value." + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "ReadWrite value." + } + ] + } + }, + "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSeedMode": { + "type": "string", + "description": "ReplicaSeedMode", + "enum": [ + "Unknown", + "Manual", + "Automatic" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSeedMode", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Manual", + "value": "Manual", + "description": "Manual value." + }, + { + "name": "Automatic", + "value": "Automatic", + "description": "Automatic value." + } + ] + } + }, + "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaState": { + "type": "string", + "description": "ReplicaState", + "enum": [ + "Unknown", + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Primary", + "value": "Primary", + "description": "Primary value." + }, + { + "name": "Secondary", + "value": "Secondary", + "description": "Secondary value." + } + ] + } + }, + "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSyncStatus": { + "type": "string", + "description": "ReplicaSyncStatus", + "enum": [ + "Unknown", + "Synchronized", + "Unsynchronized" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSyncStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Synchronized", + "value": "Synchronized", + "description": "Synchronized value." + }, + { + "name": "Unsynchronized", + "value": "Unsynchronized", + "description": "Unsynchronized value." + } + ] + } + }, + "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaType": { + "type": "string", + "description": "ReplicaType", + "enum": [ + "Unknown", + "DatabaseReplica", + "AvailabilityGroupReplica" + ], + "x-ms-enum": { + "name": "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "DatabaseReplica", + "value": "DatabaseReplica", + "description": "DatabaseReplica value." + }, + { + "name": "AvailabilityGroupReplica", + "value": "AvailabilityGroupReplica", + "description": "AvailabilityGroupReplica value." + } + ] + } + }, + "SqlAvailabilityReplicaOverview": { + "type": "object", + "description": "Web model for SQL replica overview.", + "properties": { + "replicaState": { + "$ref": "#/definitions/SqlAvailabilityReplicaOverviewReplicaState", + "description": "Gets or sets the state of the availability replica." + }, + "availabilityReplicaId": { + "type": "string", + "description": "Gets or sets the SQL Availability Replica Id within the Availability Group this\ndatabase is a part of." + }, + "availabilityGroupArmId": { + "type": "string", + "description": "Gets or sets the Availability Group Id in which this database participates if\nany. It would be set if the database has\n{Microsoft.Azure.FDS.CosmosDB.SqlDatabaseEntity.IsDatabaseHighlyAvailable} has\na value \"true\"." + }, + "availabilityGroupName": { + "type": "string", + "description": "Gets or sets the SQL Availability group name." + } + } + }, + "SqlAvailabilityReplicaOverviewReplicaState": { + "type": "string", + "description": "Overview Replica State", + "enum": [ + "Unknown", + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "SqlAvailabilityReplicaOverviewReplicaState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Primary", + "value": "Primary", + "description": "Primary value." + }, + { + "name": "Secondary", + "value": "Secondary", + "description": "Secondary value." + } + ] + } + }, + "SqlAvailabilityReplicaProperties": { + "type": "object", + "description": "Class for SQL Server availability replica properties.", + "properties": { + "availabilityReplicaName": { + "type": "string", + "description": "Gets or sets the SQL Availability Replica Name." + }, + "availabilityReplicaId": { + "type": "string", + "description": "Gets or sets the SQL Availability Replica Id." + }, + "replicaType": { + "$ref": "#/definitions/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaType", + "description": "Gets or sets the replica type of the availability group." + }, + "replicaState": { + "$ref": "#/definitions/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaState", + "description": "Gets or sets the state of the availability replica." + }, + "replicaSyncStatus": { + "$ref": "#/definitions/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSyncStatus", + "description": "Gets or sets the synchronization status of the replica." + }, + "replicaCommitMode": { + "$ref": "#/definitions/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaCommitMode", + "description": "Gets or sets the commit mode of the replica." + }, + "replicaReadMode": { + "$ref": "#/definitions/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaReadMode", + "description": "Gets or sets the read mode of the replica." + }, + "replicaSeedMode": { + "$ref": "#/definitions/SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaSeedMode", + "description": "Gets or sets the seed mode of the replica." + }, + "sqlDatabaseReplicaInfo": { + "$ref": "#/definitions/SqlDatabaseReplicaInfo", + "description": "Gets or sets the Availability Replica object if Replica is of type database.\nThis is null in case Replica is\n of type AG. This is to be populated\nin case of normal AG." + }, + "sqlAvailabilityGroupReplicaInfo": { + "$ref": "#/definitions/SqlAvailabilityGroupReplicaInfo", + "description": "Gets or sets the Availability Replica object if Replica is of type AG. This is\nnull in case Replica is\n of type database. This is to be populated\nin case AG is of type DAG." + } + } + }, + "SqlDatabasePropertiesV2": { + "type": "object", + "description": "Class for SQL Server database properties.", + "properties": { + "parentReplicaOverview": { + "$ref": "#/definitions/SqlAvailabilityReplicaOverview", + "description": "Gets or sets the Replica overview." + }, + "isDatabaseHighlyAvailable": { + "type": "boolean", + "description": "Gets or sets a value indicating whether this database is a part of an HA setup." + }, + "fileMetadataList": { + "type": "array", + "description": "Gets the file metadata list.", + "items": { + "$ref": "#/definitions/FileMetaData" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "hostname": { + "type": "string", + "description": "Gets or sets the hostname." + }, + "sqlServerName": { + "type": "string", + "description": "Gets or sets the SQL Server Id in which the database resides." + }, + "status": { + "type": "string", + "description": "Gets or sets the status." + }, + "sizeMb": { + "type": "number", + "format": "float", + "description": "Gets or sets the size in Mb." + }, + "databaseName": { + "type": "string", + "description": "Gets or sets the SQL database name." + }, + "sqlServerArmId": { + "type": "string", + "description": "Gets or sets the SQL Server ARM Id in which the database resides." + }, + "compatibilityLevel": { + "type": "string", + "description": "Gets or sets the database compatibility level." + }, + "isDeleted": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the entity is deleted." + }, + "errors": { + "type": "array", + "description": "Gets the errors.", + "items": { + "$ref": "#/definitions/Errors" + }, + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets or sets the marking machine creation." + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets or sets the timestamp marking last updated on the machine." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "SqlDatabaseReplicaInfo": { + "type": "object", + "description": "Class which represents the SQL availability replica properties of type\ndatabases.", + "properties": { + "hostName": { + "type": "string", + "description": "Gets or sets the host name of the availability replica." + }, + "sqlServerName": { + "type": "string", + "description": "Gets or sets the SQL Server name of the availability replica." + }, + "sqlServerArmId": { + "type": "string", + "description": "Gets or sets the SQL Server name of the availability replica." + } + } + }, + "SqlDatabaseV2": { + "type": "object", + "description": "Class representing the web model of SQL Database.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlDatabasePropertiesV2", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlDatabaseV2ListResult": { + "type": "object", + "description": "The response of a SqlDatabaseV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlDatabaseV2 items on this page", + "items": { + "$ref": "#/definitions/SqlDatabaseV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlDiscovery": { + "type": "object", + "description": "Contains data related SQL discovery.", + "properties": { + "successfullyDiscoveredServerCount": { + "type": "integer", + "format": "int32", + "description": " successfully Discovered ServerCount" + }, + "totalServerCount": { + "type": "integer", + "format": "int32", + "description": "total Server Count" + }, + "sqlMetadataHydratedRunAsAccountId": { + "type": "string", + "description": "sql Metadata Hydrated RunAsAccountId" + }, + "sqlMetadataDiscoveryPipe": { + "$ref": "#/definitions/SqlMetadataDiscoveryPipe", + "description": "sql Metadata DiscoveryPipe" + }, + "discoveryScopeStatus": { + "$ref": "#/definitions/SQLDiscoveryScopeStatus", + "description": "discovery Scope Status" + } + } + }, + "SqlDiscoverySiteDataSource": { + "type": "object", + "description": "A SQL discovery site data source resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlDiscoverySiteDataSourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlDiscoverySiteDataSourceListResult": { + "type": "object", + "description": "The response of a SqlDiscoverySiteDataSource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlDiscoverySiteDataSource items on this page", + "items": { + "$ref": "#/definitions/SqlDiscoverySiteDataSource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlDiscoverySiteDataSourceProperties": { + "type": "object", + "description": "Discovery site data source properties class.", + "properties": { + "discoverySiteId": { + "type": "string", + "description": "Gets or sets the discovery site Id." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "SqlFciProperties": { + "type": "object", + "description": "The class representing the properties for an FCI instance.", + "properties": { + "state": { + "$ref": "#/definitions/FCIInstanceState", + "description": "Gets or sets the state of the FCI instance." + }, + "networkName": { + "type": "string", + "description": "Gets or sets the FCI Network Name used to connect to this FCI instance." + }, + "isMultiSubnet": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the FCI is hosted on possible owners\nwhich are in multiple subnets." + }, + "sharedDiskCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of Shared Disks for SQL FCI." + } + } + }, + "SqlJob": { + "type": "object", + "description": "Class representing the web model of SQL Database.", + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlJobListResult": { + "type": "object", + "description": "The response of a SqlJob list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlJob items on this page", + "items": { + "$ref": "#/definitions/SqlJob" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlMachineOverview": { + "type": "object", + "description": "Gets or sets SQL machine overview data.", + "properties": { + "machineArmId": { + "type": "string", + "description": "Gets or sets SQL machine ARM ID." + }, + "displayName": { + "type": "string", + "description": "Gets or sets SQL machine display name." + }, + "fciRole": { + "$ref": "#/definitions/SqlMachineOverviewFciRole", + "description": "Gets or sets SQL machine FCI role." + } + } + }, + "SqlMachineOverviewFciRole": { + "type": "string", + "description": "sql fci role ", + "enum": [ + "Unknown", + "NotApplicable", + "ActiveNode", + "PossibleOwnerNode" + ], + "x-ms-enum": { + "name": "SqlMachineOverviewFciRole", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "NotApplicable", + "value": "NotApplicable", + "description": "NotApplicable value." + }, + { + "name": "ActiveNode", + "value": "ActiveNode", + "description": "ActiveNode value." + }, + { + "name": "PossibleOwnerNode", + "value": "PossibleOwnerNode", + "description": "PossibleOwnerNode value." + } + ] + } + }, + "SqlMetadataDiscoveryPipe": { + "type": "string", + "description": "SQL metadata discovery pipe", + "enum": [ + "Unknown", + "VMware", + "PowerShell", + "SSH", + "CIM", + "Other" + ], + "x-ms-enum": { + "name": "SqlMetadataDiscoveryPipe", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "VMware", + "value": "VMware", + "description": "VMware value." + }, + { + "name": "PowerShell", + "value": "PowerShell", + "description": "PowerShell value." + }, + { + "name": "SSH", + "value": "SSH", + "description": "SSH value." + }, + { + "name": "CIM", + "value": "CIM", + "description": "CIM value." + }, + { + "name": "Other", + "value": "Other", + "description": "Other value." + } + ] + } + }, + "SqlRunAsAccount": { + "type": "object", + "description": "A runasaccount resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RunAsAccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlRunAsAccountListResult": { + "type": "object", + "description": "The response of a SqlRunAsAccount list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlRunAsAccount items on this page", + "items": { + "$ref": "#/definitions/SqlRunAsAccount" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlServerApplication": { + "type": "object", + "description": "SQLServer in the guest virtual machine.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets Name of the SQLServer.", + "readOnly": true + }, + "edition": { + "type": "string", + "description": "Gets or sets Edition of the SQLServer.", + "readOnly": true + }, + "servicePack": { + "type": "string", + "description": "Gets or sets ServicePack of the SQLServer.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the SQLServer.", + "readOnly": true + }, + "clustered": { + "type": "string", + "description": "Gets or sets Clustered of the SQLServer.", + "readOnly": true + }, + "clusterName": { + "type": "string", + "description": "Gets or sets ClusterName of the SQLServer.", + "readOnly": true + }, + "dnsHostName": { + "type": "string", + "description": "Gets or sets the DNS host name of SQLServer.", + "readOnly": true + }, + "port": { + "type": "string", + "description": "Gets or sets the port of the SQLServer.", + "readOnly": true + }, + "commaSeparatedIps": { + "type": "string", + "description": "Gets or sets the comma separated IPs of the SQLServer.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets the status.", + "readOnly": true + }, + "isNamedPipeEnabled": { + "type": "boolean", + "description": "Gets or sets the value which reflects if Named Pipe is enabled or not.", + "readOnly": true + }, + "isTcpIpEnabled": { + "type": "boolean", + "description": "Gets or sets the value which reflects if Named Pipe is enabled or not.", + "readOnly": true + }, + "namedPipeName": { + "type": "string", + "description": "Gets the status.", + "readOnly": true + } + } + }, + "SqlServerProperties": { + "type": "object", + "description": "Class for SQL Server properties.", + "properties": { + "machineOverviewList": { + "type": "array", + "description": "Gets the Machine Overview properties of all machines on which the SQL server is deployed.", + "items": { + "$ref": "#/definitions/SqlMachineOverview" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfAgDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of databases part of availability group on this SQL instance." + }, + "sqlFciProperties": { + "$ref": "#/definitions/SqlFciProperties", + "description": "Gets or sets the FCI properties if the instance is an FCI instance. This would be populated if IsClustered is true." + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "version": { + "type": "string", + "description": "Gets or sets the SQL server version." + }, + "numberOfUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets or sets total number of users databases." + }, + "sumOfUserDatabasesSizeInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets total size of all user databases." + }, + "tempDbSizeInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets size of temp database." + }, + "maxServerMemoryInUseInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets maximum server memory in use." + }, + "visibleOnlineCoreCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the SQL server number of cores that have visible online status." + }, + "numOfLogins": { + "type": "integer", + "format": "int32", + "description": "Gets or sets number of logins." + }, + "physicalCpuCount": { + "type": "number", + "format": "float", + "description": "Gets or sets physical CPU count." + }, + "logicalCpuCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets logical CPU count." + }, + "engineEdition": { + "type": "string", + "description": "Gets or sets the SQL server engine edition." + }, + "edition": { + "type": "string", + "description": "Gets or sets the SQL server edition." + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether High Availability is enabled or not." + }, + "isClustered": { + "type": "boolean", + "description": "Gets or sets a value indicating whether failover cluster is configured or not." + }, + "hyperthreadRatio": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Hyper thread ratio." + }, + "sqlStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the SQL start time." + }, + "machineArmIds": { + "type": "array", + "description": "Gets the list of machine ARM Ids on which the SQL server is deployed.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the SQL server." + }, + "hydratedRunAsAccountId": { + "type": "string", + "description": "Gets or sets the hydrated run as account ID of the SQL server." + }, + "hostName": { + "type": "string", + "description": "Gets or sets hostname." + }, + "sqlServerName": { + "type": "string", + "description": "Gets or sets the SQL server instance name." + }, + "portNumber": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Preferred Port Number." + }, + "errors": { + "type": "array", + "description": "Gets the errors.", + "items": { + "$ref": "#/definitions/Errors" + }, + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the resource.", + "additionalProperties": { + "$ref": "#/definitions/Azure.ResourceManager.Object" + } + }, + "isDeleted": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the entity is deleted." + }, + "createdTimestamp": { + "type": "string", + "description": "Gets or sets the marking machine creation." + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets or sets the timestamp marking last updated on the machine." + }, + "status": { + "$ref": "#/definitions/SqlServerStatus", + "description": "Gets or sets the powered on status." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "SqlServerStatus": { + "type": "string", + "description": "sql server status", + "enum": [ + "Unknown", + "ContinuePending", + "Paused", + "PausePending", + "Running", + "StartPending", + "Stopped", + "StopPending" + ], + "x-ms-enum": { + "name": "SqlServerStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "ContinuePending", + "value": "ContinuePending", + "description": "ContinuePending value." + }, + { + "name": "Paused", + "value": "Paused", + "description": "Paused value." + }, + { + "name": "PausePending", + "value": "PausePending", + "description": "PausePending value." + }, + { + "name": "Running", + "value": "Running", + "description": "Running value." + }, + { + "name": "StartPending", + "value": "StartPending", + "description": "StartPending value." + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Stopped value." + }, + { + "name": "StopPending", + "value": "StopPending", + "description": "StopPending value." + } + ] + } + }, + "SqlServerV2": { + "type": "object", + "description": "Class representing the web model of SQL Server.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlServerV2ListResult": { + "type": "object", + "description": "The response of a SqlServerV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlServerV2 items on this page", + "items": { + "$ref": "#/definitions/SqlServerV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlServerV2Update": { + "type": "object", + "description": "The type used for update operations of the SqlServerV2.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerV2UpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "SqlServerV2UpdateProperties": { + "type": "object", + "description": "The updatable properties of the SqlServerV2.", + "properties": { + "numberOfAgDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of databases part of availability group on this SQL instance." + }, + "sqlFciProperties": { + "$ref": "#/definitions/SqlFciProperties", + "description": "Gets or sets the FCI properties if the instance is an FCI instance. This would be populated if IsClustered is true." + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "version": { + "type": "string", + "description": "Gets or sets the SQL server version." + }, + "numberOfUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets or sets total number of users databases." + }, + "sumOfUserDatabasesSizeInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets total size of all user databases." + }, + "tempDbSizeInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets size of temp database." + }, + "maxServerMemoryInUseInMb": { + "type": "number", + "format": "float", + "description": "Gets or sets maximum server memory in use." + }, + "visibleOnlineCoreCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the SQL server number of cores that have visible online status." + }, + "numOfLogins": { + "type": "integer", + "format": "int32", + "description": "Gets or sets number of logins." + }, + "physicalCpuCount": { + "type": "number", + "format": "float", + "description": "Gets or sets physical CPU count." + }, + "logicalCpuCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets logical CPU count." + }, + "engineEdition": { + "type": "string", + "description": "Gets or sets the SQL server engine edition." + }, + "edition": { + "type": "string", + "description": "Gets or sets the SQL server edition." + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether High Availability is enabled or not." + }, + "isClustered": { + "type": "boolean", + "description": "Gets or sets a value indicating whether failover cluster is configured or not." + }, + "hyperthreadRatio": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Hyper thread ratio." + }, + "sqlStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the SQL start time." + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the SQL server." + }, + "hydratedRunAsAccountId": { + "type": "string", + "description": "Gets or sets the hydrated run as account ID of the SQL server." + }, + "hostName": { + "type": "string", + "description": "Gets or sets hostname." + }, + "sqlServerName": { + "type": "string", + "description": "Gets or sets the SQL server instance name." + }, + "portNumber": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Preferred Port Number." + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the resource.", + "additionalProperties": { + "$ref": "#/definitions/Azure.ResourceManager.Object" + } + }, + "isDeleted": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the entity is deleted." + }, + "createdTimestamp": { + "type": "string", + "description": "Gets or sets the marking machine creation." + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets or sets the timestamp marking last updated on the machine." + }, + "status": { + "$ref": "#/definitions/SqlServerStatus", + "description": "Gets or sets the powered on status." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "SqlSite": { + "type": "object", + "description": "SQL site web model.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlSiteProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlSiteListResult": { + "type": "object", + "description": "The response of a SqlSite list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlSite items on this page", + "items": { + "$ref": "#/definitions/SqlSite" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlSiteProperties": { + "type": "object", + "description": "Class for SQL site properties.", + "properties": { + "siteAppliancePropertiesCollection": { + "type": "array", + "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", + "items": { + "$ref": "#/definitions/SiteApplianceProperties" + }, + "x-ms-identifiers": [] + }, + "discoveryScenario": { + "$ref": "#/definitions/SqlSitePropertiesDiscoveryScenario", + "description": "Gets or sets the discovery scenario." + }, + "serviceEndpoint": { + "type": "string", + "description": "Gets the service endpoint.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "SqlSitePropertiesDiscoveryScenario": { + "type": "string", + "description": "SqlSiteProperties DiscoveryScenario", + "enum": [ + "Migrate", + "DR" + ], + "x-ms-enum": { + "name": "SqlSitePropertiesDiscoveryScenario", + "modelAsString": true, + "values": [ + { + "name": "Migrate", + "value": "Migrate", + "description": "Migrate value." + }, + { + "name": "DR", + "value": "DR", + "description": "DR value." + } + ] + } + }, + "SqlSiteRefreshBody": { + "type": "object", + "description": "SQL site refresh.", + "properties": { + "applianceName": { + "type": "string", + "description": "Gets or sets the appliance name of the agent in the site." + } + } + }, + "SqlSiteUpdate": { + "type": "object", + "description": "The type used for update operations of the SqlSite.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlSiteUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "SqlSiteUpdateProperties": { + "type": "object", + "description": "The updatable properties of the SqlSite.", + "properties": { + "siteAppliancePropertiesCollection": { + "type": "array", + "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", + "items": { + "$ref": "#/definitions/SiteApplianceProperties" + }, + "x-ms-identifiers": [] + }, + "discoveryScenario": { + "$ref": "#/definitions/SqlSitePropertiesDiscoveryScenario", + "description": "Gets or sets the discovery scenario." + } + } + }, + "SqlSiteUsage": { + "type": "object", + "description": "SQL site usage.", + "properties": { + "serverCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of servers discovered in the site." + }, + "databaseCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of databases discovered in the site." + }, + "runAsAccountCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of run as accounts in the site." + } + } + }, + "StaticDiscovery": { + "type": "object", + "description": "Contains data related static data discovery scope.", + "properties": { + "discoveryScopeStatus": { + "$ref": "#/definitions/StaticDiscoveryScopeStatus", + "description": "Gets discovery scope status.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets errors for discovery scope.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "hydratedRunAsAccountId": { + "type": "string", + "description": "Gets the run as account ID with which feature worked successfully.\n \nIt is discovered by the agent from the list of credentials.", + "readOnly": true + } + } + }, + "StaticDiscoveryScopeStatus": { + "type": "string", + "description": "Static DiscoveryScopeStatus", + "enum": [ + "DiscoverySucceededAtleastOnce", + "DiscoveryFailed", + "RunAsAccountNotAssociated", + "DiscoveryNotStarted", + "DiscoveryInProgress", + "Disabled", + "DiscoveryPartiallySucceded", + "DiscoverySucceeded" + ], + "x-ms-enum": { + "name": "StaticDiscoveryScopeStatus", + "modelAsString": true, + "values": [ + { + "name": "DiscoverySucceededAtleastOnce", + "value": "DiscoverySucceededAtleastOnce", + "description": "DiscoverySucceededAtleastOnce value." + }, + { + "name": "DiscoveryFailed", + "value": "DiscoveryFailed", + "description": "DiscoveryFailed value." + }, + { + "name": "RunAsAccountNotAssociated", + "value": "RunAsAccountNotAssociated", + "description": "RunAsAccountNotAssociated value." + }, + { + "name": "DiscoveryNotStarted", + "value": "DiscoveryNotStarted", + "description": "DiscoveryNotStarted value." + }, + { + "name": "DiscoveryInProgress", + "value": "DiscoveryInProgress", + "description": "DiscoveryInProgress value." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled value." + }, + { + "name": "DiscoveryPartiallySucceded", + "value": "DiscoveryPartiallySucceded", + "description": "DiscoveryPartiallySucceded value." + }, + { + "name": "DiscoverySucceeded", + "value": "DiscoverySucceeded", + "description": "DiscoverySucceeded value." + } + ] + } + }, + "SystemCenter": { + "type": "object", + "description": "SystemCenter in the guest virtual machine.", + "properties": { + "productName": { + "type": "string", + "description": "Gets or sets ProductName of the SystemCenter.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets or sets Status of the SystemCenter.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the SystemCenter.", + "readOnly": true + } + } + }, + "TagsMachineInput": { + "type": "object", + "description": "Machine class.", + "properties": { + "machineId": { + "type": "string", + "description": "Gets or sets the ARM id of the machine." + }, + "tags": { + "type": "object", + "description": "run as AccountId", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TomcatEngineUnit": { + "type": "object", + "description": "Tomcat engine data.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the engine." + }, + "hosts": { + "type": "array", + "description": "Gets or sets the hosts defined for the engine.", + "items": { + "$ref": "#/definitions/TomcatHostUnit" + }, + "x-ms-identifiers": [] + } + } + }, + "TomcatHostUnit": { + "type": "object", + "description": "Tomcat host data.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the host." + }, + "appBasePath": { + "type": "string", + "description": "Gets or sets the app base path for the host." + }, + "appBase": { + "type": "string", + "description": "Gets or sets the app base value configured for the host." + } + } + }, + "TomcatServiceUnit": { + "type": "object", + "description": "Tomcat service data.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the service." + }, + "connectors": { + "type": "array", + "description": "Gets or sets the connectors defined for the service component.", + "items": { + "$ref": "#/definitions/ConnectorUnit" + }, + "x-ms-identifiers": [] + }, + "engine": { + "$ref": "#/definitions/TomcatEngineUnit", + "description": "Gets or sets the engine defined for the service component." + } + } + }, + "TomcatWebApplicationProperties": { + "type": "object", + "description": "Class for web application properties.", + "properties": { + "hasDatabaseDependency": { + "type": "boolean", + "description": "Boolean value having true if the application has database dependency.", + "readOnly": true + }, + "isExternalLoggingConfigured": { + "type": "boolean", + "description": "Boolean value having true if the application has file dependency.", + "readOnly": true + }, + "webServerId": { + "type": "string", + "description": "Gets the web server id.", + "readOnly": true + }, + "webServerName": { + "type": "string", + "description": "Gets the web server name.", + "readOnly": true + }, + "machineArmIds": { + "type": "array", + "description": "Gets the list of machine ARM Ids on which the web application is deployed.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "virtualPath": { + "type": "string", + "description": "Gets the virtual path of the application.", + "readOnly": true + }, + "physicalPath": { + "type": "string", + "description": "Gets the physical path of the application.", + "readOnly": true + }, + "bindings": { + "type": "array", + "description": "Gets the front end bindings for the application.", + "items": { + "$ref": "#/definitions/FrontEndBinding" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "frameworks": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/WebApplicationFramework" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "configurations": { + "type": "array", + "description": "Gets the configuration.", + "items": { + "$ref": "#/definitions/WebApplicationConfigurationUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "directories": { + "type": "array", + "description": "Gets the directories.", + "items": { + "$ref": "#/definitions/WebApplicationDirectoryUnit" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets tags that can be used with ODATA.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "staticFolders": { + "type": "array", + "description": "Static folders.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "machineDisplayName": { + "type": "string", + "description": "Machine display name", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Gets the server type.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hasErrors": { + "type": "boolean", + "description": "Gets a value indicating whether the WebApp has errors or not.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "TomcatWebApplications": { + "type": "object", + "description": "Web application REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/TomcatWebApplicationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "TomcatWebApplicationsListResult": { + "type": "object", + "description": "The response of a TomcatWebApplications list operation.", + "properties": { + "value": { + "type": "array", + "description": "The TomcatWebApplications items on this page", + "items": { + "$ref": "#/definitions/TomcatWebApplications" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "TomcatWebApplicationsUpdate": { + "type": "object", + "description": "The type used for update operations of the TomcatWebApplications." + }, + "TomcatWebServerProperties": { + "type": "object", + "description": "Class for web server properties.", + "properties": { + "services": { + "type": "array", + "description": "Gets or sets the services defined in the server.", + "items": { + "$ref": "#/definitions/TomcatServiceUnit" + }, + "x-ms-identifiers": [] + }, + "catalinaHome": { + "type": "string", + "description": "Catalina Home", + "readOnly": true + }, + "jvmVersion": { + "type": "string", + "description": "Version of the JVM", + "readOnly": true + }, + "sessionPersistenceMechanism": { + "type": "string", + "description": "session persistence mechanism", + "readOnly": true + }, + "isClusteringPresent": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted." + }, + "isMemoryRealmPresent": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "isSessionTrackingPresent": { + "type": "boolean", + "description": "is session tracking present", + "readOnly": true + }, + "isAccessLogValvePresent": { + "type": "boolean", + "description": "is access log valve present", + "readOnly": true + }, + "maxMemoryUsageInMb": { + "type": "string", + "description": "max memory usage in mb", + "readOnly": true + }, + "configurationLocation": { + "type": "string", + "description": "Gets the configuration location.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets the configuration location.", + "readOnly": true + }, + "machineIds": { + "type": "array", + "description": "Gets the list of machines.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "webApplications": { + "type": "array", + "description": "Gets the list of web applications.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name.", + "readOnly": true + }, + "serverFqdn": { + "type": "string", + "description": "Gets the server FQDN.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets the run as account id.", + "readOnly": true + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Gets the server type.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hasErrors": { + "type": "boolean", + "description": "Gets a value indicating whether the WebApp has errors or not.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "TomcatWebServers": { + "type": "object", + "description": "Web server REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/TomcatWebServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "TomcatWebServersListResult": { + "type": "object", + "description": "The response of a TomcatWebServers list operation.", + "properties": { + "value": { + "type": "array", + "description": "The TomcatWebServers items on this page", + "items": { + "$ref": "#/definitions/TomcatWebServers" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "UpdateMachineDepMapStatus": { + "type": "object", + "description": "Defines class that represents input to enable or disable DMP on machine\n \n for cosmos entity operation.", + "properties": { + "machines": { + "type": "array", + "description": "Gets or sets the machine collection.", + "items": { + "$ref": "#/definitions/DependencyMapMachineInput" + }, + "x-ms-identifiers": [] + } + } + }, + "UpdateMachineRunAsAccount": { + "type": "object", + "description": "Defines class that represents input to update RunAsAccount on machine\n \n for cosmos entity operation.", + "properties": { + "machines": { + "type": "array", + "description": "Gets or sets the machine collection.", + "items": { + "$ref": "#/definitions/RunAsAccountMachineInput" + }, + "x-ms-identifiers": [] + } + } + }, + "UpdateMachineTags": { + "type": "object", + "description": "Defines class that represents input to update Tags on machine\n \n for cosmos entity operation.", + "properties": { + "machines": { + "type": "array", + "description": "Gets or sets the machine collection.", + "items": { + "$ref": "#/definitions/TagsMachineInput" + }, + "x-ms-identifiers": [] + } + } + }, + "V20180501PreviewVmwareRunAsAccount": { + "type": "object", + "description": "Run as account REST Resource.", + "properties": { + "id": { + "type": "string", + "description": "Relative URL to get this run as account.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Gets the Name of the Run as account.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Handled by resource provider. Type =\nMicrosoft.OffAzure/VMWareSites/RunAsAccounts.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/RunAsAccountProperties", + "description": "Gets nested properties.", + "readOnly": true + } + } + }, + "V20180501PreviewVmwareRunAsAccountVmwareRunAsAccountCollection": { + "type": "object", + "description": "Collection of VMware run as accounts.", + "properties": { + "value": { + "type": "array", + "description": "Gets the list of run as accounts.", + "items": { + "$ref": "#/definitions/V20180501PreviewVmwareRunAsAccount" + } + }, + "nextLink": { + "type": "string", + "description": "Gets the value of next link.", + "readOnly": true + } + } + }, + "VMwareDatastoreType": { + "type": "string", + "description": "vmware datastore type", + "enum": [ + "Unknown", + "CIFS", + "NFS", + "NFS41", + "PMEM", + "VFFS", + "VMFS", + "VSAN", + "VVOL" + ], + "x-ms-enum": { + "name": "VMwareDatastoreType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Cifs", + "value": "CIFS", + "description": "CIFS value." + }, + { + "name": "NFS", + "value": "NFS", + "description": "NFS value." + }, + { + "name": "NFS41", + "value": "NFS41", + "description": "NFS41 value." + }, + { + "name": "Pmem", + "value": "PMEM", + "description": "PMEM value." + }, + { + "name": "Vffs", + "value": "VFFS", + "description": "VFFS value." + }, + { + "name": "Vmfs", + "value": "VMFS", + "description": "VMFS value." + }, + { + "name": "Vsan", + "value": "VSAN", + "description": "VSAN value." + }, + { + "name": "Vvol", + "value": "VVOL", + "description": "VVOL value." + } + ] + } + }, + "Vcenter": { + "type": "object", + "description": "A vcenter resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/VcenterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VcenterListResult": { + "type": "object", + "description": "The response of a Vcenter list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Vcenter items on this page", + "items": { + "$ref": "#/definitions/Vcenter" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VcenterProperties": { + "type": "object", + "description": "The properties of VMwareSiteResource", + "properties": { + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the vCenter." + }, + "errors": { + "type": "array", + "description": "Gets the errors.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking vCenter creation.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the vCenter.", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN/IPAddress of the vCenter." + }, + "port": { + "type": "string", + "description": "Gets or sets the port of the vCenter." + }, + "version": { + "type": "string", + "description": "Gets the version of the vCenter.", + "readOnly": true + }, + "perfStatisticsLevel": { + "type": "string", + "description": "Gets the performance statistics enabled on the vCenter.", + "readOnly": true + }, + "instanceUuid": { + "type": "string", + "description": "Gets the instance UUID of the vCenter.", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Gets or sets the friendly name of the vCenter." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "Versions": { + "type": "string", + "description": "service api versions", + "enum": [ + "2018-05-01-preview", + "2019-05-01-preview", + "2020-01-01", + "2020-01-01-preview", + "2020-02-01", + "2020-07-07", + "2020-07-10", + "2020-08-01-preview", + "2020-11-11-preview", + "2022-10-27", + "2023-06-06" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2018_05_01_preview", + "value": "2018-05-01-preview", + "description": "Api version 2018-05-01-preview." + }, + { + "name": "v2019_05_01_preview", + "value": "2019-05-01-preview", + "description": "Api version 2019-05-01-preview." + }, + { + "name": "v2020_01_01", + "value": "2020-01-01", + "description": "Api version 2020-01-01." + }, + { + "name": "v2020_01_01_preview", + "value": "2020-01-01-preview", + "description": "Api version 2020-01-01-preview." + }, + { + "name": "v2020_02_01", + "value": "2020-02-01", + "description": "Api version 2020-02-01." + }, + { + "name": "v2020_07_07", + "value": "2020-07-07", + "description": "Api version 2020-07-07." + }, + { + "name": "v2020_07_10", + "value": "2020-07-10", + "description": "Api version 2020-07-10." + }, + { + "name": "v2020_08_01_preview", + "value": "2020-08-01-preview", + "description": "Api version 2020-08-01-preview." + }, + { + "name": "v2020_11_11_preview", + "value": "2020-11-11-preview", + "description": "Api version 2020-11-11-preview." + }, + { + "name": "v2022_10_27", + "value": "2022-10-27", + "description": "Api version 2022-10-27." + }, + { + "name": "v2023_06_06", + "value": "2023-06-06", + "description": "Api version 2023-06-06." + } + ] + } + }, + "VmwareDatastore": { + "type": "object", + "description": "Second level object returned as part of VMware host REST resource.", + "properties": { + "uuid": { + "type": "string", + "description": "Data store UUID.", + "readOnly": true + }, + "capacityInGb": { + "type": "number", + "format": "float", + "description": "Capacity of the data store.", + "readOnly": true + }, + "freeSpaceInGb": { + "type": "number", + "format": "float", + "description": "Free space of the data store.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/VMwareDatastoreType", + "description": "Type of the data store.", + "readOnly": true + }, + "symbolicName": { + "type": "string", + "description": "Symbolic name of the data store.", + "readOnly": true + } + } + }, + "VmwareDisk": { + "type": "object", + "description": "Second level object returned as part of Machine REST resource.", + "properties": { + "uuid": { + "type": "string", + "description": "Disk UUID.", + "readOnly": true + }, + "label": { + "type": "string", + "description": "Label of the disk.", + "readOnly": true + }, + "diskProvisioningPolicy": { + "type": "string", + "description": "The provisioning policy of the disk.\n It is Thin or Thick or\nUnknown for the VMWare VMDK.", + "readOnly": true + }, + "diskScrubbingPolicy": { + "type": "string", + "description": "The scrubbing policy of disks which can be\n eagerly zeroed or\nlazily zeroed.", + "readOnly": true + }, + "diskMode": { + "type": "string", + "description": "Disk mode property used for identifying independent disks.", + "readOnly": true + }, + "controllerType": { + "type": "string", + "description": "Gets or sets a value indicating the type of the disk controller type.", + "readOnly": true + }, + "maxSizeInBytes": { + "type": "integer", + "format": "int64", + "description": "Gets or sets Bytes allocated for the disk." + }, + "name": { + "type": "string", + "description": "Gets or sets Name of the disk." + }, + "diskType": { + "type": "string", + "description": "Gets or sets Type of the disk." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Gets or sets LUN of the disk." + }, + "path": { + "type": "string", + "description": "Gets or sets Path of the disk." + } + } + }, + "VmwareHost": { + "type": "object", + "description": "A host resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/VmwareHostProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VmwareHostListResult": { + "type": "object", + "description": "The response of a VmwareHost list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareHost items on this page", + "items": { + "$ref": "#/definitions/VmwareHost" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VmwareHostProperties": { + "type": "object", + "description": "Class for host properties.", + "properties": { + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking VMware host creation.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the VMware host.", + "readOnly": true + }, + "datastores": { + "type": "array", + "description": "Gets the data stores.", + "items": { + "$ref": "#/definitions/VmwareDatastore" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "vcenterId": { + "type": "string", + "description": "Gets the V-center ID.", + "readOnly": true + }, + "uuid": { + "type": "string", + "description": "Gets the instance UUID of the vmware host.", + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "VmwareJob": { + "type": "object", + "description": "A host resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VmwareJobListResult": { + "type": "object", + "description": "The response of a VmwareJob list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareJob items on this page", + "items": { + "$ref": "#/definitions/VmwareJob" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VmwareMachineProperties": { + "type": "object", + "description": "Class for machine properties.", + "properties": { + "vCenterFqdn": { + "type": "string", + "description": "VCenter FQDN/IPAddress.", + "readOnly": true + }, + "vCenterId": { + "type": "string", + "description": "VCenter ARM ID.", + "readOnly": true + }, + "instanceUuid": { + "type": "string", + "description": "On-premise Instance UUID of the machine.", + "readOnly": true + }, + "dataCenterScope": { + "type": "string", + "description": "Scope of the data center.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "User description of the machine.", + "readOnly": true + }, + "disks": { + "type": "array", + "description": "Disks attached to the machine.", + "items": { + "$ref": "#/definitions/VmwareDisk" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "hostInMaintenanceMode": { + "type": "boolean", + "description": "Indicates whether the host is in maintenance mode.", + "readOnly": true + }, + "hostName": { + "type": "string", + "description": "The host name.", + "readOnly": true + }, + "hostPowerState": { + "type": "string", + "description": "The host power state.", + "readOnly": true + }, + "hostVersion": { + "type": "string", + "description": "The host version.", + "readOnly": true + }, + "networkAdapters": { + "type": "array", + "description": "Network adapters attached to the machine.", + "items": { + "$ref": "#/definitions/VmwareNetworkAdapter" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "vMwareToolsStatus": { + "type": "string", + "description": "VMware tools status.", + "readOnly": true + }, + "vMwareToolsVersion": { + "type": "string", + "description": "VMware tools version.", + "readOnly": true + }, + "changeTrackingSupported": { + "type": "boolean", + "description": "Value indicating whether change tracking is supported.", + "readOnly": true + }, + "changeTrackingEnabled": { + "type": "boolean", + "description": "Value indicating whether change tracking is enabled.", + "readOnly": true + }, + "maxSnapshots": { + "type": "integer", + "format": "int32", + "description": "Maximum number of snapshots for the VM. Default value is -1.", + "readOnly": true + }, + "diskEnabledUuid": { + "type": "string", + "description": "Gets or sets whether Disk Enabled UUID is set or not.", + "readOnly": true + }, + "numberOfSnapshots": { + "type": "integer", + "format": "int32", + "description": "Number of snapshots for the VM. Default value is -1.", + "readOnly": true + }, + "altGuestName": { + "type": "string", + "description": "Gets or sets the machine alt guest name.", + "readOnly": true + }, + "powerStatus": { + "type": "string", + "description": "Gets the Machine power status.", + "readOnly": true + }, + "vmFqdn": { + "type": "string", + "description": "Gets the VM FQDN.", + "readOnly": true + }, + "vmConfigurationFileLocation": { + "type": "string", + "description": "Gets the Root location of the VM configuration file.", + "readOnly": true + }, + "firmware": { + "type": "string", + "description": "Gets or sets the firmware." + }, + "guestOsDetails": { + "$ref": "#/definitions/GuestOsDetails", + "description": "Operating System Details extracted from the guest\n bu executing\nscript inside the guest VM.", + "readOnly": true + }, + "numberOfApplications": { + "type": "integer", + "format": "int32", + "description": "Number of applications installed in the guest VM.", + "readOnly": true + }, + "guestDetailsDiscoveryTimestamp": { + "type": "string", + "format": "date-time", + "description": "The last time at which the Guest Details was discovered\n or the\nerror while discovering guest details based discovery\n of the\nmachine.", + "readOnly": true + }, + "isGuestDetailsDiscoveryInProgress": { + "type": "boolean", + "description": "Whether Refresh Fabric Layout Guest Details has been completed once.\n \n Portal will show discovery in progress, if this value is true.", + "readOnly": true + }, + "dependencyMapping": { + "type": "string", + "description": "Gets or sets if dependency mapping feature is enabled or not\n for\nthe VM.", + "readOnly": true + }, + "dependencyMappingStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets when dependency mapping collection is last started.", + "readOnly": true + }, + "dependencyMappingEndTime": { + "type": "string", + "description": "Gets or sets when dependency mapping collection was last disabled.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets or sets the run as account ID of the machine." + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Errors for machine.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applicationDiscovery": { + "$ref": "#/definitions/ApplicationDiscovery", + "description": "Gets the data related to application discovery.", + "readOnly": true + }, + "dependencyMapDiscovery": { + "$ref": "#/definitions/DependencyMapDiscovery", + "description": "Gets the data related to dependency map discovery.", + "readOnly": true + }, + "staticDiscovery": { + "$ref": "#/definitions/StaticDiscovery", + "description": "Gets the data related to static discovery.", + "readOnly": true + }, + "sqlDiscovery": { + "$ref": "#/definitions/SqlDiscovery", + "description": "Gets the data related to SQL discovery.", + "readOnly": true + }, + "webAppDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to Web application discovery.", + "readOnly": true + }, + "oracleDiscovery": { + "$ref": "#/definitions/OracleDiscovery", + "description": "Gets the data related to Oracle discovery.", + "readOnly": true + }, + "springBootDiscovery": { + "$ref": "#/definitions/SpringBootDiscovery", + "description": "Gets the data related to SpringBoot discovery.", + "readOnly": true + }, + "iisDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to iis discovery.", + "readOnly": true + }, + "tomcatDiscovery": { + "$ref": "#/definitions/WebAppDiscovery", + "description": "Gets the data related to tomcat discovery.", + "readOnly": true + }, + "appsAndRoles": { + "$ref": "#/definitions/AppsAndRoles", + "description": "Apps And Roles of the Server.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "product support status." + }, + "numberOfProcessorCore": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." + }, + "allocatedMemoryInMb": { + "type": "number", + "format": "double", + "description": "Gets or sets the allocated Memory in MB." + }, + "operatingSystemDetails": { + "$ref": "#/definitions/OperatingSystem", + "description": "Gets or sets the Operating System Details installed on the machine." + }, + "biosSerialNumber": { + "type": "string", + "description": "Gets or sets the Machine BIOS serial number." + }, + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID." + }, + "displayName": { + "type": "string", + "description": "Gets the Display name of the machine.", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Value indicating whether VM is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the marking machine creation.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets or sets tags on the VMware machine.", + "additionalProperties": { + "type": "string" + } + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last updated on the machine.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "VmwareMachineSoftwareInventory": { + "type": "object", + "description": "An software inventory resource belonging to a machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineSoftwareInventoryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VmwareMachineSoftwareInventoryListResult": { + "type": "object", + "description": "The response of a VmwareMachineSoftwareInventory list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareMachineSoftwareInventory items on this page", + "items": { + "$ref": "#/definitions/VmwareMachineSoftwareInventory" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VmwareNetworkAdapter": { + "type": "object", + "description": "Second level object represented in responses as part of Machine REST resource.", + "properties": { + "label": { + "type": "string", + "description": "Label of the NIC.", + "readOnly": true + }, + "adapterType": { + "type": "string", + "description": "Gets or sets the adapter type.", + "readOnly": true + }, + "nicId": { + "type": "string", + "description": "Gets or sets the NIC Id." + }, + "macAddress": { + "type": "string", + "description": "Gets or sets Mac address of the NIC." + }, + "ipAddressList": { + "type": "array", + "description": "Gets IP addresses for the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "networkName": { + "type": "string", + "description": "Gets or sets Network Name." + }, + "ipAddressType": { + "type": "string", + "description": "Gets or sets Type of the IP address." + } + } + }, + "VmwareRunAsAccountResource": { + "type": "object", + "description": "A runasaccount resource belonging to a site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RunAsAccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VmwareRunAsAccountResourceListResult": { + "type": "object", + "description": "The response of a VmwareRunAsAccountResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareRunAsAccountResource items on this page", + "items": { + "$ref": "#/definitions/VmwareRunAsAccountResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VmwareSite": { + "type": "object", + "description": "A VmwareSite", + "properties": { + "properties": { + "$ref": "#/definitions/SitesProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "VmwareSiteListResult": { + "type": "object", + "description": "The response of a VmwareSite list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareSite items on this page", + "items": { + "$ref": "#/definitions/VmwareSite" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VmwareSiteUpdate": { + "type": "object", + "description": "The type used for update operations of the VmwareSite.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/VmwareSiteUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "VmwareSiteUpdateProperties": { + "type": "object", + "description": "The updatable properties of the VmwareSite.", + "properties": { + "servicePrincipalIdentityDetails": { + "$ref": "#/definitions/SiteSpnProperties", + "description": "Gets or sets the service principal identity details used by agent for\ncommunication\n to the service." + }, + "agentDetails": { + "$ref": "#/definitions/SiteAgentProperties", + "description": "Gets or sets the on-premises agent details." + }, + "applianceName": { + "type": "string", + "description": "Gets or sets the Appliance Name." + }, + "discoverySolutionId": { + "type": "string", + "description": "Gets or sets the ARM ID of migration hub solution for SDS." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "VmwareSiteUsage": { + "type": "object", + "description": "VMware site usage.", + "properties": { + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of machines discovered in the site." + }, + "runAsAccountCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of run as accounts in the site." + }, + "vCenterCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of vCenters part of the site." + } + } + }, + "WebAppDiscovery": { + "type": "object", + "description": "Data related to a machine's WebApps discovery.", + "properties": { + "totalWebServerCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets number of successfully discovered web servers.." + }, + "totalWebApplicationCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets number of successfully discovered web applications." + }, + "discoveryScopeStatus": { + "$ref": "#/definitions/DiscoveryScopeStatus", + "description": "Gets or sets status of partner discovery." + } + } + }, + "WebAppExtendedMachine": { + "type": "object", + "description": "Web app extended machine REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppExtendedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppExtendedMachineListResult": { + "type": "object", + "description": "The response of a WebAppExtendedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppExtendedMachine items on this page", + "items": { + "$ref": "#/definitions/WebAppExtendedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppExtendedMachineProperties": { + "type": "object", + "description": "Class for web extended machine properties.", + "properties": { + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "hostName": { + "type": "string", + "description": "Gets the hydrated host name.", + "readOnly": true + }, + "machineDisplayName": { + "type": "string", + "description": "Gets the Name of the extended machine.", + "readOnly": true + }, + "machineId": { + "type": "string", + "description": "Gets the machine ARM id.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets the run as account ID of the machine used for web app discovery.", + "readOnly": true + }, + "hydratedRunAsAccountId": { + "type": "string", + "description": "Gets the agent hydrated run as account.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "WebAppProperties": { + "type": "object", + "description": "Class representing web app properties web model.", + "properties": { + "webAppArmId": { + "type": "string", + "description": "Gets or sets the arm id of the web app." + }, + "tags": { + "type": "object", + "description": "Gets or sets Tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WebAppPropertiesCollection": { + "type": "object", + "description": "Collection of web app properties.", + "properties": { + "webApps": { + "type": "array", + "description": "Gets or sets the list of web app properties.", + "items": { + "$ref": "#/definitions/WebAppProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "WebAppRunAsAccount": { + "type": "object", + "description": "Run as account REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RunAsAccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppRunAsAccountListResult": { + "type": "object", + "description": "The response of a WebAppRunAsAccount list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppRunAsAccount items on this page", + "items": { + "$ref": "#/definitions/WebAppRunAsAccount" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppSite": { + "type": "object", + "description": "WebApp site web model.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppSiteProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppSiteListResult": { + "type": "object", + "description": "The response of a WebAppSite list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppSite items on this page", + "items": { + "$ref": "#/definitions/WebAppSite" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppSiteProperties": { + "type": "object", + "description": "Class for Web app site properties.", + "properties": { + "siteAppliancePropertiesCollection": { + "type": "array", + "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", + "items": { + "$ref": "#/definitions/SiteApplianceProperties" + }, + "x-ms-identifiers": [] + }, + "discoveryScenario": { + "$ref": "#/definitions/WebAppSitePropertiesDiscoveryScenario", + "description": "Gets or sets the discovery scenario." + }, + "serviceEndpoint": { + "type": "string", + "description": "Gets the service endpoint.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "WebAppSitePropertiesDiscoveryScenario": { + "type": "string", + "description": "Discovery Scenario", + "enum": [ + "Migrate", + "DR" + ], + "x-ms-enum": { + "name": "WebAppSitePropertiesDiscoveryScenario", + "modelAsString": true, + "values": [ + { + "name": "Migrate", + "value": "Migrate", + "description": "Migrate value." + }, + { + "name": "DR", + "value": "DR", + "description": "DR value." + } + ] + } + }, + "WebAppSiteUpdate": { + "type": "object", + "description": "The type used for update operations of the WebAppSite.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppSiteUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "WebAppSiteUpdateProperties": { + "type": "object", + "description": "The updatable properties of the WebAppSite.", + "properties": { + "siteAppliancePropertiesCollection": { + "type": "array", + "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", + "items": { + "$ref": "#/definitions/SiteApplianceProperties" + }, + "x-ms-identifiers": [] + }, + "discoveryScenario": { + "$ref": "#/definitions/WebAppSitePropertiesDiscoveryScenario", + "description": "Gets or sets the discovery scenario." + } + } + }, + "WebAppSiteUsage": { + "type": "object", + "description": "Web app site usage.", + "properties": { + "webServerCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of web servers discovered in the site." + }, + "webApplicationCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of web applications discovered in the site." + }, + "runAsAccountCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of run as accounts in the site." + } + } + }, + "WebApplication": { + "type": "object", + "description": "Web application REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebApplicationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "WebApplicationAppsAndRolesModel": { + "type": "object", + "description": "WebApplication in the guest virtual machine.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets Name of the WebApplication.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Gets or sets Status of the WebApplication.", + "readOnly": true + }, + "platform": { + "type": "string", + "description": "Gets or sets Platform of the WebApplication.", + "readOnly": true + }, + "groupName": { + "type": "string", + "description": "Gets or sets GroupName of the WebApplication.", + "readOnly": true + }, + "webServer": { + "type": "string", + "description": "Gets or sets WebServer of the WebApplication.", + "readOnly": true + }, + "applicationPool": { + "type": "string", + "description": "Gets or sets ApplicationPool of the WebApplication.", + "readOnly": true + } + } + }, + "WebApplicationConfigurationUnit": { + "type": "object", + "description": "Web Application configuration unit.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the configuration name." + }, + "filePath": { + "type": "string", + "description": "Gets or sets the configuration file path." + }, + "localFilePath": { + "type": "string", + "description": "Gets or sets the configuration local file path." + }, + "targetFilePath": { + "type": "string", + "description": "Gets or sets the configuration target file path." + }, + "section": { + "type": "string", + "description": "Gets or sets the configuration section in the file." + }, + "type": { + "type": "string", + "description": "Gets or sets the configuration type." + }, + "isDeploymentTimeEditable": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the configuration is edited or not by\nthe user." + }, + "identifier": { + "type": "string", + "description": "Gets or sets the identifier for the configuration." + } + } + }, + "WebApplicationDirectoryUnit": { + "type": "object", + "description": "Web Application directory unit.", + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the unique id corresponding to the application directory." + }, + "isEditable": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the directory object is editable.\n \n True when the directory is added as an optional directory, false when\ndiscovery is done\n manually." + }, + "sourcePaths": { + "type": "array", + "description": "Gets or sets the paths of the directory on the source machine.", + "items": { + "type": "string" + } + }, + "localScratchPath": { + "type": "string", + "description": "Gets or sets the local scratch path at which the directories has been copied." + }, + "mountPath": { + "type": "string", + "description": "Gets or sets the mount path of the application directory." + }, + "sourceSize": { + "type": "string", + "description": "Gets or sets the size of the directory on the source machine." + } + } + }, + "WebApplicationFramework": { + "type": "object", + "description": "Framework specific data for a web application.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets Name of the framework." + }, + "version": { + "type": "string", + "description": "Gets or sets Version of the framework." + } + } + }, + "WebApplicationListResult": { + "type": "object", + "description": "The response of a WebApplication list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebApplication items on this page", + "items": { + "$ref": "#/definitions/WebApplication" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebApplicationProperties": { + "type": "object", + "description": "Class for web application properties.", + "properties": { + "webServerId": { + "type": "string", + "description": "Gets the web server id.", + "readOnly": true + }, + "webServerName": { + "type": "string", + "description": "Gets the web server name.", + "readOnly": true + }, + "machineArmIds": { + "type": "array", + "description": "Gets the list of machine ARM Ids on which the SQL server is deployed.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "virtualPath": { + "type": "string", + "description": "Gets the virtual path of the application.", + "readOnly": true + }, + "physicalPath": { + "type": "string", + "description": "Gets the physical path of the application.", + "readOnly": true + }, + "bindings": { + "type": "array", + "description": "Gets the front end bindings for the application.", + "items": { + "$ref": "#/definitions/FrontEndBinding" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "frameworks": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/WebApplicationFramework" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "configurations": { + "type": "array", + "description": "Gets the configuration.", + "items": { + "$ref": "#/definitions/WebApplicationConfigurationUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "directories": { + "type": "array", + "description": "Gets the directories.", + "items": { + "$ref": "#/definitions/WebApplicationDirectoryUnit" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "displayName": { + "type": "string", + "description": "Gets the display name.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Gets tags that can be used with ODATA.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "staticFolders": { + "type": "array", + "description": "Static folders.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "machineDisplayName": { + "type": "string", + "description": "Machine display name", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Gets the server type.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hasErrors": { + "type": "boolean", + "description": "Gets a value indicating whether the WebApp has errors or not.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "WebRoleImportDisk": { + "type": "object", + "description": "Class representing the imported machine web model.", + "properties": { + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Disk read throughput.", + "readOnly": true + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Disk write throughput.", + "readOnly": true + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Disk read IOPS.", + "readOnly": true + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Disk write IOPS.", + "readOnly": true + }, + "maxSizeInBytes": { + "type": "integer", + "format": "int64", + "description": "Gets or sets Bytes allocated for the disk." + }, + "name": { + "type": "string", + "description": "Gets or sets Name of the disk." + }, + "diskType": { + "type": "string", + "description": "Gets or sets Type of the disk." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Gets or sets LUN of the disk." + }, + "path": { + "type": "string", + "description": "Gets or sets Path of the disk." + } + } + }, + "WebRoleOperatingSystem": { + "type": "object", + "description": "Second level object returned as part of Machine REST resource.", + "properties": { + "osType": { + "type": "string", + "description": "Gets or sets the type of the operating system." + }, + "osName": { + "type": "string", + "description": "Gets or sets the Name of the operating system." + }, + "osVersion": { + "type": "string", + "description": "Gets or sets the Version of the operating system." + }, + "osArchitecture": { + "type": "string", + "description": "Gets or sets the Architecture of the operating system." + } + } + }, + "WebServer": { + "type": "object", + "description": "Web application REST Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebServerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "WebServerListResult": { + "type": "object", + "description": "The response of a WebServer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebServer items on this page", + "items": { + "$ref": "#/definitions/WebServer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebServerProperties": { + "type": "object", + "description": "Class for web server properties.", + "properties": { + "configurationLocation": { + "type": "string", + "description": "Gets the configuration location.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Gets the configuration location.", + "readOnly": true + }, + "machineIds": { + "type": "array", + "description": "Gets the list of machines.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "webApplications": { + "type": "array", + "description": "Gets the list of web applications.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name.", + "readOnly": true + }, + "serverFqdn": { + "type": "string", + "description": "Gets the server FQDN.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets the run as account id.", + "readOnly": true + }, + "isDeleted": { + "type": "boolean", + "description": "Gets a value indicating whether application is deleted.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "description": "Gets the timestamp marking creation of the entity.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "description": "Gets the timestamp marking last update operation.", + "readOnly": true + }, + "serverType": { + "type": "string", + "description": "Gets the server type.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Gets the Error details.", + "items": { + "$ref": "#/definitions/HealthErrorDetails" + }, + "readOnly": true + }, + "applianceNames": { + "type": "array", + "description": "Gets the appliance names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hasErrors": { + "type": "boolean", + "description": "Gets a value indicating whether the WebApp has errors or not.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "provisioning state enum", + "readOnly": true + } + } + }, + "esuStatus": { + "type": "string", + "description": "esu Status", + "enum": [ + "Unknown", + "Active", + "InActive" + ], + "x-ms-enum": { + "name": "esuStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Active", + "value": "Active", + "description": "Active value." + }, + { + "name": "InActive", + "value": "InActive", + "description": "InActive value." + } + ] + } + }, + "esuYear": { + "type": "string", + "description": "esu year", + "enum": [ + "Unknown", + "FirstYear", + "SecondYear", + "ThirdYear", + "UpgradeYear" + ], + "x-ms-enum": { + "name": "esuYear", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "FirstYear", + "value": "FirstYear", + "description": "FirstYear value." + }, + { + "name": "SecondYear", + "value": "SecondYear", + "description": "SecondYear value." + }, + { + "name": "ThirdYear", + "value": "ThirdYear", + "description": "ThirdYear value." + }, + { + "name": "UpgradeYear", + "value": "UpgradeYear", + "description": "UpgradeYear value." + } + ] + } + }, + "supportStatus": { + "type": "string", + "description": "support status", + "enum": [ + "Unknown", + "Mainstream", + "Extended" + ], + "x-ms-enum": { + "name": "supportStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown value." + }, + { + "name": "Mainstream", + "value": "Mainstream", + "description": "Mainstream value." + }, + { + "name": "Extended", + "value": "Extended", + "description": "Extended value." + } + ] + } + } + }, + "parameters": {} +} diff --git a/swagger-specs/migrate/resource-manager/api-set.json b/swagger-specs/migrate/resource-manager/api-set.json index 3f816e0c8..96a0fb20b 100644 --- a/swagger-specs/migrate/resource-manager/api-set.json +++ b/swagger-specs/migrate/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Migrate/AssessmentProjects/stable/2023-03-15/migrate.json"], "name": "package-migrate-2023-03"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.OffAzure/stable/2023-06-06/migrate.json"], "name": "package-2023-06"} \ No newline at end of file diff --git a/swagger-specs/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json b/swagger-specs/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json new file mode 100644 index 000000000..8926b7ebe --- /dev/null +++ b/swagger-specs/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json @@ -0,0 +1,1731 @@ +{ + "swagger": "2.0", + "info": { + "title": "MongoClusterManagementClient", + "version": "2024-03-01-preview", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure Cosmos DB for MongoDB vCore resources including clusters and firewall rules.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "MongoClusters" + }, + { + "name": "FirewallRules" + }, + { + "name": "PrivateEndpointConnections" + }, + { + "name": "PrivateLinks" + } + ], + "paths": { + "/providers/Microsoft.DocumentDB/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/checkMongoClusterNameAvailability": { + "post": { + "operationId": "MongoClusters_CheckNameAvailability", + "tags": [ + "MongoClusters" + ], + "description": "Check if mongo cluster name is available for use.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "body", + "in": "body", + "description": "The CheckAvailability request", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Checks and confirms the Mongo Cluster name is availability for use.": { + "$ref": "./examples/MongoClusters_NameAvailability.json" + }, + "Checks and returns that the Mongo Cluster name is already in-use.": { + "$ref": "./examples/MongoClusters_NameAvailability_AlreadyExists.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/mongoClusters": { + "get": { + "operationId": "MongoClusters_List", + "tags": [ + "MongoClusters" + ], + "description": "List all the mongo clusters in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MongoClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists the Mongo Cluster resources in a subscription.": { + "$ref": "./examples/MongoClusters_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters": { + "get": { + "operationId": "MongoClusters_ListByResourceGroup", + "tags": [ + "MongoClusters" + ], + "description": "List all the mongo clusters in a given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MongoClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists the Mongo Cluster resources in a resource group.": { + "$ref": "./examples/MongoClusters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}": { + "get": { + "operationId": "MongoClusters_Get", + "tags": [ + "MongoClusters" + ], + "description": "Gets information about a mongo cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MongoCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_Get.json" + } + } + }, + "put": { + "operationId": "MongoClusters_CreateOrUpdate", + "tags": [ + "MongoClusters" + ], + "description": "Create or update a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/MongoCluster" + } + } + ], + "responses": { + "200": { + "description": "Resource 'MongoCluster' update operation succeeded", + "schema": { + "$ref": "#/definitions/MongoCluster" + } + }, + "201": { + "description": "Resource 'MongoCluster' create operation succeeded", + "schema": { + "$ref": "#/definitions/MongoCluster" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates a Mongo Cluster resource from a point in time restore": { + "$ref": "./examples/MongoClusters_CreatePITR.json" + }, + "Creates a new Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "MongoClusters_Update", + "tags": [ + "MongoClusters" + ], + "description": "Updates an existing mongo cluster. The request body can contain one to many of the properties present in the normal mongo cluster definition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/MongoClusterUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MongoCluster" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Disables public network access on a Mongo Cluster resource with a private endpoint connection.": { + "$ref": "./examples/MongoClusters_PatchPrivateNetworkAccess.json" + }, + "Updates a Mongo Cluster resource": { + "$ref": "./examples/MongoClusters_Update.json" + }, + "Updates the disk size on a Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_PatchDiskSize.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "MongoClusters_Delete", + "tags": [ + "MongoClusters" + ], + "description": "Deletes a mongo cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deletes a Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules": { + "get": { + "operationId": "FirewallRules_ListByMongoCluster", + "tags": [ + "FirewallRules" + ], + "description": "List all the firewall rules in a given mongo cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List the firewall rules on a Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_FirewallRuleList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName}": { + "get": { + "operationId": "FirewallRules_Get", + "tags": [ + "FirewallRules" + ], + "description": "Gets information about a mongo cluster firewall rule.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + { + "name": "firewallRuleName", + "in": "path", + "description": "The name of the mongo cluster firewall rule.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[a-zA-Z0-9][-_.a-zA-Z0-9]*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a firewall rule on a Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_FirewallRuleGet.json" + } + } + }, + "put": { + "operationId": "FirewallRules_CreateOrUpdate", + "tags": [ + "FirewallRules" + ], + "description": "Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + { + "name": "firewallRuleName", + "in": "path", + "description": "The name of the mongo cluster firewall rule.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[a-zA-Z0-9][-_.a-zA-Z0-9]*" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallRule" + } + } + ], + "responses": { + "200": { + "description": "Resource 'FirewallRule' update operation succeeded", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "201": { + "description": "Resource 'FirewallRule' create operation succeeded", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates a firewall rule on a Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_FirewallRuleCreate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "FirewallRules_Delete", + "tags": [ + "FirewallRules" + ], + "description": "Deletes a mongo cluster firewall rule.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + { + "name": "firewallRuleName", + "in": "path", + "description": "The name of the mongo cluster firewall rule.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[a-zA-Z0-9][-_.a-zA-Z0-9]*" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deletes a firewall rule on a Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_FirewallRuleDelete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/listConnectionStrings": { + "post": { + "operationId": "MongoClusters_ListConnectionStrings", + "tags": [ + "MongoClusters" + ], + "description": "List mongo cluster connection strings. This includes the default connection string using SCRAM-SHA-256, as well as other connection strings supported by the cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ListConnectionStringsResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List the available connection strings for the Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_ListConnectionStrings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnections_ListByMongoCluster", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "List existing private connections", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists the private endpoint connection resources on a Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_PrivateEndpointConnectionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnections_Get", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Get a specific private connection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a private endpoint connection on a Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_PrivateEndpointConnectionGet.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnections_Create", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Create a Private endpoint connection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnectionResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "201": { + "description": "Resource 'PrivateEndpointConnectionResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Approves a private endpoint connection on a Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_PrivateEndpointConnectionPut.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "PrivateEndpointConnections_Delete", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Delete the private endpoint connection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a private endpoint connection on a Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_PrivateEndpointConnectionDelete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinks_ListByMongoCluster", + "tags": [ + "PrivateLinks" + ], + "description": "list private links on the given resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "mongoClusterName", + "in": "path", + "description": "The name of the mongo cluster.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 40, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists the private link resources available on a Mongo Cluster resource.": { + "$ref": "./examples/MongoClusters_PrivateLinkResourceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Azure.ResourceManager.PrivateEndpointConnection": { + "type": "object", + "description": "The private endpoint connection resource", + "properties": { + "properties": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", + "description": "The private endpoint connection properties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ConnectionString": { + "type": "object", + "description": "Connection string for the mongo cluster", + "properties": { + "connectionString": { + "type": "string", + "description": "Value of the connection string", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the connection string", + "readOnly": true + } + } + }, + "CreateMode": { + "type": "string", + "description": "The mode that the Mongo Cluster is created with.", + "enum": [ + "Default", + "PointInTimeRestore" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Create a new mongo cluster." + }, + { + "name": "PointInTimeRestore", + "value": "PointInTimeRestore", + "description": "Create a mongo cluster from a restore point-in-time." + } + ] + } + }, + "FirewallRule": { + "type": "object", + "description": "Represents a mongo cluster firewall rule.", + "properties": { + "properties": { + "$ref": "#/definitions/FirewallRuleProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "FirewallRuleListResult": { + "type": "object", + "description": "The response of a FirewallRule list operation.", + "properties": { + "value": { + "type": "array", + "description": "The FirewallRule items on this page", + "items": { + "$ref": "#/definitions/FirewallRule" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "FirewallRuleProperties": { + "type": "object", + "description": "The properties of a mongo cluster firewall rule.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the firewall rule.", + "readOnly": true + }, + "startIpAddress": { + "type": "string", + "description": "The start IP address of the mongo cluster firewall rule. Must be IPv4 format.", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" + }, + "endIpAddress": { + "type": "string", + "description": "The end IP address of the mongo cluster firewall rule. Must be IPv4 format.", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" + } + }, + "required": [ + "startIpAddress", + "endIpAddress" + ] + }, + "ListConnectionStringsResult": { + "type": "object", + "description": "The connection strings for the given mongo cluster.", + "properties": { + "connectionStrings": { + "type": "array", + "description": "An array that contains the connection strings for a mongo cluster.", + "items": { + "$ref": "#/definitions/ConnectionString" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "MongoCluster": { + "type": "object", + "description": "Represents a mongo cluster resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MongoClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "MongoClusterListResult": { + "type": "object", + "description": "The response of a MongoCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MongoCluster items on this page", + "items": { + "$ref": "#/definitions/MongoCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MongoClusterProperties": { + "type": "object", + "description": "The properties of a mongo cluster.", + "properties": { + "createMode": { + "$ref": "#/definitions/CreateMode", + "description": "The mode to create a mongo cluster.", + "x-ms-mutability": [ + "create" + ] + }, + "restoreParameters": { + "$ref": "#/definitions/MongoClusterRestoreParameters", + "description": "The parameters to create a point-in-time restore mongo cluster.", + "x-ms-mutability": [ + "create" + ] + }, + "administratorLogin": { + "type": "string", + "description": "The administrator's login for the mongo cluster.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "administratorLoginPassword": { + "type": "string", + "format": "password", + "description": "The password of the administrator login.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "serverVersion": { + "type": "string", + "description": "The Mongo DB server version. Defaults to the latest available version if not specified." + }, + "connectionString": { + "type": "string", + "description": "The default mongo connection string for the cluster.", + "readOnly": true + }, + "earliestRestoreTime": { + "type": "string", + "description": "Earliest restore timestamp in UTC ISO8601 format.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the mongo cluster.", + "readOnly": true + }, + "clusterStatus": { + "$ref": "#/definitions/MongoClusterStatus", + "description": "The status of the mongo cluster.", + "readOnly": true + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Whether or not public endpoint access is allowed for this mongo cluster." + }, + "nodeGroupSpecs": { + "type": "array", + "description": "The list of node group specs in the cluster.", + "items": { + "$ref": "#/definitions/NodeGroupSpec" + }, + "x-ms-identifiers": [] + }, + "privateEndpointConnections": { + "type": "array", + "description": "List of private endpoint connections.", + "items": { + "$ref": "#/definitions/Azure.ResourceManager.PrivateEndpointConnection" + }, + "readOnly": true + } + } + }, + "MongoClusterRestoreParameters": { + "type": "object", + "description": "Parameters used for restore operations", + "properties": { + "pointInTimeUTC": { + "type": "string", + "format": "date-time", + "description": "UTC point in time to restore a mongo cluster" + }, + "sourceResourceId": { + "type": "string", + "description": "Resource ID to locate the source cluster to restore" + } + } + }, + "MongoClusterStatus": { + "type": "string", + "description": "The status of the Mongo cluster resource.", + "enum": [ + "Ready", + "Provisioning", + "Updating", + "Starting", + "Stopping", + "Stopped", + "Dropping" + ], + "x-ms-enum": { + "name": "MongoClusterStatus", + "modelAsString": true, + "values": [ + { + "name": "Ready", + "value": "Ready", + "description": "The mongo cluster resource is ready for use." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "The mongo cluster resource is being provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The mongo cluster resource is being updated." + }, + { + "name": "Starting", + "value": "Starting", + "description": "The mongo cluster resource is being started." + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "The mongo cluster resource is being stopped." + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "The mongo cluster resource is stopped." + }, + { + "name": "Dropping", + "value": "Dropping", + "description": "The mongo cluster resource is being dropped." + } + ] + } + }, + "MongoClusterUpdate": { + "type": "object", + "description": "The type used for update operations of the MongoCluster.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/MongoClusterUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "MongoClusterUpdateProperties": { + "type": "object", + "description": "The updatable properties of the MongoCluster.", + "properties": { + "administratorLogin": { + "type": "string", + "description": "The administrator's login for the mongo cluster.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "administratorLoginPassword": { + "type": "string", + "format": "password", + "description": "The password of the administrator login.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "serverVersion": { + "type": "string", + "description": "The Mongo DB server version. Defaults to the latest available version if not specified." + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Whether or not public endpoint access is allowed for this mongo cluster." + }, + "nodeGroupSpecs": { + "type": "array", + "description": "The list of node group specs in the cluster.", + "items": { + "$ref": "#/definitions/NodeGroupSpec" + }, + "x-ms-identifiers": [] + } + } + }, + "NodeGroupProperties": { + "type": "object", + "description": "The properties of the node group on a cluster.", + "properties": { + "sku": { + "type": "string", + "description": "The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'." + }, + "diskSizeGB": { + "type": "integer", + "format": "int64", + "description": "The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024." + }, + "enableHa": { + "type": "boolean", + "description": "Whether high availability is enabled on the node group." + } + } + }, + "NodeGroupSpec": { + "type": "object", + "description": "Specification for a node group.", + "properties": { + "sku": { + "type": "string", + "description": "The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'." + }, + "diskSizeGB": { + "type": "integer", + "format": "int64", + "description": "The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024." + }, + "enableHa": { + "type": "boolean", + "description": "Whether high availability is enabled on the node group." + }, + "kind": { + "$ref": "#/definitions/NodeKind", + "description": "The node type deployed in the node group." + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the node group." + } + } + }, + "NodeKind": { + "type": "string", + "description": "The kind of the node on the cluster.", + "enum": [ + "Shard" + ], + "x-ms-enum": { + "name": "NodeKind", + "modelAsString": true, + "values": [ + { + "name": "Shard", + "value": "Shard", + "description": "The node is a shard kind." + } + ] + } + }, + "PrivateEndpointConnectionResource": { + "type": "object", + "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionResourceListResult": { + "type": "object", + "description": "The response of a PrivateEndpointConnectionResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnectionResource items on this page", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateLinkResource": { + "type": "object", + "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "The response of a PrivateLinkResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateLinkResource items on this page", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of the last accepted operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress", + "Updating", + "Dropping" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "An operation is in-progress on the resource." + }, + { + "name": "Updating", + "value": "Updating", + "description": "An update operation is in-progress on the resource." + }, + { + "name": "Dropping", + "value": "Dropping", + "description": "A drop operation is in-progress on the resource." + } + ] + }, + "readOnly": true + }, + "PublicNetworkAccess": { + "type": "string", + "description": "Whether or not public endpoint access is allowed for this Mongo cluster. Value is optional and default value is 'Enabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "If set, mongo cluster can be accessed through private and public methods." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "If set, the private endpoints are the exclusive access method." + } + ] + } + } + }, + "parameters": {} +} diff --git a/swagger-specs/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/scenarios/basic.yaml b/swagger-specs/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/scenarios/basic.yaml new file mode 100644 index 000000000..29faed305 --- /dev/null +++ b/swagger-specs/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2024-03-01-preview/scenarios/basic.yaml @@ -0,0 +1,40 @@ +# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/documentation/api-scenario/references/v1.2/schema.json +scope: ResourceGroup +variables: + mongoClusterName: + type: string + prefix: mongoclu + administratorLoginPassword: + type: secureString + firewallRuleName: + type: string + prefix: firewall +scenarios: + - scenario: basic + description: Basic scenario for creating, reading and deleting a Mongo Cluster. + steps: + - step: MongoClusters_NameAvailability + exampleFile: ../examples/MongoClusters_NameAvailability.json + - step: MongoClusters_CreateOrUpdate + exampleFile: ../examples/MongoClusters_Create.json + requestUpdate: + - replace: /resource/properties/administratorLoginPassword + value: $(administratorLoginPassword) + - step: MongoClusters_ListByResourceGroup + exampleFile: ../examples/MongoClusters_ListByResourceGroup.json + - step: MongoClusters_Get + exampleFile: ../examples/MongoClusters_Get.json + - step: FirewallRules_CreateOrUpdate + exampleFile: ../examples/MongoClusters_FirewallRuleCreate.json + - step: FirewallRules_ListByMongoCluster + exampleFile: ../examples/MongoClusters_FirewallRuleList.json + - step: FirewallRules_Get + exampleFile: ../examples/MongoClusters_FirewallRuleGet.json + - step: MongoClusters_ListConnectionStrings + exampleFile: ../examples/MongoClusters_ListConnectionStrings.json + - step: MongoClusters_Update + exampleFile: ../examples/MongoClusters_PatchDiskSize.json + - step: FirewallRules_Delete + exampleFile: ../examples/MongoClusters_FirewallRuleDelete.json + - step: MongoClusters_Delete + exampleFile: ../examples/MongoClusters_Delete.json \ No newline at end of file diff --git a/swagger-specs/mongocluster/resource-manager/api-set.json b/swagger-specs/mongocluster/resource-manager/api-set.json new file mode 100644 index 000000000..85a74bc2d --- /dev/null +++ b/swagger-specs/mongocluster/resource-manager/api-set.json @@ -0,0 +1 @@ +{"addition_input_file_paths": [], "input_files": ["Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json"], "name": "package-2024-03-01-preview"} \ No newline at end of file diff --git a/swagger-specs/monitor/data-plane/Microsoft.Insights/stable/2024-02-01/metricBatch.json b/swagger-specs/monitor/data-plane/Microsoft.Insights/stable/2024-02-01/metricBatch.json new file mode 100644 index 000000000..da083b1c2 --- /dev/null +++ b/swagger-specs/monitor/data-plane/Microsoft.Insights/stable/2024-02-01/metricBatch.json @@ -0,0 +1,279 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Monitor Metric Batch", + "version": "2024-02-01" + }, + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/token", + "flow": "application", + "description": "Azure Active Directory OAuth2 Authentication", + "scopes": { + "https://metrics.monitor.azure.com/.default": "https://metrics.monitor.azure.com/.default" + } + } + }, + "security": [ + { + "AADToken": [ + "https://metrics.monitor.azure.com/.default" + ] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "endpoint", + "description": "The regional endpoint to use, for example https://eastus.metrics.monitor.azure.com. The region should match the region of the requested resources. For global resources, the region should be 'global'.", + "required": true, + "type": "string", + "in": "path", + "format": "url", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/metrics:getBatch": { + "post": { + "tags": [ + "Metrics" + ], + "operationId": "MetricsBatch_Batch", + "description": "Lists the metric values for multiple resources.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/StartTimeParameter" + }, + { + "$ref": "#/parameters/EndTimeParameter" + }, + { + "$ref": "#/parameters/IntervalParameter" + }, + { + "$ref": "#/parameters/MetricNamespaceParameter" + }, + { + "$ref": "#/parameters/MetricNamesParameter" + }, + { + "$ref": "../../../../common-types/v2/commonMonitoringTypes.json#/parameters/AggregationsParameter" + }, + { + "$ref": "../../../../common-types/v2/commonMonitoringTypes.json#/parameters/TopParameter" + }, + { + "$ref": "../../../../common-types/v2/commonMonitoringTypes.json#/parameters/OrderByParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "../../../../common-types/v2/commonMonitoringTypes.json#/parameters/RollUpByParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "batchRequest", + "in": "body", + "required": true, + "description": "Metrics batch body including the list of resource ids", + "schema": { + "$ref": "#/definitions/ResourceIdList" + } + } + ], + "responses": { + "200": { + "description": "The response to a metrics query.", + "schema": { + "$ref": "#/definitions/MetricResultsResponse" + } + }, + "default": { + "description": "Describes the format of Error response.", + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code for specific error that occurred." + } + }, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query Storage Metrics": { + "$ref": "./examples/MetricBatchExample.json" + }, + "Query Redis Metrics summary": { + "$ref": "./examples/MetricBatchExample2.json" + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "The subscription identifier for the resources in this batch.", + "x-ms-parameter-location": "method" + }, + "StartTimeParameter": { + "name": "starttime", + "in": "query", + "required": false, + "type": "string", + "description": "The start time of the query. It is a string in the format 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endtime parameter, then this parameter is required.\nIf only starttime is specified, then endtime defaults to the current time.\nIf no time interval is specified, the default is 1 hour.", + "x-ms-parameter-location": "method" + }, + "EndTimeParameter": { + "name": "endtime", + "in": "query", + "required": false, + "type": "string", + "description": "The end time of the query. It is a string in the format 'yyyy-MM-ddTHH:mm:ss.fffZ'.", + "x-ms-parameter-location": "method" + }, + "IntervalParameter": { + "name": "interval", + "in": "query", + "required": false, + "type": "string", + "default": "PT1M", + "description": "The interval (i.e. timegrain) of the query in ISO 8601 duration format. Defaults to PT1M. Special case for 'FULL' value that returns single datapoint for entire time span requested.\n*Examples: PT15M, PT1H, P1D, FULL*", + "x-ms-parameter-location": "method" + }, + "MetricNamespaceParameter": { + "name": "metricnamespace", + "in": "query", + "required": true, + "type": "string", + "description": "Metric namespace that contains the requested metric names.", + "x-ms-parameter-location": "method" + }, + "MetricNamesParameter": { + "name": "metricnames", + "in": "query", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "description": "The names of the metrics (comma separated) to retrieve.", + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "name": "filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter is used to reduce the set of metric data returned.
Example:
Metric contains metadata A, B and C.
- Return all time series of C where A = a1 and B = b1 or b2
**filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical or operator cannot separate two different metadata names.
- Return all time series where A = a1, B = b1 and C = c1:
**filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**
- Return all time series where A = a1
**filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’**.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + } + }, + "definitions": { + "ResourceIdList": { + "description": "The comma separated list of resource IDs to query metrics for.", + "type": "object", + "properties": { + "resourceids": { + "description": "The list of resource IDs to query metrics for.", + "type": "array", + "items": { + "type": "string", + "format": "arm-id" + } + } + }, + "example": { + "resourceids": [ + "/subscriptions/123456728-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1", + "/subscriptions/123456728-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2" + ] + } + }, + "MetricResultsResponse": { + "description": "The metrics result for a resource.", + "type": "object", + "properties": { + "values": { + "description": "The collection of metric data responses per resource, per metric.", + "type": "array", + "items": { + "type": "object", + "properties": { + "starttime": { + "type": "string", + "description": "The start time, in datetime format, for which the data was retrieved." + }, + "endtime": { + "type": "string", + "description": "The end time, in datetime format, for which the data was retrieved." + }, + "interval": { + "type": "string", + "description": "The interval (window size) for which the metric data was returned in ISO 8601 duration format with a special case for 'FULL' value that returns single datapoint for entire time span requested (*Examples: PT15M, PT1H, P1D, FULL*). \nThis may be adjusted and different from what was originally requested if AutoAdjustTimegrain=true is specified." + }, + "namespace": { + "type": "string", + "description": "The namespace of the metrics been queried" + }, + "resourceregion": { + "type": "string", + "description": "The region of the resource been queried for metrics." + }, + "resourceid": { + "type": "string", + "description": "The resource that has been queried for metrics." + }, + "value": { + "type": "array", + "items": { + "$ref": "../../../../common-types/v2/commonMonitoringTypes.json#/definitions/Metric" + }, + "description": "The value of the collection." + } + }, + "required": [ + "starttime", + "endtime", + "value" + ] + } + } + } + } + } +} diff --git a/swagger-specs/monitor/data-plane/api-set.json b/swagger-specs/monitor/data-plane/api-set.json index 1cc4dafdc..841f87b63 100644 --- a/swagger-specs/monitor/data-plane/api-set.json +++ b/swagger-specs/monitor/data-plane/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["preview/2018-09-01-preview/metricsCreate_API.json"], "name": "package-2018-09-preview"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.Insights/stable/2024-02-01/metricBatch.json"], "name": "package-2024-02"} \ No newline at end of file diff --git a/swagger-specs/monitor/data-plane/preview/2018-09-01-preview/metricsCreate_API.json b/swagger-specs/monitor/data-plane/preview/2018-09-01-preview/metricsCreate_API.json deleted file mode 100644 index 499c2dcdb..000000000 --- a/swagger-specs/monitor/data-plane/preview/2018-09-01-preview/metricsCreate_API.json +++ /dev/null @@ -1,258 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Metrics", - "version": "2018-09-01-preview", - "description": "A client for issuing REST requests to the Azure metrics service.", - "x-ms-code-generation-settings": { - "name": "AzureMetricsClient" - } - }, - "host": "monitoring.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json; odata=minimalmetadata" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProvider}/{resourceTypeName}/{resourceName}/metrics": { - "post": { - "tags": [ - "Metrics" - ], - "operationId": "Metrics_Create", - "description": "**Post the metric values for a resource**.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "header", - "name": "Content-Type", - "description": "Supports application/json and application/x-ndjson", - "required": true, - "type": "string" - }, - { - "in": "header", - "name": "Content-Length", - "description": "Content length of the payload", - "type": "integer", - "required": true, - "format": "int32" - }, - { - "in": "header", - "name": "Authorization", - "description": "Authorization token issue for issued for audience \"https:\\\\monitoring.azure.com\\\"", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "subscriptionId", - "description": "The azure subscription id", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "resourceGroupName", - "description": "The ARM resource group name", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "resourceProvider", - "description": "The ARM resource provider name", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "resourceTypeName", - "description": "The ARM resource type name", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "resourceName", - "description": "The ARM resource name", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "description": "The Azure metrics document json payload", - "required": true, - "schema": { - "$ref": "#/definitions/AzureMetricsDocument" - } - } - ], - "responses": { - "200": { - "description": "The azure metrics publish succeeded", - "schema": { - "$ref": "#/definitions/AzureMetricsResult" - } - }, - "default": { - "description": "An unexpected error from the server. See response object for the reason", - "schema": { - "$ref": "#/definitions/AzureMetricsResult" - } - } - }, - "x-ms-examples": { - "Post azure metrics for cows sold with related metadata as dimensions": { - "$ref": "./examples/AzureMetrics_IngestMetrics.json" - } - } - } - } - }, - "definitions": { - "AzureMetricsDocument": { - "type": "object", - "properties": { - "time": { - "description": "Gets or sets Time property (in ISO 8601 format)", - "type": "string" - }, - "data": { - "$ref": "#/definitions/AzureMetricsData" - } - }, - "required": [ - "time", - "data" - ] - }, - "AzureMetricsData": { - "type": "object", - "properties": { - "baseData": { - "$ref": "#/definitions/AzureMetricsBaseData" - } - }, - "required": [ - "baseData" - ] - }, - "AzureMetricsBaseData": { - "type": "object", - "properties": { - "metric": { - "description": "Gets or sets the Metric name", - "type": "string" - }, - "namespace": { - "description": "Gets or sets the Metric namespace", - "type": "string" - }, - "dimNames": { - "description": "Gets or sets the list of dimension names (optional)", - "type": "array", - "items": { - "type": "string" - } - }, - "series": { - "description": "Gets or sets the list of time series data for the metric (one per unique dimension combination)", - "type": "array", - "items": { - "$ref": "#/definitions/AzureTimeSeriesData" - } - } - }, - "required": [ - "metric", - "namespace", - "series" - ] - }, - "AzureTimeSeriesData": { - "type": "object", - "properties": { - "dimValues": { - "description": "Gets or sets dimension values", - "type": "array", - "items": { - "type": "string" - } - }, - "min": { - "format": "double", - "description": "Gets or sets Min value", - "type": "number" - }, - "max": { - "format": "double", - "description": "Gets or sets Max value", - "type": "number" - }, - "sum": { - "format": "double", - "description": "Gets or sets Sum value", - "type": "number" - }, - "count": { - "format": "int32", - "description": "Gets or sets Count value", - "type": "integer" - } - }, - "required": [ - "min", - "max", - "sum", - "count" - ] - }, - "AzureMetricsResult": { - "type": "object", - "properties": { - "statusCode": { - "format": "int32", - "description": "Http status code response ", - "type": "integer" - }, - "apiFailureResponse": { - "$ref": "#/definitions/ApiFailureResponse" - } - } - }, - "ApiFailureResponse": { - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/ApiError" - } - } - }, - "ApiError": { - "type": "object", - "properties": { - "code": { - "description": "Gets or sets the azure metrics error code", - "type": "string" - }, - "message": { - "description": "Gets or sets the azure metrics error message", - "type": "string" - } - } - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json deleted file mode 100644 index 1b999fa03..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json +++ /dev/null @@ -1,177 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "version": "2017-12-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": { - "/{resourceUri}/providers/microsoft.insights/metricNamespaces": { - "get": { - "tags": [ - "metricNamespaces" - ], - "operationId": "MetricNamespaces_List", - "description": "Lists the metric namespaces for the resource.", - "parameters": [ - { - "$ref": "#/parameters/ResourceUriParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/StartTimeParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get the list of metric namespaces", - "schema": { - "$ref": "#/definitions/MetricNamespaceCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Get Metric Namespaces without filter": { - "$ref": "./examples/GetMetricNamespaces.json" - } - } - } - } - }, - "definitions": { - "MetricNamespaceName": { - "properties": { - "metricNamespaceName": { - "type": "string", - "description": "The metric namespace name." - } - }, - "description": "The fully qualified metric namespace name." - }, - "NamespaceClassification": { - "type": "string", - "description": "Kind of namespace", - "enum": [ - "Platform", - "Custom", - "Qos" - ], - "x-ms-enum": { - "name": "NamespaceClassification", - "modelAsString": true - } - }, - "MetricNamespace": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the metric namespace." - }, - "type": { - "type": "string", - "description": "The type of the namespace." - }, - "name": { - "type": "string", - "description": "The escaped name of the namespace." - }, - "classification": { - "$ref": "#/definitions/NamespaceClassification", - "description": "Kind of namespace" - }, - "properties": { - "$ref": "#/definitions/MetricNamespaceName", - "description": "Properties which include the fully qualified namespace name." - } - }, - "description": "Metric namespace class specifies the metadata for a metric namespace." - }, - "MetricNamespaceCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricNamespace" - }, - "description": "The values for the metric namespaces." - } - }, - "required": [ - "value" - ], - "description": "Represents collection of metric namespaces." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - } - }, - "parameters": { - "ResourceUriParameter": { - "name": "resourceUri", - "in": "path", - "required": true, - "type": "string", - "description": "The identifier of the resource.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "StartTimeParameter": { - "name": "startTime", - "in": "query", - "required": false, - "type": "string", - "description": "The ISO 8601 conform Date start time from which to query for metric namespaces.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json deleted file mode 100644 index 68388244a..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json +++ /dev/null @@ -1,254 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "VM Insights Onboarding API", - "description": "API to manage VM Insights Onboarding", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2018-11-27-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": { - "/{resourceUri}/providers/Microsoft.Insights/vmInsightsOnboardingStatuses/default": { - "get": { - "tags": [ - "VM Insights Onboarding" - ], - "operationId": "VMInsights_GetOnboardingStatus", - "description": "Retrieves the VM Insights onboarding status for the specified resource or resource scope.", - "x-ms-examples": { - "Get status for a VM that has not yet reported data": { - "$ref": "./examples/getOnboardingStatusSingleVMUnknown.json" - }, - "Get status for a VM that is actively reporting data": { - "$ref": "./examples/getOnboardingStatusSingleVM.json" - }, - "Get status for a VM scale set that is actively reporting data": { - "$ref": "./examples/getOnboardingStatusVMScaleSet.json" - }, - "Get status for a resource group that has at least one VM that is actively reporting data": { - "$ref": "./examples/getOnboardingStatusResourceGroup.json" - }, - "Get status for a subscription that has at least one VM that is actively reporting data": { - "$ref": "./examples/getOnboardingStatusSubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "resourceUri", - "in": "path", - "required": true, - "type": "string", - "description": "The fully qualified Azure Resource manager identifier of the resource, or scope, whose status to retrieve.", - "x-ms-skip-url-encoding": true - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/VMInsightsOnboardingStatus" - } - }, - "default": { - "description": "An error occurred while processing the request. See the error.code parameter to identify the specific error.", - "schema": { - "$ref": "#/definitions/ResponseWithError" - } - } - } - } - } - }, - "definitions": { - "ProxyResource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Azure resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - } - }, - "x-ms-azure-resource": true, - "description": "An azure resource object" - }, - "ResponseWithError": { - "type": "object", - "description": "An error response from the API.", - "properties": { - "error": { - "$ref": "#/definitions/Error", - "description": "Error information." - } - }, - "required": [ - "error" - ] - }, - "Error": { - "type": "object", - "description": "Error details.", - "properties": { - "code": { - "type": "string", - "description": "Error code identifying the specific error." - }, - "message": { - "type": "string", - "description": "Error message in the caller's locale." - } - }, - "required": [ - "code" - ] - }, - "WorkspaceInfo": { - "type": "object", - "description": "Information about a Log Analytics Workspace.", - "properties": { - "id": { - "type": "string", - "description": "Azure Resource Manager identifier of the Log Analytics Workspace." - }, - "location": { - "type": "string", - "description": "Location of the Log Analytics workspace." - }, - "properties": { - "x-ms-client-flatten": true, - "type": "object", - "description": "Resource properties.", - "properties": { - "customerId": { - "type": "string", - "description": "Log Analytics workspace identifier." - } - }, - "required": [ - "customerId" - ] - } - }, - "required": [ - "id", - "location", - "properties" - ] - }, - "DataContainer": { - "type": "object", - "description": "Information about a container with data for a given resource.", - "properties": { - "workspace": { - "$ref": "#/definitions/WorkspaceInfo", - "description": "Log Analytics workspace information." - } - }, - "required": [ - "workspace" - ] - }, - "VMInsightsOnboardingStatus": { - "description": "VM Insights onboarding status for a resource.", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "type": "object", - "description": "Resource properties.", - "properties": { - "resourceId": { - "type": "string", - "description": "Azure Resource Manager identifier of the resource whose onboarding status is being represented." - }, - "onboardingStatus": { - "type": "string", - "enum": [ - "onboarded", - "notOnboarded", - "unknown" - ], - "x-ms-enum": { - "name": "OnboardingStatus", - "modelAsString": true - }, - "description": "The onboarding status for the resource. Note that, a higher level scope, e.g., resource group or subscription, is considered onboarded if at least one resource under it is onboarded." - }, - "dataStatus": { - "type": "string", - "enum": [ - "present", - "notPresent" - ], - "x-ms-enum": { - "name": "DataStatus", - "modelAsString": true - }, - "description": "The status of VM Insights data from the resource. When reported as `present` the data array will contain information about the data containers to which data for the specified resource is being routed." - }, - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/DataContainer" - }, - "x-ms-identifiers": [ - "/workspace/id" - ], - "description": "Containers that currently store VM Insights data for the specified resource." - } - }, - "required": [ - "resourceId", - "onboardingStatus", - "dataStatus" - ] - } - } - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/autoscale_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/autoscale_API.json deleted file mode 100644 index 9a37f6d3d..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/autoscale_API.json +++ /dev/null @@ -1,1083 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "version": "2021-05-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.Insights/autoscalesettings": { - "get": { - "description": "Lists the autoscale settings for a resource group", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_ListByResourceGroup", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "Successful request for a list of autoscale settings", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResourceCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List autoscale settings": { - "$ref": "./examples/listAutoscaleSetting.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}": { - "put": { - "description": "Creates or updates an autoscale setting.", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - }, - "description": "Parameters supplied to the operation." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "Successful request to create or update an autoscale setting", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - } - }, - "201": { - "description": "Created autoscale setting", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - } - } - }, - "x-ms-examples": { - "Create or update an autoscale setting": { - "$ref": "./examples/createOrUpdateAutoscaleSetting.json" - } - } - }, - "delete": { - "description": "Deletes and autoscale setting", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_Delete", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "Successful request to delete an autoscale setting" - }, - "204": { - "description": "No content: Successful request to delete an autoscale setting, but the response is intentionally empty" - } - }, - "x-ms-examples": { - "Delete an autoscale setting": { - "$ref": "./examples/deleteAutoscaleSetting.json" - } - } - }, - "get": { - "description": "Gets an autoscale setting", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "Successful request to get one autoscale setting", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - } - } - }, - "x-ms-examples": { - "Get an autoscale setting": { - "$ref": "./examples/getAutoscaleSetting.json" - } - } - }, - "patch": { - "description": "Updates an existing AutoscaleSettingsResource. To update other fields use the CreateOrUpdate method.", - "operationId": "AutoscaleSettings_Update", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "autoscaleSettingResource", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AutoscaleSettingResourcePatch" - }, - "description": "Parameters supplied to the operation." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "An existing autoscale setting resource was successfully updated.", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - } - } - }, - "x-ms-examples": { - "Patch an autoscale setting": { - "$ref": "./examples/patchAutoscaleSetting.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}/predictiveMetrics": { - "get": { - "tags": [ - "Metrics" - ], - "operationId": "PredictiveMetric_Get", - "description": "get predictive autoscale metric future data", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "$ref": "#/parameters/TimespanParameter" - }, - { - "$ref": "#/parameters/IntervalParameter" - }, - { - "$ref": "#/parameters/MetricNamespaceParameter" - }, - { - "$ref": "#/parameters/MetricNamesParameter" - }, - { - "$ref": "#/parameters/AggregationParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "Successful request to get the list of metric values.", - "schema": { - "$ref": "#/definitions/PredictiveResponse" - } - } - }, - "x-ms-examples": { - "Get Metric for data": { - "$ref": "./examples/GetPredictiveMetric.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/autoscalesettings": { - "get": { - "description": "Lists the autoscale settings for a subscription", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_ListBySubscription", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "Successful request for a list of autoscale settings", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResourceCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List autoscale settings by subs": { - "$ref": "./examples/listAutoscaleSettingBySubscription.json" - } - } - } - } - }, - "definitions": { - "ScaleCapacity": { - "type": "object", - "required": [ - "minimum", - "maximum", - "default" - ], - "properties": { - "minimum": { - "type": "string", - "description": "the minimum number of instances for the resource." - }, - "maximum": { - "type": "string", - "description": "the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription." - }, - "default": { - "type": "string", - "description": "the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default." - } - }, - "description": "The number of instances that can be used during this profile." - }, - "MetricTrigger": { - "type": "object", - "required": [ - "metricName", - "metricResourceUri", - "timeGrain", - "statistic", - "timeWindow", - "timeAggregation", - "operator", - "threshold" - ], - "properties": { - "metricName": { - "type": "string", - "description": "the name of the metric that defines what the rule monitors." - }, - "metricNamespace": { - "type": "string", - "description": "the namespace of the metric that defines what the rule monitors." - }, - "metricResourceUri": { - "type": "string", - "description": "the resource identifier of the resource the rule monitors." - }, - "metricResourceLocation": { - "type": "string", - "description": "the location of the resource the rule monitors." - }, - "timeGrain": { - "type": "string", - "format": "duration", - "description": "the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute." - }, - "statistic": { - "type": "string", - "description": "the metric statistic type. How the metrics from multiple instances are combined.", - "enum": [ - "Average", - "Min", - "Max", - "Sum", - "Count" - ], - "x-ms-enum": { - "name": "MetricStatisticType", - "modelAsString": false - } - }, - "timeWindow": { - "type": "string", - "format": "duration", - "description": "the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes." - }, - "timeAggregation": { - "type": "string", - "description": "time aggregation type. How the data that is collected should be combined over time. The default value is Average.", - "enum": [ - "Average", - "Minimum", - "Maximum", - "Total", - "Count", - "Last" - ], - "x-ms-enum": { - "name": "TimeAggregationType", - "modelAsString": false - } - }, - "operator": { - "type": "string", - "description": "the operator that is used to compare the metric data and the threshold.", - "enum": [ - "Equals", - "NotEquals", - "GreaterThan", - "GreaterThanOrEqual", - "LessThan", - "LessThanOrEqual" - ], - "x-ms-enum": { - "name": "ComparisonOperationType", - "modelAsString": false - } - }, - "threshold": { - "type": "number", - "format": "double", - "description": "the threshold of the metric that triggers the scale action." - }, - "dimensions": { - "type": "array", - "items": { - "$ref": "#/definitions/ScaleRuleMetricDimension" - }, - "description": "List of dimension conditions. For example: [{\"DimensionName\":\"AppName\",\"Operator\":\"Equals\",\"Values\":[\"App1\"]},{\"DimensionName\":\"Deployment\",\"Operator\":\"Equals\",\"Values\":[\"default\"]}]." - }, - "dividePerInstance": { - "type": "boolean", - "description": "a value indicating whether metric should divide per instance." - } - }, - "description": "The trigger that results in a scaling action." - }, - "ScaleAction": { - "type": "object", - "required": [ - "direction", - "type", - "cooldown" - ], - "properties": { - "direction": { - "type": "string", - "description": "the scale direction. Whether the scaling action increases or decreases the number of instances.", - "enum": [ - "None", - "Increase", - "Decrease" - ], - "x-ms-enum": { - "name": "ScaleDirection", - "modelAsString": false - } - }, - "type": { - "type": "string", - "description": "the type of action that should occur when the scale rule fires.", - "enum": [ - "ChangeCount", - "PercentChangeCount", - "ExactCount", - "ServiceAllowedNextValue" - ], - "x-ms-enum": { - "name": "ScaleType", - "modelAsString": false - } - }, - "value": { - "type": "string", - "description": "the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1.", - "default": "1" - }, - "cooldown": { - "type": "string", - "format": "duration", - "description": "the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format." - } - }, - "description": "The parameters for the scaling action." - }, - "ScaleRule": { - "type": "object", - "required": [ - "scaleAction", - "metricTrigger" - ], - "properties": { - "metricTrigger": { - "$ref": "#/definitions/MetricTrigger", - "description": "the trigger that results in a scaling action." - }, - "scaleAction": { - "$ref": "#/definitions/ScaleAction", - "description": "the parameters for the scaling action." - } - }, - "description": "A rule that provide the triggers and parameters for the scaling action." - }, - "TimeWindow": { - "type": "object", - "properties": { - "timeZone": { - "type": "string", - "description": "the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time" - }, - "start": { - "type": "string", - "format": "date-time", - "description": "the start time for the profile in ISO 8601 format." - }, - "end": { - "type": "string", - "format": "date-time", - "description": "the end time for the profile in ISO 8601 format." - } - }, - "required": [ - "start", - "end" - ], - "description": "A specific date-time for the profile." - }, - "RecurrentSchedule": { - "type": "object", - "required": [ - "timeZone", - "days", - "hours", - "minutes" - ], - "properties": { - "timeZone": { - "type": "string", - "description": "the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time" - }, - "days": { - "type": "array", - "items": { - "type": "string" - }, - "description": "the collection of days that the profile takes effect on. Possible values are Sunday through Saturday." - }, - "hours": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported)." - }, - "minutes": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "A collection of minutes at which the profile takes effect at." - } - }, - "description": "The scheduling constraints for when the profile begins." - }, - "Recurrence": { - "type": "object", - "required": [ - "frequency", - "schedule" - ], - "properties": { - "frequency": { - "type": "string", - "description": "the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set **schedule** to every day of the week. The frequency property specifies that the schedule is repeated weekly.", - "enum": [ - "None", - "Second", - "Minute", - "Hour", - "Day", - "Week", - "Month", - "Year" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "schedule": { - "$ref": "#/definitions/RecurrentSchedule", - "description": "the scheduling constraints for when the profile begins." - } - }, - "description": "The repeating times at which this profile begins. This element is not used if the FixedDate element is used." - }, - "AutoscaleProfile": { - "type": "object", - "required": [ - "rules", - "name", - "capacity" - ], - "properties": { - "name": { - "type": "string", - "description": "the name of the profile." - }, - "capacity": { - "$ref": "#/definitions/ScaleCapacity", - "description": "the number of instances that can be used during this profile." - }, - "rules": { - "type": "array", - "items": { - "$ref": "#/definitions/ScaleRule" - }, - "description": "the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified." - }, - "fixedDate": { - "$ref": "#/definitions/TimeWindow", - "description": "the specific date-time for the profile. This element is not used if the Recurrence element is used." - }, - "recurrence": { - "$ref": "#/definitions/Recurrence", - "description": "the repeating times at which this profile begins. This element is not used if the FixedDate element is used." - } - }, - "description": "Autoscale profile." - }, - "PredictiveAutoscalePolicy": { - "type": "object", - "required": [ - "scaleMode" - ], - "properties": { - "scaleMode": { - "type": "string", - "description": "the predictive autoscale mode", - "enum": [ - "Disabled", - "ForecastOnly", - "Enabled" - ], - "x-ms-enum": { - "name": "PredictiveAutoscalePolicyScaleMode", - "modelAsString": false - } - }, - "scaleLookAheadTime": { - "type": "string", - "format": "duration", - "description": "the amount of time to specify by which instances are launched in advance. It must be between 1 minute and 60 minutes in ISO 8601 format." - } - }, - "description": "The parameters for enabling predictive autoscale." - }, - "EmailNotification": { - "type": "object", - "properties": { - "sendToSubscriptionAdministrator": { - "type": "boolean", - "description": "a value indicating whether to send email to subscription administrator.", - "default": false - }, - "sendToSubscriptionCoAdministrators": { - "type": "boolean", - "description": "a value indicating whether to send email to subscription co-administrators.", - "default": false - }, - "customEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored." - } - }, - "description": "Email notification of an autoscale event." - }, - "WebhookNotification": { - "type": "object", - "properties": { - "serviceUri": { - "type": "string", - "description": "the service address to receive the notification." - }, - "properties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "a property bag of settings. This value can be empty." - } - }, - "description": "Webhook notification of an autoscale event." - }, - "AutoscaleNotification": { - "type": "object", - "required": [ - "operation" - ], - "properties": { - "operation": { - "type": "string", - "description": "the operation associated with the notification and its value must be \"scale\"", - "enum": [ - "Scale" - ], - "x-ms-enum": { - "name": "OperationType", - "modelAsString": false - } - }, - "email": { - "$ref": "#/definitions/EmailNotification", - "description": "the email notification." - }, - "webhooks": { - "type": "array", - "items": { - "$ref": "#/definitions/WebhookNotification" - }, - "description": "the collection of webhook notifications." - } - }, - "description": "Autoscale notification." - }, - "AutoscaleSetting": { - "type": "object", - "required": [ - "profiles" - ], - "properties": { - "profiles": { - "type": "array", - "maxItems": 20, - "items": { - "$ref": "#/definitions/AutoscaleProfile" - }, - "description": "the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified." - }, - "notifications": { - "type": "array", - "items": { - "$ref": "#/definitions/AutoscaleNotification" - }, - "description": "the collection of notifications." - }, - "enabled": { - "type": "boolean", - "description": "the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'false'.", - "default": false - }, - "predictiveAutoscalePolicy": { - "$ref": "#/definitions/PredictiveAutoscalePolicy", - "description": "the predictive autoscale policy mode." - }, - "name": { - "type": "string", - "description": "the name of the autoscale setting." - }, - "targetResourceUri": { - "type": "string", - "description": "the resource identifier of the resource that the autoscale setting should be added to." - }, - "targetResourceLocation": { - "type": "string", - "description": "the location of the resource that the autoscale setting should be added to." - } - }, - "description": "A setting that contains all of the configuration for the automatic scaling of a resource." - }, - "AutoscaleSettingResource": { - "type": "object", - "required": [ - "location", - "properties" - ], - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Azure resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AutoscaleSetting", - "description": "The autoscale setting of the resource." - }, - "systemData": { - "readOnly": true, - "description": "The system metadata related to the response.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - }, - "x-ms-azure-resource": true, - "description": "The autoscale setting resource." - }, - "AutoscaleSettingResourcePatch": { - "type": "object", - "description": "The autoscale setting object for patch operations.", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AutoscaleSetting", - "description": "The autoscale setting properties of the update operation." - } - } - }, - "AutoscaleSettingResourceCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AutoscaleSettingResource" - }, - "description": "the values for the autoscale setting resources." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of results." - } - }, - "required": [ - "value" - ], - "description": "Represents a collection of autoscale setting resources." - }, - "AutoscaleErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "error": { - "type": "object", - "description": "The error object.", - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "type": "string" - }, - "message": { - "description": "A human-readable representation of the error.", - "type": "string" - }, - "target": { - "description": "The target of the particular error.", - "type": "string" - }, - "details": { - "description": "A human-readable representation of the error's details.", - "type": "string" - } - } - }, - "systemData": { - "readOnly": true, - "description": "The system metadata related to the response.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - } - }, - "ScaleRuleMetricDimension": { - "type": "object", - "required": [ - "DimensionName", - "Operator", - "Values" - ], - "properties": { - "DimensionName": { - "type": "string", - "description": "Name of the dimension." - }, - "Operator": { - "type": "string", - "description": "the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values", - "enum": [ - "Equals", - "NotEquals" - ], - "x-ms-enum": { - "name": "ScaleRuleMetricDimensionOperationType", - "modelAsString": true - } - }, - "Values": { - "type": "array", - "items": { - "type": "string" - }, - "description": "list of dimension values. For example: [\"App1\",\"App2\"]." - } - }, - "description": "Specifies an auto scale rule metric dimension." - }, - "PredictiveResponse": { - "type": "object", - "properties": { - "timespan": { - "type": "string", - "description": "The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." - }, - "interval": { - "type": "string", - "format": "duration", - "description": "The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made." - }, - "metricName": { - "type": "string", - "description": "The metrics being queried" - }, - "targetResourceId": { - "type": "string", - "description": "resource of the predictive metric." - }, - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/PredictiveValue" - }, - "description": "the value of the collection." - } - }, - "description": "The response to a metrics query." - }, - "PredictiveValue": { - "type": "object", - "required": [ - "timeStamp", - "value" - ], - "properties": { - "timeStamp": { - "type": "string", - "format": "date-time", - "description": "the timestamp for the metric value in ISO 8601 format." - }, - "value": { - "type": "number", - "format": "double", - "description": "Predictive value in this time bucket." - } - }, - "description": "Represents a predictive metric value in the given bucket." - } - }, - "parameters": { - "AutoscaleSettingNameParameter": { - "name": "autoscaleSettingName", - "in": "path", - "required": true, - "type": "string", - "description": "The autoscale setting name.", - "x-ms-parameter-location": "method" - }, - "TimespanParameter": { - "name": "timespan", - "in": "query", - "required": true, - "type": "string", - "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", - "x-ms-parameter-location": "method" - }, - "IntervalParameter": { - "name": "interval", - "in": "query", - "required": true, - "type": "string", - "format": "duration", - "description": "The interval (i.e. timegrain) of the query.", - "x-ms-parameter-location": "method" - }, - "MetricNamesParameter": { - "name": "metricName", - "in": "query", - "required": true, - "type": "string", - "description": "The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**", - "x-ms-parameter-location": "method" - }, - "AggregationParameter": { - "name": "aggregation", - "in": "query", - "required": true, - "type": "string", - "description": "The list of aggregation types (comma separated) to retrieve.", - "x-ms-parameter-location": "method" - }, - "MetricNamespaceParameter": { - "name": "metricNamespace", - "in": "query", - "required": true, - "type": "string", - "description": "Metric namespace to query metric definitions for.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json deleted file mode 100644 index fc6a5a651..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json +++ /dev/null @@ -1,214 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2021-05-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": { - "/{resourceUri}/providers/Microsoft.Insights/diagnosticSettingsCategories/{name}": { - "get": { - "tags": [ - "DiagnosticSettingsCategories" - ], - "operationId": "DiagnosticSettingsCategory_Get", - "description": "Gets the diagnostic settings category for the specified resource.", - "parameters": [ - { - "$ref": "#/parameters/ResourceUriParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/NameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get more information about diagnostic setting category", - "schema": { - "$ref": "#/definitions/DiagnosticSettingsCategoryResource" - } - } - }, - "x-ms-examples": { - "Gets the diagnostic setting": { - "$ref": "./examples/getDiagnosticSettingsCategory.json" - } - } - } - }, - "/{resourceUri}/providers/Microsoft.Insights/diagnosticSettingsCategories": { - "get": { - "tags": [ - "DiagnosticSettingsCategories" - ], - "operationId": "DiagnosticSettingsCategory_List", - "description": "Lists the diagnostic settings categories for the specified resource.", - "parameters": [ - { - "$ref": "#/parameters/ResourceUriParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get more information about diagnostic setting category", - "schema": { - "$ref": "#/definitions/DiagnosticSettingsCategoryResourceCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Gets the diagnostic setting": { - "$ref": "./examples/listDiagnosticSettingsCategories.json" - } - } - } - } - }, - "definitions": { - "DiagnosticSettingsCategory": { - "type": "object", - "readOnly": true, - "properties": { - "categoryType": { - "enum": [ - "Metrics", - "Logs" - ], - "type": "string", - "x-ms-enum": { - "name": "categoryType", - "modelAsString": true - }, - "x-nullable": false, - "description": "The type of the diagnostic settings category." - }, - "categoryGroups": { - "type": "array", - "items": { - "type": "string" - }, - "description": "the collection of what category groups are supported." - } - }, - "description": "The diagnostic settings Category." - }, - "DiagnosticSettingsCategoryResource": { - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DiagnosticSettingsCategory", - "description": "The properties of a Diagnostic Settings Category." - }, - "systemData": { - "readOnly": true, - "description": "The system metadata related to this resource.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - }, - "description": "The diagnostic settings category resource." - }, - "DiagnosticSettingsCategoryResourceCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnosticSettingsCategoryResource" - }, - "description": "The collection of diagnostic settings category resources." - } - }, - "description": "Represents a collection of diagnostic setting category resources." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - } - }, - "parameters": { - "ResourceUriParameter": { - "name": "resourceUri", - "in": "path", - "required": true, - "type": "string", - "description": "The identifier of the resource.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "NameParameter": { - "name": "name", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the diagnostic setting.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json deleted file mode 100644 index 3f1bcaa24..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json +++ /dev/null @@ -1,398 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2021-05-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": { - "/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}": { - "get": { - "tags": [ - "DiagnosticSettings" - ], - "operationId": "DiagnosticSettings_Get", - "description": "Gets the active diagnostic settings for the specified resource.", - "parameters": [ - { - "$ref": "#/parameters/ResourceUriParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/NameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get more information about diagnostic setting", - "schema": { - "$ref": "#/definitions/DiagnosticSettingsResource" - } - } - }, - "x-ms-examples": { - "Gets the diagnostic setting": { - "$ref": "./examples/getDiagnosticSetting.json" - }, - "Gets the diagnostic setting for category": { - "$ref": "./examples/getDiagnosticSettingCategory.json" - } - } - }, - "put": { - "tags": [ - "DiagnosticSettings" - ], - "operationId": "DiagnosticSettings_CreateOrUpdate", - "description": "Creates or updates diagnostic settings for the specified resource.", - "parameters": [ - { - "$ref": "#/parameters/ResourceUriParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DiagnosticSettingsResource" - }, - "description": "Parameters supplied to the operation." - }, - { - "$ref": "#/parameters/NameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to create a diagnostic setting", - "schema": { - "$ref": "#/definitions/DiagnosticSettingsResource" - } - } - }, - "x-ms-examples": { - "Creates or Updates the diagnostic setting": { - "$ref": "./examples/createOrUpdateDiagnosticSetting.json" - }, - "Creates or Updates the diagnostic setting for category": { - "$ref": "./examples/createOrUpdateDiagnosticSettingCategory.json" - } - } - }, - "delete": { - "tags": [ - "DiagnosticSettings" - ], - "operationId": "DiagnosticSettings_Delete", - "description": "Deletes existing diagnostic settings for the specified resource.", - "parameters": [ - { - "$ref": "#/parameters/ResourceUriParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/NameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to remove a diagnostic setting" - }, - "204": { - "description": "Successful request to remove a diagnostic setting" - } - }, - "x-ms-examples": { - "Deletes the diagnostic setting": { - "$ref": "./examples/deleteDiagnosticSetting.json" - } - } - } - }, - "/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings": { - "get": { - "tags": [ - "DiagnosticSettings" - ], - "operationId": "DiagnosticSettings_List", - "description": "Gets the active diagnostic settings list for the specified resource.", - "parameters": [ - { - "$ref": "#/parameters/ResourceUriParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get more information about diagnostic setting", - "schema": { - "$ref": "#/definitions/DiagnosticSettingsResourceCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Gets the diagnostic setting": { - "$ref": "./examples/listDiagnosticSettings.json" - }, - "Gets the diagnostic setting for category": { - "$ref": "./examples/listDiagnosticSettingsCategory.json" - } - } - } - } - }, - "definitions": { - "RetentionPolicy": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "a value indicating whether the retention policy is enabled." - }, - "days": { - "type": "integer", - "format": "int32", - "minimum": 0, - "description": "the number of days for the retention in days. A value of 0 will retain the events indefinitely." - } - }, - "required": [ - "enabled", - "days" - ], - "description": "Specifies the retention policy for the log." - }, - "MetricSettings": { - "type": "object", - "properties": { - "timeGrain": { - "type": "string", - "format": "duration", - "description": "the timegrain of the metric in ISO8601 format." - }, - "category": { - "type": "string", - "description": "Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation." - }, - "enabled": { - "type": "boolean", - "description": "a value indicating whether this category is enabled." - }, - "retentionPolicy": { - "$ref": "#/definitions/RetentionPolicy", - "description": "the retention policy for this category." - } - }, - "required": [ - "enabled" - ], - "description": "Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular metric." - }, - "LogSettings": { - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation." - }, - "categoryGroup": { - "type": "string", - "description": "Name of a Diagnostic Log category group for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation." - }, - "enabled": { - "type": "boolean", - "description": "a value indicating whether this log is enabled." - }, - "retentionPolicy": { - "$ref": "#/definitions/RetentionPolicy", - "description": "the retention policy for this log." - } - }, - "required": [ - "enabled" - ], - "description": "Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log." - }, - "DiagnosticSettings": { - "type": "object", - "properties": { - "storageAccountId": { - "type": "string", - "description": "The resource ID of the storage account to which you would like to send Diagnostic Logs." - }, - "serviceBusRuleId": { - "type": "string", - "description": "The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility." - }, - "eventHubAuthorizationRuleId": { - "type": "string", - "description": "The resource Id for the event hub authorization rule." - }, - "eventHubName": { - "type": "string", - "description": "The name of the event hub. If none is specified, the default event hub will be selected." - }, - "metrics": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricSettings" - }, - "description": "The list of metric settings." - }, - "logs": { - "type": "array", - "items": { - "$ref": "#/definitions/LogSettings" - }, - "description": "The list of logs settings." - }, - "workspaceId": { - "type": "string", - "description": "The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" - }, - "marketplacePartnerId": { - "type": "string", - "description": "The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs." - }, - "logAnalyticsDestinationType": { - "type": "string", - "description": "A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.)" - } - }, - "description": "The diagnostic settings." - }, - "DiagnosticSettingsResource": { - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DiagnosticSettings", - "description": "Properties of a Diagnostic Settings Resource." - }, - "systemData": { - "readOnly": true, - "description": "The system metadata related to this resource.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - }, - "description": "The diagnostic setting resource." - }, - "DiagnosticSettingsResourceCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnosticSettingsResource" - }, - "description": "The collection of diagnostic settings resources;." - } - }, - "description": "Represents a collection of alert rule resources." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - } - }, - "parameters": { - "ResourceUriParameter": { - "name": "resourceUri", - "in": "path", - "required": true, - "type": "string", - "description": "The identifier of the resource.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "NameParameter": { - "name": "name", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the diagnostic setting.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/managementGroupDiagnosticSettings_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/managementGroupDiagnosticSettings_API.json deleted file mode 100644 index 7ed04076d..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/managementGroupDiagnosticSettings_API.json +++ /dev/null @@ -1,337 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2021-05-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.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/diagnosticSettings/{name}": { - "get": { - "tags": [ - "ManagementGroupDiagnosticSettings" - ], - "operationId": "ManagementGroupDiagnosticSettings_Get", - "description": "Gets the active management group diagnostic settings for the specified resource.", - "parameters": [ - { - "$ref": "#/parameters/ManagementGroupIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/NameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get more information about diagnostic setting.", - "schema": { - "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResource" - } - } - }, - "x-ms-examples": { - "Gets the management group diagnostic setting": { - "$ref": "./examples/getManagementGroupDiagnosticSetting.json" - }, - "Gets the management group diagnostic setting for category": { - "$ref": "./examples/getManagementGroupDiagnosticSettingCategory.json" - } - } - }, - "put": { - "tags": [ - "ManagementGroupDiagnosticSettings" - ], - "operationId": "ManagementGroupDiagnosticSettings_CreateOrUpdate", - "description": "Creates or updates management group diagnostic settings for the specified resource.", - "parameters": [ - { - "$ref": "#/parameters/ManagementGroupIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResource" - }, - "description": "Parameters supplied to the operation." - }, - { - "$ref": "#/parameters/NameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to create a management group diagnostic setting", - "schema": { - "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResource" - } - } - }, - "x-ms-examples": { - "Creates or Updates the management group diagnostic setting": { - "$ref": "./examples/createOrUpdateManagementGroupDiagnosticSetting.json" - }, - "Creates or Updates the management group diagnostic setting for category": { - "$ref": "./examples/createOrUpdateManagementGroupDiagnosticSettingCategory.json" - } - } - }, - "delete": { - "tags": [ - "ManagementGroupDiagnosticSettings" - ], - "operationId": "ManagementGroupDiagnosticSettings_Delete", - "description": "Deletes existing management group diagnostic settings for the specified resource.", - "parameters": [ - { - "$ref": "#/parameters/ManagementGroupIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/NameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to remove a management group diagnostic setting" - }, - "204": { - "description": "Successful request to remove a management group diagnostic setting" - } - }, - "x-ms-examples": { - "Deletes the management group diagnostic setting": { - "$ref": "./examples/deleteManagementGroupDiagnosticSetting.json" - } - } - } - }, - "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/diagnosticSettings": { - "get": { - "tags": [ - "ManagementGroupDiagnosticSettings" - ], - "operationId": "ManagementGroupDiagnosticSettings_List", - "description": "Gets the active management group diagnostic settings list for the specified management group.", - "parameters": [ - { - "$ref": "#/parameters/ManagementGroupIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get more information about management group diagnostic setting", - "schema": { - "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResourceCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Gets the management group diagnostic setting": { - "$ref": "./examples/listManagementGroupDiagnosticSettings.json" - }, - "Gets the management group diagnostic setting for category": { - "$ref": "./examples/listManagementGroupDiagnosticSettingsCategory.json" - } - } - } - } - }, - "definitions": { - "ManagementGroupLogSettings": { - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Name of a Management Group Diagnostic Log category for a resource type this setting is applied to." - }, - "categoryGroup": { - "type": "string", - "description": "Name of a Management Group Diagnostic Log category group for a resource type this setting is applied to." - }, - "enabled": { - "type": "boolean", - "description": "a value indicating whether this log is enabled." - } - }, - "required": [ - "enabled" - ], - "description": "Part of Management Group diagnostic setting. Specifies the settings for a particular log." - }, - "ManagementGroupDiagnosticSettings": { - "type": "object", - "properties": { - "storageAccountId": { - "type": "string", - "description": "The resource ID of the storage account to which you would like to send Diagnostic Logs." - }, - "serviceBusRuleId": { - "type": "string", - "description": "The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility." - }, - "eventHubAuthorizationRuleId": { - "type": "string", - "description": "The resource Id for the event hub authorization rule." - }, - "eventHubName": { - "type": "string", - "description": "The name of the event hub. If none is specified, the default event hub will be selected." - }, - "logs": { - "type": "array", - "items": { - "$ref": "#/definitions/ManagementGroupLogSettings" - }, - "description": "The list of logs settings." - }, - "workspaceId": { - "type": "string", - "description": "The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" - }, - "marketplacePartnerId": { - "type": "string", - "description": "The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs." - } - }, - "description": "The management group diagnostic settings." - }, - "ManagementGroupDiagnosticSettingsResource": { - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ManagementGroupDiagnosticSettings", - "description": "Properties of a Management Group Diagnostic Settings Resource." - }, - "systemData": { - "readOnly": true, - "description": "The system metadata related to this resource.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - }, - "description": "The management group diagnostic setting resource." - }, - "ManagementGroupDiagnosticSettingsResourceCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResource" - }, - "description": "The collection of management group diagnostic settings resources." - } - }, - "description": "Represents a collection of management group diagnostic settings resources." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - } - }, - "parameters": { - "ManagementGroupIdParameter": { - "name": "managementGroupId", - "in": "path", - "required": true, - "type": "string", - "description": "The management group id.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "NameParameter": { - "name": "name", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the diagnostic setting.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/subscriptionDiagnosticsSettings_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/subscriptionDiagnosticsSettings_API.json deleted file mode 100644 index af49be8aa..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/subscriptionDiagnosticsSettings_API.json +++ /dev/null @@ -1,328 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2021-05-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.Insights/diagnosticSettings/{name}": { - "get": { - "tags": [ - "SubscriptionDiagnosticSettings" - ], - "operationId": "SubscriptionDiagnosticSettings_Get", - "description": "Gets the active subscription diagnostic settings for the specified resource.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/NameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get more information about diagnostic setting.", - "schema": { - "$ref": "#/definitions/SubscriptionDiagnosticSettingsResource" - } - } - }, - "x-ms-examples": { - "Gets the subscription diagnostic setting": { - "$ref": "./examples/getSubscriptionDiagnosticSetting.json" - }, - "Gets the subscription diagnostic setting for category": { - "$ref": "./examples/getSubscriptionDiagnosticSettingCategory.json" - } - } - }, - "put": { - "tags": [ - "SubscriptionDiagnosticSettings" - ], - "operationId": "SubscriptionDiagnosticSettings_CreateOrUpdate", - "description": "Creates or updates subscription diagnostic settings for the specified resource.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SubscriptionDiagnosticSettingsResource" - }, - "description": "Parameters supplied to the operation." - }, - { - "$ref": "#/parameters/NameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to create a subscription diagnostic setting", - "schema": { - "$ref": "#/definitions/SubscriptionDiagnosticSettingsResource" - } - } - }, - "x-ms-examples": { - "Creates or Updates the subscription diagnostic setting": { - "$ref": "./examples/createOrUpdateSubscriptionDiagnosticSetting.json" - }, - "Creates or Updates the subscription diagnostic setting for category": { - "$ref": "./examples/createOrUpdateSubscriptionDiagnosticSettingCategory.json" - } - } - }, - "delete": { - "tags": [ - "SubscriptionDiagnosticSettings" - ], - "operationId": "SubscriptionDiagnosticSettings_Delete", - "description": "Deletes existing subscription diagnostic settings for the specified resource.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/NameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to remove a subscription diagnostic setting" - }, - "204": { - "description": "Successful request to remove a subscription diagnostic setting" - } - }, - "x-ms-examples": { - "Deletes the subscription diagnostic setting": { - "$ref": "./examples/deleteSubscriptionDiagnosticSetting.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/diagnosticSettings": { - "get": { - "tags": [ - "SubscriptionDiagnosticSettings" - ], - "operationId": "SubscriptionDiagnosticSettings_List", - "description": "Gets the active subscription diagnostic settings list for the specified subscriptionId.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get more information about subscription diagnostic setting", - "schema": { - "$ref": "#/definitions/SubscriptionDiagnosticSettingsResourceCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Gets the subscription diagnostic setting": { - "$ref": "./examples/listSubscriptionDiagnosticSettings.json" - }, - "Gets the subscription diagnostic settings for category": { - "$ref": "./examples/listSubscriptionDiagnosticSettingsCategory.json" - } - } - } - } - }, - "definitions": { - "SubscriptionLogSettings": { - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Name of a Subscription Diagnostic Log category for a resource type this setting is applied to." - }, - "categoryGroup": { - "type": "string", - "description": "Name of a Subscription Diagnostic Log category group for a resource type this setting is applied to." - }, - "enabled": { - "type": "boolean", - "description": "a value indicating whether this log is enabled." - } - }, - "required": [ - "enabled" - ], - "description": "Part of Subscription diagnostic setting. Specifies the settings for a particular log." - }, - "SubscriptionDiagnosticSettings": { - "type": "object", - "properties": { - "storageAccountId": { - "type": "string", - "description": "The resource ID of the storage account to which you would like to send Diagnostic Logs." - }, - "serviceBusRuleId": { - "type": "string", - "description": "The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility." - }, - "eventHubAuthorizationRuleId": { - "type": "string", - "description": "The resource Id for the event hub authorization rule." - }, - "eventHubName": { - "type": "string", - "description": "The name of the event hub. If none is specified, the default event hub will be selected." - }, - "logs": { - "type": "array", - "items": { - "$ref": "#/definitions/SubscriptionLogSettings" - }, - "description": "The list of logs settings." - }, - "workspaceId": { - "type": "string", - "description": "The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" - }, - "marketplacePartnerId": { - "type": "string", - "description": "The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs." - } - }, - "description": "The subscription diagnostic settings." - }, - "SubscriptionDiagnosticSettingsResource": { - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SubscriptionDiagnosticSettings", - "description": "Properties of a Subscription Diagnostic Settings Resource." - }, - "systemData": { - "readOnly": true, - "description": "The system metadata related to this resource.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - }, - "description": "The subscription diagnostic setting resource." - }, - "SubscriptionDiagnosticSettingsResourceCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SubscriptionDiagnosticSettingsResource" - }, - "description": "The collection of subscription diagnostic settings resources." - } - }, - "description": "Represents a collection of subscription diagnostic settings resources." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - } - }, - "parameters": { - "NameParameter": { - "name": "name", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the diagnostic setting.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json deleted file mode 100644 index 30da6ca51..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json +++ /dev/null @@ -1,1097 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "description": "Azure Monitor API reference for Private Links Scopes management.", - "version": "2021-07-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.insights/privateLinkScopes": { - "get": { - "description": "Gets a list of all Azure Monitor PrivateLinkScopes within a subscription.", - "operationId": "PrivateLinkScopes_List", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A list containing 0 or more Azure Monitor PrivateLinkScope definitions.", - "schema": { - "$ref": "#/definitions/AzureMonitorPrivateLinkScopeListResult" - } - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateLinkScopesList.json": { - "$ref": "./examples/PrivateLinkScopesList.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopes": { - "get": { - "description": "Gets a list of Azure Monitor PrivateLinkScopes within a resource group.", - "operationId": "PrivateLinkScopes_ListByResourceGroup", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A list containing 0 or more Azure Monitor PrivateLinkScope definitions.", - "schema": { - "$ref": "#/definitions/AzureMonitorPrivateLinkScopeListResult" - } - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateLinkScopeListByResourceGroup": { - "$ref": "./examples/PrivateLinkScopesListByResourceGroup.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopes/{scopeName}": { - "delete": { - "description": "Deletes a Azure Monitor PrivateLinkScope.", - "operationId": "PrivateLinkScopes_Delete", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - } - ], - "responses": { - "200": { - "description": "Successful request when deleting a Azure Monitor PrivateLinkScope." - }, - "204": { - "description": "The specified PrivateLinkScope does not exist." - }, - "202": { - "description": "Accepted." - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "PrivateLinkScopesDelete": { - "$ref": "./examples/PrivateLinkScopesDelete.json" - } - } - }, - "get": { - "description": "Returns a Azure Monitor PrivateLinkScope.", - "operationId": "PrivateLinkScopes_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - } - ], - "responses": { - "200": { - "description": "An Azure Monitor PrivateLinkScope definition.", - "schema": { - "$ref": "#/definitions/AzureMonitorPrivateLinkScope" - } - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateLinkScopeGet": { - "$ref": "./examples/PrivateLinkScopesGet.json" - } - } - }, - "put": { - "description": "Creates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.", - "operationId": "PrivateLinkScopes_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "name": "AzureMonitorPrivateLinkScopePayload", - "description": "Properties that need to be specified to create or update a Azure Monitor PrivateLinkScope.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AzureMonitorPrivateLinkScope" - } - } - ], - "responses": { - "200": { - "description": "Successful request when creating or updating a Azure Monitor PrivateLinkScope. The updated PrivateLinkScope is returned.", - "schema": { - "$ref": "#/definitions/AzureMonitorPrivateLinkScope" - } - }, - "201": { - "description": "Successful request when creating or updating a Azure Monitor PrivateLinkScope. The updated PrivateLinkScope was created and is returned.", - "schema": { - "$ref": "#/definitions/AzureMonitorPrivateLinkScope" - } - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateLinkScopeCreate": { - "$ref": "./examples/PrivateLinkScopesCreate.json" - }, - "PrivateLinkScopeUpdate": { - "$ref": "./examples/PrivateLinkScopesUpdate.json" - } - } - }, - "patch": { - "description": "Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.", - "operationId": "PrivateLinkScopes_UpdateTags", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "name": "PrivateLinkScopeTags", - "description": "Updated tag information to set into the PrivateLinkScope instance.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TagsResource" - } - } - ], - "responses": { - "200": { - "description": "Updating the Azure Monitor PrivateLinkScope's tags was successful. PrivateLinkScope tags are updated and returned with the rest of the PrivateLinkScope's object properties.", - "schema": { - "$ref": "#/definitions/AzureMonitorPrivateLinkScope" - } - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateLinkScopeUpdateTagsOnly": { - "$ref": "./examples/PrivateLinkScopesUpdateTagsOnly.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopeOperationStatuses/{asyncOperationId}": { - "get": { - "x-ms-examples": { - "Get specific operation status": { - "$ref": "./examples/privateLinkScopeOperationStatuses.json" - } - }, - "tags": [ - "asyncOperations" - ], - "operationId": "PrivateLinkScopeOperationStatus_Get", - "description": "Get the status of an azure asynchronous operation associated with a private link scope operation.", - "parameters": [ - { - "name": "asyncOperationId", - "in": "path", - "required": true, - "type": "string", - "description": "The operation Id." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK. Operation status.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateLinkResources": { - "get": { - "tags": [ - "PrivateLinkResources" - ], - "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", - "operationId": "PrivateLinkResources_ListByPrivateLinkScope", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved private link resources.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResourceListResult" - } - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "Gets private endpoint connection.": { - "$ref": "./examples/PrivateLinkScopePrivateLinkResourceListGet.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}": { - "get": { - "tags": [ - "PrivateLinkResources" - ], - "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", - "operationId": "PrivateLinkResources_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "$ref": "#/parameters/GroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved a specified private link resource.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResource" - } - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "Gets private endpoint connection.": { - "$ref": "./examples/PrivateLinkScopePrivateLinkResourceGet.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}": { - "get": { - "tags": [ - "PrivateEndpointConnections" - ], - "description": "Gets a private endpoint connection.", - "operationId": "PrivateEndpointConnections_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "The name of the private endpoint connection.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved a specified private endpoint connection.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" - } - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "Gets private endpoint connection.": { - "$ref": "./examples/PrivateEndpointConnectionGet.json" - } - } - }, - "put": { - "tags": [ - "PrivateEndpointConnections" - ], - "description": "Approve or reject a private endpoint connection with a given name.", - "operationId": "PrivateEndpointConnections_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "The name of the private endpoint connection.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" - } - } - ], - "responses": { - "200": { - "description": "Successfully approved or rejected private endpoint connection.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Approve or reject a private endpoint connection with a given name.": { - "$ref": "./examples/PrivateEndpointConnectionUpdate.json" - } - } - }, - "delete": { - "tags": [ - "PrivateEndpointConnections" - ], - "description": "Deletes a private endpoint connection with a given name.", - "operationId": "PrivateEndpointConnections_Delete", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "The name of the private endpoint connection.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Successfully deleted private endpoint connection." - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "Private endpoint connection does not exist." - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Deletes a private endpoint connection with a given name.": { - "$ref": "./examples/PrivateEndpointConnectionDelete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections": { - "get": { - "tags": [ - "PrivateEndpointConnections" - ], - "description": "Gets all private endpoint connections on a private link scope.", - "operationId": "PrivateEndpointConnections_ListByPrivateLinkScope", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved private endpoint connections.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" - } - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "Gets list of private endpoint connections on a private link scope.": { - "$ref": "./examples/PrivateEndpointConnectionList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/scopedResources/{name}": { - "get": { - "tags": [ - "PrivateLinkScopedResources" - ], - "description": "Gets a scoped resource in a private link scope.", - "operationId": "PrivateLinkScopedResources_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "name": "name", - "in": "path", - "description": "The name of the scoped resource object.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved a scoped resource in a private link scope.", - "schema": { - "$ref": "#/definitions/ScopedResource" - } - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "Gets private link scoped resource.": { - "$ref": "./examples/PrivateLinkScopedResourceGet.json" - } - } - }, - "put": { - "tags": [ - "PrivateLinkScopedResources" - ], - "description": "Approve or reject a private endpoint connection with a given name.", - "operationId": "PrivateLinkScopedResources_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "name": "name", - "in": "path", - "description": "The name of the scoped resource object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ScopedResource" - } - } - ], - "responses": { - "200": { - "description": "Successfully create or updated a new azure monitor scoped resource in a private link scope.", - "schema": { - "$ref": "#/definitions/ScopedResource" - } - }, - "201": { - "description": "Successfully created a new azure monitor scoped resource in a private link scope.", - "schema": { - "$ref": "#/definitions/ScopedResource" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update a scoped resource in a private link scope.": { - "$ref": "./examples/PrivateLinkScopedResourceUpdate.json" - } - } - }, - "delete": { - "tags": [ - "PrivateLinkScopedResources" - ], - "description": "Deletes a private endpoint connection with a given name.", - "operationId": "PrivateLinkScopedResources_Delete", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "name": "name", - "in": "path", - "description": "The name of the scoped resource object.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Successfully deleted scoped resource." - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "Scoped resource does not exist." - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Deletes a scoped resource with a given name.": { - "$ref": "./examples/PrivateLinkScopedResourceDelete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/scopedResources": { - "get": { - "tags": [ - "PrivateLinkScopedResources" - ], - "description": "Gets all private endpoint connections on a private link scope.", - "operationId": "PrivateLinkScopedResources_ListByPrivateLinkScope", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved scoped resources in a private link scope.", - "schema": { - "$ref": "#/definitions/ScopedResourceListResult" - } - }, - "default": { - "description": "An error occurred.", - "schema": { - "$ref": "#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets list of scoped resources in a private link scope.": { - "$ref": "./examples/PrivateLinkScopedResourceList.json" - } - } - } - } - }, - "definitions": { - "OperationStatus": { - "description": "The status of operation.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The operation Id." - }, - "name": { - "type": "string", - "description": "The operation name." - }, - "startTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "description": "Start time of the job in standard ISO8601 format." - }, - "endTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "description": "End time of the job in standard ISO8601 format." - }, - "status": { - "type": "string", - "description": "The status of the operation." - }, - "error": { - "type": "object", - "description": "The error detail of the operation if any.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail", - "x-nullable": true - } - } - }, - "TagsResource": { - "properties": { - "tags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "description": "A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance." - }, - "AzureMonitorPrivateLinkScope": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Properties that define a Azure Monitor PrivateLinkScope resource.", - "$ref": "#/definitions/AzureMonitorPrivateLinkScopeProperties" - }, - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "System data", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" - } - ], - "required": [ - "properties" - ], - "description": "An Azure Monitor PrivateLinkScope definition." - }, - "AzureMonitorPrivateLinkScopeProperties": { - "description": "Properties that define a Azure Monitor PrivateLinkScope resource.", - "properties": { - "provisioningState": { - "type": "string", - "description": "Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.", - "readOnly": true - }, - "privateEndpointConnections": { - "readOnly": true, - "description": "List of private endpoint connections.", - "type": "array", - "items": { - "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" - } - }, - "accessModeSettings": { - "type": "object", - "$ref": "#/definitions/AccessModeSettings", - "description": "Access mode settings" - } - }, - "required": [ - "accessModeSettings" - ] - }, - "AccessModeSettings": { - "type": "object", - "description": "Properties that define the scope private link mode settings.", - "properties": { - "queryAccessMode": { - "description": "Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.", - "$ref": "#/definitions/AccessMode" - }, - "ingestionAccessMode": { - "description": "Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.", - "$ref": "#/definitions/AccessMode" - }, - "exclusions": { - "description": "List of exclusions that override the default access mode settings for specific private endpoint connections.", - "type": "array", - "items": { - "$ref": "#/definitions/AccessModeSettingsExclusion" - } - } - }, - "required": [ - "queryAccessMode", - "ingestionAccessMode" - ] - }, - "AccessModeSettingsExclusion": { - "type": "object", - "description": "Properties that define the scope private link mode settings exclusion item. This setting applies to a specific private endpoint connection and overrides the default settings for that private endpoint connection.", - "properties": { - "privateEndpointConnectionName": { - "description": "The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings.", - "type": "string" - }, - "queryAccessMode": { - "description": "Specifies the access mode of queries through the specified private endpoint connection in the exclusion.", - "$ref": "#/definitions/AccessMode" - }, - "ingestionAccessMode": { - "description": "Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion.", - "$ref": "#/definitions/AccessMode" - } - } - }, - "AccessMode": { - "description": "Access mode types.", - "type": "string", - "enum": [ - "Open", - "PrivateOnly" - ], - "x-ms-enum": { - "name": "AccessMode", - "modelAsString": true - } - }, - "AzureMonitorPrivateLinkScopeListResult": { - "description": "Describes the list of Azure Monitor PrivateLinkScope resources.", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of Azure Monitor PrivateLinkScope definitions.", - "items": { - "$ref": "#/definitions/AzureMonitorPrivateLinkScope" - } - }, - "nextLink": { - "type": "string", - "description": "The URI to get the next set of Azure Monitor PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set." - } - } - }, - "ScopedResourceListResult": { - "description": "A list of scoped resources in a private link scope.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/ScopedResource" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "ScopedResource": { - "description": "A private link scoped resource", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ScopedResourceProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - }, - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "System data", - "readOnly": true - } - } - }, - "ScopedResourceProperties": { - "description": "Properties of a private link scoped resource.", - "type": "object", - "properties": { - "linkedResourceId": { - "description": "The resource id of the scoped Azure monitor resource.", - "type": "string" - }, - "provisioningState": { - "description": "State of the private endpoint connection.", - "type": "string", - "readOnly": true - } - } - }, - "DefaultErrorResponse": { - "title": "Default error response", - "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", - "type": "object", - "properties": { - "error": { - "description": "The error object.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail" - } - } - } - }, - "parameters": { - "PrivateLinkScopeName": { - "name": "scopeName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Azure Monitor PrivateLinkScope resource.", - "x-ms-parameter-location": "method" - }, - "GroupNameParameter": { - "name": "groupName", - "in": "path", - "description": "The name of the private link resource.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2022-08-01-preview/scheduledQueryRule_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2022-08-01-preview/scheduledQueryRule_API.json deleted file mode 100644 index 203dee870..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2022-08-01-preview/scheduledQueryRule_API.json +++ /dev/null @@ -1,859 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2022-08-01-preview", - "title": "Scheduled Query Rules API", - "description": "Azure Monitor client to create/update/delete Scheduled Query Rules." - }, - "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.Insights/scheduledQueryRules": { - "get": { - "tags": [ - "ScheduledQueryRules" - ], - "description": "Retrieve a scheduled query rule definitions in a subscription.", - "operationId": "ScheduledQueryRules_ListBySubscription", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successful request for a list of scheduled query rules", - "schema": { - "$ref": "#/definitions/ScheduledQueryRuleResourceCollection" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/ErrorContract" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List scheduled query rules by subscription": { - "$ref": "./examples/listScheduledQueryRulesBySubscription.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules": { - "get": { - "tags": [ - "ScheduledQueryRules" - ], - "description": "Retrieve scheduled query rule definitions in a resource group.", - "operationId": "ScheduledQueryRules_ListByResourceGroup", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successful request for a list of scheduled query rules", - "schema": { - "$ref": "#/definitions/ScheduledQueryRuleResourceCollection" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/ErrorContract" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List scheduled query rules by resource group": { - "$ref": "./examples/listScheduledQueryRulesByResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}": { - "get": { - "tags": [ - "ScheduledQueryRules" - ], - "description": "Retrieve an scheduled query rule definition.", - "operationId": "ScheduledQueryRules_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successful request to get a scheduled query rule", - "schema": { - "$ref": "#/definitions/ScheduledQueryRuleResource" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/ErrorContract" - } - } - }, - "x-ms-examples": { - "Get a scheduled query rule for single resource": { - "$ref": "./examples/getScheduledQueryRule.json" - } - } - }, - "put": { - "tags": [ - "ScheduledQueryRules" - ], - "description": "Creates or updates a scheduled query rule.", - "operationId": "ScheduledQueryRules_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ScheduledQueryRuleResource" - }, - "description": "The parameters of the rule to create or update." - } - ], - "responses": { - "200": { - "description": "Successful request to update a scheduled query rule", - "schema": { - "$ref": "#/definitions/ScheduledQueryRuleResource" - } - }, - "201": { - "description": "Created a scheduled query rule", - "schema": { - "$ref": "#/definitions/ScheduledQueryRuleResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorContract" - } - } - }, - "x-ms-examples": { - "Create or update a scheduled query rule for Single Resource": { - "$ref": "./examples/createOrUpdateScheduledQueryRule.json" - }, - "Create or update a scheduled query rule on Resource group(s)": { - "$ref": "./examples/createOrUpdateScheduledQueryRuleResourceGroup.json" - }, - "Create or update a scheduled query rule on Subscription ": { - "$ref": "./examples/createOrUpdateScheduledQueryRuleSubscription.json" - } - } - }, - "patch": { - "tags": [ - "ScheduledQueryRules" - ], - "description": "Update a scheduled query rule.", - "operationId": "ScheduledQueryRules_Update", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ScheduledQueryRuleResourcePatch" - }, - "description": "The parameters of the rule to update." - } - ], - "responses": { - "200": { - "description": "Successful request to update a scheduled query rule", - "schema": { - "$ref": "#/definitions/ScheduledQueryRuleResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorContract" - } - } - }, - "x-ms-examples": { - "Create or update a scheduled query rule": { - "$ref": "./examples/patchScheduledQueryRule.json" - } - } - }, - "delete": { - "tags": [ - "ScheduledQueryRules" - ], - "description": "Deletes a scheduled query rule.", - "operationId": "ScheduledQueryRules_Delete", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorContract" - } - }, - "200": { - "description": "Successful request to delete a scheduled query rule" - }, - "204": { - "description": "No content: the request was successful, but the response is empty" - } - }, - "x-ms-examples": { - "Delete a scheduled query rule": { - "$ref": "./examples/deleteScheduledQueryRule.json" - } - } - } - } - }, - "definitions": { - "Actions": { - "type": "object", - "description": "Actions to invoke when the alert fires.", - "properties": { - "actionGroups": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Action Group resource Ids to invoke when the alert fires." - }, - "customProperties": { - "type": "object", - "additionalProperties": { - "type": "string", - "description": "The dictionary of custom properties to include with the post operation. These data are appended to the alert payload." - }, - "description": "The properties of an alert payload." - } - } - }, - "RuleResolveConfiguration": { - "type": "object", - "description": "TBD. Relevant only for rules of the kind LogAlert.", - "properties": { - "autoResolved": { - "type": "boolean", - "description": "The flag that indicates whether or not to auto resolve a fired alert." - }, - "timeToResolve": { - "type": "string", - "format": "duration", - "description": "The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format." - } - } - }, - "ScheduledQueryRuleProperties": { - "type": "object", - "properties": { - "createdWithApiVersion": { - "type": "string", - "readOnly": true, - "description": "The api-version used when creating this alert rule" - }, - "isLegacyLogAnalyticsRule": { - "type": "boolean", - "readOnly": true, - "description": "True if alert rule is legacy Log Analytic rule" - }, - "description": { - "type": "string", - "description": "The description of the scheduled query rule." - }, - "displayName": { - "type": "string", - "description": "The display name of the alert rule" - }, - "severity": { - "type": "integer", - "format": "int64", - "description": "Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.", - "enum": [ - 0, - 1, - 2, - 3, - 4 - ], - "x-ms-enum": { - "name": "AlertSeverity", - "modelAsString": true - } - }, - "enabled": { - "type": "boolean", - "description": "The flag which indicates whether this scheduled query rule is enabled. Value should be true or false" - }, - "publicNetworkAccess": { - "description": "This determines if traffic is allowed over public network. By default it is enabled.", - "enum": [ - "Enabled", - "Disabled", - "SecuredByPerimeter" - ], - "type": "string", - "x-ms-enum": { - "name": "PublicNetworkAccess", - "modelAsString": true - }, - "default": "Enabled" - }, - "scopes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of resource id's that this scheduled query rule is scoped to." - }, - "evaluationFrequency": { - "type": "string", - "format": "duration", - "description": "How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert." - }, - "windowSize": { - "type": "string", - "format": "duration", - "description": "The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert." - }, - "overrideQueryTimeRange": { - "type": "string", - "format": "duration", - "description": "If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert." - }, - "targetResourceTypes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert" - }, - "criteria": { - "$ref": "#/definitions/ScheduledQueryRuleCriteria", - "description": "The rule criteria that defines the conditions of the scheduled query rule." - }, - "muteActionsDuration": { - "type": "string", - "format": "duration", - "description": "Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert." - }, - "actions": { - "type": "object", - "$ref": "#/definitions/Actions", - "description": "Actions to invoke when the alert fires." - }, - "isWorkspaceAlertsStorageConfigured": { - "type": "boolean", - "readOnly": true, - "description": "The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false." - }, - "checkWorkspaceAlertsStorageConfigured": { - "type": "boolean", - "description": "The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert." - }, - "skipQueryValidation": { - "type": "boolean", - "description": "The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert." - }, - "autoMitigate": { - "type": "boolean", - "description": "The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert." - }, - "ruleResolveConfiguration": { - "type": "object", - "$ref": "#/definitions/RuleResolveConfiguration", - "description": "Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert." - } - }, - "description": "scheduled query rule Definition" - }, - "ScheduledQueryRuleResource": { - "type": "object", - "required": [ - "properties", - "location" - ], - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The name of the resource" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" - }, - "identity": { - "$ref": "#/definitions/Identity", - "description": "The identity of the resource." - }, - "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" - }, - "kind": { - "type": "string", - "description": "Indicates the type of scheduled query rule. The default is LogAlert.", - "enum": [ - "LogAlert", - "LogToMetric" - ], - "x-ms-enum": { - "name": "Kind", - "modelAsString": true - } - }, - "etag": { - "type": "string", - "readOnly": true, - "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. " - }, - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "SystemData of ScheduledQueryRule.", - "readOnly": true - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ScheduledQueryRuleProperties", - "description": "The rule properties of the resource.", - "required": [ - "enabled", - "criteria", - "scopes" - ] - } - }, - "description": "The scheduled query rule resource.", - "x-ms-azure-resource": true - }, - "ScheduledQueryRuleResourcePatch": { - "type": "object", - "properties": { - "identity": { - "$ref": "#/definitions/Identity", - "description": "The identity of the resource." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ScheduledQueryRuleProperties", - "description": "The scheduled query rule properties of the resource." - } - }, - "description": "The scheduled query rule resource for patch operations." - }, - "ScheduledQueryRuleResourceCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ScheduledQueryRuleResource" - }, - "description": "The values for the scheduled query rule resources." - }, - "nextLink": { - "description": "Provides the link to retrieve the next set of elements.", - "type": "string", - "readOnly": true - } - }, - "description": "Represents a collection of scheduled query rule resources." - }, - "ScheduledQueryRuleCriteria": { - "type": "object", - "description": "The rule criteria that defines the conditions of the scheduled query rule.", - "properties": { - "allOf": { - "type": "array", - "description": "A list of conditions to evaluate against the specified scopes", - "items": { - "$ref": "#/definitions/Condition" - }, - "x-ms-identifiers": [] - } - } - }, - "Condition": { - "type": "object", - "description": "A condition of the scheduled query rule.", - "properties": { - "query": { - "type": "string", - "description": "Log query alert" - }, - "timeAggregation": { - "type": "string", - "description": "Aggregation type. Relevant and required only for rules of the kind LogAlert.", - "enum": [ - "Count", - "Average", - "Minimum", - "Maximum", - "Total" - ], - "x-ms-enum": { - "name": "timeAggregation", - "modelAsString": true - } - }, - "metricMeasureColumn": { - "type": "string", - "description": "The column containing the metric measure number. Relevant only for rules of the kind LogAlert." - }, - "resourceIdColumn": { - "type": "string", - "description": "The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert." - }, - "dimensions": { - "type": "array", - "items": { - "$ref": "#/definitions/Dimension" - }, - "description": "List of Dimensions conditions", - "x-ms-identifiers": [] - }, - "operator": { - "type": "string", - "enum": [ - "Equals", - "GreaterThan", - "GreaterThanOrEqual", - "LessThan", - "LessThanOrEqual" - ], - "x-ms-enum": { - "name": "conditionOperator", - "modelAsString": true - }, - "description": "The criteria operator. Relevant and required only for rules of the kind LogAlert." - }, - "threshold": { - "type": "number", - "format": "double", - "description": "the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert." - }, - "failingPeriods": { - "type": "object", - "description": "The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.", - "properties": { - "numberOfEvaluationPeriods": { - "type": "integer", - "format": "int64", - "default": 1, - "description": "The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1" - }, - "minFailingPeriodsToAlert": { - "type": "integer", - "format": "int64", - "default": 1, - "description": "The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1" - } - } - }, - "metricName": { - "type": "string", - "description": "The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric." - } - } - }, - "Dimension": { - "type": "object", - "description": "Dimension splitting and filtering definition", - "properties": { - "name": { - "type": "string", - "description": "Name of the dimension" - }, - "operator": { - "type": "string", - "description": "Operator for dimension values", - "enum": [ - "Include", - "Exclude" - ], - "x-ms-enum": { - "name": "dimensionOperator", - "modelAsString": true - } - }, - "values": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of dimension values" - } - }, - "required": [ - "name", - "operator", - "values" - ] - }, - "ErrorContract": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "error": { - "description": "The error details.", - "$ref": "#/definitions/ErrorResponseDetails" - } - } - }, - "ErrorResponseDetails": { - "title": "Error Response", - "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)", - "type": "object", - "properties": { - "code": { - "readOnly": true, - "type": "string", - "description": "The error code." - }, - "message": { - "readOnly": true, - "type": "string", - "description": "The error message." - }, - "target": { - "readOnly": true, - "type": "string", - "description": "The error target." - }, - "details": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/ErrorResponseDetails" - }, - "x-ms-identifiers": [ - "message", - "target" - ], - "description": "The error details." - }, - "additionalInfo": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/ErrorResponseAdditionalInfo" - }, - "x-ms-identifiers": [], - "description": "The error additional info." - } - } - }, - "ErrorResponseAdditionalInfo": { - "type": "object", - "properties": { - "type": { - "readOnly": true, - "type": "string", - "description": "The additional info type." - }, - "info": { - "readOnly": true, - "type": "object", - "description": "The additional info." - } - }, - "description": "The resource management error additional info." - }, - "Identity": { - "properties": { - "principalId": { - "readOnly": true, - "type": "string", - "description": "The principal ID of resource identity." - }, - "tenantId": { - "readOnly": true, - "type": "string", - "description": "The tenant ID of resource." - }, - "type": { - "type": "string", - "description": "Type of managed service identity.", - "enum": [ - "SystemAssigned", - "UserAssigned", - "None" - ], - "x-ms-enum": { - "name": "IdentityType", - "modelAsString": false - } - }, - "userAssignedIdentities": { - "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/UserIdentityProperties" - } - } - }, - "required": [ - "type" - ], - "type": "object", - "description": "Identity for the resource." - }, - "UserIdentityProperties": { - "type": "object", - "description": "User assigned identity properties.", - "properties": { - "principalId": { - "readOnly": true, - "description": "The principal id of user assigned identity.", - "type": "string" - }, - "clientId": { - "readOnly": true, - "description": "The client id of user assigned identity.", - "type": "string" - } - } - } - }, - "parameters": { - "RuleNameParameter": { - "name": "ruleName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the rule.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json deleted file mode 100644 index 95ce35186..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json +++ /dev/null @@ -1,862 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Tenant Action Groups API", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2023-05-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.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName}": { - "put": { - "description": "Create a new tenant action group or update an existing one.", - "operationId": "TenantActionGroups_CreateOrUpdate", - "x-ms-examples": { - "Create or update a tenant action group": { - "$ref": "./examples/createOrUpdateTenantActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ManagementGroupIdParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "#/parameters/TenantIdParameter" - }, - { - "name": "actionGroup", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TenantActionGroupResource" - }, - "description": "The tenant action group to create or use for the update." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "An existing tenant action group was successfully updated.", - "schema": { - "$ref": "#/definitions/TenantActionGroupResource" - } - }, - "201": { - "description": "A new tenant action group was successfully created.", - "schema": { - "$ref": "#/definitions/TenantActionGroupResource" - } - }, - "default": { - "description": "An error occurred and the tenant action group could not be created or updated.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "description": "Get a tenant action group.", - "operationId": "TenantActionGroups_Get", - "x-ms-examples": { - "Get an action group": { - "$ref": "./examples/getTenantActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ManagementGroupIdParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "#/parameters/TenantIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/TenantActionGroupResource" - } - }, - "default": { - "description": "An error occurred and the tenant action group could not be retrieved. 404: The tenant action group does not exist.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "description": "Delete a tenant action group.", - "operationId": "TenantActionGroups_Delete", - "x-ms-examples": { - "Delete a tenant action group": { - "$ref": "./examples/deleteTenantActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ManagementGroupIdParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "#/parameters/TenantIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The tenant action group was successfully deleted." - }, - "204": { - "description": "The tenant action group does not exist. It may have already been deleted." - }, - "default": { - "description": "An error occurred and the tenant action group could not be deleted.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "description": "Updates an existing tenant action group's tags. To update other fields use the CreateOrUpdate method.", - "operationId": "TenantActionGroups_Update", - "parameters": [ - { - "$ref": "#/parameters/ManagementGroupIdParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "#/parameters/TenantIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "tenantActionGroupPatch", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActionGroupPatchBody" - }, - "description": "Parameters supplied to the operation." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "An existing tenant action group was successfully updated.", - "schema": { - "$ref": "#/definitions/TenantActionGroupResource" - } - } - }, - "x-ms-examples": { - "Patch a tenant action group": { - "$ref": "./examples/patchTenantActionGroup.json" - } - } - } - }, - "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups": { - "get": { - "description": "Get a list of all tenant action groups in a management group.", - "operationId": "TenantActionGroups_ListByManagementGroupId", - "x-ms-examples": { - "List tenant action groups at management group level": { - "$ref": "./examples/listTenantActionGroups.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "parameters": [ - { - "$ref": "#/parameters/ManagementGroupIdParameter" - }, - { - "$ref": "#/parameters/TenantIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/TenantActionGroupList" - } - }, - "default": { - "description": "An error occurred and the list of tenant action groups could not be retrieved.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName}/createNotifications": { - "post": { - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "description": "Send test notifications to a set of provided receivers", - "operationId": "CreateNotificationsAtTenantActionGroupResourceLevel", - "x-ms-examples": { - "Create notifications at tenant action group level": { - "$ref": "./examples/postTestNotificationsAtTenantActionGroupResourceLevel.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ManagementGroupIdParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "#/parameters/TenantIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "notificationRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TenantNotificationRequestBody" - }, - "description": "The notification request body which includes the contact details" - } - ], - "responses": { - "202": { - "description": "The notification request accepted", - "headers": { - "location": { - "type": "string", - "description": "The location header that has the polling uri." - } - } - }, - "200": { - "description": "The notification succeeded", - "schema": { - "$ref": "#/definitions/TestNotificationDetailsResponse" - } - }, - "default": { - "description": "An error occurred while sending the test notifications", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName}/notificationStatus/{notificationId}": { - "get": { - "description": "Get the test notifications by the notification id", - "operationId": "GetTestNotificationsAtTenantActionGroupResourceLevel", - "x-ms-examples": { - "Get notification details at tenant action group level": { - "$ref": "./examples/getTestNotificationsAtTenantActionGroupResourceLevel.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ManagementGroupIdParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "#/parameters/TenantIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/NotificationIdParameter" - } - ], - "responses": { - "200": { - "description": "The notification details", - "schema": { - "$ref": "#/definitions/TestNotificationDetailsResponse" - } - }, - "default": { - "description": "An error occurred while sending the test notifications", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "AzureResource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Azure resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "additionalProperties": { - "type": "string" - }, - "type": "object", - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "type": "object", - "x-ms-azure-resource": true, - "description": "An azure resource object" - }, - "TenantNotificationRequestBody": { - "description": "The request body which contain contact detail metadata", - "type": "object", - "properties": { - "alertType": { - "type": "string", - "maxLength": 30, - "description": "The value of the supported alert type. Supported alert type value is: servicehealth" - }, - "emailReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/EmailReceiver" - }, - "description": "The list of email receivers that are part of this action group." - }, - "smsReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/SmsReceiver" - }, - "description": "The list of SMS receivers that are part of this action group." - }, - "webhookReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/WebhookReceiver" - }, - "description": "The list of webhook receivers that are part of this action group." - }, - "azureAppPushReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/AzureAppPushReceiver" - }, - "description": "The list of AzureAppPush receivers that are part of this action group." - }, - "voiceReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/VoiceReceiver" - }, - "description": "The list of voice receivers that are part of this action group." - } - }, - "required": [ - "alertType" - ] - }, - "TestNotificationDetailsResponse": { - "description": "The details of the test notification results.", - "type": "object", - "properties": { - "context": { - "type": "object", - "$ref": "#/definitions/Context" - }, - "state": { - "type": "string", - "description": "The overall state" - }, - "completedTime": { - "type": "string", - "description": "The completed time" - }, - "createdTime": { - "type": "string", - "description": "The created time" - }, - "actionDetails": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/ActionDetail" - }, - "description": "The list of action detail" - } - }, - "required": [ - "state" - ] - }, - "ActionDetail": { - "description": "The action detail", - "type": "object", - "properties": { - "mechanismType": { - "type": "string", - "description": "The mechanism type" - }, - "name": { - "type": "string", - "description": "The name of the action" - }, - "status": { - "type": "string", - "description": "The status of the action" - }, - "subState": { - "type": "string", - "description": "The substatus of the action" - }, - "sendTime": { - "type": "string", - "description": "The send time" - }, - "message": { - "type": "string", - "description": "The detail of the friendly error message" - } - } - }, - "Context": { - "description": "The context info", - "type": "object", - "properties": { - "notificationSource": { - "type": "string", - "description": "The source of the notification request" - }, - "contextType": { - "type": "string", - "description": "The context id type" - } - } - }, - "TenantActionGroupResource": { - "description": "A tenant action group resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AzureResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/TenantActionGroup", - "description": "The tenant action groups properties of the resource." - } - } - }, - "TenantActionGroupList": { - "description": "A list of tenant action groups.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TenantActionGroupResource" - }, - "description": "The list of tenant action groups." - }, - "nextLink": { - "type": "string", - "description": "Provides the link to retrieve the next set of elements." - } - } - }, - "TenantActionGroup": { - "description": "A tenant action group.", - "type": "object", - "properties": { - "groupShortName": { - "type": "string", - "maxLength": 12, - "description": "The short name of the action group. This will be used in SMS messages." - }, - "enabled": { - "type": "boolean", - "default": true, - "description": "Indicates whether this tenant action group is enabled. If a tenant action group is not enabled, then none of its receivers will receive communications." - }, - "emailReceivers": { - "x-ms-identifiers": [ - "emailAddress" - ], - "type": "array", - "items": { - "$ref": "#/definitions/EmailReceiver" - }, - "description": "The list of email receivers that are part of this tenant action group." - }, - "smsReceivers": { - "x-ms-identifiers": [ - "phoneNumber" - ], - "type": "array", - "items": { - "$ref": "#/definitions/SmsReceiver" - }, - "description": "The list of SMS receivers that are part of this tenant action group." - }, - "webhookReceivers": { - "x-ms-identifiers": [ - "name" - ], - "type": "array", - "items": { - "$ref": "#/definitions/WebhookReceiver" - }, - "description": "The list of webhook receivers that are part of this tenant action group." - }, - "azureAppPushReceivers": { - "x-ms-identifiers": [ - "emailAddress" - ], - "type": "array", - "items": { - "$ref": "#/definitions/AzureAppPushReceiver" - }, - "description": "The list of AzureAppPush receivers that are part of this tenant action group." - }, - "voiceReceivers": { - "x-ms-identifiers": [ - "phoneNumber" - ], - "type": "array", - "items": { - "$ref": "#/definitions/VoiceReceiver" - }, - "description": "The list of voice receivers that are part of this tenant action group." - } - }, - "required": [ - "groupShortName", - "enabled" - ] - }, - "EmailReceiver": { - "description": "An email receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the email receiver. Names must be unique across all receivers within a tenant action group." - }, - "emailAddress": { - "type": "string", - "description": "The email address of this receiver." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ReceiverStatus", - "description": "The receiver status of the e-mail." - } - }, - "required": [ - "name", - "emailAddress" - ] - }, - "SmsReceiver": { - "description": "An SMS receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the SMS receiver. Names must be unique across all receivers within a tenant action group." - }, - "countryCode": { - "type": "string", - "description": "The country code of the SMS receiver." - }, - "phoneNumber": { - "type": "string", - "description": "The phone number of the SMS receiver." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ReceiverStatus", - "description": "The status of the receiver." - } - }, - "required": [ - "name", - "countryCode", - "phoneNumber" - ] - }, - "WebhookReceiver": { - "description": "A webhook receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the webhook receiver. Names must be unique across all receivers within a tenant action group." - }, - "serviceUri": { - "type": "string", - "description": "The URI where webhooks should be sent." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - }, - "useAadAuth": { - "type": "boolean", - "default": false, - "description": "Indicates whether or not use AAD authentication." - }, - "objectId": { - "type": "string", - "description": "Indicates the webhook app object Id for aad auth." - }, - "identifierUri": { - "type": "string", - "description": "Indicates the identifier uri for aad auth." - }, - "tenantId": { - "type": "string", - "description": "Indicates the tenant id for aad auth." - } - }, - "required": [ - "name", - "serviceUri" - ] - }, - "AzureAppPushReceiver": { - "description": "The Azure mobile App push notification receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group." - }, - "emailAddress": { - "type": "string", - "description": "The email address registered for the Azure mobile app." - } - }, - "required": [ - "name", - "emailAddress" - ] - }, - "VoiceReceiver": { - "description": "A voice receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the voice receiver. Names must be unique across all receivers within a tenant action group." - }, - "countryCode": { - "type": "string", - "description": "The country code of the voice receiver." - }, - "phoneNumber": { - "type": "string", - "description": "The phone number of the voice receiver." - } - }, - "required": [ - "name", - "countryCode", - "phoneNumber" - ] - }, - "ReceiverStatus": { - "type": "string", - "enum": [ - "NotSpecified", - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "ReceiverStatus", - "modelAsString": false - }, - "description": "Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "ActionGroupPatchBody": { - "description": "A tenant action group object for the body of patch operations.", - "type": "object", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ActionGroupPatch", - "description": "The action group settings for an update operation." - } - } - }, - "ActionGroupPatch": { - "description": "A tenant action group for patch operations.", - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "default": true, - "description": "Indicates whether this tenant action group is enabled. If a tenant action group is not enabled, then none of its actions will be activated." - } - } - } - }, - "parameters": { - "ManagementGroupIdParameter": { - "name": "managementGroupId", - "in": "path", - "required": true, - "type": "string", - "description": "The management group id.", - "x-ms-parameter-location": "method" - }, - "ActionGroupNameParameter": { - "name": "tenantActionGroupName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z][A-Za-z0-9]*$", - "minLength": 1, - "maxLength": 260, - "description": "The name of the action group.", - "x-ms-parameter-location": "method" - }, - "NotificationIdParameter": { - "name": "notificationId", - "in": "path", - "required": true, - "type": "string", - "description": "The notification id", - "x-ms-parameter-location": "method" - }, - "TenantIdParameter": { - "name": "x-ms-client-tenant-id", - "in": "header", - "description": "The tenant ID of the client making the request.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/activityLogs_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/activityLogs_API.json deleted file mode 100644 index 5e645cee8..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +++ /dev/null @@ -1,348 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2015-04-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/eventtypes/management/values": { - "get": { - "tags": [ - "ActivityLogs" - ], - "operationId": "ActivityLogs_List", - "description": "Provides the list of records from the activity logs.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "$filter", - "in": "query", - "type": "string", - "required": true, - "description": "Reduces the set of data collected.
This argument is required and it also requires at least the start date/time.
The **$filter** argument is very restricted and allows only the following patterns.
- *List events for a resource group*: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and resourceGroupName eq 'resourceGroupName'.
- *List events for resource*: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and resourceUri eq 'resourceURI'.
- *List events for a subscription in a time range*: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z'.
- *List events for a resource provider*: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and resourceProvider eq 'resourceProviderName'.
- *List events for a correlation Id*: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and correlationId eq 'correlationID'.

**NOTE**: No other syntax is allowed." - }, - { - "$ref": "#/parameters/SelectParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get a page of events in the activity logs", - "schema": { - "$ref": "#/definitions/EventDataCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/EventData", - "x-ms-examples": { - "Get Activity Logs with filter": { - "$ref": "./examples/GetActivityLogsFiltered.json" - }, - "Get Activity Logs with filter and select": { - "$ref": "./examples/GetActivityLogsFilteredAndSelected.json" - } - } - } - } - }, - "definitions": { - "LocalizableString": { - "required": [ - "value" - ], - "properties": { - "value": { - "type": "string", - "description": "the invariant value." - }, - "localizedValue": { - "type": "string", - "description": "the locale specific value." - } - }, - "description": "The localizable string class." - }, - "SenderAuthorization": { - "properties": { - "action": { - "type": "string", - "description": "the permissible actions. For instance: microsoft.support/supporttickets/write" - }, - "role": { - "type": "string", - "description": "the role of the user. For instance: Subscription Admin" - }, - "scope": { - "type": "string", - "description": "the scope." - } - }, - "description": "the authorization used by the user who has performed the operation that led to this event. This captures the RBAC properties of the event. These usually include the 'action', 'role' and the 'scope'" - }, - "HttpRequestInfo": { - "properties": { - "clientRequestId": { - "type": "string", - "description": "the client request id." - }, - "clientIpAddress": { - "type": "string", - "description": "the client Ip Address" - }, - "method": { - "type": "string", - "description": "the Http request method." - }, - "uri": { - "type": "string", - "description": "the Uri." - } - }, - "description": "The Http request info." - }, - "EventData": { - "properties": { - "authorization": { - "readOnly": true, - "$ref": "#/definitions/SenderAuthorization", - "description": "The sender authorization information." - }, - "claims": { - "readOnly": true, - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "key value pairs to identify ARM permissions." - }, - "caller": { - "readOnly": true, - "type": "string", - "description": "the email address of the user who has performed the operation, the UPN claim or SPN claim based on availability." - }, - "description": { - "readOnly": true, - "type": "string", - "description": "the description of the event." - }, - "id": { - "readOnly": true, - "type": "string", - "description": "the Id of this event as required by ARM for RBAC. It contains the EventDataID and a timestamp information." - }, - "eventDataId": { - "readOnly": true, - "type": "string", - "description": "the event data Id. This is a unique identifier for an event." - }, - "correlationId": { - "readOnly": true, - "type": "string", - "description": "the correlation Id, usually a GUID in the string format. The correlation Id is shared among the events that belong to the same uber operation." - }, - "eventName": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "description": "the event name. This value should not be confused with OperationName. For practical purposes, OperationName might be more appealing to end users." - }, - "category": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "description": "the event category." - }, - "httpRequest": { - "readOnly": true, - "$ref": "#/definitions/HttpRequestInfo", - "description": "the HTTP request info. Usually includes the 'clientRequestId', 'clientIpAddress' (IP address of the user who initiated the event) and 'method' (HTTP method e.g. PUT)." - }, - "level": { - "readOnly": true, - "type": "string", - "description": "the event level", - "enum": [ - "Critical", - "Error", - "Warning", - "Informational", - "Verbose" - ], - "x-ms-enum": { - "name": "EventLevel", - "modelAsString": false - } - }, - "resourceGroupName": { - "readOnly": true, - "externalDocs": { - "url": "http://msdn.microsoft.com/en-us/library/azure/dn790546.aspx" - }, - "type": "string", - "description": "the resource group name of the impacted resource." - }, - "resourceProviderName": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "externalDocs": { - "url": "http://msdn.microsoft.com/en-us/library/azure/dn790572.aspx" - }, - "description": "the resource provider name of the impacted resource." - }, - "resourceId": { - "readOnly": true, - "externalDocs": { - "url": "http://msdn.microsoft.com/en-us/library/azure/dn790569.aspx" - }, - "type": "string", - "description": "the resource uri that uniquely identifies the resource that caused this event." - }, - "resourceType": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "externalDocs": { - "url": "http://msdn.microsoft.com/en-us/library/azure/dn790569.aspx" - }, - "description": "the resource type" - }, - "operationId": { - "readOnly": true, - "type": "string", - "description": "It is usually a GUID shared among the events corresponding to single operation. This value should not be confused with EventName." - }, - "operationName": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "description": "the operation name." - }, - "properties": { - "readOnly": true, - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "the set of pairs (usually a Dictionary) that includes details about the event." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "description": "a string describing the status of the operation. Some typical values are: Started, In progress, Succeeded, Failed, Resolved." - }, - "subStatus": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "description": "the event sub status. Most of the time, when included, this captures the HTTP status code of the REST call. Common values are: OK (HTTP Status Code: 200), Created (HTTP Status Code: 201), Accepted (HTTP Status Code: 202), No Content (HTTP Status Code: 204), Bad Request(HTTP Status Code: 400), Not Found (HTTP Status Code: 404), Conflict (HTTP Status Code: 409), Internal Server Error (HTTP Status Code: 500), Service Unavailable (HTTP Status Code:503), Gateway Timeout (HTTP Status Code: 504)" - }, - "eventTimestamp": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "the timestamp of when the event was generated by the Azure service processing the request corresponding the event. It in ISO 8601 format." - }, - "submissionTimestamp": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "the timestamp of when the event became available for querying via this API. It is in ISO 8601 format. This value should not be confused eventTimestamp. As there might be a delay between the occurrence time of the event, and the time that the event is submitted to the Azure logging infrastructure." - }, - "subscriptionId": { - "readOnly": true, - "type": "string", - "description": "the Azure subscription Id usually a GUID." - }, - "tenantId": { - "readOnly": true, - "type": "string", - "description": "the Azure tenant Id" - } - }, - "description": "The Azure event log entries are of type EventData" - }, - "EventDataCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/EventData" - }, - "description": "this list that includes the Azure audit logs." - }, - "nextLink": { - "type": "string", - "description": "Provides the link to retrieve the next set of events." - } - }, - "required": [ - "value" - ], - "description": "Represents collection of events." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - } - }, - "parameters": { - "SelectParameter": { - "name": "$select", - "in": "query", - "required": false, - "type": "string", - "description": "Used to fetch events with only the given properties.
The **$select** argument is a comma separated list of property names to be returned. Possible values are: *authorization*, *claims*, *correlationId*, *description*, *eventDataId*, *eventName*, *eventTimestamp*, *httpRequest*, *level*, *operationId*, *operationName*, *properties*, *resourceGroupName*, *resourceProviderName*, *resourceId*, *status*, *submissionTimestamp*, *subStatus*, *subscriptionId*", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json deleted file mode 100644 index d2bd9394f..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json +++ /dev/null @@ -1,891 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2015-04-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings": { - "get": { - "description": "Lists the autoscale settings for a resource group", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_ListByResourceGroup", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request for a list of autoscale settings", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResourceCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List autoscale settings": { - "$ref": "./examples/listAutoscaleSetting.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}": { - "put": { - "description": "Creates or updates an autoscale setting.", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - }, - "description": "Parameters supplied to the operation." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to create or update an autoscale setting", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - } - }, - "201": { - "description": "Created autoscale setting", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - } - } - }, - "x-ms-examples": { - "Create or update an autoscale setting": { - "$ref": "./examples/createOrUpdateAutoscaleSetting.json" - } - } - }, - "delete": { - "description": "Deletes and autoscale setting", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_Delete", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to delete an autoscale setting" - }, - "204": { - "description": "No content: Successful request to delete an autoscale setting, but the response is intentionally empty" - } - }, - "x-ms-examples": { - "Delete an autoscale setting": { - "$ref": "./examples/deleteAutoscaleSetting.json" - } - } - }, - "get": { - "description": "Gets an autoscale setting", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get one autoscale setting", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - } - } - }, - "x-ms-examples": { - "Get an autoscale setting": { - "$ref": "./examples/getAutoscaleSetting.json" - } - } - }, - "patch": { - "description": "Updates an existing AutoscaleSettingsResource. To update other fields use the CreateOrUpdate method.", - "operationId": "AutoscaleSettings_Update", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "autoscaleSettingResource", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AutoscaleSettingResourcePatch" - }, - "description": "Parameters supplied to the operation." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "An existing autoscale setting resource was successfully updated.", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - } - } - }, - "x-ms-examples": { - "Patch an autoscale setting": { - "$ref": "./examples/patchAutoscaleSetting.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/autoscalesettings": { - "get": { - "description": "Lists the autoscale settings for a subscription", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_ListBySubscription", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request for a list of autoscale settings", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResourceCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List autoscale settings": { - "$ref": "./examples/listAutoscaleSettingBySubscription.json" - } - } - } - } - }, - "definitions": { - "Resource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Azure resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true, - "description": "An azure resource object" - }, - "ScaleCapacity": { - "required": [ - "minimum", - "maximum", - "default" - ], - "properties": { - "minimum": { - "type": "string", - "description": "the minimum number of instances for the resource." - }, - "maximum": { - "type": "string", - "description": "the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription." - }, - "default": { - "type": "string", - "description": "the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default." - } - }, - "description": "The number of instances that can be used during this profile." - }, - "MetricTrigger": { - "required": [ - "metricName", - "metricResourceUri", - "timeGrain", - "statistic", - "timeWindow", - "timeAggregation", - "operator", - "threshold" - ], - "properties": { - "metricName": { - "type": "string", - "description": "the name of the metric that defines what the rule monitors." - }, - "metricNamespace": { - "type": "string", - "description": "the namespace of the metric that defines what the rule monitors." - }, - "metricResourceUri": { - "type": "string", - "description": "the resource identifier of the resource the rule monitors." - }, - "metricResourceLocation": { - "type": "string", - "description": "the location of the resource the rule monitors." - }, - "timeGrain": { - "type": "string", - "format": "duration", - "description": "the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute." - }, - "statistic": { - "type": "string", - "description": "the metric statistic type. How the metrics from multiple instances are combined.", - "enum": [ - "Average", - "Min", - "Max", - "Sum", - "Count" - ], - "x-ms-enum": { - "name": "MetricStatisticType", - "modelAsString": false - } - }, - "timeWindow": { - "type": "string", - "format": "duration", - "description": "the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes." - }, - "timeAggregation": { - "type": "string", - "description": "time aggregation type. How the data that is collected should be combined over time. The default value is Average.", - "enum": [ - "Average", - "Minimum", - "Maximum", - "Total", - "Count", - "Last" - ], - "x-ms-enum": { - "name": "TimeAggregationType", - "modelAsString": false - } - }, - "operator": { - "type": "string", - "description": "the operator that is used to compare the metric data and the threshold.", - "enum": [ - "Equals", - "NotEquals", - "GreaterThan", - "GreaterThanOrEqual", - "LessThan", - "LessThanOrEqual" - ], - "x-ms-enum": { - "name": "ComparisonOperationType", - "modelAsString": false - } - }, - "threshold": { - "type": "number", - "format": "double", - "description": "the threshold of the metric that triggers the scale action." - }, - "dimensions": { - "type": "array", - "items": { - "$ref": "#/definitions/ScaleRuleMetricDimension" - }, - "x-ms-identifiers": [ - "DimensionName" - ], - "description": "List of dimension conditions. For example: [{\"DimensionName\":\"AppName\",\"Operator\":\"Equals\",\"Values\":[\"App1\"]},{\"DimensionName\":\"Deployment\",\"Operator\":\"Equals\",\"Values\":[\"default\"]}]." - }, - "dividePerInstance": { - "type": "boolean", - "description": "a value indicating whether metric should divide per instance." - } - }, - "description": "The trigger that results in a scaling action." - }, - "ScaleAction": { - "required": [ - "direction", - "type", - "cooldown" - ], - "properties": { - "direction": { - "type": "string", - "description": "the scale direction. Whether the scaling action increases or decreases the number of instances.", - "enum": [ - "None", - "Increase", - "Decrease" - ], - "x-ms-enum": { - "name": "ScaleDirection", - "modelAsString": false - } - }, - "type": { - "type": "string", - "description": "the type of action that should occur when the scale rule fires.", - "enum": [ - "ChangeCount", - "PercentChangeCount", - "ExactCount", - "ServiceAllowedNextValue" - ], - "x-ms-enum": { - "name": "ScaleType", - "modelAsString": false - } - }, - "value": { - "type": "string", - "description": "the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1.", - "default": "1" - }, - "cooldown": { - "type": "string", - "format": "duration", - "description": "the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format." - } - }, - "description": "The parameters for the scaling action." - }, - "ScaleRule": { - "required": [ - "scaleAction", - "metricTrigger" - ], - "properties": { - "metricTrigger": { - "$ref": "#/definitions/MetricTrigger", - "description": "the trigger that results in a scaling action." - }, - "scaleAction": { - "$ref": "#/definitions/ScaleAction", - "description": "the parameters for the scaling action." - } - }, - "description": "A rule that provide the triggers and parameters for the scaling action." - }, - "TimeWindow": { - "properties": { - "timeZone": { - "type": "string", - "description": "the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time" - }, - "start": { - "type": "string", - "format": "date-time", - "description": "the start time for the profile in ISO 8601 format." - }, - "end": { - "type": "string", - "format": "date-time", - "description": "the end time for the profile in ISO 8601 format." - } - }, - "required": [ - "start", - "end" - ], - "description": "A specific date-time for the profile." - }, - "RecurrentSchedule": { - "required": [ - "timeZone", - "days", - "hours", - "minutes" - ], - "properties": { - "timeZone": { - "type": "string", - "description": "the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time" - }, - "days": { - "type": "array", - "items": { - "type": "string" - }, - "description": "the collection of days that the profile takes effect on. Possible values are Sunday through Saturday." - }, - "hours": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported)." - }, - "minutes": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "A collection of minutes at which the profile takes effect at." - } - }, - "description": "The scheduling constraints for when the profile begins." - }, - "Recurrence": { - "required": [ - "frequency", - "schedule" - ], - "properties": { - "frequency": { - "type": "string", - "description": "the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set **schedule** to every day of the week. The frequency property specifies that the schedule is repeated weekly.", - "enum": [ - "None", - "Second", - "Minute", - "Hour", - "Day", - "Week", - "Month", - "Year" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "schedule": { - "$ref": "#/definitions/RecurrentSchedule", - "description": "the scheduling constraints for when the profile begins." - } - }, - "description": "The repeating times at which this profile begins. This element is not used if the FixedDate element is used." - }, - "AutoscaleProfile": { - "required": [ - "rules", - "name", - "capacity" - ], - "properties": { - "name": { - "type": "string", - "description": "the name of the profile." - }, - "capacity": { - "$ref": "#/definitions/ScaleCapacity", - "description": "the number of instances that can be used during this profile." - }, - "rules": { - "type": "array", - "items": { - "$ref": "#/definitions/ScaleRule" - }, - "x-ms-identifiers": [ - "/metricTrigger/metricName" - ], - "description": "the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified." - }, - "fixedDate": { - "$ref": "#/definitions/TimeWindow", - "description": "the specific date-time for the profile. This element is not used if the Recurrence element is used." - }, - "recurrence": { - "$ref": "#/definitions/Recurrence", - "description": "the repeating times at which this profile begins. This element is not used if the FixedDate element is used." - } - }, - "description": "Autoscale profile." - }, - "EmailNotification": { - "properties": { - "sendToSubscriptionAdministrator": { - "type": "boolean", - "description": "a value indicating whether to send email to subscription administrator.", - "default": false - }, - "sendToSubscriptionCoAdministrators": { - "type": "boolean", - "description": "a value indicating whether to send email to subscription co-administrators.", - "default": false - }, - "customEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored." - } - }, - "description": "Email notification of an autoscale event." - }, - "WebhookNotification": { - "properties": { - "serviceUri": { - "type": "string", - "description": "the service address to receive the notification." - }, - "properties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "a property bag of settings. This value can be empty." - } - }, - "description": "Webhook notification of an autoscale event." - }, - "AutoscaleNotification": { - "required": [ - "operation" - ], - "properties": { - "operation": { - "type": "string", - "description": "the operation associated with the notification and its value must be \"scale\"", - "enum": [ - "Scale" - ], - "x-ms-enum": { - "name": "OperationType", - "modelAsString": false - } - }, - "email": { - "$ref": "#/definitions/EmailNotification", - "description": "the email notification." - }, - "webhooks": { - "type": "array", - "items": { - "$ref": "#/definitions/WebhookNotification" - }, - "x-ms-identifiers": [ - "serviceUri" - ], - "description": "the collection of webhook notifications." - } - }, - "description": "Autoscale notification." - }, - "AutoscaleSetting": { - "required": [ - "profiles" - ], - "properties": { - "profiles": { - "type": "array", - "maxItems": 20, - "items": { - "$ref": "#/definitions/AutoscaleProfile" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified." - }, - "notifications": { - "type": "array", - "items": { - "$ref": "#/definitions/AutoscaleNotification" - }, - "x-ms-identifiers": [], - "description": "the collection of notifications." - }, - "enabled": { - "type": "boolean", - "description": "the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'false'.", - "default": false - }, - "name": { - "type": "string", - "description": "the name of the autoscale setting." - }, - "targetResourceUri": { - "type": "string", - "description": "the resource identifier of the resource that the autoscale setting should be added to." - }, - "targetResourceLocation": { - "type": "string", - "description": "the location of the resource that the autoscale setting should be added to." - } - }, - "description": "A setting that contains all of the configuration for the automatic scaling of a resource." - }, - "AutoscaleSettingResource": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AutoscaleSetting", - "description": "The autoscale setting of the resource." - } - }, - "description": "The autoscale setting resource." - }, - "AutoscaleSettingResourcePatch": { - "description": "The autoscale setting object for patch operations.", - "properties": { - "tags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AutoscaleSetting", - "description": "The autoscale setting properties of the update operation." - } - } - }, - "AutoscaleSettingResourceCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AutoscaleSettingResource" - }, - "description": "the values for the autoscale setting resources." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of results." - } - }, - "required": [ - "value" - ], - "description": "Represents a collection of autoscale setting resources." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "ScaleRuleMetricDimension": { - "required": [ - "DimensionName", - "Operator", - "Values" - ], - "properties": { - "DimensionName": { - "type": "string", - "description": "Name of the dimension." - }, - "Operator": { - "type": "string", - "description": "the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values", - "enum": [ - "Equals", - "NotEquals" - ], - "x-ms-enum": { - "name": "ScaleRuleMetricDimensionOperationType", - "modelAsString": true - } - }, - "Values": { - "type": "array", - "items": { - "type": "string" - }, - "description": "list of dimension values. For example: [\"App1\",\"App2\"]." - } - }, - "description": "Specifies an auto scale rule metric dimension." - } - }, - "parameters": { - "AutoscaleSettingNameParameter": { - "name": "autoscaleSettingName", - "in": "path", - "required": true, - "type": "string", - "description": "The autoscale setting name.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/eventCategories_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/eventCategories_API.json deleted file mode 100644 index 700f8cd75..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +++ /dev/null @@ -1,126 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2015-04-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.Insights/eventcategories": { - "get": { - "tags": [ - "EventCategories" - ], - "operationId": "EventCategories_List", - "description": "Get the list of available event categories supported in the Activity Logs Service.
The current list includes the following: Administrative, Security, ServiceHealth, Alert, Recommendation, Policy.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get the list of event categories", - "schema": { - "$ref": "#/definitions/EventCategoryCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Get event categories": { - "$ref": "./examples/GetEventCategories.json" - } - } - } - } - }, - "definitions": { - "LocalizableString": { - "required": [ - "value" - ], - "properties": { - "value": { - "type": "string", - "description": "the invariant value." - }, - "localizedValue": { - "type": "string", - "description": "the locale specific value." - } - }, - "description": "The localizable string class." - }, - "EventCategoryCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/LocalizableString" - }, - "x-ms-identifiers": [ - "value" - ], - "description": "the list that includes the Azure event categories." - } - }, - "required": [ - "value" - ], - "description": "A collection of event categories. Currently possible values are: Administrative, Security, ServiceHealth, Alert, Recommendation, Policy." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json deleted file mode 100644 index de44ec195..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +++ /dev/null @@ -1,351 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2015-04-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.Insights/eventtypes/management/values": { - "get": { - "tags": [ - "TenantActivityLogs" - ], - "operationId": "TenantActivityLogs_List", - "description": "Gets the Activity Logs for the Tenant.
Everything that is applicable to the API to get the Activity Logs for the subscription is applicable to this API (the parameters, $filter, etc.).
One thing to point out here is that this API does *not* retrieve the logs at the individual subscription of the tenant but only surfaces the logs that were generated at the tenant level.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "$filter", - "in": "query", - "type": "string", - "required": false, - "description": "Reduces the set of data collected.
The **$filter** is very restricted and allows only the following patterns.
- List events for a resource group: $filter=eventTimestamp ge '' and eventTimestamp le '' and eventChannels eq 'Admin, Operation' and resourceGroupName eq ''.
- List events for resource: $filter=eventTimestamp ge '' and eventTimestamp le '' and eventChannels eq 'Admin, Operation' and resourceUri eq ''.
- List events for a subscription: $filter=eventTimestamp ge '' and eventTimestamp le '' and eventChannels eq 'Admin, Operation'.
- List events for a resource provider: $filter=eventTimestamp ge '' and eventTimestamp le '' and eventChannels eq 'Admin, Operation' and resourceProvider eq ''.
- List events for a correlation Id: api-version=2014-04-01&$filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and eventChannels eq 'Admin, Operation' and correlationId eq ''.
**NOTE**: No other syntax is allowed." - }, - { - "$ref": "#/parameters/SelectParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get a page of events in the tenant activity logs", - "schema": { - "$ref": "#/definitions/EventDataCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/EventData", - "x-ms-examples": { - "Get Tenant Activity Logs without filter or select": { - "$ref": "./examples/GetTenantActivityLogsNoParams.json" - }, - "Get Tenant Activity Logs with filter": { - "$ref": "./examples/GetTenantActivityLogsFiltered.json" - }, - "Get Tenant Activity Logs with select": { - "$ref": "./examples/GetTenantActivityLogsSelected.json" - }, - "Get Tenant Activity Logs with filter and select": { - "$ref": "./examples/GetTenantActivityLogsFilteredAndSelected.json" - } - } - } - } - }, - "definitions": { - "LocalizableString": { - "required": [ - "value" - ], - "properties": { - "value": { - "type": "string", - "description": "the invariant value." - }, - "localizedValue": { - "type": "string", - "description": "the locale specific value." - } - }, - "description": "The localizable string class." - }, - "SenderAuthorization": { - "properties": { - "action": { - "type": "string", - "description": "the permissible actions. For instance: microsoft.support/supporttickets/write" - }, - "role": { - "type": "string", - "description": "the role of the user. For instance: Subscription Admin" - }, - "scope": { - "type": "string", - "description": "the scope." - } - }, - "description": "the authorization used by the user who has performed the operation that led to this event. This captures the RBAC properties of the event. These usually include the 'action', 'role' and the 'scope'" - }, - "HttpRequestInfo": { - "properties": { - "clientRequestId": { - "type": "string", - "description": "the client request id." - }, - "clientIpAddress": { - "type": "string", - "description": "the client Ip Address" - }, - "method": { - "type": "string", - "description": "the Http request method." - }, - "uri": { - "type": "string", - "description": "the Uri." - } - }, - "description": "The Http request info." - }, - "EventData": { - "properties": { - "authorization": { - "readOnly": true, - "$ref": "#/definitions/SenderAuthorization", - "description": "The sender authorization information." - }, - "claims": { - "readOnly": true, - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "key value pairs to identify ARM permissions." - }, - "caller": { - "readOnly": true, - "type": "string", - "description": "the email address of the user who has performed the operation, the UPN claim or SPN claim based on availability." - }, - "description": { - "readOnly": true, - "type": "string", - "description": "the description of the event." - }, - "id": { - "readOnly": true, - "type": "string", - "description": "the Id of this event as required by ARM for RBAC. It contains the EventDataID and a timestamp information." - }, - "eventDataId": { - "readOnly": true, - "type": "string", - "description": "the event data Id. This is a unique identifier for an event." - }, - "correlationId": { - "readOnly": true, - "type": "string", - "description": "the correlation Id, usually a GUID in the string format. The correlation Id is shared among the events that belong to the same uber operation." - }, - "eventName": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "description": "the event name. This value should not be confused with OperationName. For practical purposes, OperationName might be more appealing to end users." - }, - "category": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "description": "the event category." - }, - "httpRequest": { - "readOnly": true, - "$ref": "#/definitions/HttpRequestInfo", - "description": "the HTTP request info. Usually includes the 'clientRequestId', 'clientIpAddress' (IP address of the user who initiated the event) and 'method' (HTTP method e.g. PUT)." - }, - "level": { - "readOnly": true, - "type": "string", - "description": "the event level", - "enum": [ - "Critical", - "Error", - "Warning", - "Informational", - "Verbose" - ], - "x-ms-enum": { - "name": "EventLevel", - "modelAsString": false - } - }, - "resourceGroupName": { - "readOnly": true, - "externalDocs": { - "url": "http://msdn.microsoft.com/en-us/library/azure/dn790546.aspx" - }, - "type": "string", - "description": "the resource group name of the impacted resource." - }, - "resourceProviderName": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "externalDocs": { - "url": "http://msdn.microsoft.com/en-us/library/azure/dn790572.aspx" - }, - "description": "the resource provider name of the impacted resource." - }, - "resourceId": { - "readOnly": true, - "externalDocs": { - "url": "http://msdn.microsoft.com/en-us/library/azure/dn790569.aspx" - }, - "type": "string", - "description": "the resource uri that uniquely identifies the resource that caused this event." - }, - "resourceType": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "externalDocs": { - "url": "http://msdn.microsoft.com/en-us/library/azure/dn790569.aspx" - }, - "description": "the resource type" - }, - "operationId": { - "readOnly": true, - "type": "string", - "description": "It is usually a GUID shared among the events corresponding to single operation. This value should not be confused with EventName." - }, - "operationName": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "description": "the operation name." - }, - "properties": { - "readOnly": true, - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "the set of pairs (usually a Dictionary) that includes details about the event." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "description": "a string describing the status of the operation. Some typical values are: Started, In progress, Succeeded, Failed, Resolved." - }, - "subStatus": { - "readOnly": true, - "$ref": "#/definitions/LocalizableString", - "description": "the event sub status. Most of the time, when included, this captures the HTTP status code of the REST call. Common values are: OK (HTTP Status Code: 200), Created (HTTP Status Code: 201), Accepted (HTTP Status Code: 202), No Content (HTTP Status Code: 204), Bad Request(HTTP Status Code: 400), Not Found (HTTP Status Code: 404), Conflict (HTTP Status Code: 409), Internal Server Error (HTTP Status Code: 500), Service Unavailable (HTTP Status Code:503), Gateway Timeout (HTTP Status Code: 504)" - }, - "eventTimestamp": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "the timestamp of when the event was generated by the Azure service processing the request corresponding the event. It in ISO 8601 format." - }, - "submissionTimestamp": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "the timestamp of when the event became available for querying via this API. It is in ISO 8601 format. This value should not be confused eventTimestamp. As there might be a delay between the occurrence time of the event, and the time that the event is submitted to the Azure logging infrastructure." - }, - "subscriptionId": { - "readOnly": true, - "type": "string", - "description": "the Azure subscription Id usually a GUID." - }, - "tenantId": { - "readOnly": true, - "type": "string", - "description": "the Azure tenant Id" - } - }, - "description": "The Azure event log entries are of type EventData" - }, - "EventDataCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/EventData" - }, - "description": "this list that includes the Azure audit logs." - }, - "nextLink": { - "type": "string", - "description": "Provides the link to retrieve the next set of events." - } - }, - "required": [ - "value" - ], - "description": "Represents collection of events." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - } - }, - "parameters": { - "SelectParameter": { - "name": "$select", - "in": "query", - "required": false, - "type": "string", - "description": "Used to fetch events with only the given properties.
The **$select** argument is a comma separated list of property names to be returned. Possible values are: *authorization*, *claims*, *correlationId*, *description*, *eventDataId*, *eventName*, *eventTimestamp*, *httpRequest*, *level*, *operationId*, *operationName*, *properties*, *resourceGroupName*, *resourceProviderName*, *resourceId*, *status*, *submissionTimestamp*, *subStatus*, *subscriptionId*", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json deleted file mode 100644 index b9a0af81d..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +++ /dev/null @@ -1,201 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2016-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/alertrules/{ruleName}/incidents/{incidentName}": { - "get": { - "description": "Gets an incident associated to an alert rule", - "tags": [ - "AlertRuleIncidents" - ], - "operationId": "AlertRuleIncidents_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "name": "incidentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the incident to retrieve." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request for one alert rule related incident", - "schema": { - "$ref": "#/definitions/Incident" - } - } - }, - "x-ms-examples": { - "Get a single alert rule incident": { - "$ref": "./examples/getAlertRuleIncident.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/alertrules/{ruleName}/incidents": { - "get": { - "description": "Gets a list of incidents associated to an alert rule", - "tags": [ - "AlertRuleIncidents" - ], - "operationId": "AlertRuleIncidents_ListByAlertRule", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successful request for a list of alert rule related incidents", - "schema": { - "$ref": "#/definitions/IncidentListResult" - } - } - }, - "x-ms-examples": { - "List alert rule incidents": { - "$ref": "./examples/listAlertRuleIncidents.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - } - }, - "definitions": { - "Incident": { - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Incident name." - }, - "ruleName": { - "readOnly": true, - "type": "string", - "description": "Rule name that is associated with the incident." - }, - "isActive": { - "readOnly": true, - "type": "boolean", - "description": "A boolean to indicate whether the incident is active or resolved." - }, - "activatedTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "The time at which the incident was activated in ISO8601 format." - }, - "resolvedTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "The time at which the incident was resolved in ISO8601 format. If null, it means the incident is still active." - } - }, - "description": "An alert incident indicates the activation status of an alert rule." - }, - "IncidentListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Incident" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "the incident collection." - } - }, - "description": "The List incidents operation response." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - } - }, - "parameters": { - "RuleNameParameter": { - "name": "ruleName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the rule.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/alertRules_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/alertRules_API.json deleted file mode 100644 index 1f43a284f..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/alertRules_API.json +++ /dev/null @@ -1,779 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2016-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}": { - "put": { - "description": "Creates or updates a classic metric alert rule.", - "tags": [ - "AlertRules" - ], - "operationId": "AlertRules_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AlertRuleResource" - }, - "description": "The parameters of the rule to create or update." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to update an alert rule", - "schema": { - "$ref": "#/definitions/AlertRuleResource" - } - }, - "201": { - "description": "Created alert rule", - "schema": { - "$ref": "#/definitions/AlertRuleResource" - } - } - }, - "x-ms-examples": { - "Create or update an alert rule": { - "$ref": "./examples/createOrUpdateAlertRule.json" - } - } - }, - "delete": { - "description": "Deletes a classic metric alert rule", - "tags": [ - "AlertRules" - ], - "operationId": "AlertRules_Delete", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content: the request was successful, but the response is empty" - }, - "200": { - "description": "Successful request to delete an alert rule" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete an alert rule": { - "$ref": "./examples/deleteAlertRule.json" - } - } - }, - "get": { - "description": "Gets a classic metric alert rule", - "tags": [ - "AlertRules" - ], - "operationId": "AlertRules_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successful request to get an alert rule", - "schema": { - "$ref": "#/definitions/AlertRuleResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get an alert rule": { - "$ref": "./examples/getAlertRule.json" - } - } - }, - "patch": { - "description": "Updates an existing classic metric AlertRuleResource. To update other fields use the CreateOrUpdate method.", - "operationId": "AlertRules_Update", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "alertRulesResource", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AlertRuleResourcePatch" - }, - "description": "Parameters supplied to the operation." - } - ], - "responses": { - "200": { - "description": "Successful request to update an alert rule", - "schema": { - "$ref": "#/definitions/AlertRuleResource" - } - }, - "201": { - "description": "Successful request to update an alert rule that resulted in a creation of the alert rule", - "schema": { - "$ref": "#/definitions/AlertRuleResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Patch an alert rule": { - "$ref": "./examples/patchAlertRule.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules": { - "get": { - "tags": [ - "AlertRules" - ], - "operationId": "AlertRules_ListByResourceGroup", - "description": "List the classic metric alert rules within a resource group.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successful request for a list of alert rules", - "schema": { - "$ref": "#/definitions/AlertRuleResourceCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "List alert rules": { - "$ref": "./examples/listAlertRule.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/alertrules": { - "get": { - "tags": [ - "AlertRules" - ], - "operationId": "AlertRules_ListBySubscription", - "description": "List the classic metric alert rules within a subscription.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successful request for a list of alert rules", - "schema": { - "$ref": "#/definitions/AlertRuleResourceCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "List alert rules": { - "$ref": "./examples/listAlertRuleBySubscription.json" - } - } - } - } - }, - "definitions": { - "RuleCondition": { - "type": "object", - "discriminator": "odata.type", - "properties": { - "odata.type": { - "type": "string", - "description": "specifies the type of condition. This can be one of three types: ManagementEventRuleCondition (occurrences of management events), LocationThresholdRuleCondition (based on the number of failures of a web test), and ThresholdRuleCondition (based on the threshold of a metric)." - }, - "dataSource": { - "$ref": "#/definitions/RuleDataSource", - "description": "the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource." - } - }, - "required": [ - "odata.type" - ], - "description": "The condition that results in the alert rule being activated." - }, - "RuleDataSource": { - "type": "object", - "discriminator": "odata.type", - "properties": { - "odata.type": { - "type": "string", - "description": "specifies the type of data source. There are two types of rule data sources: RuleMetricDataSource and RuleManagementEventDataSource" - }, - "resourceUri": { - "type": "string", - "description": "the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule." - }, - "legacyResourceId": { - "type": "string", - "description": "the legacy resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule." - }, - "resourceLocation": { - "type": "string", - "description": "the location of the resource." - }, - "metricNamespace": { - "type": "string", - "description": "the namespace of the metric." - } - }, - "required": [ - "odata.type" - ], - "description": "The resource from which the rule collects its data." - }, - "RuleMetricDataSource": { - "x-ms-discriminator-value": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/RuleDataSource" - } - ], - "properties": { - "metricName": { - "type": "string", - "description": "the name of the metric that defines what the rule monitors." - } - }, - "description": "A rule metric data source. The discriminator value is always RuleMetricDataSource in this case." - }, - "RuleManagementEventClaimsDataSource": { - "properties": { - "emailAddress": { - "type": "string", - "description": "the email address." - } - }, - "description": "The claims for a rule management event data source." - }, - "RuleManagementEventDataSource": { - "x-ms-discriminator-value": "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/RuleDataSource" - } - ], - "properties": { - "eventName": { - "type": "string", - "description": "the event name." - }, - "eventSource": { - "type": "string", - "description": "the event source." - }, - "level": { - "type": "string", - "description": "the level." - }, - "operationName": { - "type": "string", - "description": "The name of the operation that should be checked for. If no name is provided, any operation will match." - }, - "resourceGroupName": { - "type": "string", - "description": "the resource group name." - }, - "resourceProviderName": { - "type": "string", - "description": "the resource provider name." - }, - "status": { - "type": "string", - "description": "The status of the operation that should be checked for. If no status is provided, any status will match." - }, - "subStatus": { - "type": "string", - "description": "the substatus." - }, - "claims": { - "$ref": "#/definitions/RuleManagementEventClaimsDataSource", - "description": "the claims." - } - }, - "description": "A rule management event data source. The discriminator fields is always RuleManagementEventDataSource in this case." - }, - "ConditionOperator": { - "type": "string", - "enum": [ - "GreaterThan", - "GreaterThanOrEqual", - "LessThan", - "LessThanOrEqual" - ], - "x-ms-enum": { - "name": "ConditionOperator", - "modelAsString": false - }, - "description": "Operators allowed in the rule condition." - }, - "TimeAggregationOperator": { - "type": "string", - "enum": [ - "Average", - "Minimum", - "Maximum", - "Total", - "Last" - ], - "x-ms-enum": { - "name": "TimeAggregationOperator", - "modelAsString": false - }, - "description": "Aggregation operators allowed in a rule." - }, - "ThresholdRuleCondition": { - "x-ms-discriminator-value": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/RuleCondition" - } - ], - "required": [ - "threshold", - "operator" - ], - "properties": { - "operator": { - "$ref": "#/definitions/ConditionOperator", - "description": "the operator used to compare the data and the threshold." - }, - "threshold": { - "type": "number", - "format": "double", - "description": "the threshold value that activates the alert." - }, - "windowSize": { - "type": "string", - "format": "duration", - "description": "the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day." - }, - "timeAggregation": { - "$ref": "#/definitions/TimeAggregationOperator", - "description": "the time aggregation operator. How the data that are collected should be combined over time. The default value is the PrimaryAggregationType of the Metric." - } - }, - "description": "A rule condition based on a metric crossing a threshold.", - "example": "\"condition\": {\r\n\t\"odata.type\": \"Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition\",\r\n\t\"dataSource\": {\r\n\t\"odata.type\": \"Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource\",\r\n\t\"resourceUri\":\r\n\t\"/subscriptions/089bd33f-d4ec-47fe-8ba5-0753aa5c5b33/resourceGroups/Default-Storage-NorthCentralUS/providers/Microsoft.Web/serverfarms/Plan\",\r\n\t\"metricName\": \"CpuPercentage\",\r\n\t\"operator\": \"GreaterThan\"\r\n\t},\r\n\t\"threshold\": 90,\r\n\t\"windowSize\": \"PT15M\",\r\n\t\"timeAggregation\": \"Average\"}" - }, - "LocationThresholdRuleCondition": { - "x-ms-discriminator-value": "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/RuleCondition" - } - ], - "properties": { - "windowSize": { - "type": "string", - "format": "duration", - "description": "the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day." - }, - "failedLocationCount": { - "type": "integer", - "format": "int32", - "minimum": 0, - "description": "the number of locations that must fail to activate the alert." - } - }, - "required": [ - "failedLocationCount" - ], - "description": "A rule condition based on a certain number of locations failing.", - "example": "{\r\n\t\"odata.type\": \"Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition\",\r\n\t\"dataSource\": {\r\n\t\t\"odata.type\": \"Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource\",\r\n\t\t\"resourceUri\": \"/subscriptions/089bd33f-d4ec-47fe-8ba5-0753aa5c5b33/resourcegroups/Default-Web-CentralUS/providers/microsoft.insights/webtests/homepagetest-newrelapp2\",r\n\t\t\"metricName\": \"GSMT_AvRaW\"\r\n\t},\r\n\t\"windowSize\": \"PT5M\",\r\n\t\"failedLocationCount\": 1\r\n}" - }, - "ManagementEventAggregationCondition": { - "properties": { - "operator": { - "$ref": "#/definitions/ConditionOperator", - "description": "the condition operator." - }, - "threshold": { - "type": "number", - "format": "double", - "description": "The threshold value that activates the alert." - }, - "windowSize": { - "type": "string", - "format": "duration", - "description": "the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day." - } - }, - "description": "How the data that is collected should be combined over time." - }, - "ManagementEventRuleCondition": { - "x-ms-discriminator-value": "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/RuleCondition" - } - ], - "properties": { - "aggregation": { - "$ref": "#/definitions/ManagementEventAggregationCondition", - "description": "How the data that is collected should be combined over time and when the alert is activated. Note that for management event alerts aggregation is optional – if it is not provided then any event will cause the alert to activate." - } - }, - "description": "A management event rule condition.", - "example": "{\r\n\t\"odata.type\": \"Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition\",\r\n\t\"dataSource\": {\r\n\t\t\"odata.type\": \"Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource\",\r\n\t\t\"operationName\": \"\",\r\n\t\t\"resourceUri\": \"/subscriptions/089bd33f-d4ec-47fe-8ba5-0753aa5c5b33/resourceGroups/Default-Web-CentralUS/providers/Microsoft.Web/sites/TestLatestWebsite\",\r\n\t\t\"status\": \"failed\",\r\n\t\t\"claims\": { }\r\n\t},\r\n\t\"aggregation\": {\r\n\t\t\"threshold\": 1,\r\n\t\t\"windowSize\": \"PT5M\"\r\n\t}\r\n}" - }, - "RuleAction": { - "type": "object", - "discriminator": "odata.type", - "properties": { - "odata.type": { - "type": "string", - "description": "specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction." - } - }, - "required": [ - "odata.type" - ], - "description": "The action that is performed when the alert rule becomes active, and when an alert condition is resolved." - }, - "RuleEmailAction": { - "x-ms-discriminator-value": "Microsoft.Azure.Management.Insights.Models.RuleEmailAction", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/RuleAction" - } - ], - "properties": { - "sendToServiceOwners": { - "type": "boolean", - "description": "Whether the administrators (service and co-administrators) of the service should be notified when the alert is activated." - }, - "customEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "the list of administrator's custom email addresses to notify of the activation of the alert." - } - }, - "description": "Specifies the action to send email when the rule condition is evaluated. The discriminator is always RuleEmailAction in this case.", - "example": "{\r\n\t\"odata.type\": \"Microsoft.Azure.Management.Insights.Models.RuleEmailAction\",\r\n\t\"sendToServiceOwners\": true,\r\n\t\"customEmails\": [\"email1@contoso.com\",\"email2@contoso.com\" ]\r\n}" - }, - "RuleWebhookAction": { - "x-ms-discriminator-value": "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/RuleAction" - } - ], - "properties": { - "serviceUri": { - "type": "string", - "description": "the service uri to Post the notification when the alert activates or resolves." - }, - "properties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload." - } - }, - "description": "Specifies the action to post to service when the rule condition is evaluated. The discriminator is always RuleWebhookAction in this case.", - "example": "{\r\n\t\"odata.type\": \"Microsoft.Azure.Management.Insights.Models.RuleWebhookAction\",\r\n\t\"serviceUri\": \"http://contoso.com/\",\r\n\t\"properties\": { }\r\n}" - }, - "AlertRule": { - "required": [ - "name", - "isEnabled", - "condition" - ], - "properties": { - "name": { - "type": "string", - "description": "the name of the alert rule." - }, - "description": { - "type": "string", - "description": "the description of the alert rule that will be included in the alert email." - }, - "provisioningState": { - "type": "string", - "description": "the provisioning state." - }, - "isEnabled": { - "type": "boolean", - "description": "the flag that indicates whether the alert rule is enabled." - }, - "condition": { - "$ref": "#/definitions/RuleCondition", - "description": "the condition that results in the alert rule being activated." - }, - "action": { - "$ref": "#/definitions/RuleAction", - "description": "action that is performed when the alert rule becomes active, and when an alert condition is resolved." - }, - "actions": { - "type": "array", - "items": { - "$ref": "#/definitions/RuleAction" - }, - "x-ms-identifiers": [], - "description": "the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved." - }, - "lastUpdatedTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "Last time the rule was updated in ISO8601 format." - } - }, - "description": "An alert rule." - }, - "Resource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Azure resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true, - "description": "An azure resource object" - }, - "AlertRuleResource": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AlertRule", - "description": "The alert rule properties of the resource." - } - }, - "description": "The alert rule resource." - }, - "AlertRuleResourcePatch": { - "description": "The alert rule object for patch operations.", - "properties": { - "tags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AlertRule", - "description": "The properties of an alert rule." - } - } - }, - "AlertRuleResourceCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AlertRuleResource" - }, - "description": "the values for the alert rule resources." - } - }, - "description": "Represents a collection of alert rule resources." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - } - }, - "parameters": { - "RuleNameParameter": { - "name": "ruleName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the rule.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/logProfiles_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/logProfiles_API.json deleted file mode 100644 index dd7c6175f..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +++ /dev/null @@ -1,392 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2016-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/logprofiles/{logProfileName}": { - "delete": { - "tags": [ - "LogProfiles" - ], - "operationId": "LogProfiles_Delete", - "description": "Deletes the log profile.", - "parameters": [ - { - "$ref": "#/parameters/LogProfileNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successful request to delete a log profile" - } - }, - "x-ms-examples": { - "Delete log profile": { - "$ref": "./examples/deleteLogProfile.json" - } - } - }, - "get": { - "tags": [ - "LogProfiles" - ], - "operationId": "LogProfiles_Get", - "description": "Gets the log profile.", - "parameters": [ - { - "$ref": "#/parameters/LogProfileNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get more information about a log profile.", - "schema": { - "$ref": "#/definitions/LogProfileResource" - } - } - }, - "x-ms-examples": { - "Get log profile": { - "$ref": "./examples/getLogProfile.json" - } - } - }, - "put": { - "tags": [ - "LogProfiles" - ], - "operationId": "LogProfiles_CreateOrUpdate", - "description": "Create or update a log profile in Azure Monitoring REST API.", - "parameters": [ - { - "$ref": "#/parameters/LogProfileNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/LogProfileResource" - }, - "description": "Parameters supplied to the operation." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successful request to create or update a log profile", - "schema": { - "$ref": "#/definitions/LogProfileResource" - } - } - }, - "x-ms-examples": { - "Create or update a log profile": { - "$ref": "./examples/createOrUpdateLogProfile.json" - } - } - }, - "patch": { - "description": "Updates an existing LogProfilesResource. To update other fields use the CreateOrUpdate method.", - "operationId": "LogProfiles_Update", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/LogProfileNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "logProfilesResource", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/LogProfileResourcePatch" - }, - "description": "Parameters supplied to the operation." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "An existing log profile was successfully updated.", - "schema": { - "$ref": "#/definitions/LogProfileResource" - } - } - }, - "x-ms-examples": { - "Patch a log profile": { - "$ref": "./examples/patchLogProfile.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/logprofiles": { - "get": { - "tags": [ - "LogProfiles" - ], - "operationId": "LogProfiles_List", - "description": "List the log profiles.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successful request to list log profiles", - "schema": { - "$ref": "#/definitions/LogProfileCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "List log profiles": { - "$ref": "./examples/listLogProfile.json" - } - } - } - } - }, - "definitions": { - "Resource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Azure resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true, - "description": "An azure resource object" - }, - "RetentionPolicy": { - "properties": { - "enabled": { - "type": "boolean", - "description": "a value indicating whether the retention policy is enabled." - }, - "days": { - "type": "integer", - "format": "int32", - "minimum": 0, - "description": "the number of days for the retention in days. A value of 0 will retain the events indefinitely." - } - }, - "required": [ - "enabled", - "days" - ], - "description": "Specifies the retention policy for the log." - }, - "LogProfileProperties": { - "required": [ - "locations", - "categories", - "retentionPolicy" - ], - "properties": { - "storageAccountId": { - "type": "string", - "description": "the resource id of the storage account to which you would like to send the Activity Log." - }, - "serviceBusRuleId": { - "type": "string", - "description": "The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming the Activity Log. The rule ID is of the format: '{service bus resource ID}/authorizationrules/{key name}'." - }, - "locations": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of regions for which Activity Log events should be stored or streamed. It is a comma separated list of valid ARM locations including the 'global' location." - }, - "categories": { - "type": "array", - "items": { - "type": "string" - }, - "description": "the categories of the logs. These categories are created as is convenient to the user. Some values are: 'Write', 'Delete', and/or 'Action.'" - }, - "retentionPolicy": { - "$ref": "#/definitions/RetentionPolicy", - "description": "the retention policy for the events in the log." - } - }, - "description": "The log profile properties." - }, - "LogProfileResource": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/LogProfileProperties", - "description": "The log profile properties of the resource." - } - }, - "required": [ - "properties" - ], - "description": "The log profile resource." - }, - "LogProfileResourcePatch": { - "description": "The log profile resource for patch operations.", - "properties": { - "tags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/LogProfileProperties", - "description": "The log profile properties for an update operation." - } - } - }, - "LogProfileCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/LogProfileResource" - }, - "description": "the values of the log profiles." - } - }, - "required": [ - "value" - ], - "description": "Represents a collection of log profiles." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - } - }, - "parameters": { - "LogProfileNameParameter": { - "name": "logProfileName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the log profile.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/metricDefinitions_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/metricDefinitions_API.json deleted file mode 100644 index a559365e7..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/metricDefinitions_API.json +++ /dev/null @@ -1,293 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorClient", - "version": "2016-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/{resourceUri}/providers/microsoft.insights/metricDefinitions": { - "get": { - "tags": [ - "MetricDefinitions" - ], - "operationId": "MetricDefinitions_List", - "description": "Lists the metric definitions for the resource.", - "parameters": [ - { - "$ref": "#/parameters/ResourceUriParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "$filter", - "in": "query", - "type": "string", - "description": "Reduces the set of data collected by retrieving particular metric definitions from all the definitions available for the resource.
For example, to get just the definition for the 'CPU percentage' counter: $filter=name.value eq '\\Processor(_Total)\\% Processor Time'.
Multiple metrics can be retrieved by joining together *'name eq '* clauses separated by *or* logical operators.
**NOTE**: No other syntax is allowed.", - "required": false - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get the list of metric definitions", - "schema": { - "$ref": "#/definitions/MetricDefinitionCollection" - }, - "examples": { - "application/json": { - "value": [ - { - "resourceId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/andy0802australia/providers/Microsoft.Logic/workflows/andy0803australia", - "name": { - "value": "RunsStarted", - "localizedValue": "Runs Started" - }, - "unit": "Count", - "primaryAggregationType": "Total", - "metricAvailabilities": [ - { - "timeGrain": "PT1M", - "retention": "P30D" - }, - { - "timeGrain": "PT1H", - "retention": "P30D" - } - ], - "id": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/andy0802australia/providers/Microsoft.Logic/workflows/andy0803australia/providers/microsoft.insights/metricdefinitions/RunsStarted" - }, - { - "resourceId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/andy0802australia/providers/Microsoft.Logic/workflows/andy0803australia", - "name": { - "value": "RunsCompleted", - "localizedValue": "Runs Completed" - }, - "unit": "Count", - "primaryAggregationType": "Total", - "metricAvailabilities": [ - { - "timeGrain": "PT1M", - "retention": "P30D" - }, - { - "timeGrain": "PT1H", - "retention": "P30D" - } - ], - "id": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/andy0802australia/providers/Microsoft.Logic/workflows/andy0803australia/providers/microsoft.insights/metricdefinitions/RunsCompleted" - }, - { - "resourceId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/andy0802australia/providers/Microsoft.Logic/workflows/andy0803australia", - "name": { - "value": "RunsSucceeded", - "localizedValue": "Runs Succeeded" - }, - "unit": "Count", - "primaryAggregationType": "Total", - "metricAvailabilities": [ - { - "timeGrain": "PT1M", - "retention": "P30D" - }, - { - "timeGrain": "PT1H", - "retention": "P30D" - } - ], - "id": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/andy0802australia/providers/Microsoft.Logic/workflows/andy0803australia/providers/microsoft.insights/metricdefinitions/RunsSucceeded" - } - ] - } - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-odata": "#/definitions/MetricDefinition", - "x-ms-examples": { - "Get Metric Definitions without filter": { - "$ref": "./examples/GetMetricDefinitions.json" - }, - "Get Metric Definitions with filter": { - "$ref": "./examples/GetMetricDefinitionsFiltered.json" - } - } - } - } - }, - "definitions": { - "LocalizableString": { - "required": [ - "value" - ], - "properties": { - "value": { - "type": "string", - "description": "the invariant value." - }, - "localizedValue": { - "type": "string", - "description": "the locale specific value." - } - }, - "description": "The localizable string class." - }, - "MetricAvailability": { - "properties": { - "timeGrain": { - "type": "string", - "format": "duration", - "description": "the time grain specifies the aggregation interval for the metric. Expressed as a duration 'PT1M', 'P1D', etc." - }, - "retention": { - "type": "string", - "format": "duration", - "description": "the retention period for the metric at the specified timegrain. Expressed as a duration 'PT1M', 'P1D', etc." - } - }, - "description": "Metric availability specifies the time grain (aggregation interval or frequency) and the retention period for that time grain." - }, - "Unit": { - "type": "string", - "description": "The unit of the metric.", - "enum": [ - "Count", - "Bytes", - "Seconds", - "CountPerSecond", - "BytesPerSecond", - "Percent", - "MilliSeconds", - "ByteSeconds", - "Unspecified", - "Cores", - "MilliCores", - "NanoCores", - "BitsPerSecond" - ], - "x-ms-enum": { - "name": "Unit", - "modelAsString": false - } - }, - "MetricDefinition": { - "properties": { - "resourceId": { - "type": "string", - "description": "the resource identifier of the resource that emitted the metric." - }, - "name": { - "$ref": "#/definitions/LocalizableString", - "description": "the name and the display name of the metric, i.e. it is a localizable string." - }, - "unit": { - "$ref": "#/definitions/Unit", - "description": "the unit of the metric." - }, - "primaryAggregationType": { - "type": "string", - "description": "the primary aggregation type value defining how to use the values for display.", - "enum": [ - "None", - "Average", - "Count", - "Minimum", - "Maximum", - "Total" - ], - "x-ms-enum": { - "name": "AggregationType", - "modelAsString": false - } - }, - "metricAvailabilities": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricAvailability" - }, - "description": "the collection of what aggregation intervals are available to be queried." - }, - "id": { - "type": "string", - "description": "the resource identifier of the metric definition." - } - }, - "description": "Metric definition class specifies the metadata for a metric." - }, - "MetricDefinitionCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricDefinition" - }, - "description": "the values for the metric definitions." - } - }, - "required": [ - "value" - ], - "description": "Represents collection of metric definitions." - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - } - }, - "parameters": { - "ResourceUriParameter": { - "name": "resourceUri", - "in": "path", - "required": true, - "type": "string", - "description": "The identifier of the resource.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/actionGroups_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/actionGroups_API.json deleted file mode 100644 index 5f8759cc8..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/actionGroups_API.json +++ /dev/null @@ -1,786 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Action Groups API", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2018-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/actionGroups/{actionGroupName}": { - "put": { - "description": "Create a new action group or update an existing one.", - "operationId": "ActionGroups_CreateOrUpdate", - "x-ms-examples": { - "Create or update an action group": { - "$ref": "./examples/createOrUpdateActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "name": "actionGroup", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActionGroupResource" - }, - "description": "The action group to create or use for the update." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "An existing action group was successfully updated.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - }, - "201": { - "description": "A new action group was successfully created.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - }, - "default": { - "description": "An error occurred and the action group could not be created or updated.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "description": "Get an action group.", - "operationId": "ActionGroups_Get", - "x-ms-examples": { - "Get an action group": { - "$ref": "./examples/getActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - }, - "default": { - "description": "An error occurred and the action group could not be retrieved. 404: The action group does not exist.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "description": "Delete an action group.", - "operationId": "ActionGroups_Delete", - "x-ms-examples": { - "Delete an action group": { - "$ref": "./examples/deleteActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The action group was successfully deleted." - }, - "204": { - "description": "The action group does not exist. It may have already been deleted." - }, - "default": { - "description": "An error occurred and the action group could not be deleted.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "description": "Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.", - "operationId": "ActionGroups_Update", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "actionGroupPatch", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActionGroupPatchBody" - }, - "description": "Parameters supplied to the operation." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "An existing action group was successfully updated.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - } - }, - "x-ms-examples": { - "Patch an action group": { - "$ref": "./examples/patchActionGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/microsoft.insights/actionGroups": { - "get": { - "description": "Get a list of all action groups in a subscription.", - "operationId": "ActionGroups_ListBySubscriptionId", - "x-ms-examples": { - "List action groups": { - "$ref": "./examples/listActionGroups.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/ActionGroupList" - } - }, - "default": { - "description": "An error occurred and the list of action groups could not be retrieved.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/actionGroups": { - "get": { - "description": "Get a list of all action groups in a resource group.", - "operationId": "ActionGroups_ListByResourceGroup", - "x-ms-examples": { - "List action groups": { - "$ref": "./examples/listActionGroups.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/ActionGroupList" - } - }, - "default": { - "description": "An error occurred and the list of action groups could not be retrieved.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/actionGroups/{actionGroupName}/subscribe": { - "post": { - "description": "Enable a receiver in an action group. This changes the receiver's status from Disabled to Enabled. This operation is only supported for Email or SMS receivers.", - "operationId": "ActionGroups_EnableReceiver", - "x-ms-examples": { - "Enable the receiver": { - "$ref": "./examples/enableReceiver.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "name": "enableRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/EnableRequest" - }, - "description": "The receiver to re-enable." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The receiver was successfully enabled." - }, - "409": { - "description": "The receiver is already enabled in the action group." - }, - "default": { - "description": "An error occurred and the receiver could not be enabled, e.g.: 404: The action group was not found or no matching receiver was found in the action group.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "Resource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Azure resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true, - "description": "An azure resource object" - }, - "ActionGroupResource": { - "description": "An action group resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ActionGroup", - "description": "The action groups properties of the resource." - } - } - }, - "ActionGroupList": { - "description": "A list of action groups.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ActionGroupResource" - }, - "description": "The list of action groups." - }, - "nextLink": { - "type": "string", - "description": "Provides the link to retrieve the next set of elements." - } - } - }, - "ActionGroup": { - "description": "An Azure action group.", - "properties": { - "groupShortName": { - "type": "string", - "maxLength": 12, - "description": "The short name of the action group. This will be used in SMS messages." - }, - "enabled": { - "type": "boolean", - "default": true, - "description": "Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications." - }, - "emailReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/EmailReceiver" - }, - "description": "The list of email receivers that are part of this action group." - }, - "smsReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/SmsReceiver" - }, - "description": "The list of SMS receivers that are part of this action group." - }, - "webhookReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/WebhookReceiver" - }, - "description": "The list of webhook receivers that are part of this action group." - }, - "itsmReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/ItsmReceiver" - }, - "description": "The list of ITSM receivers that are part of this action group." - }, - "azureAppPushReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/AzureAppPushReceiver" - }, - "description": "The list of AzureAppPush receivers that are part of this action group." - }, - "automationRunbookReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/AutomationRunbookReceiver" - }, - "description": "The list of AutomationRunbook receivers that are part of this action group." - }, - "voiceReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/VoiceReceiver" - }, - "description": "The list of voice receivers that are part of this action group." - }, - "logicAppReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/LogicAppReceiver" - }, - "description": "The list of logic app receivers that are part of this action group." - }, - "azureFunctionReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/AzureFunctionReceiver" - }, - "description": "The list of azure function receivers that are part of this action group." - } - }, - "required": [ - "groupShortName", - "enabled" - ] - }, - "EmailReceiver": { - "description": "An email receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the email receiver. Names must be unique across all receivers within an action group." - }, - "emailAddress": { - "type": "string", - "description": "The email address of this receiver." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ReceiverStatus", - "description": "The receiver status of the e-mail." - } - }, - "required": [ - "name", - "emailAddress" - ] - }, - "SmsReceiver": { - "description": "An SMS receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the SMS receiver. Names must be unique across all receivers within an action group." - }, - "countryCode": { - "type": "string", - "description": "The country code of the SMS receiver." - }, - "phoneNumber": { - "type": "string", - "description": "The phone number of the SMS receiver." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ReceiverStatus", - "description": "The status of the receiver." - } - }, - "required": [ - "name", - "countryCode", - "phoneNumber" - ] - }, - "WebhookReceiver": { - "description": "A webhook receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the webhook receiver. Names must be unique across all receivers within an action group." - }, - "serviceUri": { - "type": "string", - "description": "The URI where webhooks should be sent." - } - }, - "required": [ - "name", - "serviceUri" - ] - }, - "ItsmReceiver": { - "description": "An Itsm receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the Itsm receiver. Names must be unique across all receivers within an action group." - }, - "workspaceId": { - "type": "string", - "description": "OMS LA instance identifier." - }, - "connectionId": { - "type": "string", - "description": "Unique identification of ITSM connection among multiple defined in above workspace." - }, - "ticketConfiguration": { - "type": "string", - "description": "JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well." - }, - "region": { - "type": "string", - "description": "Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'" - } - }, - "required": [ - "name", - "workspaceId", - "connectionId", - "ticketConfiguration", - "region" - ] - }, - "AzureAppPushReceiver": { - "description": "The Azure mobile App push notification receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group." - }, - "emailAddress": { - "type": "string", - "description": "The email address registered for the Azure mobile app." - } - }, - "required": [ - "name", - "emailAddress" - ] - }, - "AutomationRunbookReceiver": { - "description": "The Azure Automation Runbook notification receiver.", - "properties": { - "automationAccountId": { - "type": "string", - "description": "The Azure automation account Id which holds this runbook and authenticate to Azure resource." - }, - "runbookName": { - "type": "string", - "description": "The name for this runbook." - }, - "webhookResourceId": { - "type": "string", - "description": "The resource id for webhook linked to this runbook." - }, - "isGlobalRunbook": { - "type": "boolean", - "description": "Indicates whether this instance is global runbook." - }, - "name": { - "type": "string", - "description": "Indicates name of the webhook." - }, - "serviceUri": { - "type": "string", - "description": "The URI where webhooks should be sent." - } - }, - "required": [ - "automationAccountId", - "runbookName", - "webhookResourceId", - "isGlobalRunbook" - ] - }, - "VoiceReceiver": { - "description": "A voice receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the voice receiver. Names must be unique across all receivers within an action group." - }, - "countryCode": { - "type": "string", - "description": "The country code of the voice receiver." - }, - "phoneNumber": { - "type": "string", - "description": "The phone number of the voice receiver." - } - }, - "required": [ - "name", - "countryCode", - "phoneNumber" - ] - }, - "LogicAppReceiver": { - "description": "A logic app receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the logic app receiver. Names must be unique across all receivers within an action group." - }, - "resourceId": { - "type": "string", - "description": "The azure resource id of the logic app receiver." - }, - "callbackUrl": { - "type": "string", - "description": "The callback url where http request sent to." - } - }, - "required": [ - "name", - "resourceId", - "callbackUrl" - ] - }, - "AzureFunctionReceiver": { - "description": "An azure function receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the azure function receiver. Names must be unique across all receivers within an action group." - }, - "functionAppResourceId": { - "type": "string", - "description": "The azure resource id of the function app." - }, - "functionName": { - "type": "string", - "description": "The function name in the function app." - }, - "httpTriggerUrl": { - "type": "string", - "description": "The http trigger url where http request sent to." - } - }, - "required": [ - "name", - "functionAppResourceId", - "functionName", - "httpTriggerUrl" - ] - }, - "ReceiverStatus": { - "type": "string", - "enum": [ - "NotSpecified", - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "ReceiverStatus", - "modelAsString": false - }, - "description": "Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications." - }, - "EnableRequest": { - "description": "Describes a receiver that should be resubscribed.", - "properties": { - "receiverName": { - "type": "string", - "description": "The name of the receiver to resubscribe." - } - }, - "required": [ - "receiverName" - ] - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "ActionGroupPatchBody": { - "description": "An action group object for the body of patch operations.", - "properties": { - "tags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ActionGroupPatch", - "description": "The action group settings for an update operation." - } - } - }, - "ActionGroupPatch": { - "description": "An Azure action group for patch operations.", - "properties": { - "enabled": { - "type": "boolean", - "default": true, - "description": "Indicates whether this action group is enabled. If an action group is not enabled, then none of its actions will be activated." - } - } - } - }, - "parameters": { - "ActionGroupNameParameter": { - "name": "actionGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the action group.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/metricAlert_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/metricAlert_API.json deleted file mode 100644 index 544705436..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/metricAlert_API.json +++ /dev/null @@ -1,1056 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2018-03-01", - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "description": "Azure Monitor client to create/update/delete metric based alerts." - }, - "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.Insights/metricAlerts": { - "get": { - "tags": [ - "MetricAlerts" - ], - "description": "Retrieve alert rule definitions in a subscription.", - "operationId": "MetricAlerts_ListBySubscription", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successful request for a list of metric alerts", - "schema": { - "$ref": "#/definitions/MetricAlertResourceCollection" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "../../stable/2016-03-01/alertRules_API.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "List metric alert rules": { - "$ref": "./examples/listMetricAlert.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts": { - "get": { - "tags": [ - "MetricAlerts" - ], - "description": "Retrieve alert rule definitions in a resource group.", - "operationId": "MetricAlerts_ListByResourceGroup", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successful request for a list of metric alerts", - "schema": { - "$ref": "#/definitions/MetricAlertResourceCollection" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "../../stable/2016-03-01/alertRules_API.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "List metric alert rules": { - "$ref": "./examples/listMetricAlert.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}": { - "get": { - "tags": [ - "MetricAlerts" - ], - "description": "Retrieve an alert rule definition.", - "operationId": "MetricAlerts_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successful request for a list of metric alerts", - "schema": { - "$ref": "#/definitions/MetricAlertResource" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "../../stable/2016-03-01/alertRules_API.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get an alert rule for single resource": { - "$ref": "./examples/getMetricAlertSingleResource.json" - }, - "Get an alert rule for multiple resources": { - "$ref": "./examples/getMetricAlertMultipleResource.json" - }, - "Get an alert rule on resource group(s)": { - "$ref": "./examples/getMetricAlertResourceGroup.json" - }, - "Get an alert rule on subscription": { - "$ref": "./examples/getMetricAlertSubscription.json" - }, - "Get a dynamic alert rule for single resource": { - "$ref": "./examples/getDynamicMetricAlertSingleResource.json" - }, - "Get a dynamic alert rule for multiple resources": { - "$ref": "./examples/getDynamicMetricAlertMultipleResource.json" - }, - "Get a web test alert rule": { - "$ref": "./examples/getWebTestMetricAlert.json" - } - } - }, - "put": { - "tags": [ - "MetricAlerts" - ], - "description": "Create or update an metric alert definition.", - "operationId": "MetricAlerts_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MetricAlertResource" - }, - "description": "The parameters of the rule to create or update." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MetricAlertResource" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "../../stable/2016-03-01/alertRules_API.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create or update an alert rule for Single Resource": { - "$ref": "./examples/createOrUpdateMetricAlertSingleResource.json" - }, - "Create or update an alert rule for Multiple Resource": { - "$ref": "./examples/createOrUpdateMetricAlertMultipleResource.json" - }, - "Create or update an alert rule on Resource group(s)": { - "$ref": "./examples/createOrUpdateMetricAlertResourceGroup.json" - }, - "Create or update an alert rule on Subscription ": { - "$ref": "./examples/createOrUpdateMetricAlertSubscription.json" - }, - "Create or update a dynamic alert rule for Single Resource": { - "$ref": "./examples/createOrUpdateDynamicMetricAlertSingleResource.json" - }, - "Create or update a dynamic alert rule for Multiple Resources": { - "$ref": "./examples/createOrUpdateDynamicMetricAlertMultipleResource.json" - }, - "Create or update a web test alert rule": { - "$ref": "./examples/createOrUpdateWebTestMetricAlert.json" - }, - "Create or update an alert rules with dimensions": { - "$ref": "./examples/createOrUpdateMetricAlertWithDimensions.json" - } - } - }, - "patch": { - "tags": [ - "MetricAlerts" - ], - "description": "Update an metric alert definition.", - "operationId": "MetricAlerts_Update", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MetricAlertResourcePatch" - }, - "description": "The parameters of the rule to update." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MetricAlertResource" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "../../stable/2016-03-01/alertRules_API.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create or update an alert rule": { - "$ref": "./examples/UpdateMetricAlert.json" - } - } - }, - "delete": { - "tags": [ - "MetricAlerts" - ], - "description": "Delete an alert rule definition.", - "operationId": "MetricAlerts_Delete", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successful request to delete an metric alert rule" - }, - "204": { - "description": "No content: the request was successful, but the response is empty" - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "../../stable/2016-03-01/alertRules_API.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete an alert rule": { - "$ref": "./examples/deleteMetricAlert.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}/status": { - "get": { - "tags": [ - "MetricAlertsStatus" - ], - "description": "Retrieve an alert rule status.", - "operationId": "MetricAlertsStatus_List", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successful request for a list of metric alerts", - "schema": { - "$ref": "#/definitions/MetricAlertStatusCollection" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "../../stable/2016-03-01/alertRules_API.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get an alert rule status": { - "$ref": "./examples/getMetricAlertStatus.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}/status/{statusName}": { - "get": { - "tags": [ - "MetricAlertsStatus" - ], - "description": "Retrieve an alert rule status.", - "operationId": "MetricAlertsStatus_ListByName", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "#/parameters/StatusNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successful request for a list of metric alerts", - "schema": { - "$ref": "#/definitions/MetricAlertStatusCollection" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "../../stable/2016-03-01/alertRules_API.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get an alert rule status": { - "$ref": "./examples/getMetricAlertStatusByName.json" - } - } - } - } - }, - "definitions": { - "Resource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Azure resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true, - "description": "An azure resource object" - }, - "MetricAlertAction": { - "description": "An alert action.", - "properties": { - "actionGroupId": { - "type": "string", - "description": "the id of the action group to use." - }, - "webHookProperties": { - "type": "object", - "additionalProperties": { - "type": "string", - "description": "the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload." - }, - "description": "This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook." - } - } - }, - "MetricAlertProperties": { - "required": [ - "enabled", - "severity", - "evaluationFrequency", - "windowSize", - "criteria", - "scopes" - ], - "properties": { - "description": { - "type": "string", - "description": "the description of the metric alert that will be included in the alert email." - }, - "severity": { - "type": "integer", - "format": "int32", - "description": "Alert severity {0, 1, 2, 3, 4}" - }, - "enabled": { - "type": "boolean", - "description": "the flag that indicates whether the metric alert is enabled." - }, - "scopes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "the list of resource id's that this metric alert is scoped to." - }, - "evaluationFrequency": { - "type": "string", - "format": "duration", - "description": "how often the metric alert is evaluated represented in ISO 8601 duration format." - }, - "windowSize": { - "type": "string", - "format": "duration", - "description": "the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold." - }, - "targetResourceType": { - "type": "string", - "description": "the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource." - }, - "targetResourceRegion": { - "type": "string", - "description": "the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource." - }, - "criteria": { - "$ref": "#/definitions/MetricAlertCriteria", - "description": "defines the specific alert criteria information." - }, - "autoMitigate": { - "type": "boolean", - "description": "the flag that indicates whether the alert should be auto resolved or not. The default is true." - }, - "actions": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricAlertAction" - }, - "x-ms-identifiers": [ - "actionGroupId" - ], - "description": "the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved." - }, - "lastUpdatedTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "Last time the rule was updated in ISO8601 format." - }, - "isMigrated": { - "type": "boolean", - "description": "the value indicating whether this alert rule is migrated.", - "readOnly": true - } - }, - "description": "An alert rule." - }, - "MetricAlertPropertiesPatch": { - "properties": { - "description": { - "type": "string", - "description": "the description of the metric alert that will be included in the alert email." - }, - "severity": { - "type": "integer", - "format": "int32", - "description": "Alert severity {0, 1, 2, 3, 4}" - }, - "enabled": { - "type": "boolean", - "description": "the flag that indicates whether the metric alert is enabled." - }, - "scopes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "the list of resource id's that this metric alert is scoped to." - }, - "evaluationFrequency": { - "type": "string", - "format": "duration", - "description": "how often the metric alert is evaluated represented in ISO 8601 duration format." - }, - "windowSize": { - "type": "string", - "format": "duration", - "description": "the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold." - }, - "targetResourceType": { - "type": "string", - "description": "the resource type of the target resource(s) on which the alert is created/updated. Mandatory for MultipleResourceMultipleMetricCriteria." - }, - "targetResourceRegion": { - "type": "string", - "description": "the region of the target resource(s) on which the alert is created/updated. Mandatory for MultipleResourceMultipleMetricCriteria." - }, - "criteria": { - "$ref": "#/definitions/MetricAlertCriteria", - "description": "defines the specific alert criteria information." - }, - "autoMitigate": { - "type": "boolean", - "description": "the flag that indicates whether the alert should be auto resolved or not. The default is true." - }, - "actions": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricAlertAction" - }, - "x-ms-identifiers": [ - "actionGroupId" - ], - "description": "the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved." - }, - "lastUpdatedTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "Last time the rule was updated in ISO8601 format." - }, - "isMigrated": { - "type": "boolean", - "description": "the value indicating whether this alert rule is migrated.", - "readOnly": true - } - }, - "description": "An alert rule properties for patch." - }, - "MetricAlertResource": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/MetricAlertProperties", - "description": "The alert rule properties of the resource." - } - }, - "description": "The metric alert resource." - }, - "MetricAlertResourcePatch": { - "properties": { - "tags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/MetricAlertPropertiesPatch", - "description": "The alert rule properties of the resource." - } - }, - "description": "The metric alert resource for patch operations." - }, - "MetricAlertResourceCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricAlertResource" - }, - "description": "the values for the alert rule resources." - } - }, - "description": "Represents a collection of alert rule resources." - }, - "MetricAlertStatusCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricAlertStatus" - }, - "description": "the values for the alert rule resources." - } - }, - "description": "Represents a collection of alert rule resources." - }, - "MetricAlertStatusProperties": { - "description": "An alert status properties.", - "properties": { - "dimensions": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "An object describing the type of the dimensions." - }, - "status": { - "type": "string", - "description": "status value" - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "UTC time when the status was checked." - } - } - }, - "MetricAlertStatus": { - "description": "An alert status.", - "properties": { - "name": { - "type": "string", - "description": "The status name." - }, - "id": { - "type": "string", - "description": "The alert rule arm id." - }, - "type": { - "type": "string", - "description": "The extended resource type name." - }, - "properties": { - "x-ms-client-flatten": false, - "$ref": "#/definitions/MetricAlertStatusProperties", - "description": "The alert status properties of the metric alert status." - } - } - }, - "MetricAlertCriteria": { - "type": "object", - "additionalProperties": { - "type": "object" - }, - "discriminator": "odata.type", - "properties": { - "odata.type": { - "type": "string", - "enum": [ - "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria", - "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria", - "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria" - ], - "x-ms-enum": { - "name": "odatatype", - "modelAsString": true - }, - "description": "specifies the type of the alert criteria." - } - }, - "required": [ - "odata.type" - ], - "description": "The rule criteria that defines the conditions of the alert rule." - }, - "MetricAlertSingleResourceMultipleMetricCriteria": { - "x-ms-discriminator-value": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/MetricAlertCriteria" - } - ], - "properties": { - "allOf": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricCriteria" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "The list of metric criteria for this 'all of' operation. " - } - }, - "description": "Specifies the metric alert criteria for a single resource that has multiple metric criteria." - }, - "WebtestLocationAvailabilityCriteria": { - "x-ms-discriminator-value": "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/MetricAlertCriteria" - } - ], - "properties": { - "webTestId": { - "type": "string", - "description": "The Application Insights web test Id." - }, - "componentId": { - "type": "string", - "description": "The Application Insights resource Id." - }, - "failedLocationCount": { - "type": "number", - "description": "The number of failed locations." - } - }, - "required": [ - "webTestId", - "componentId", - "failedLocationCount" - ], - "description": "Specifies the metric alert rule criteria for a web test resource." - }, - "MetricCriteria": { - "x-ms-discriminator-value": "StaticThresholdCriterion", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/MultiMetricCriteria" - } - ], - "required": [ - "operator", - "threshold" - ], - "properties": { - "operator": { - "type": "string", - "enum": [ - "Equals", - "GreaterThan", - "GreaterThanOrEqual", - "LessThan", - "LessThanOrEqual" - ], - "x-ms-enum": { - "name": "Operator", - "modelAsString": true - }, - "description": "the criteria operator." - }, - "threshold": { - "type": "number", - "format": "double", - "description": "the criteria threshold value that activates the alert." - } - }, - "description": "Criterion to filter metrics." - }, - "MetricDimension": { - "required": [ - "name", - "operator", - "values" - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the dimension." - }, - "operator": { - "type": "string", - "description": "the dimension operator. Only 'Include' and 'Exclude' are supported" - }, - "values": { - "type": "array", - "items": { - "type": "string" - }, - "description": "list of dimension values." - } - }, - "description": "Specifies a metric dimension." - }, - "MetricAlertMultipleResourceMultipleMetricCriteria": { - "x-ms-discriminator-value": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/MetricAlertCriteria" - } - ], - "properties": { - "allOf": { - "type": "array", - "items": { - "$ref": "#/definitions/MultiMetricCriteria" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "the list of multiple metric criteria for this 'all of' operation. " - } - }, - "description": "Specifies the metric alert criteria for multiple resource that has multiple metric criteria." - }, - "MultiMetricCriteria": { - "type": "object", - "additionalProperties": { - "type": "object" - }, - "discriminator": "criterionType", - "properties": { - "criterionType": { - "type": "string", - "enum": [ - "StaticThresholdCriterion", - "DynamicThresholdCriterion" - ], - "x-ms-enum": { - "name": "criterionType", - "modelAsString": true - }, - "description": "Specifies the type of threshold criteria" - }, - "name": { - "type": "string", - "description": "Name of the criteria." - }, - "metricName": { - "type": "string", - "description": "Name of the metric." - }, - "metricNamespace": { - "type": "string", - "description": "Namespace of the metric." - }, - "timeAggregation": { - "type": "string", - "enum": [ - "Average", - "Count", - "Minimum", - "Maximum", - "Total" - ], - "x-ms-enum": { - "name": "AggregationTypeEnum", - "modelAsString": true - }, - "description": "the criteria time aggregation types." - }, - "dimensions": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricDimension" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "List of dimension conditions." - }, - "skipMetricValidation": { - "type": "boolean", - "description": "Allows creating an alert rule on a custom metric that isn't yet emitted, by causing the metric validation to be skipped." - } - }, - "required": [ - "criterionType", - "name", - "metricName", - "timeAggregation" - ], - "description": "The types of conditions for a multi resource alert." - }, - "DynamicMetricCriteria": { - "x-ms-discriminator-value": "DynamicThresholdCriterion", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/MultiMetricCriteria" - } - ], - "required": [ - "operator", - "alertSensitivity", - "failingPeriods" - ], - "properties": { - "operator": { - "type": "string", - "enum": [ - "GreaterThan", - "LessThan", - "GreaterOrLessThan" - ], - "x-ms-enum": { - "name": "DynamicThresholdOperator", - "modelAsString": true - }, - "description": "The operator used to compare the metric value against the threshold." - }, - "alertSensitivity": { - "type": "string", - "enum": [ - "Low", - "Medium", - "High" - ], - "x-ms-enum": { - "name": "DynamicThresholdSensitivity", - "modelAsString": true - }, - "description": "The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern." - }, - "failingPeriods": { - "type": "object", - "$ref": "#/definitions/DynamicThresholdFailingPeriods", - "description": "The minimum number of violations required within the selected lookback time window required to raise an alert." - }, - "ignoreDataBefore": { - "type": "string", - "format": "date-time", - "description": "Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format)" - } - }, - "description": "Criterion for dynamic threshold." - }, - "DynamicThresholdFailingPeriods": { - "required": [ - "numberOfEvaluationPeriods", - "minFailingPeriodsToAlert" - ], - "properties": { - "numberOfEvaluationPeriods": { - "type": "number", - "description": "The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points." - }, - "minFailingPeriodsToAlert": { - "type": "number", - "description": "The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods." - } - }, - "description": "The minimum number of violations required within the selected lookback time window required to raise an alert." - } - }, - "parameters": { - "RuleNameParameter": { - "name": "ruleName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the rule.", - "x-ms-parameter-location": "method" - }, - "StatusNameParameter": { - "name": "statusName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the status.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/actionGroups_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/actionGroups_API.json deleted file mode 100644 index 9c47e7b9c..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/actionGroups_API.json +++ /dev/null @@ -1,840 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Action Groups API", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2019-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/actionGroups/{actionGroupName}": { - "put": { - "description": "Create a new action group or update an existing one.", - "operationId": "ActionGroups_CreateOrUpdate", - "x-ms-examples": { - "Create or update an action group": { - "$ref": "./examples/createOrUpdateActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "name": "actionGroup", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActionGroupResource" - }, - "description": "The action group to create or use for the update." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "An existing action group was successfully updated.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - }, - "201": { - "description": "A new action group was successfully created.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - }, - "default": { - "description": "An error occurred and the action group could not be created or updated.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "description": "Get an action group.", - "operationId": "ActionGroups_Get", - "x-ms-examples": { - "Get an action group": { - "$ref": "./examples/getActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - }, - "default": { - "description": "An error occurred and the action group could not be retrieved. 404: The action group does not exist.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "description": "Delete an action group.", - "operationId": "ActionGroups_Delete", - "x-ms-examples": { - "Delete an action group": { - "$ref": "./examples/deleteActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The action group was successfully deleted." - }, - "204": { - "description": "The action group does not exist. It may have already been deleted." - }, - "default": { - "description": "An error occurred and the action group could not be deleted.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "description": "Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.", - "operationId": "ActionGroups_Update", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "actionGroupPatch", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActionGroupPatchBody" - }, - "description": "Parameters supplied to the operation." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "An existing action group was successfully updated.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - } - }, - "x-ms-examples": { - "Patch an action group": { - "$ref": "./examples/patchActionGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/microsoft.insights/actionGroups": { - "get": { - "description": "Get a list of all action groups in a subscription.", - "operationId": "ActionGroups_ListBySubscriptionId", - "x-ms-examples": { - "List action groups": { - "$ref": "./examples/listActionGroups.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/ActionGroupList" - } - }, - "default": { - "description": "An error occurred and the list of action groups could not be retrieved.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/actionGroups": { - "get": { - "description": "Get a list of all action groups in a resource group.", - "operationId": "ActionGroups_ListByResourceGroup", - "x-ms-examples": { - "List action groups": { - "$ref": "./examples/listActionGroups.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/ActionGroupList" - } - }, - "default": { - "description": "An error occurred and the list of action groups could not be retrieved.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/actionGroups/{actionGroupName}/subscribe": { - "post": { - "description": "Enable a receiver in an action group. This changes the receiver's status from Disabled to Enabled. This operation is only supported for Email or SMS receivers.", - "operationId": "ActionGroups_EnableReceiver", - "x-ms-examples": { - "Enable the receiver": { - "$ref": "./examples/enableReceiver.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "name": "enableRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/EnableRequest" - }, - "description": "The receiver to re-enable." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The receiver was successfully enabled." - }, - "409": { - "description": "The receiver is already enabled in the action group." - }, - "default": { - "description": "An error occurred and the receiver could not be enabled, e.g.: 404: The action group was not found or no matching receiver was found in the action group.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "AzureResource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Azure resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true, - "description": "An azure resource object" - }, - "ActionGroupResource": { - "description": "An action group resource.", - "allOf": [ - { - "$ref": "#/definitions/AzureResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ActionGroup", - "description": "The action groups properties of the resource." - } - } - }, - "ActionGroupList": { - "description": "A list of action groups.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ActionGroupResource" - }, - "description": "The list of action groups." - }, - "nextLink": { - "type": "string", - "description": "Provides the link to retrieve the next set of elements." - } - } - }, - "ActionGroup": { - "description": "An Azure action group.", - "properties": { - "groupShortName": { - "type": "string", - "maxLength": 12, - "description": "The short name of the action group. This will be used in SMS messages." - }, - "enabled": { - "type": "boolean", - "default": true, - "description": "Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications." - }, - "emailReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/EmailReceiver" - }, - "description": "The list of email receivers that are part of this action group." - }, - "smsReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/SmsReceiver" - }, - "description": "The list of SMS receivers that are part of this action group." - }, - "webhookReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/WebhookReceiver" - }, - "description": "The list of webhook receivers that are part of this action group." - }, - "itsmReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/ItsmReceiver" - }, - "description": "The list of ITSM receivers that are part of this action group." - }, - "azureAppPushReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/AzureAppPushReceiver" - }, - "description": "The list of AzureAppPush receivers that are part of this action group." - }, - "automationRunbookReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/AutomationRunbookReceiver" - }, - "description": "The list of AutomationRunbook receivers that are part of this action group." - }, - "voiceReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/VoiceReceiver" - }, - "description": "The list of voice receivers that are part of this action group." - }, - "logicAppReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/LogicAppReceiver" - }, - "description": "The list of logic app receivers that are part of this action group." - }, - "azureFunctionReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/AzureFunctionReceiver" - }, - "description": "The list of azure function receivers that are part of this action group." - }, - "armRoleReceivers": { - "type": "array", - "items": { - "$ref": "#/definitions/ArmRoleReceiver" - }, - "description": "The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported." - } - }, - "required": [ - "groupShortName", - "enabled" - ] - }, - "EmailReceiver": { - "description": "An email receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the email receiver. Names must be unique across all receivers within an action group." - }, - "emailAddress": { - "type": "string", - "description": "The email address of this receiver." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ReceiverStatus", - "description": "The receiver status of the e-mail." - } - }, - "required": [ - "name", - "emailAddress" - ] - }, - "SmsReceiver": { - "description": "An SMS receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the SMS receiver. Names must be unique across all receivers within an action group." - }, - "countryCode": { - "type": "string", - "description": "The country code of the SMS receiver." - }, - "phoneNumber": { - "type": "string", - "description": "The phone number of the SMS receiver." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ReceiverStatus", - "description": "The status of the receiver." - } - }, - "required": [ - "name", - "countryCode", - "phoneNumber" - ] - }, - "WebhookReceiver": { - "description": "A webhook receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the webhook receiver. Names must be unique across all receivers within an action group." - }, - "serviceUri": { - "type": "string", - "description": "The URI where webhooks should be sent." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - } - }, - "required": [ - "name", - "serviceUri" - ] - }, - "ItsmReceiver": { - "description": "An Itsm receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the Itsm receiver. Names must be unique across all receivers within an action group." - }, - "workspaceId": { - "type": "string", - "description": "OMS LA instance identifier." - }, - "connectionId": { - "type": "string", - "description": "Unique identification of ITSM connection among multiple defined in above workspace." - }, - "ticketConfiguration": { - "type": "string", - "description": "JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well." - }, - "region": { - "type": "string", - "description": "Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'" - } - }, - "required": [ - "name", - "workspaceId", - "connectionId", - "ticketConfiguration", - "region" - ] - }, - "AzureAppPushReceiver": { - "description": "The Azure mobile App push notification receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group." - }, - "emailAddress": { - "type": "string", - "description": "The email address registered for the Azure mobile app." - } - }, - "required": [ - "name", - "emailAddress" - ] - }, - "AutomationRunbookReceiver": { - "description": "The Azure Automation Runbook notification receiver.", - "properties": { - "automationAccountId": { - "type": "string", - "description": "The Azure automation account Id which holds this runbook and authenticate to Azure resource." - }, - "runbookName": { - "type": "string", - "description": "The name for this runbook." - }, - "webhookResourceId": { - "type": "string", - "description": "The resource id for webhook linked to this runbook." - }, - "isGlobalRunbook": { - "type": "boolean", - "description": "Indicates whether this instance is global runbook." - }, - "name": { - "type": "string", - "description": "Indicates name of the webhook." - }, - "serviceUri": { - "type": "string", - "description": "The URI where webhooks should be sent." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - } - }, - "required": [ - "automationAccountId", - "runbookName", - "webhookResourceId", - "isGlobalRunbook" - ] - }, - "VoiceReceiver": { - "description": "A voice receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the voice receiver. Names must be unique across all receivers within an action group." - }, - "countryCode": { - "type": "string", - "description": "The country code of the voice receiver." - }, - "phoneNumber": { - "type": "string", - "description": "The phone number of the voice receiver." - } - }, - "required": [ - "name", - "countryCode", - "phoneNumber" - ] - }, - "LogicAppReceiver": { - "description": "A logic app receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the logic app receiver. Names must be unique across all receivers within an action group." - }, - "resourceId": { - "type": "string", - "description": "The azure resource id of the logic app receiver." - }, - "callbackUrl": { - "type": "string", - "description": "The callback url where http request sent to." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - } - }, - "required": [ - "name", - "resourceId", - "callbackUrl" - ] - }, - "AzureFunctionReceiver": { - "description": "An azure function receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the azure function receiver. Names must be unique across all receivers within an action group." - }, - "functionAppResourceId": { - "type": "string", - "description": "The azure resource id of the function app." - }, - "functionName": { - "type": "string", - "description": "The function name in the function app." - }, - "httpTriggerUrl": { - "type": "string", - "description": "The http trigger url where http request sent to." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - } - }, - "required": [ - "name", - "functionAppResourceId", - "functionName", - "httpTriggerUrl" - ] - }, - "ArmRoleReceiver": { - "description": "An arm role receiver.", - "properties": { - "name": { - "type": "string", - "description": "The name of the arm role receiver. Names must be unique across all receivers within an action group." - }, - "roleId": { - "type": "string", - "description": "The arm role id." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - } - }, - "required": [ - "name", - "roleId" - ] - }, - "ReceiverStatus": { - "type": "string", - "enum": [ - "NotSpecified", - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "ReceiverStatus", - "modelAsString": false - }, - "description": "Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications." - }, - "EnableRequest": { - "description": "Describes a receiver that should be resubscribed.", - "properties": { - "receiverName": { - "type": "string", - "description": "The name of the receiver to resubscribe." - } - }, - "required": [ - "receiverName" - ] - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "ActionGroupPatchBody": { - "description": "An action group object for the body of patch operations.", - "properties": { - "tags": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ActionGroupPatch", - "description": "The action group settings for an update operation." - } - } - }, - "ActionGroupPatch": { - "description": "An Azure action group for patch operations.", - "properties": { - "enabled": { - "type": "boolean", - "default": true, - "description": "Indicates whether this action group is enabled. If an action group is not enabled, then none of its actions will be activated." - } - } - } - }, - "parameters": { - "ActionGroupNameParameter": { - "name": "actionGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the action group.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json deleted file mode 100644 index 7e59ae215..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json +++ /dev/null @@ -1,400 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2019-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/{resourceUri}/providers/Microsoft.Insights/metricBaselines": { - "get": { - "tags": [ - "Baseline", - "Metric" - ], - "operationId": "Baselines_List", - "description": "**Lists the metric baseline values for a resource**.", - "x-ms-examples": { - "Get metric baselines": { - "$ref": "./examples/metricBaselines.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceUriParameter" - }, - { - "$ref": "#/parameters/MetricNamesParameter" - }, - { - "$ref": "#/parameters/MetricNamespaceParameter" - }, - { - "$ref": "#/parameters/TimespanParameter" - }, - { - "$ref": "#/parameters/IntervalParameter" - }, - { - "$ref": "#/parameters/AggregationsParameter" - }, - { - "$ref": "#/parameters/SensitivitiesParameter" - }, - { - "name": "$filter", - "in": "query", - "type": "string", - "description": "The **$filter** is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 **$filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*'** - Invalid variant: **$filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2'** This is invalid because the logical or operator cannot separate two different metadata names. - Return all time series where A = a1, B = b1 and C = c1: **$filter=A eq 'a1' and B eq 'b1' and C eq 'c1'** - Return all time series where A = a1 **$filter=A eq 'a1' and B eq '*' and C eq '*'**. Special case: When dimension name or dimension value uses round brackets. Eg: When dimension name is **dim (test) 1** Instead of using $filter= \"dim (test) 1 eq '*' \" use **$filter= \"dim %2528test%2529 1 eq '*' \"** When dimension name is **dim (test) 3** and dimension value is **dim3 (test) val** Instead of using $filter= \"dim (test) 3 eq 'dim3 (test) val' \" use **$filter= \"dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' \"**", - "required": false - }, - { - "$ref": "#/parameters/BaselineResultTypeParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get the list of metric baseline values.", - "schema": { - "$ref": "#/definitions/MetricBaselinesResponse" - } - } - } - } - } - }, - "definitions": { - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "MetricBaselinesResponse": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SingleMetricBaseline" - }, - "description": "The list of metric baselines." - } - }, - "description": "A list of metric baselines." - }, - "SingleMetricBaseline": { - "properties": { - "id": { - "type": "string", - "description": "The metric baseline Id." - }, - "type": { - "type": "string", - "description": "The resource type of the metric baseline resource." - }, - "name": { - "type": "string", - "description": "The name of the metric for which the baselines were retrieved." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/MetricBaselinesProperties", - "description": "The metric baseline properties of the metric." - } - }, - "required": [ - "id", - "type", - "name", - "properties" - ], - "description": "The baseline results of a single metric." - }, - "MetricBaselinesProperties": { - "type": "object", - "properties": { - "timespan": { - "type": "string", - "description": "The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." - }, - "interval": { - "type": "string", - "format": "duration", - "description": "The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made." - }, - "namespace": { - "type": "string", - "description": "The namespace of the metrics been queried." - }, - "baselines": { - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesBaseline" - }, - "x-ms-identifiers": [], - "description": "The baseline for each time series that was queried." - } - }, - "required": [ - "timespan", - "interval", - "baselines" - ], - "description": "The response to a metric baselines query." - }, - "TimeSeriesBaseline": { - "properties": { - "aggregation": { - "type": "string", - "description": "The aggregation type of the metric." - }, - "dimensions": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricSingleDimension" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "The dimensions of this time series." - }, - "timestamps": { - "type": "array", - "items": { - "type": "string", - "format": "date-time", - "description": "The timestamp for the baseline value in ISO 8601 format." - }, - "description": "The list of timestamps of the baselines." - }, - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/SingleBaseline" - }, - "x-ms-identifiers": [], - "description": "The baseline values for each sensitivity." - }, - "metadataValues": { - "type": "array", - "items": { - "$ref": "#/definitions/BaselineMetadata" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "The baseline metadata values." - } - }, - "required": [ - "aggregation", - "timestamps", - "data" - ], - "description": "The baseline values for a single time series." - }, - "MetricSingleDimension": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the dimension." - }, - "value": { - "type": "string", - "description": "Value of the dimension." - } - }, - "required": [ - "name", - "value" - ], - "description": "The metric dimension name and value." - }, - "SingleBaseline": { - "type": "object", - "properties": { - "sensitivity": { - "type": "string", - "enum": [ - "Low", - "Medium", - "High" - ], - "x-ms-enum": { - "name": "BaselineSensitivity", - "modelAsString": true - }, - "description": "the sensitivity of the baseline." - }, - "lowThresholds": { - "type": "array", - "items": { - "type": "number", - "format": "double", - "description": "A single low threshold value." - }, - "description": "The low thresholds of the baseline." - }, - "highThresholds": { - "type": "array", - "items": { - "type": "number", - "format": "double", - "description": "A single high threshold value." - }, - "description": "The high thresholds of the baseline." - } - }, - "required": [ - "sensitivity", - "lowThresholds", - "highThresholds" - ], - "description": "The baseline values for a single sensitivity value." - }, - "BaselineMetadata": { - "properties": { - "name": { - "type": "string", - "description": "Name of the baseline metadata." - }, - "value": { - "type": "string", - "description": "Value of the baseline metadata." - } - }, - "required": [ - "name", - "value" - ], - "description": "Represents a baseline metadata value." - } - }, - "parameters": { - "ResourceUriParameter": { - "name": "resourceUri", - "in": "path", - "required": true, - "type": "string", - "description": "The identifier of the resource.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "TimespanParameter": { - "name": "timespan", - "in": "query", - "required": false, - "type": "string", - "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", - "x-ms-parameter-location": "method" - }, - "IntervalParameter": { - "name": "interval", - "in": "query", - "required": false, - "type": "string", - "format": "duration", - "description": "The interval (i.e. timegrain) of the query.", - "x-ms-parameter-location": "method" - }, - "MetricNamesParameter": { - "name": "metricnames", - "in": "query", - "required": false, - "type": "string", - "description": "The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**", - "x-ms-parameter-location": "method" - }, - "MetricNamespaceParameter": { - "name": "metricnamespace", - "in": "query", - "required": false, - "type": "string", - "description": "Metric namespace to query metric definitions for.", - "x-ms-parameter-location": "method" - }, - "AggregationsParameter": { - "name": "aggregation", - "in": "query", - "required": false, - "type": "string", - "description": "The list of aggregation types (comma separated) to retrieve.", - "x-ms-parameter-location": "method" - }, - "SensitivitiesParameter": { - "name": "sensitivities", - "in": "query", - "required": false, - "type": "string", - "description": "The list of sensitivities (comma separated) to retrieve.", - "x-ms-parameter-location": "method" - }, - "BaselineResultTypeParameter": { - "name": "resultType", - "in": "query", - "type": "string", - "enum": [ - "Data", - "Metadata" - ], - "x-ms-enum": { - "name": "ResultType", - "modelAsString": false - }, - "description": "Allows retrieving only metadata of the baseline. On data request all information is retrieved.", - "x-ms-parameter-location": "method", - "required": false - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json deleted file mode 100644 index e394bfdcb..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json +++ /dev/null @@ -1,548 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Activity Log Alerts API", - "description": "API for Azure Activity Log Alert rules CRUD operations.", - "version": "2020-10-01", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - } - }, - "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.Insights/activityLogAlerts/{activityLogAlertName}": { - "put": { - "description": "Create a new Activity Log Alert rule or update an existing one.", - "operationId": "ActivityLogAlerts_CreateOrUpdate", - "x-ms-examples": { - "Create or update an Activity Log Alert rule": { - "$ref": "./examples/ActivityLogAlertRule_CreateOrUpdate.json" - }, - "Create or update an Activity Log Alert rule with 'anyOf' condition": { - "$ref": "./examples/ActivityLogAlertRule_CreateOrUpdateRuleWithAnyOfCondition.json" - }, - "Create or update an Activity Log Alert rule with 'containsAny'": { - "$ref": "./examples/ActivityLogAlertRule_CreateOrUpdateRuleWithContainsAny.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActivityLogAlertNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "activityLogAlertRule", - "description": "The Activity Log Alert rule to create or use for the update.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActivityLogAlertResource" - } - } - ], - "responses": { - "200": { - "description": "An existing Activity Log Alert rule was successfully updated.", - "schema": { - "$ref": "#/definitions/ActivityLogAlertResource" - } - }, - "201": { - "description": "A new Activity Log Alert rule was successfully created.", - "schema": { - "$ref": "#/definitions/ActivityLogAlertResource" - } - }, - "default": { - "description": "An error occurred and the Activity Log Alert rule could not be created or updated.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "description": "Get an Activity Log Alert rule.", - "operationId": "ActivityLogAlerts_Get", - "x-ms-examples": { - "Get an Activity Log Alert rule": { - "$ref": "./examples/ActivityLogAlertRule_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActivityLogAlertNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/ActivityLogAlertResource" - } - }, - "default": { - "description": "An error occurred and the Activity Log Alert rule could not be retrieved.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "description": "Delete an Activity Log Alert rule.", - "operationId": "ActivityLogAlerts_Delete", - "x-ms-examples": { - "Delete an Activity Log Alert rule": { - "$ref": "./examples/ActivityLogAlertRule_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActivityLogAlertNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Activity Log Alert rule was successfully deleted." - }, - "204": { - "description": "The Activity Log Alert rule does not exist. It may have already been deleted." - }, - "default": { - "description": "An error occurred and the Activity Log Alert rule could not be deleted.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "description": "Updates 'tags' and 'enabled' fields in an existing Alert rule. This method is used to update the Alert rule tags, and to enable or disable the Alert rule. To update other fields use CreateOrUpdate operation.", - "operationId": "ActivityLogAlerts_Update", - "x-ms-examples": { - "Patch an Activity Log Alert rule": { - "$ref": "./examples/ActivityLogAlertRule_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActivityLogAlertNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "activityLogAlertRulePatch", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AlertRulePatchObject" - }, - "description": "Parameters supplied to the operation." - } - ], - "responses": { - "200": { - "description": "An existing Activity Log Alert rule was successfully updated.", - "schema": { - "$ref": "#/definitions/ActivityLogAlertResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/activityLogAlerts": { - "get": { - "description": "Get a list of all Activity Log Alert rules in a subscription.", - "operationId": "ActivityLogAlerts_ListBySubscriptionId", - "x-ms-examples": { - "Get list of all Activity Log Alert rules under a subscription": { - "$ref": "./examples/ActivityLogAlertRule_ListBySubscriptionId.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/AlertRuleList" - } - }, - "default": { - "description": "An error occurred and the list of Activity Log Alert rules could not be retrieved.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts": { - "get": { - "description": "Get a list of all Activity Log Alert rules in a resource group.", - "operationId": "ActivityLogAlerts_ListByResourceGroup", - "x-ms-examples": { - "List activity log alerts": { - "$ref": "./examples/ActivityLogAlertRule_ListByResourceGroupName.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/AlertRuleList" - } - }, - "default": { - "description": "An error occurred and the list of Activity Log Alert rules could not be retrieved.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "AzureResource": { - "description": "An Azure resource object.", - "x-ms-azure-resource": true, - "type": "object", - "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. Since Azure Activity Log Alerts is a global service, the location of the rules should always be 'global'.", - "type": "string", - "default": "global", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "description": "The tags of the resource.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "ActivityLogAlertResource": { - "description": "An Activity Log Alert rule resource.", - "allOf": [ - { - "$ref": "#/definitions/AzureResource" - } - ], - "properties": { - "properties": { - "description": "The Activity Log Alert rule properties of the resource.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AlertRuleProperties" - } - } - }, - "AlertRuleList": { - "description": "A list of Activity Log Alert rules.", - "properties": { - "value": { - "description": "The list of Activity Log Alert rules.", - "type": "array", - "items": { - "$ref": "#/definitions/ActivityLogAlertResource" - }, - "x-ms-identifiers": [ - "id" - ] - }, - "nextLink": { - "description": "Provides the link to retrieve the next set of elements.", - "type": "string" - } - } - }, - "AlertRuleProperties": { - "description": "An Azure Activity Log Alert rule.", - "type": "object", - "properties": { - "scopes": { - "description": "A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item.", - "type": "array", - "items": { - "type": "string" - } - }, - "condition": { - "description": "The condition that will cause this alert to activate.", - "$ref": "#/definitions/AlertRuleAllOfCondition" - }, - "actions": { - "description": "The actions that will activate when the condition is met.", - "$ref": "#/definitions/ActionList" - }, - "enabled": { - "description": "Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated.", - "type": "boolean", - "default": true - }, - "description": { - "description": "A description of this Activity Log Alert rule.", - "type": "string" - } - }, - "required": [ - "scopes", - "condition", - "actions" - ] - }, - "AlertRuleAllOfCondition": { - "description": "An Activity Log Alert rule condition that is met when all its member conditions are met.", - "type": "object", - "properties": { - "allOf": { - "description": "The list of Activity Log Alert rule conditions.", - "type": "array", - "items": { - "$ref": "#/definitions/AlertRuleAnyOfOrLeafCondition" - }, - "x-ms-identifiers": [] - } - }, - "required": [ - "allOf" - ] - }, - "AlertRuleAnyOfOrLeafCondition": { - "description": "An Activity Log Alert rule condition that is met when all its member conditions are met.\nEach condition can be of one of the following types:\n__Important__: Each type has its unique subset of properties. Properties from different types CANNOT exist in one condition.\n * __Leaf Condition -__ must contain 'field' and either 'equals' or 'containsAny'.\n _Please note, 'anyOf' should __not__ be set in a Leaf Condition._\n * __AnyOf Condition -__ must contain __only__ 'anyOf' (which is an array of Leaf Conditions).\n _Please note, 'field', 'equals' and 'containsAny' should __not__ be set in an AnyOf Condition._\n", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AlertRuleLeafCondition" - } - ], - "properties": { - "anyOf": { - "title": "An Activity Log Alert rule 'anyOf' condition.", - "description": "An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met.", - "type": "array", - "items": { - "$ref": "#/definitions/AlertRuleLeafCondition" - }, - "x-ms-identifiers": [] - } - } - }, - "AlertRuleLeafCondition": { - "description": "An Activity Log Alert rule condition that is met by comparing the field and value of an Activity Log event.\nThis condition must contain 'field' and either 'equals' or 'containsAny'.", - "type": "object", - "properties": { - "field": { - "description": "The name of the Activity Log event's field that this condition will examine.\nThe possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'.", - "type": "string" - }, - "equals": { - "description": "The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met.", - "type": "string" - }, - "containsAny": { - "description": "The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ActionList": { - "description": "A list of Activity Log Alert rule actions.", - "properties": { - "actionGroups": { - "description": "The list of the Action Groups.", - "type": "array", - "items": { - "$ref": "#/definitions/ActionGroup" - }, - "x-ms-identifiers": [ - "actionGroupId" - ] - } - } - }, - "ActionGroup": { - "description": "A pointer to an Azure Action Group.", - "properties": { - "actionGroupId": { - "description": "The resource ID of the Action Group. This cannot be null or empty.", - "type": "string" - }, - "webhookProperties": { - "description": "the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload.", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "actionGroupId" - ] - }, - "AlertRulePatchObject": { - "description": "An Activity Log Alert rule object for the body of patch operations.", - "properties": { - "tags": { - "description": "The resource tags", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AlertRulePatchProperties", - "description": "The activity log alert settings for an update operation." - } - } - }, - "AlertRulePatchProperties": { - "description": "An Activity Log Alert rule properties for patch operations.", - "properties": { - "enabled": { - "description": "Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated.", - "type": "boolean", - "default": true - } - } - }, - "ErrorResponse": { - "description": "The error response.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "The error message indicating why the operation failed.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "ActivityLogAlertNameParameter": { - "name": "activityLogAlertName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Activity Log Alert rule.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2021-05-01/commonMonitoringTypes.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2021-05-01/commonMonitoringTypes.json deleted file mode 100644 index 6c38f9c1d..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2021-05-01/commonMonitoringTypes.json +++ /dev/null @@ -1,102 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2021-05-01", - "title": "Common Monitoring types" - }, - "paths": {}, - "definitions": { - "LocalizableString": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "string", - "description": "the invariant value." - }, - "localizedValue": { - "type": "string", - "description": "the locale specific value." - } - }, - "description": "The localizable string class." - }, - "MetricUnit": { - "type": "string", - "description": "The unit of the metric.", - "enum": [ - "Count", - "Bytes", - "Seconds", - "CountPerSecond", - "BytesPerSecond", - "Percent", - "MilliSeconds", - "ByteSeconds", - "Unspecified", - "Cores", - "MilliCores", - "NanoCores", - "BitsPerSecond" - ], - "x-ms-enum": { - "name": "MetricUnit", - "modelAsString": true - } - }, - "ErrorContract": { - "title": "Error Response", - "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)", - "type": "object", - "properties": { - "error": { - "description": "The error object.", - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - } - }, - "parameters": { - "ResourceUriParameter": { - "name": "resourceUri", - "in": "path", - "required": true, - "type": "string", - "description": "The identifier of the resource.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "RegionParameter": { - "name": "region", - "in": "query", - "required": true, - "type": "string", - "description": "The region where the metrics you want reside.", - "x-ms-parameter-location": "method" - }, - "MetricNamespaceParameter": { - "name": "metricnamespace", - "in": "query", - "required": false, - "type": "string", - "description": "Metric namespace where the metrics you want reside.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json deleted file mode 100644 index 3caaf2b1a..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json +++ /dev/null @@ -1,365 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Monitor Metrics Definitions API", - "description": "Provides APIs for getting the metric metadata for Azure resources.", - "version": "2021-05-01", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - } - }, - "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.Insights/metricDefinitions": { - "get": { - "tags": [ - "MetricDefinitions" - ], - "operationId": "MetricDefinitions_ListAtSubscriptionScope", - "description": "Lists the metric definitions for the subscription.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./commonMonitoringTypes.json#/parameters/RegionParameter" - }, - { - "$ref": "./commonMonitoringTypes.json#/parameters/MetricNamespaceParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./commonMonitoringTypes.json#/definitions/ErrorContract" - } - }, - "200": { - "description": "Successful request to get the list of metric definitions", - "schema": { - "$ref": "#/definitions/SubscriptionScopeMetricDefinitionCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Get Subscription level Metric Definitions without filter": { - "$ref": "./examples/GetMultiResourceMetricDefinitions.json" - } - } - } - }, - "/{resourceUri}/providers/Microsoft.Insights/metricDefinitions": { - "get": { - "tags": [ - "MetricDefinitions" - ], - "operationId": "MetricDefinitions_List", - "description": "Lists the metric definitions for the resource.", - "parameters": [ - { - "$ref": "./commonMonitoringTypes.json#/parameters/ResourceUriParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./commonMonitoringTypes.json#/parameters/MetricNamespaceParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./commonMonitoringTypes.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get the list of metric definitions", - "schema": { - "$ref": "#/definitions/MetricDefinitionCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Get Metric Definitions without filter": { - "$ref": "./examples/GetMetricDefinitions.json" - }, - "Get Application Insights Metric Definitions without filter": { - "$ref": "./examples/GetMetricDefinitionsApplicationInsights.json" - }, - "Get StorageCache Metric Definitions with metric class": { - "$ref": "./examples/GetMetricDefinitionsMetricClass.json" - } - } - } - } - }, - "definitions": { - "MetricAvailability": { - "type": "object", - "properties": { - "timeGrain": { - "type": "string", - "format": "duration", - "description": "the time grain specifies the aggregation interval for the metric. Expressed as a duration 'PT1M', 'P1D', etc." - }, - "retention": { - "type": "string", - "format": "duration", - "description": "the retention period for the metric at the specified timegrain. Expressed as a duration 'PT1M', 'P1D', etc." - } - }, - "description": "Metric availability specifies the time grain (aggregation interval or frequency) and the retention period for that time grain." - }, - "AggregationType": { - "type": "string", - "description": "the aggregation type of the metric.", - "enum": [ - "None", - "Average", - "Count", - "Minimum", - "Maximum", - "Total" - ], - "x-ms-enum": { - "name": "AggregationType", - "modelAsString": false - } - }, - "MetricAggregationType": { - "type": "string", - "description": "the aggregation type of the metric.", - "enum": [ - "None", - "Average", - "Count", - "Minimum", - "Maximum", - "Total" - ], - "x-ms-enum": { - "name": "MetricAggregationType", - "modelAsString": true - } - }, - "MetricClass": { - "type": "string", - "description": "The class of the metric.", - "enum": [ - "Availability", - "Transactions", - "Errors", - "Latency", - "Saturation" - ], - "x-ms-enum": { - "name": "MetricClass", - "modelAsString": true - } - }, - "MetricDefinition": { - "type": "object", - "properties": { - "isDimensionRequired": { - "type": "boolean", - "description": "Flag to indicate whether the dimension is required." - }, - "resourceId": { - "type": "string", - "description": "the resource identifier of the resource that emitted the metric." - }, - "namespace": { - "type": "string", - "description": "the namespace the metric belongs to." - }, - "name": { - "$ref": "./commonMonitoringTypes.json#/definitions/LocalizableString", - "description": "the name and the display name of the metric, i.e. it is a localizable string." - }, - "displayDescription": { - "type": "string", - "description": "Detailed description of this metric." - }, - "category": { - "type": "string", - "description": "Custom category name for this metric." - }, - "metricClass": { - "$ref": "#/definitions/MetricClass", - "description": "The class of the metric." - }, - "unit": { - "$ref": "./commonMonitoringTypes.json#/definitions/MetricUnit", - "description": "the unit of the metric." - }, - "primaryAggregationType": { - "$ref": "#/definitions/AggregationType", - "description": "the primary aggregation type value defining how to use the values for display." - }, - "supportedAggregationTypes": { - "type": "array", - "items": { - "$ref": "#/definitions/AggregationType" - }, - "description": "the collection of what aggregation types are supported." - }, - "metricAvailabilities": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricAvailability" - }, - "description": "the collection of what aggregation intervals are available to be queried." - }, - "id": { - "type": "string", - "description": "the resource identifier of the metric definition." - }, - "dimensions": { - "type": "array", - "items": { - "$ref": "./commonMonitoringTypes.json#/definitions/LocalizableString" - }, - "description": "the name and the display name of the dimension, i.e. it is a localizable string." - } - }, - "description": "Metric definition class specifies the metadata for a metric." - }, - "MetricDefinitionCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricDefinition" - }, - "description": "the values for the metric definitions." - } - }, - "required": [ - "value" - ], - "description": "Represents collection of metric definitions." - }, - "SubscriptionScopeMetricDefinition": { - "type": "object", - "description": "Metric definition class specifies the metadata for a metric.", - "properties": { - "isDimensionRequired": { - "type": "boolean", - "description": "Flag to indicate whether the dimension is required." - }, - "resourceId": { - "type": "string", - "description": "the resource identifier of the resource that emitted the metric." - }, - "namespace": { - "type": "string", - "description": "the namespace the metric belongs to." - }, - "name": { - "$ref": "./commonMonitoringTypes.json#/definitions/LocalizableString", - "description": "the name and the display name of the metric, i.e. it is a localizable string." - }, - "displayDescription": { - "type": "string", - "description": "Detailed description of this metric." - }, - "category": { - "type": "string", - "description": "Custom category name for this metric." - }, - "metricClass": { - "$ref": "#/definitions/MetricClass", - "description": "The class of the metric." - }, - "unit": { - "$ref": "./commonMonitoringTypes.json#/definitions/MetricUnit", - "description": "the unit of the metric." - }, - "primaryAggregationType": { - "$ref": "#/definitions/MetricAggregationType", - "description": "the primary aggregation type value defining how to use the values for display." - }, - "supportedAggregationTypes": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricAggregationType" - }, - "description": "the collection of what aggregation types are supported." - }, - "metricAvailabilities": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricAvailability" - }, - "description": "the collection of what aggregation intervals are available to be queried." - }, - "id": { - "type": "string", - "description": "the resource identifier of the metric definition." - }, - "dimensions": { - "type": "array", - "items": { - "$ref": "./commonMonitoringTypes.json#/definitions/LocalizableString" - }, - "description": "the name and the display name of the dimension, i.e. it is a localizable string." - } - } - }, - "SubscriptionScopeMetricDefinitionCollection": { - "type": "object", - "description": "Represents collection of metric definitions.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SubscriptionScopeMetricDefinition" - }, - "description": "The values for the metric definitions." - } - }, - "required": [ - "value" - ] - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2021-05-01/metrics_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2021-05-01/metrics_API.json deleted file mode 100644 index 5cc8387fe..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2021-05-01/metrics_API.json +++ /dev/null @@ -1,733 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Monitor Metrics Data API", - "description": "Provides APIs for getting the metric data for Azure resources.", - "version": "2021-05-01", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - } - }, - "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.Insights/metrics": { - "get": { - "tags": [ - "Metrics" - ], - "operationId": "Metrics_ListAtSubscriptionScope", - "description": "**Lists the metric data for a subscription**.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./commonMonitoringTypes.json#/parameters/RegionParameter" - }, - { - "$ref": "#/parameters/TimespanParameter" - }, - { - "$ref": "#/parameters/IntervalParameter" - }, - { - "$ref": "#/parameters/MetricNamesParameter" - }, - { - "$ref": "#/parameters/AggregationsParameter" - }, - { - "$ref": "#/parameters/TopParameter" - }, - { - "$ref": "#/parameters/OrderByParameter" - }, - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SubscriptionScopeResultTypeParameter" - }, - { - "$ref": "./commonMonitoringTypes.json#/parameters/MetricNamespaceParameter" - }, - { - "$ref": "#/parameters/AutoAdjustTimegrain" - }, - { - "$ref": "#/parameters/ValidateDimensions" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./commonMonitoringTypes.json#/definitions/ErrorContract" - } - }, - "200": { - "description": "Successful request to get the list of metric values.", - "schema": { - "$ref": "#/definitions/SubscriptionScopeMetricResponse" - } - } - }, - "x-ms-odata": "#/definitions/MetadataValue", - "x-ms-examples": { - "Get subscription level metric data": { - "$ref": "./examples/GetMultiResourceMetric.json" - }, - "Get subscription level metric metadata": { - "$ref": "./examples/GetMultiResourceMetricMetadata.json" - } - } - }, - "post": { - "tags": [ - "Metrics" - ], - "operationId": "Metrics_ListAtSubscriptionScopePost", - "description": "**Lists the metric data for a subscription**. Parameters can be specified on either query params or the body.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./commonMonitoringTypes.json#/parameters/RegionParameter" - }, - { - "$ref": "#/parameters/TimespanParameter" - }, - { - "$ref": "#/parameters/IntervalParameter" - }, - { - "$ref": "#/parameters/MetricNamesParameter" - }, - { - "$ref": "#/parameters/AggregationsParameter" - }, - { - "$ref": "#/parameters/TopParameter" - }, - { - "$ref": "#/parameters/OrderByParameter" - }, - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SubscriptionScopeResultTypeParameter" - }, - { - "$ref": "./commonMonitoringTypes.json#/parameters/MetricNamespaceParameter" - }, - { - "$ref": "#/parameters/AutoAdjustTimegrain" - }, - { - "$ref": "#/parameters/ValidateDimensions" - }, - { - "in": "body", - "name": "body", - "description": "Parameters serialized in the body", - "schema": { - "$ref": "#/definitions/SubscriptionScopeMetricsRequestBodyParameters" - } - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./commonMonitoringTypes.json#/definitions/ErrorContract" - } - }, - "200": { - "description": "Successful request to get the list of metric values.", - "schema": { - "$ref": "#/definitions/SubscriptionScopeMetricResponse" - } - } - }, - "x-ms-odata": "#/definitions/MetadataValue", - "x-ms-examples": { - "Post request for subscription level metric data": { - "$ref": "./examples/GetMultiResourceMetric.json" - }, - "Post request for subscription level metric data using body params": { - "$ref": "./examples/PostMultiResourceMetricBody.json" - }, - "Post request for subscription level metric metadata": { - "$ref": "./examples/GetMultiResourceMetricMetadata.json" - } - } - } - }, - "/{resourceUri}/providers/Microsoft.Insights/metrics": { - "get": { - "tags": [ - "Metrics" - ], - "operationId": "Metrics_List", - "description": "**Lists the metric values for a resource**.", - "parameters": [ - { - "$ref": "./commonMonitoringTypes.json#/parameters/ResourceUriParameter" - }, - { - "$ref": "#/parameters/TimespanParameter" - }, - { - "$ref": "#/parameters/IntervalParameter" - }, - { - "$ref": "#/parameters/MetricNamesParameter" - }, - { - "$ref": "#/parameters/AggregationsParameter" - }, - { - "$ref": "#/parameters/TopParameter" - }, - { - "$ref": "#/parameters/OrderByParameter" - }, - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/ResultTypeParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./commonMonitoringTypes.json#/parameters/MetricNamespaceParameter" - }, - { - "$ref": "#/parameters/AutoAdjustTimegrain" - }, - { - "$ref": "#/parameters/ValidateDimensions" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./commonMonitoringTypes.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Successful request to get the list of metric values.", - "schema": { - "$ref": "#/definitions/Response" - } - } - }, - "x-ms-odata": "#/definitions/MetadataValue", - "x-ms-examples": { - "Get Metric for data": { - "$ref": "./examples/GetMetric.json" - }, - "Get Metric for metadata": { - "$ref": "./examples/GetMetricMetadata.json" - }, - "Get Metric with error": { - "$ref": "./examples/GetMetricError.json" - } - } - } - } - }, - "definitions": { - "SubscriptionScopeMetricsRequestBodyParameters": { - "description": "Query parameters can also be specified in the body, specifying the same parameter in both the body and query parameters will result in an error.", - "type": "object", - "properties": { - "timespan": { - "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", - "type": "string", - "format": "time" - }, - "interval": { - "description": "The interval (i.e. timegrain) of the query.", - "type": "string", - "format": "duration" - }, - "metricNames": { - "description": "The names of the metrics (comma separated) to retrieve.", - "type": "string" - }, - "aggregation": { - "description": "The list of aggregation types (comma separated) to retrieve.", - "type": "string" - }, - "filter": { - "description": "The **$filter** is used to reduce the set of metric data returned.
Example:
Metric contains metadata A, B and C.
- Return all time series of C where A = a1 and B = b1 or b2
**$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical or operator cannot separate two different metadata names.
- Return all time series where A = a1, B = b1 and C = c1:
**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**
- Return all time series where A = a1
**$filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’**.", - "type": "string" - }, - "top": { - "description": "The maximum number of records to retrieve.\nValid only if $filter is specified.\nDefaults to 10.", - "type": "integer", - "format": "int32" - }, - "orderBy": { - "description": "The aggregation to use for sorting results and the direction of the sort.\nOnly one order can be specified.\nExamples: sum asc.", - "type": "string" - }, - "rollUpBy": { - "description": "Dimension name(s) to rollup results by. For example if you only want to see metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't want to see separate values for each city, you can specify 'RollUpBy=City' to see the results for Seattle and Tacoma rolled up into one timeseries.", - "type": "string" - }, - "resultType": { - "description": "Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.", - "type": "string", - "enum": [ - "Data", - "Metadata" - ], - "x-ms-enum": { - "name": "MetricResultType", - "modelAsString": true - } - }, - "metricNamespace": { - "description": "Metric namespace where the metrics you want reside.", - "type": "string" - }, - "autoAdjustTimegrain": { - "description": "When set to true, if the timespan passed in is not supported by this metric, the API will return the result using the closest supported timespan. When set to false, an error is returned for invalid timespan parameters. Defaults to false.", - "type": "boolean" - }, - "validateDimensions": { - "description": "When set to false, invalid filter parameter values will be ignored. When set to true, an error is returned for invalid filter parameters. Defaults to true.", - "type": "boolean" - } - } - }, - "Unit": { - "type": "string", - "description": "The unit of the metric.", - "enum": [ - "Count", - "Bytes", - "Seconds", - "CountPerSecond", - "BytesPerSecond", - "Percent", - "MilliSeconds", - "ByteSeconds", - "Unspecified", - "Cores", - "MilliCores", - "NanoCores", - "BitsPerSecond" - ], - "x-ms-enum": { - "name": "Unit", - "modelAsString": false - } - }, - "MetricValue": { - "type": "object", - "description": "Represents a metric value.", - "required": [ - "timeStamp" - ], - "properties": { - "timeStamp": { - "type": "string", - "format": "date-time", - "description": "the timestamp for the metric value in ISO 8601 format." - }, - "average": { - "type": "number", - "format": "double", - "description": "the average value in the time range." - }, - "minimum": { - "type": "number", - "format": "double", - "description": "the least value in the time range." - }, - "maximum": { - "type": "number", - "format": "double", - "description": "the greatest value in the time range." - }, - "total": { - "type": "number", - "format": "double", - "description": "the sum of all of the values in the time range." - }, - "count": { - "type": "number", - "format": "double", - "description": "the number of samples in the time range. Can be used to determine the number of values that contributed to the average value." - } - } - }, - "MetadataValue": { - "type": "object", - "description": "Represents a metric metadata value.", - "properties": { - "name": { - "$ref": "./commonMonitoringTypes.json#/definitions/LocalizableString", - "description": "the name of the metadata." - }, - "value": { - "type": "string", - "description": "the value of the metadata." - } - } - }, - "Response": { - "type": "object", - "description": "The response to a metrics query.", - "properties": { - "cost": { - "type": "number", - "format": "int32", - "minimum": 0, - "description": "The integer value representing the relative cost of the query." - }, - "timespan": { - "type": "string", - "description": "The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." - }, - "interval": { - "type": "string", - "format": "duration", - "description": "The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made." - }, - "namespace": { - "type": "string", - "description": "The namespace of the metrics being queried" - }, - "resourceregion": { - "type": "string", - "description": "The region of the resource being queried for metrics." - }, - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Metric" - }, - "description": "the value of the collection." - } - }, - "required": [ - "timespan", - "value" - ] - }, - "Metric": { - "type": "object", - "description": "The result data of a query.", - "properties": { - "id": { - "type": "string", - "description": "the metric Id." - }, - "type": { - "type": "string", - "description": "the resource type of the metric resource." - }, - "name": { - "$ref": "./commonMonitoringTypes.json#/definitions/LocalizableString", - "description": "the name and the display name of the metric, i.e. it is localizable string." - }, - "displayDescription": { - "type": "string", - "description": "Detailed description of this metric." - }, - "errorCode": { - "type": "string", - "description": "'Success' or the error details on query failures for this metric." - }, - "errorMessage": { - "type": "string", - "description": "Error message encountered querying this specific metric." - }, - "unit": { - "$ref": "#/definitions/Unit", - "description": "The unit of the metric." - }, - "timeseries": { - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesElement" - }, - "description": "the time series returned when a data query is performed." - } - }, - "required": [ - "id", - "type", - "name", - "unit", - "timeseries" - ] - }, - "SubscriptionScopeMetricResponse": { - "type": "object", - "description": "The response to a subscription scope metrics query.", - "properties": { - "cost": { - "type": "number", - "format": "int32", - "minimum": 0, - "description": "The integer value representing the relative cost of the query." - }, - "timespan": { - "type": "string", - "description": "The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." - }, - "interval": { - "type": "string", - "format": "duration", - "description": "The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made." - }, - "namespace": { - "type": "string", - "description": "The namespace of the metrics being queried" - }, - "resourceregion": { - "type": "string", - "description": "The region of the resource being queried for metrics." - }, - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SubscriptionScopeMetric" - }, - "description": "the value of the collection." - } - }, - "required": [ - "timespan", - "value" - ] - }, - "SubscriptionScopeMetric": { - "type": "object", - "description": "The result data of a query.", - "properties": { - "id": { - "type": "string", - "description": "the metric Id." - }, - "type": { - "type": "string", - "description": "the resource type of the metric resource." - }, - "name": { - "$ref": "./commonMonitoringTypes.json#/definitions/LocalizableString", - "description": "the name and the display name of the metric, i.e. it is localizable string." - }, - "displayDescription": { - "type": "string", - "description": "Detailed description of this metric." - }, - "errorCode": { - "type": "string", - "description": "'Success' or the error details on query failures for this metric." - }, - "errorMessage": { - "type": "string", - "description": "Error message encountered querying this specific metric." - }, - "unit": { - "$ref": "./commonMonitoringTypes.json#/definitions/MetricUnit", - "description": "The unit of the metric." - }, - "timeseries": { - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesElement" - }, - "description": "the time series returned when a data query is performed." - } - }, - "required": [ - "id", - "type", - "name", - "unit", - "timeseries" - ] - }, - "TimeSeriesElement": { - "type": "object", - "description": "A time series result type. The discriminator value is always TimeSeries in this case.", - "properties": { - "metadatavalues": { - "type": "array", - "items": { - "$ref": "#/definitions/MetadataValue" - }, - "description": "the metadata values returned if $filter was specified in the call." - }, - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricValue" - }, - "description": "An array of data points representing the metric values. This is only returned if a result type of data is specified." - } - } - } - }, - "parameters": { - "TimespanParameter": { - "name": "timespan", - "in": "query", - "required": false, - "type": "string", - "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", - "x-ms-parameter-location": "method" - }, - "IntervalParameter": { - "name": "interval", - "in": "query", - "required": false, - "type": "string", - "format": "duration", - "description": "The interval (i.e. timegrain) of the query.", - "x-ms-parameter-location": "method" - }, - "MetricNamesParameter": { - "name": "metricnames", - "in": "query", - "required": false, - "type": "string", - "description": "The names of the metrics (comma separated) to retrieve.", - "x-ms-parameter-location": "method" - }, - "AggregationsParameter": { - "name": "aggregation", - "in": "query", - "required": false, - "type": "string", - "description": "The list of aggregation types (comma separated) to retrieve.", - "x-ms-parameter-location": "method" - }, - "FilterParameter": { - "name": "$filter", - "in": "query", - "type": "string", - "description": "The **$filter** is used to reduce the set of metric data returned.
Example:
Metric contains metadata A, B and C.
- Return all time series of C where A = a1 and B = b1 or b2
**$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical or operator cannot separate two different metadata names.
- Return all time series where A = a1, B = b1 and C = c1:
**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**
- Return all time series where A = a1
**$filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’**.", - "required": false, - "x-ms-parameter-location": "method" - }, - "TopParameter": { - "name": "top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "The maximum number of records to retrieve.\nValid only if $filter is specified.\nDefaults to 10.", - "x-ms-parameter-location": "method" - }, - "OrderByParameter": { - "name": "orderby", - "in": "query", - "required": false, - "type": "string", - "description": "The aggregation to use for sorting results and the direction of the sort.\nOnly one order can be specified.\nExamples: sum asc.", - "x-ms-parameter-location": "method" - }, - "RollUpByParameter": { - "name": "rollupby", - "in": "query", - "required": false, - "type": "string", - "description": "Dimension name(s) to rollup results by. For example if you only want to see metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't want to see separate values for each city, you can specify 'RollUpBy=City' to see the results for Seattle and Tacoma rolled up into one timeseries.", - "x-ms-parameter-location": "method" - }, - "SubscriptionScopeResultTypeParameter": { - "name": "resultType", - "in": "query", - "type": "string", - "enum": [ - "Data", - "Metadata" - ], - "x-ms-enum": { - "name": "MetricResultType", - "modelAsString": true - }, - "description": "Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.", - "x-ms-parameter-location": "method", - "required": false - }, - "ResultTypeParameter": { - "name": "resultType", - "in": "query", - "type": "string", - "enum": [ - "Data", - "Metadata" - ], - "x-ms-enum": { - "name": "ResultType", - "modelAsString": false - }, - "description": "Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.", - "x-ms-parameter-location": "method", - "required": false - }, - "AutoAdjustTimegrain": { - "name": "AutoAdjustTimegrain", - "in": "query", - "required": false, - "type": "boolean", - "description": "When set to true, if the timespan passed in is not supported by this metric, the API will return the result using the closest supported timespan. When set to false, an error is returned for invalid timespan parameters. Defaults to false.", - "x-ms-parameter-location": "method" - }, - "ValidateDimensions": { - "name": "ValidateDimensions", - "in": "query", - "required": false, - "type": "boolean", - "description": "When set to false, invalid filter parameter values will be ignored. When set to true, an error is returned for invalid filter parameters. Defaults to true.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2021-05-01/operations_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2021-05-01/operations_API.json deleted file mode 100644 index c0b730551..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2021-05-01/operations_API.json +++ /dev/null @@ -1,287 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Monitor Operations API", - "description": "Lists all of the possible operations available for the Azure Monitor resource provider.", - "version": "2021-05-01", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - } - }, - "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.Insights/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all of the available operations from Microsoft.Insights provider.", - "operationId": "Operations_List", - "x-ms-examples": { - "Get a list of operations for a resource provider": { - "$ref": "./examples/OperationList.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "./commonMonitoringTypes.json#/definitions/ErrorContract" - } - } - } - } - } - }, - "definitions": { - "OperationListResult": { - "description": "Result of the request to list Microsoft.Insights operations. It contains a list of operations and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of operations supported by the Microsoft.Insights provider." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - } - }, - "Operation": { - "description": "Microsoft Insights API operation definition.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "isDataAction": { - "type": "boolean", - "description": "Property to specify whether the action is a data action." - }, - "display": { - "description": "Display metadata associated with the operation.", - "type": "object", - "properties": { - "publisher": { - "description": "The publisher of this operation.", - "type": "string" - }, - "provider": { - "description": "Service provider: Microsoft.Insights", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed: AlertRules, Autoscale, etc.", - "type": "string" - }, - "operation": { - "description": "Operation type: Read, write, delete, etc.", - "type": "string" - }, - "description": { - "description": "The description of the operation.", - "type": "string" - } - } - }, - "properties": { - "description": "Properties of operation, include metric specifications.", - "x-ms-client-flatten": true, - "x-ms-client-name": "OperationProperties", - "$ref": "#/definitions/OperationProperties" - } - } - }, - "OperationProperties": { - "description": "Properties of operation, include metric specifications.", - "type": "object", - "properties": { - "serviceSpecification": { - "$ref": "#/definitions/ServiceSpecification", - "description": "One property of operation, include metric specifications." - } - } - }, - "ServiceSpecification": { - "description": "One property of operation, include log specifications.", - "type": "object", - "properties": { - "logSpecifications": { - "description": "Log specifications of operation.", - "type": "array", - "items": { - "$ref": "#/definitions/LogSpecification" - } - }, - "metricSpecifications": { - "description": "Metric specifications of operation.", - "type": "array", - "items": { - "$ref": "#/definitions/MetricSpecification" - } - }, - "legacyMetricSpecifications": { - "description": "Legacy Metric specifications for operation. Deprecated, do not use.", - "type": "object" - } - } - }, - "LogSpecification": { - "description": "Log specification of operation.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of log specification." - }, - "displayName": { - "type": "string", - "description": "Display name of log specification." - }, - "blobDuration": { - "type": "string", - "description": "Blob duration of specification." - } - } - }, - "MetricSpecification": { - "description": "Metric specification of operation.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the metric." - }, - "displayName": { - "type": "string", - "description": "Display name of the metric." - }, - "displayDescription": { - "type": "string", - "description": "Display description of the metric." - }, - "unit": { - "type": "string", - "description": "The metric unit. Possible values include: Count,Bytes,Seconds,Percent,CountPerSecond,BytesPerSecond,MilliSeconds,ByteSeconds,Unspecified,BitsPerSecond,Cores,MilliCores,NanoCores" - }, - "aggregationType": { - "type": "string", - "description": "The default metric aggregation type. Possible values include: Total,Average,Maximum,Minimum,Count" - }, - "supportedAggregationTypes": { - "type": "array", - "description": "The supported aggregation types for the metrics.", - "items": { - "type": "string" - } - }, - "supportedTimeGrainTypes": { - "type": "array", - "description": "The supported time grain types for the metrics.", - "items": { - "type": "string" - } - }, - "availabilities": { - "type": "array", - "description": "The supported time grain types for the metrics.", - "items": { - "type": "string" - } - }, - "lockAggregationType": { - "type": "string", - "description": "The metric lock aggregation type." - }, - "category": { - "type": "string", - "description": "Category or type of metric." - }, - "dimensions": { - "type": "array", - "description": "The dimensions of metric.", - "items": { - "$ref": "#/definitions/DimensionProperties" - } - }, - "fillGapWithZero": { - "type": "boolean", - "description": "Property to specify whether to fill empty gaps with zero." - }, - "internalMetricName": { - "type": "string", - "description": "The internal metric name." - } - } - }, - "DimensionProperties": { - "description": "Type of operation: get, read, delete, etc.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of dimension." - }, - "displayName": { - "type": "string", - "description": "Display name of dimension." - }, - "toBeExportedForShoebox": { - "type": "boolean", - "description": "Legacy usage, should not set." - }, - "isHidden": { - "type": "boolean", - "description": "When set, the dimension is hidden from the customer, used in conjunction with the defaultDimensionValues field below" - }, - "defaultDimensionValues": { - "type": "object", - "description": "Default dimension value to be sent down for the hidden dimension during query" - } - } - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/actionGroups_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/actionGroups_API.json deleted file mode 100644 index 000cfdb7a..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/actionGroups_API.json +++ /dev/null @@ -1,1411 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Action Groups API", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2022-06-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}": { - "put": { - "description": "Create a new action group or update an existing one.", - "operationId": "ActionGroups_CreateOrUpdate", - "x-ms-examples": { - "Create or update an action group": { - "$ref": "./examples/createOrUpdateActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "name": "actionGroup", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActionGroupResource" - }, - "description": "The action group to create or use for the update." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "An existing action group was successfully updated.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - }, - "201": { - "description": "A new action group was successfully created.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - }, - "default": { - "description": "An error occurred and the action group could not be created or updated.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "description": "Get an action group.", - "operationId": "ActionGroups_Get", - "x-ms-examples": { - "Get an action group": { - "$ref": "./examples/getActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - }, - "default": { - "description": "An error occurred and the action group could not be retrieved. 404: The action group does not exist.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "description": "Delete an action group.", - "operationId": "ActionGroups_Delete", - "x-ms-examples": { - "Delete an action group": { - "$ref": "./examples/deleteActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The action group was successfully deleted." - }, - "204": { - "description": "The action group does not exist. It may have already been deleted." - }, - "default": { - "description": "An error occurred and the action group could not be deleted.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "description": "Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.", - "operationId": "ActionGroups_Update", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "actionGroupPatch", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActionGroupPatchBody" - }, - "description": "Parameters supplied to the operation." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "An existing action group was successfully updated.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - } - }, - "x-ms-examples": { - "Patch an action group": { - "$ref": "./examples/patchActionGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/createNotifications": { - "post": { - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "description": "Send test notifications to a set of provided receivers", - "operationId": "ActionGroups_PostTestNotifications", - "x-ms-examples": { - "Create notifications at subscription level": { - "$ref": "./examples/postTestNotifications.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "notificationRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NotificationRequestBody" - }, - "description": "The notification request body which includes the contact details" - } - ], - "responses": { - "202": { - "description": "The notification request accepted", - "headers": { - "location": { - "type": "string", - "description": "The location header that has the polling uri." - } - } - }, - "200": { - "description": "The notification succeeded", - "schema": { - "$ref": "#/definitions/TestNotificationDetailsResponse" - } - }, - "default": { - "description": "An error occurred while sending the test notifications", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/createNotifications": { - "post": { - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "description": "Send test notifications to a set of provided receivers", - "operationId": "ActionGroups_CreateNotificationsAtResourceGroupLevel", - "x-ms-examples": { - "Create notifications at resource group level": { - "$ref": "./examples/postTestNotificationsAtResourceGroupLevel.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "notificationRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NotificationRequestBody" - }, - "description": "The notification request body which includes the contact details" - } - ], - "responses": { - "202": { - "description": "The notification request accepted", - "headers": { - "location": { - "type": "string", - "description": "The location header that has the polling uri." - } - } - }, - "200": { - "description": "The notification succeeded", - "schema": { - "$ref": "#/definitions/TestNotificationDetailsResponse" - } - }, - "default": { - "description": "An error occurred while sending the test notifications", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/createNotifications": { - "post": { - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "description": "Send test notifications to a set of provided receivers", - "operationId": "ActionGroups_CreateNotificationsAtActionGroupResourceLevel", - "x-ms-examples": { - "Create notifications at resource group level": { - "$ref": "./examples/postTestNotificationsAtActionGroupResourceLevel.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "notificationRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NotificationRequestBody" - }, - "description": "The notification request body which includes the contact details" - } - ], - "responses": { - "202": { - "description": "The notification request accepted", - "headers": { - "location": { - "type": "string", - "description": "The location header that has the polling uri." - } - } - }, - "200": { - "description": "The notification succeeded", - "schema": { - "$ref": "#/definitions/TestNotificationDetailsResponse" - } - }, - "default": { - "description": "An error occurred while sending the test notifications", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/notificationStatus/{notificationId}": { - "get": { - "description": "Get the test notifications by the notification id", - "operationId": "ActionGroups_GetTestNotifications", - "x-ms-examples": { - "Get notification details at subscription level": { - "$ref": "./examples/getTestNotifications.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/NotificationIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The notification details", - "schema": { - "$ref": "#/definitions/TestNotificationDetailsResponse" - } - }, - "default": { - "description": "An error occurred while sending the test notifications", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/notificationStatus/{notificationId}": { - "get": { - "description": "Get the test notifications by the notification id", - "operationId": "ActionGroups_GetTestNotificationsAtResourceGroupLevel", - "x-ms-examples": { - "Get notification details at resource group level": { - "$ref": "./examples/getTestNotificationsAtResourceGroupLevel.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NotificationIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The notification details", - "schema": { - "$ref": "#/definitions/TestNotificationDetailsResponse" - } - }, - "default": { - "description": "An error occurred while sending the test notifications", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/notificationStatus/{notificationId}": { - "get": { - "description": "Get the test notifications by the notification id", - "operationId": "ActionGroups_GetTestNotificationsAtActionGroupResourceLevel", - "x-ms-examples": { - "Get notification details at resource group level": { - "$ref": "./examples/getTestNotificationsAtActionGroupResourceLevel.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "#/parameters/NotificationIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The notification details", - "schema": { - "$ref": "#/definitions/TestNotificationDetailsResponse" - } - }, - "default": { - "description": "An error occurred while sending the test notifications", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/actionGroups": { - "get": { - "description": "Get a list of all action groups in a subscription.", - "operationId": "ActionGroups_ListBySubscriptionId", - "x-ms-examples": { - "List action groups at subscription level": { - "$ref": "./examples/listActionGroups.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/ActionGroupList" - } - }, - "default": { - "description": "An error occurred and the list of action groups could not be retrieved.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups": { - "get": { - "description": "Get a list of all action groups in a resource group.", - "operationId": "ActionGroups_ListByResourceGroup", - "x-ms-examples": { - "List action groups at resource group level": { - "$ref": "./examples/listActionGroups.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/ActionGroupList" - } - }, - "default": { - "description": "An error occurred and the list of action groups could not be retrieved.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/subscribe": { - "post": { - "description": "Enable a receiver in an action group. This changes the receiver's status from Disabled to Enabled. This operation is only supported for Email or SMS receivers.", - "operationId": "ActionGroups_EnableReceiver", - "x-ms-examples": { - "Enable the receiver": { - "$ref": "./examples/enableReceiver.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "name": "enableRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/EnableRequest" - }, - "description": "The receiver to re-enable." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The receiver was successfully enabled." - }, - "409": { - "description": "The receiver is already enabled in the action group.", - "x-ms-error-response": true - }, - "default": { - "description": "An error occurred and the receiver could not be enabled, e.g.: 404: The action group was not found or no matching receiver was found in the action group.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "AzureResource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Azure resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "additionalProperties": { - "type": "string" - }, - "type": "object", - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "type": "object", - "x-ms-azure-resource": true, - "description": "An azure resource object" - }, - "TestNotificationDetailsResponse": { - "description": "The details of the test notification results.", - "type": "object", - "properties": { - "context": { - "type": "object", - "$ref": "#/definitions/Context" - }, - "state": { - "type": "string", - "description": "The overall state" - }, - "completedTime": { - "type": "string", - "description": "The completed time" - }, - "createdTime": { - "type": "string", - "description": "The created time" - }, - "actionDetails": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/ActionDetail" - }, - "description": "The list of action detail" - } - }, - "required": [ - "state" - ] - }, - "ActionDetail": { - "description": "The action detail", - "type": "object", - "properties": { - "MechanismType": { - "type": "string", - "description": "The mechanism type" - }, - "Name": { - "type": "string", - "description": "The name of the action" - }, - "Status": { - "type": "string", - "description": "The status of the action" - }, - "SubState": { - "type": "string", - "description": "The substatus of the action" - }, - "SendTime": { - "type": "string", - "description": "The send time" - }, - "Detail": { - "type": "string", - "description": "The detail of the friendly error message" - } - } - }, - "Context": { - "description": "The context info", - "type": "object", - "properties": { - "notificationSource": { - "type": "string", - "description": "The source of the notification request" - }, - "contextType": { - "type": "string", - "description": "The context id type" - } - } - }, - "ActionGroupResource": { - "description": "An action group resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AzureResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ActionGroup", - "description": "The action groups properties of the resource." - } - } - }, - "ActionGroupList": { - "description": "A list of action groups.", - "type": "object", - "properties": { - "value": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/ActionGroupResource" - }, - "description": "The list of action groups." - }, - "nextLink": { - "type": "string", - "description": "Provides the link to retrieve the next set of elements." - } - } - }, - "NotificationRequestBody": { - "description": "The request body which contain contact detail metadata", - "type": "object", - "properties": { - "alertType": { - "type": "string", - "maxLength": 30, - "description": "The value of the supported alert type. Supported alert type values are: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget" - }, - "emailReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/EmailReceiver" - }, - "description": "The list of email receivers that are part of this action group." - }, - "smsReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/SmsReceiver" - }, - "description": "The list of SMS receivers that are part of this action group." - }, - "webhookReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/WebhookReceiver" - }, - "description": "The list of webhook receivers that are part of this action group." - }, - "itsmReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/ItsmReceiver" - }, - "description": "The list of ITSM receivers that are part of this action group." - }, - "azureAppPushReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/AzureAppPushReceiver" - }, - "description": "The list of AzureAppPush receivers that are part of this action group." - }, - "automationRunbookReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/AutomationRunbookReceiver" - }, - "description": "The list of AutomationRunbook receivers that are part of this action group." - }, - "voiceReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/VoiceReceiver" - }, - "description": "The list of voice receivers that are part of this action group." - }, - "logicAppReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/LogicAppReceiver" - }, - "description": "The list of logic app receivers that are part of this action group." - }, - "azureFunctionReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/AzureFunctionReceiver" - }, - "description": "The list of azure function receivers that are part of this action group." - }, - "armRoleReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/ArmRoleReceiver" - }, - "description": "The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported." - }, - "eventHubReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/EventHubReceiver" - }, - "description": "The list of event hub receivers that are part of this action group." - } - }, - "required": [ - "alertType" - ] - }, - "ActionGroup": { - "description": "An Azure action group.", - "type": "object", - "properties": { - "groupShortName": { - "type": "string", - "maxLength": 12, - "description": "The short name of the action group. This will be used in SMS messages." - }, - "enabled": { - "type": "boolean", - "default": true, - "description": "Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications." - }, - "emailReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/EmailReceiver" - }, - "description": "The list of email receivers that are part of this action group." - }, - "smsReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/SmsReceiver" - }, - "description": "The list of SMS receivers that are part of this action group." - }, - "webhookReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/WebhookReceiver" - }, - "description": "The list of webhook receivers that are part of this action group." - }, - "itsmReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/ItsmReceiver" - }, - "description": "The list of ITSM receivers that are part of this action group." - }, - "azureAppPushReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/AzureAppPushReceiver" - }, - "description": "The list of AzureAppPush receivers that are part of this action group." - }, - "automationRunbookReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/AutomationRunbookReceiver" - }, - "description": "The list of AutomationRunbook receivers that are part of this action group." - }, - "voiceReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/VoiceReceiver" - }, - "description": "The list of voice receivers that are part of this action group." - }, - "logicAppReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/LogicAppReceiver" - }, - "description": "The list of logic app receivers that are part of this action group." - }, - "azureFunctionReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/AzureFunctionReceiver" - }, - "description": "The list of azure function receivers that are part of this action group." - }, - "armRoleReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/ArmRoleReceiver" - }, - "description": "The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported." - }, - "eventHubReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/EventHubReceiver" - }, - "description": "The list of event hub receivers that are part of this action group." - } - }, - "required": [ - "groupShortName", - "enabled" - ] - }, - "EmailReceiver": { - "description": "An email receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the email receiver. Names must be unique across all receivers within an action group." - }, - "emailAddress": { - "type": "string", - "description": "The email address of this receiver." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ReceiverStatus", - "description": "The receiver status of the e-mail." - } - }, - "required": [ - "name", - "emailAddress" - ] - }, - "SmsReceiver": { - "description": "An SMS receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the SMS receiver. Names must be unique across all receivers within an action group." - }, - "countryCode": { - "type": "string", - "description": "The country code of the SMS receiver." - }, - "phoneNumber": { - "type": "string", - "description": "The phone number of the SMS receiver." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ReceiverStatus", - "description": "The status of the receiver." - } - }, - "required": [ - "name", - "countryCode", - "phoneNumber" - ] - }, - "WebhookReceiver": { - "description": "A webhook receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the webhook receiver. Names must be unique across all receivers within an action group." - }, - "serviceUri": { - "type": "string", - "description": "The URI where webhooks should be sent." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - }, - "useAadAuth": { - "type": "boolean", - "default": false, - "description": "Indicates whether or not use AAD authentication." - }, - "objectId": { - "type": "string", - "description": "Indicates the webhook app object Id for aad auth." - }, - "identifierUri": { - "type": "string", - "description": "Indicates the identifier uri for aad auth." - }, - "tenantId": { - "type": "string", - "description": "Indicates the tenant id for aad auth." - } - }, - "required": [ - "name", - "serviceUri" - ] - }, - "ItsmReceiver": { - "description": "An Itsm receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the Itsm receiver. Names must be unique across all receivers within an action group." - }, - "workspaceId": { - "type": "string", - "description": "OMS LA instance identifier." - }, - "connectionId": { - "type": "string", - "description": "Unique identification of ITSM connection among multiple defined in above workspace." - }, - "ticketConfiguration": { - "type": "string", - "description": "JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well." - }, - "region": { - "type": "string", - "description": "Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'" - } - }, - "required": [ - "name", - "workspaceId", - "connectionId", - "ticketConfiguration", - "region" - ] - }, - "EventHubReceiver": { - "description": "An Event hub receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the Event hub receiver. Names must be unique across all receivers within an action group." - }, - "eventHubNameSpace": { - "type": "string", - "description": "The Event Hub namespace" - }, - "eventHubName": { - "type": "string", - "description": "The name of the specific Event Hub queue" - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - }, - "tenantId": { - "type": "string", - "description": "The tenant Id for the subscription containing this event hub" - }, - "subscriptionId": { - "type": "string", - "description": "The Id for the subscription containing this event hub" - } - }, - "required": [ - "name", - "eventHubNameSpace", - "eventHubName", - "subscriptionId" - ] - }, - "AzureAppPushReceiver": { - "description": "The Azure mobile App push notification receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group." - }, - "emailAddress": { - "type": "string", - "description": "The email address registered for the Azure mobile app." - } - }, - "required": [ - "name", - "emailAddress" - ] - }, - "AutomationRunbookReceiver": { - "description": "The Azure Automation Runbook notification receiver.", - "type": "object", - "properties": { - "automationAccountId": { - "type": "string", - "description": "The Azure automation account Id which holds this runbook and authenticate to Azure resource." - }, - "runbookName": { - "type": "string", - "description": "The name for this runbook." - }, - "webhookResourceId": { - "type": "string", - "description": "The resource id for webhook linked to this runbook." - }, - "isGlobalRunbook": { - "type": "boolean", - "description": "Indicates whether this instance is global runbook." - }, - "name": { - "type": "string", - "description": "Indicates name of the webhook." - }, - "serviceUri": { - "type": "string", - "description": "The URI where webhooks should be sent." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - } - }, - "required": [ - "automationAccountId", - "runbookName", - "webhookResourceId", - "isGlobalRunbook" - ] - }, - "VoiceReceiver": { - "description": "A voice receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the voice receiver. Names must be unique across all receivers within an action group." - }, - "countryCode": { - "type": "string", - "description": "The country code of the voice receiver." - }, - "phoneNumber": { - "type": "string", - "description": "The phone number of the voice receiver." - } - }, - "required": [ - "name", - "countryCode", - "phoneNumber" - ] - }, - "LogicAppReceiver": { - "description": "A logic app receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the logic app receiver. Names must be unique across all receivers within an action group." - }, - "resourceId": { - "type": "string", - "description": "The azure resource id of the logic app receiver." - }, - "callbackUrl": { - "type": "string", - "description": "The callback url where http request sent to." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - } - }, - "required": [ - "name", - "resourceId", - "callbackUrl" - ] - }, - "AzureFunctionReceiver": { - "description": "An azure function receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the azure function receiver. Names must be unique across all receivers within an action group." - }, - "functionAppResourceId": { - "type": "string", - "description": "The azure resource id of the function app." - }, - "functionName": { - "type": "string", - "description": "The function name in the function app." - }, - "httpTriggerUrl": { - "type": "string", - "description": "The http trigger url where http request sent to." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - } - }, - "required": [ - "name", - "functionAppResourceId", - "functionName", - "httpTriggerUrl" - ] - }, - "ArmRoleReceiver": { - "description": "An arm role receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the arm role receiver. Names must be unique across all receivers within an action group." - }, - "roleId": { - "type": "string", - "description": "The arm role id." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - } - }, - "required": [ - "name", - "roleId" - ] - }, - "ReceiverStatus": { - "type": "string", - "enum": [ - "NotSpecified", - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "ReceiverStatus", - "modelAsString": false - }, - "description": "Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications." - }, - "EnableRequest": { - "description": "Describes a receiver that should be resubscribed.", - "type": "object", - "properties": { - "receiverName": { - "type": "string", - "description": "The name of the receiver to resubscribe." - } - }, - "required": [ - "receiverName" - ] - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "ActionGroupPatchBody": { - "description": "An action group object for the body of patch operations.", - "type": "object", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ActionGroupPatch", - "description": "The action group settings for an update operation." - } - } - }, - "ActionGroupPatch": { - "description": "An Azure action group for patch operations.", - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "default": true, - "description": "Indicates whether this action group is enabled. If an action group is not enabled, then none of its actions will be activated." - } - } - } - }, - "parameters": { - "NotificationIdParameter": { - "name": "notificationId", - "in": "path", - "required": true, - "type": "string", - "description": "The notification id", - "x-ms-parameter-location": "method" - }, - "ActionGroupNameParameter": { - "name": "actionGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the action group.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/dataCollectionEndpoints_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/dataCollectionEndpoints_API.json deleted file mode 100644 index dd51f0bbf..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/dataCollectionEndpoints_API.json +++ /dev/null @@ -1,739 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Monitor Data Collection Endpoints API", - "description": "Provides operations for working with Azure Monitor data collection endpoints", - "version": "2022-06-01", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints": { - "get": { - "tags": [ - "DataCollectionEndpoints" - ], - "summary": "Lists all data collection endpoints in the specified resource group.", - "operationId": "DataCollectionEndpoints_ListByResourceGroup", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request completed successfully", - "schema": { - "$ref": "#/definitions/DataCollectionEndpointResourceListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List data collection endpoints by resource group": { - "$ref": "./examples/DataCollectionEndpointsListByResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/dataCollectionEndpoints": { - "get": { - "tags": [ - "DataCollectionEndpoints" - ], - "summary": "Lists all data collection endpoints in the specified subscription", - "operationId": "DataCollectionEndpoints_ListBySubscription", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request completed successfully", - "schema": { - "$ref": "#/definitions/DataCollectionEndpointResourceListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List data collection endpoints by subscription": { - "$ref": "./examples/DataCollectionEndpointsListBySubscription.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}": { - "get": { - "tags": [ - "DataCollectionEndpoints" - ], - "summary": "Returns the specified data collection endpoint.", - "operationId": "DataCollectionEndpoints_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DataCollectionEndpointNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request completed successfully", - "schema": { - "$ref": "#/definitions/DataCollectionEndpointResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-examples": { - "Get data collection endpoint": { - "$ref": "./examples/DataCollectionEndpointsGet.json" - } - } - }, - "put": { - "tags": [ - "DataCollectionEndpoints" - ], - "summary": "Creates or updates a data collection endpoint.", - "operationId": "DataCollectionEndpoints_Create", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DataCollectionEndpointNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "The payload", - "schema": { - "$ref": "#/definitions/DataCollectionEndpointResource" - } - } - ], - "responses": { - "200": { - "description": "Data collection endpoint was successfully updated", - "schema": { - "$ref": "#/definitions/DataCollectionEndpointResource" - } - }, - "201": { - "description": "Data collection endpoint was successfully created", - "schema": { - "$ref": "#/definitions/DataCollectionEndpointResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-examples": { - "Create or update data collection endpoint": { - "$ref": "./examples/DataCollectionEndpointsCreate.json" - } - } - }, - "patch": { - "tags": [ - "DataCollectionEndpoints" - ], - "summary": "Updates part of a data collection endpoint.", - "operationId": "DataCollectionEndpoints_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DataCollectionEndpointNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "The payload", - "schema": { - "$ref": "#/definitions/ResourceForUpdate" - } - } - ], - "responses": { - "200": { - "description": "Data collection endpoint was successfully updated", - "schema": { - "$ref": "#/definitions/DataCollectionEndpointResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-examples": { - "Update data collection endpoint": { - "$ref": "./examples/DataCollectionEndpointsUpdate.json" - } - } - }, - "delete": { - "tags": [ - "DataCollectionEndpoints" - ], - "summary": "Deletes a data collection endpoint.", - "operationId": "DataCollectionEndpoints_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DataCollectionEndpointNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Data collection endpoint was successfully deleted" - }, - "204": { - "description": "Data collection endpoint did not exist" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-examples": { - "Delete data collection endpoint": { - "$ref": "./examples/DataCollectionEndpointsDelete.json" - } - } - } - } - }, - "definitions": { - "ConfigurationAccessEndpointSpec": { - "description": "Definition of the endpoint used for accessing configuration.", - "type": "object", - "properties": { - "endpoint": { - "description": "The endpoint. This property is READ-ONLY.", - "type": "string", - "readOnly": true, - "example": "https://mydce-abcd.eastus-1.control.monitor.azure.com", - "x-ms-mutability": [ - "read" - ] - } - } - }, - "LogsIngestionEndpointSpec": { - "description": "Definition of the endpoint used for ingesting logs.", - "type": "object", - "properties": { - "endpoint": { - "description": "The endpoint. This property is READ-ONLY.", - "type": "string", - "readOnly": true, - "example": "https://mydce-abcd.eastus-1.ingest.monitor.azure.com", - "x-ms-mutability": [ - "read" - ] - } - } - }, - "MetricsIngestionEndpointSpec": { - "description": "Definition of the endpoint used for ingesting metrics.", - "type": "object", - "properties": { - "endpoint": { - "description": "The endpoint. This property is READ-ONLY.", - "type": "string", - "readOnly": true, - "example": "https://mydce-abcd.eastus-1.ingest.monitor.azure.com", - "x-ms-mutability": [ - "read" - ] - } - } - }, - "NetworkRuleSet": { - "description": "Definition of the network rules.", - "type": "object", - "properties": { - "publicNetworkAccess": { - "description": "The configuration to set whether network access from public internet to the endpoints are allowed.", - "enum": [ - "Enabled", - "Disabled", - "SecuredByPerimeter" - ], - "type": "string", - "x-ms-enum": { - "name": "KnownPublicNetworkAccessOptions", - "modelAsString": true - } - } - } - }, - "PrivateLinkScopedResource": { - "type": "object", - "properties": { - "resourceId": { - "description": "The resourceId of the Azure Monitor Private Link Scope Scoped Resource through which this DCE is associated with a Azure Monitor Private Link Scope.", - "type": "string", - "example": "/subscriptions/57947cb5-aadd-4b6c-9e8e-2125e5cb7bf5/resourceGroups/testResourceGroup/providers/microsoft.insights/privatelinkscopes/my-scope/scopedResources/my-scoped-resource" - }, - "scopeId": { - "description": "The immutableId of the Azure Monitor Private Link Scope Resource to which the association is.", - "type": "string", - "example": "b74e0d-383fc9415abaa-584ec41-adece3" - } - } - }, - "LocationSpec": { - "type": "object", - "properties": { - "location": { - "description": "Name of location.", - "type": "string", - "example": "East US" - }, - "provisioningStatus": { - "description": "The resource provisioning state in this location.", - "enum": [ - "Creating", - "Updating", - "Deleting", - "Succeeded", - "Canceled", - "Failed" - ], - "type": "string", - "example": "Creating", - "x-ms-enum": { - "name": "KnownLocationSpecProvisioningStatus", - "modelAsString": true - } - } - } - }, - "FailoverConfigurationSpec": { - "type": "object", - "properties": { - "activeLocation": { - "description": "Active location where data flow will occur.", - "type": "string", - "example": "East US" - }, - "locations": { - "description": "Locations that are configured for failover.", - "type": "array", - "items": { - "$ref": "#/definitions/LocationSpec" - }, - "x-ms-identifiers": [ - "location" - ] - } - } - }, - "Metadata": { - "description": "Metadata about the resource", - "type": "object", - "properties": { - "provisionedBy": { - "description": "Azure offering managing this resource on-behalf-of customer.", - "type": "string", - "readOnly": true, - "example": "Azure Security Center", - "x-ms-mutability": [ - "read" - ] - }, - "provisionedByResourceId": { - "description": "Resource Id of azure offering managing this resource on-behalf-of customer.", - "type": "string", - "readOnly": true, - "example": "/subscriptions/da58aca0-2082-4f5a-85ba-27344286c17c/resourceGroups/ws-rg/providers/Microsoft.OperationalInsights/workspaces/ws-name1", - "x-ms-mutability": [ - "read" - ] - } - } - }, - "DataCollectionEndpoint": { - "description": "Definition of data collection endpoint.", - "type": "object", - "properties": { - "description": { - "description": "Description of the data collection endpoint.", - "type": "string" - }, - "immutableId": { - "description": "The immutable ID of this data collection endpoint resource. This property is READ-ONLY.", - "type": "string", - "example": "dce-b74e0d383fc9415abaa584ec41adece3" - }, - "configurationAccess": { - "description": "The endpoint used by clients to access their configuration.", - "allOf": [ - { - "$ref": "#/definitions/ConfigurationAccessEndpointSpec" - } - ] - }, - "logsIngestion": { - "description": "The endpoint used by clients to ingest logs.", - "allOf": [ - { - "$ref": "#/definitions/LogsIngestionEndpointSpec" - } - ] - }, - "metricsIngestion": { - "description": "The endpoint used by clients to ingest metrics.", - "allOf": [ - { - "$ref": "#/definitions/MetricsIngestionEndpointSpec" - } - ] - }, - "networkAcls": { - "description": "Network access control rules for the endpoints.", - "allOf": [ - { - "$ref": "#/definitions/NetworkRuleSet" - } - ] - }, - "provisioningState": { - "description": "The resource provisioning state. This property is READ-ONLY.", - "enum": [ - "Creating", - "Updating", - "Deleting", - "Succeeded", - "Canceled", - "Failed" - ], - "type": "string", - "readOnly": true, - "example": "Creating", - "x-ms-enum": { - "name": "KnownDataCollectionEndpointProvisioningState", - "modelAsString": true - }, - "x-ms-mutability": [ - "read" - ] - }, - "privateLinkScopedResources": { - "description": "List of Azure Monitor Private Link Scope Resources to which this data collection endpoint resource is associated. This property is READ-ONLY.", - "type": "array", - "items": { - "$ref": "#/definitions/PrivateLinkScopedResource" - }, - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-identifiers": [] - }, - "failoverConfiguration": { - "description": "Failover configuration on this endpoint. This property is READ-ONLY.", - "allOf": [ - { - "$ref": "#/definitions/FailoverConfigurationSpec" - } - ], - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "metadata": { - "description": "Metadata for the resource. This property is READ-ONLY.", - "allOf": [ - { - "$ref": "#/definitions/Metadata" - } - ], - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - } - } - }, - "DataCollectionEndpointResource": { - "description": "Definition of ARM tracked top level resource.", - "required": [ - "location" - ], - "type": "object", - "properties": { - "properties": { - "description": "Resource properties.", - "allOf": [ - { - "$ref": "#/definitions/DataCollectionEndpoint" - } - ], - "x-ms-client-flatten": true - }, - "location": { - "description": "The geo-location where the resource lives.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "kind": { - "description": "The kind of the resource.", - "enum": [ - "Linux", - "Windows" - ], - "type": "string", - "example": "Linux", - "x-ms-enum": { - "name": "KnownDataCollectionEndpointResourceKind", - "modelAsString": true - } - }, - "identity": { - "description": "Managed service identity of the resource.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" - } - ] - }, - "id": { - "description": "Fully qualified ID of the resource.", - "type": "string", - "readOnly": true, - "example": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myCollectionEndpoint", - "x-ms-mutability": [ - "read" - ] - }, - "name": { - "description": "The name of the resource.", - "type": "string", - "readOnly": true, - "example": "myCollectionEndpoint", - "x-ms-mutability": [ - "read" - ] - }, - "type": { - "description": "The type of the resource.", - "type": "string", - "readOnly": true, - "example": "Microsoft.Insights/dataCollectionEndpoints", - "x-ms-mutability": [ - "read" - ] - }, - "etag": { - "description": "Resource entity tag (ETag).", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "systemData": { - "description": "Metadata pertaining to creation and last modification of the resource.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - ], - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - } - }, - "x-ms-azure-resource": true - }, - "DataCollectionEndpointResourceListResult": { - "description": "A pageable list of resources.", - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "description": "A list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/DataCollectionEndpointResource" - } - }, - "nextLink": { - "description": "The URL to use for getting the next set of results.", - "type": "string" - } - } - }, - "ResourceForUpdate": { - "description": "Definition of ARM tracked top level resource properties for update operation.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "identity": { - "description": "Managed Service Identity.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" - } - ] - } - } - } - }, - "parameters": { - "DataCollectionEndpointNameParameter": { - "in": "path", - "name": "dataCollectionEndpointName", - "description": "The name of the data collection endpoint. The name is case insensitive.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/dataCollectionRuleAssociations_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/dataCollectionRuleAssociations_API.json deleted file mode 100644 index e6b0468dc..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/dataCollectionRuleAssociations_API.json +++ /dev/null @@ -1,516 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Monitor Data Collection Rule Associations API", - "description": "Provides operations for working with Azure Monitor data collection rule associations", - "version": "2022-06-01", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/{resourceUri}/providers/Microsoft.Insights/dataCollectionRuleAssociations": { - "get": { - "tags": [ - "DataCollectionRuleAssociations" - ], - "summary": "Lists associations for the specified resource.", - "operationId": "DataCollectionRuleAssociations_ListByResource", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ResourceUriParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request completed successfully", - "schema": { - "$ref": "#/definitions/DataCollectionRuleAssociationProxyOnlyResourceListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List associations for specified resource": { - "$ref": "./examples/DataCollectionRuleAssociationsListByResource.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dataCollectionRuleName}/associations": { - "get": { - "tags": [ - "DataCollectionRuleAssociations" - ], - "summary": "Lists associations for the specified data collection rule.", - "operationId": "DataCollectionRuleAssociations_ListByRule", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DataCollectionRuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request completed successfully", - "schema": { - "$ref": "#/definitions/DataCollectionRuleAssociationProxyOnlyResourceListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List associations for specified data collection rule": { - "$ref": "./examples/DataCollectionRuleAssociationsListByRule.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}/associations": { - "get": { - "tags": [ - "DataCollectionRuleAssociations" - ], - "summary": "Lists associations for the specified data collection endpoint.", - "operationId": "DataCollectionRuleAssociations_ListByDataCollectionEndpoint", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DataCollectionEndpointNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request completed successfully", - "schema": { - "$ref": "#/definitions/DataCollectionRuleAssociationProxyOnlyResourceListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List associations for specified data collection endpoint": { - "$ref": "./examples/DataCollectionRuleAssociationsListByDataCollectionEndpoint.json" - } - } - } - }, - "/{resourceUri}/providers/Microsoft.Insights/dataCollectionRuleAssociations/{associationName}": { - "get": { - "tags": [ - "DataCollectionRuleAssociations" - ], - "summary": "Returns the specified association.", - "operationId": "DataCollectionRuleAssociations_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ResourceUriParameter" - }, - { - "$ref": "#/parameters/AssociationNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request completed successfully", - "schema": { - "$ref": "#/definitions/DataCollectionRuleAssociationProxyOnlyResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-examples": { - "Get association": { - "$ref": "./examples/DataCollectionRuleAssociationsGet.json" - } - } - }, - "put": { - "tags": [ - "DataCollectionRuleAssociations" - ], - "summary": "Creates or updates an association.", - "operationId": "DataCollectionRuleAssociations_Create", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ResourceUriParameter" - }, - { - "$ref": "#/parameters/AssociationNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "The payload", - "schema": { - "$ref": "#/definitions/DataCollectionRuleAssociationProxyOnlyResource" - } - } - ], - "responses": { - "200": { - "description": "Association was successfully updated", - "schema": { - "$ref": "#/definitions/DataCollectionRuleAssociationProxyOnlyResource" - } - }, - "201": { - "description": "Association was successfully created", - "schema": { - "$ref": "#/definitions/DataCollectionRuleAssociationProxyOnlyResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-examples": { - "Create or update association": { - "$ref": "./examples/DataCollectionRuleAssociationsCreate.json" - } - } - }, - "delete": { - "tags": [ - "DataCollectionRuleAssociations" - ], - "summary": "Deletes an association.", - "operationId": "DataCollectionRuleAssociations_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ResourceUriParameter" - }, - { - "$ref": "#/parameters/AssociationNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Association was successfully deleted" - }, - "204": { - "description": "Association did not exist" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-examples": { - "Delete association": { - "$ref": "./examples/DataCollectionRuleAssociationsDelete.json" - } - } - } - } - }, - "definitions": { - "Metadata": { - "description": "Metadata about the resource", - "type": "object", - "properties": { - "provisionedBy": { - "description": "Azure offering managing this resource on-behalf-of customer.", - "type": "string", - "readOnly": true, - "example": "Azure Security Center", - "x-ms-mutability": [ - "read" - ] - }, - "provisionedByResourceId": { - "description": "Resource Id of azure offering managing this resource on-behalf-of customer.", - "type": "string", - "readOnly": true, - "example": "/subscriptions/da58aca0-2082-4f5a-85ba-27344286c17c/resourceGroups/ws-rg/providers/Microsoft.OperationalInsights/workspaces/ws-name1", - "x-ms-mutability": [ - "read" - ] - } - } - }, - "DataCollectionRuleAssociation": { - "description": "Definition of association of a data collection rule with a monitored Azure resource.", - "type": "object", - "properties": { - "description": { - "description": "Description of the association.", - "type": "string" - }, - "dataCollectionRuleId": { - "description": "The resource ID of the data collection rule that is to be associated.", - "type": "string", - "example": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule" - }, - "dataCollectionEndpointId": { - "description": "The resource ID of the data collection endpoint that is to be associated.", - "type": "string", - "example": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myCollectionEndpoint" - }, - "provisioningState": { - "description": "The resource provisioning state.", - "enum": [ - "Creating", - "Updating", - "Deleting", - "Succeeded", - "Canceled", - "Failed" - ], - "type": "string", - "readOnly": true, - "example": "Creating", - "x-ms-enum": { - "name": "KnownDataCollectionRuleAssociationProvisioningState", - "modelAsString": true - }, - "x-ms-mutability": [ - "read" - ] - }, - "metadata": { - "description": "Metadata about the resource", - "allOf": [ - { - "$ref": "#/definitions/Metadata" - } - ], - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - } - } - }, - "DataCollectionRuleAssociationProxyOnlyResource": { - "description": "Definition of generic ARM proxy resource.", - "type": "object", - "properties": { - "properties": { - "description": "Resource properties.", - "allOf": [ - { - "$ref": "#/definitions/DataCollectionRuleAssociation" - } - ], - "x-ms-client-flatten": true - }, - "id": { - "description": "Fully qualified ID of the resource.", - "type": "string", - "readOnly": true, - "example": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule", - "x-ms-mutability": [ - "read" - ] - }, - "name": { - "description": "The name of the resource.", - "type": "string", - "readOnly": true, - "example": "myCollectionRule", - "x-ms-mutability": [ - "read" - ] - }, - "type": { - "description": "The type of the resource.", - "type": "string", - "readOnly": true, - "example": "Microsoft.Insights/dataCollectionRules", - "x-ms-mutability": [ - "read" - ] - }, - "etag": { - "description": "Resource entity tag (ETag).", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "systemData": { - "description": "Metadata pertaining to creation and last modification of the resource.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - ], - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - } - }, - "x-ms-azure-resource": true - }, - "DataCollectionRuleAssociationProxyOnlyResourceListResult": { - "description": "A pageable list of resources.", - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "description": "A list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/DataCollectionRuleAssociationProxyOnlyResource" - } - }, - "nextLink": { - "description": "The URL to use for getting the next set of results.", - "type": "string" - } - } - } - }, - "parameters": { - "AssociationNameParameter": { - "in": "path", - "name": "associationName", - "description": "The name of the association. The name is case insensitive.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DataCollectionEndpointNameParameter": { - "in": "path", - "name": "dataCollectionEndpointName", - "description": "The name of the data collection endpoint. The name is case insensitive.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DataCollectionRuleNameParameter": { - "in": "path", - "name": "dataCollectionRuleName", - "description": "The name of the data collection rule. The name is case insensitive.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ResourceUriParameter": { - "in": "path", - "name": "resourceUri", - "description": "The identifier of the resource.", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/dataCollectionRules_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/dataCollectionRules_API.json deleted file mode 100644 index a9a3926aa..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-06-01/dataCollectionRules_API.json +++ /dev/null @@ -1,1445 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Monitor Data Collection Rules API", - "description": "Provides operations for working with Azure Monitor data collection rules", - "version": "2022-06-01", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules": { - "get": { - "tags": [ - "DataCollectionRules" - ], - "summary": "Lists all data collection rules in the specified resource group.", - "operationId": "DataCollectionRules_ListByResourceGroup", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request completed successfully", - "schema": { - "$ref": "#/definitions/DataCollectionRuleResourceListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List data collection rules by resource group": { - "$ref": "./examples/DataCollectionRulesListByResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/dataCollectionRules": { - "get": { - "tags": [ - "DataCollectionRules" - ], - "summary": "Lists all data collection rules in the specified subscription.", - "operationId": "DataCollectionRules_ListBySubscription", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request completed successfully", - "schema": { - "$ref": "#/definitions/DataCollectionRuleResourceListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List data collection rules by subscription": { - "$ref": "./examples/DataCollectionRulesListBySubscription.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dataCollectionRuleName}": { - "get": { - "tags": [ - "DataCollectionRules" - ], - "summary": "Returns the specified data collection rule.", - "operationId": "DataCollectionRules_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DataCollectionRuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request completed successfully", - "schema": { - "$ref": "#/definitions/DataCollectionRuleResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-examples": { - "Get data collection rule": { - "$ref": "./examples/DataCollectionRulesGet.json" - } - } - }, - "put": { - "tags": [ - "DataCollectionRules" - ], - "summary": "Creates or updates a data collection rule.", - "operationId": "DataCollectionRules_Create", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DataCollectionRuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "The payload", - "schema": { - "$ref": "#/definitions/DataCollectionRuleResource" - } - } - ], - "responses": { - "200": { - "description": "Data collection rule was successfully updated", - "schema": { - "$ref": "#/definitions/DataCollectionRuleResource" - } - }, - "201": { - "description": "Data collection rule was successfully created", - "schema": { - "$ref": "#/definitions/DataCollectionRuleResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-examples": { - "Create or update data collection rule": { - "$ref": "./examples/DataCollectionRulesCreate.json" - } - } - }, - "patch": { - "tags": [ - "DataCollectionRules" - ], - "summary": "Updates part of a data collection rule.", - "operationId": "DataCollectionRules_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DataCollectionRuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "The payload", - "schema": { - "$ref": "#/definitions/ResourceForUpdate" - } - } - ], - "responses": { - "200": { - "description": "Data collection rule was successfully updated", - "schema": { - "$ref": "#/definitions/DataCollectionRuleResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-examples": { - "Update data collection rule": { - "$ref": "./examples/DataCollectionRulesUpdate.json" - } - } - }, - "delete": { - "tags": [ - "DataCollectionRules" - ], - "summary": "Deletes a data collection rule.", - "operationId": "DataCollectionRules_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DataCollectionRuleNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Data collection rule was successfully deleted" - }, - "204": { - "description": "Data collection rule did not exist" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponseCommonV2" - } - } - }, - "x-ms-examples": { - "Delete data collection rule": { - "$ref": "./examples/DataCollectionRulesDelete.json" - } - } - } - } - }, - "definitions": { - "Metadata": { - "description": "Metadata about the resource", - "type": "object", - "properties": { - "provisionedBy": { - "description": "Azure offering managing this resource on-behalf-of customer.", - "type": "string", - "readOnly": true, - "example": "Azure Security Center", - "x-ms-mutability": [ - "read" - ] - }, - "provisionedByResourceId": { - "description": "Resource Id of azure offering managing this resource on-behalf-of customer.", - "type": "string", - "readOnly": true, - "example": "/subscriptions/da58aca0-2082-4f5a-85ba-27344286c17c/resourceGroups/ws-rg/providers/Microsoft.OperationalInsights/workspaces/ws-name1", - "x-ms-mutability": [ - "read" - ] - } - } - }, - "ColumnDefinition": { - "description": "Definition of custom data column.", - "type": "object", - "properties": { - "name": { - "description": "The name of the column.", - "type": "string" - }, - "type": { - "description": "The type of the column data.", - "enum": [ - "string", - "int", - "long", - "real", - "boolean", - "datetime", - "dynamic" - ], - "type": "string", - "x-ms-enum": { - "name": "KnownColumnDefinitionType", - "modelAsString": true - } - } - } - }, - "StreamDeclaration": { - "description": "Declaration of a custom stream.", - "type": "object", - "properties": { - "columns": { - "description": "List of columns used by data in this stream.", - "type": "array", - "items": { - "$ref": "#/definitions/ColumnDefinition" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "PerfCounterDataSource": { - "description": "Definition of which performance counters will be collected and how they will be collected by this data collection rule.\r\nCollected from both Windows and Linux machines where the counter is present.", - "type": "object", - "properties": { - "streams": { - "description": "List of streams that this data source will be sent to.\r\nA stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.", - "type": "array", - "items": { - "enum": [ - "Microsoft-Perf", - "Microsoft-InsightsMetrics" - ], - "type": "string", - "x-ms-enum": { - "name": "KnownPerfCounterDataSourceStreams", - "modelAsString": true - } - } - }, - "samplingFrequencyInSeconds": { - "format": "int32", - "description": "The number of seconds between consecutive counter measurements (samples).", - "type": "integer", - "example": 15 - }, - "counterSpecifiers": { - "description": "A list of specifier names of the performance counters you want to collect.\r\nUse a wildcard (*) to collect a counter for all instances.\r\nTo get a list of performance counters on Windows, run the command 'typeperf'.", - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "description": "A friendly name for the data source. \r\nThis name should be unique across all data sources (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDataSource1" - } - } - }, - "WindowsEventLogDataSource": { - "description": "Definition of which Windows Event Log events will be collected and how they will be collected.\r\nOnly collected from Windows machines.", - "type": "object", - "properties": { - "streams": { - "description": "List of streams that this data source will be sent to.\r\nA stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.", - "type": "array", - "items": { - "enum": [ - "Microsoft-WindowsEvent", - "Microsoft-Event" - ], - "type": "string", - "x-ms-enum": { - "name": "KnownWindowsEventLogDataSourceStreams", - "modelAsString": true - } - } - }, - "xPathQueries": { - "description": "A list of Windows Event Log queries in XPATH format.", - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "description": "A friendly name for the data source. \r\nThis name should be unique across all data sources (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDataSource1" - } - } - }, - "SyslogDataSource": { - "description": "Definition of which syslog data will be collected and how it will be collected.\r\nOnly collected from Linux machines.", - "type": "object", - "properties": { - "streams": { - "description": "List of streams that this data source will be sent to.\r\nA stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.", - "type": "array", - "items": { - "enum": [ - "Microsoft-Syslog" - ], - "type": "string", - "x-ms-enum": { - "name": "KnownSyslogDataSourceStreams", - "modelAsString": true - } - } - }, - "facilityNames": { - "description": "The list of facility names.", - "type": "array", - "items": { - "enum": [ - "auth", - "authpriv", - "cron", - "daemon", - "kern", - "lpr", - "mail", - "mark", - "news", - "syslog", - "user", - "uucp", - "local0", - "local1", - "local2", - "local3", - "local4", - "local5", - "local6", - "local7", - "*" - ], - "type": "string", - "x-ms-enum": { - "name": "KnownSyslogDataSourceFacilityNames", - "modelAsString": true - } - } - }, - "logLevels": { - "description": "The log levels to collect.", - "type": "array", - "items": { - "enum": [ - "Debug", - "Info", - "Notice", - "Warning", - "Error", - "Critical", - "Alert", - "Emergency", - "*" - ], - "type": "string", - "x-ms-enum": { - "name": "KnownSyslogDataSourceLogLevels", - "modelAsString": true - } - } - }, - "name": { - "description": "A friendly name for the data source. \r\nThis name should be unique across all data sources (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDataSource1" - } - } - }, - "ExtensionDataSource": { - "description": "Definition of which data will be collected from a separate VM extension that integrates with the Azure Monitor Agent.\r\nCollected from either Windows and Linux machines, depending on which extension is defined.", - "required": [ - "extensionName" - ], - "type": "object", - "properties": { - "streams": { - "description": "List of streams that this data source will be sent to.\r\nA stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.", - "type": "array", - "items": { - "enum": [ - "Microsoft-Event", - "Microsoft-InsightsMetrics", - "Microsoft-Perf", - "Microsoft-Syslog", - "Microsoft-WindowsEvent" - ], - "type": "string", - "x-ms-enum": { - "name": "KnownExtensionDataSourceStreams", - "modelAsString": true - } - } - }, - "extensionName": { - "description": "The name of the VM extension.", - "type": "string", - "example": "AzureSecurityLinuxAgent" - }, - "extensionSettings": { - "description": "The extension settings. The format is specific for particular extension.", - "type": "object" - }, - "inputDataSources": { - "description": "The list of data sources this extension needs data from.", - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "description": "A friendly name for the data source. \r\nThis name should be unique across all data sources (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDataSource1" - } - } - }, - "LogFileTextSettings": { - "description": "Settings for text log files", - "required": [ - "recordStartTimestampFormat" - ], - "type": "object", - "properties": { - "recordStartTimestampFormat": { - "description": "One of the supported timestamp formats", - "enum": [ - "ISO 8601", - "YYYY-MM-DD HH:MM:SS", - "M/D/YYYY HH:MM:SS AM/PM", - "Mon DD, YYYY HH:MM:SS", - "yyMMdd HH:mm:ss", - "ddMMyy HH:mm:ss", - "MMM d hh:mm:ss", - "dd/MMM/yyyy:HH:mm:ss zzz", - "yyyy-MM-ddTHH:mm:ssK" - ], - "type": "string", - "example": "ISO 8601, yyyy-MM-dd HH:mm:ss", - "x-ms-enum": { - "name": "KnownLogFileTextSettingsRecordStartTimestampFormat", - "modelAsString": true - } - } - } - }, - "LogFileSettings": { - "description": "Settings for different log file formats", - "type": "object", - "properties": { - "text": { - "description": "Text settings", - "allOf": [ - { - "$ref": "#/definitions/LogFileTextSettings" - } - ] - } - } - }, - "LogFilesDataSource": { - "description": "Definition of which custom log files will be collected by this data collection rule", - "required": [ - "filePatterns", - "format", - "streams" - ], - "type": "object", - "properties": { - "streams": { - "description": "List of streams that this data source will be sent to.\r\nA stream indicates what schema will be used for this data source", - "type": "array", - "items": { - "type": "string" - } - }, - "filePatterns": { - "description": "File Patterns where the log files are located", - "type": "array", - "items": { - "type": "string" - } - }, - "format": { - "description": "The data format of the log files", - "enum": [ - "text" - ], - "type": "string", - "example": "text", - "x-ms-enum": { - "name": "KnownLogFilesDataSourceFormat", - "modelAsString": true - } - }, - "settings": { - "description": "The log files specific settings.", - "allOf": [ - { - "$ref": "#/definitions/LogFileSettings" - } - ] - }, - "name": { - "description": "A friendly name for the data source. \r\nThis name should be unique across all data sources (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDataSource1" - } - } - }, - "IisLogsDataSource": { - "description": "Enables IIS logs to be collected by this data collection rule.", - "required": [ - "streams" - ], - "type": "object", - "properties": { - "streams": { - "description": "IIS streams", - "type": "array", - "items": { - "type": "string" - } - }, - "logDirectories": { - "description": "Absolute paths file location", - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "description": "A friendly name for the data source. \r\nThis name should be unique across all data sources (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDataSource1" - } - } - }, - "WindowsFirewallLogsDataSource": { - "description": "Enables Firewall logs to be collected by this data collection rule.", - "required": [ - "streams" - ], - "type": "object", - "properties": { - "streams": { - "description": "Firewall logs streams", - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "description": "A friendly name for the data source. \r\nThis name should be unique across all data sources (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDataSource1" - } - } - }, - "PrometheusForwarderDataSource": { - "description": "Definition of Prometheus metrics forwarding configuration.", - "type": "object", - "properties": { - "streams": { - "description": "List of streams that this data source will be sent to.", - "type": "array", - "items": { - "enum": [ - "Microsoft-PrometheusMetrics" - ], - "type": "string", - "x-ms-enum": { - "name": "KnownPrometheusForwarderDataSourceStreams", - "modelAsString": true - } - } - }, - "labelIncludeFilter": { - "description": "The list of label inclusion filters in the form of label \"name-value\" pairs.\r\nCurrently only one label is supported: 'microsoft_metrics_include_label'.\r\nLabel values are matched case-insensitively.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "name": { - "description": "A friendly name for the data source. \r\nThis name should be unique across all data sources (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDataSource1" - } - } - }, - "PlatformTelemetryDataSource": { - "description": "Definition of platform telemetry data source configuration", - "required": [ - "streams" - ], - "type": "object", - "properties": { - "streams": { - "description": "List of platform telemetry streams to collect", - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "description": "A friendly name for the data source. \r\nThis name should be unique across all data sources (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDataSource1" - } - } - }, - "EventHubDataSource": { - "type": "object", - "properties": { - "name": { - "description": "A friendly name for the data source. \r\nThis name should be unique across all data sources (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDataSource1" - }, - "consumerGroup": { - "description": "Event Hub consumer group name", - "type": "string" - }, - "stream": { - "description": "The stream to collect from EventHub", - "type": "string" - } - } - }, - "DataImportSources": { - "type": "object", - "properties": { - "eventHub": { - "description": "Definition of Event Hub configuration.", - "allOf": [ - { - "$ref": "#/definitions/EventHubDataSource" - } - ] - } - } - }, - "DataSourcesSpec": { - "description": "Specification of data sources that will be collected.", - "type": "object", - "properties": { - "performanceCounters": { - "description": "The list of performance counter data source configurations.", - "type": "array", - "items": { - "$ref": "#/definitions/PerfCounterDataSource" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "windowsEventLogs": { - "description": "The list of Windows Event Log data source configurations.", - "type": "array", - "items": { - "$ref": "#/definitions/WindowsEventLogDataSource" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "syslog": { - "description": "The list of Syslog data source configurations.", - "type": "array", - "items": { - "$ref": "#/definitions/SyslogDataSource" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "extensions": { - "description": "The list of Azure VM extension data source configurations.", - "type": "array", - "items": { - "$ref": "#/definitions/ExtensionDataSource" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "logFiles": { - "description": "The list of Log files source configurations.", - "type": "array", - "items": { - "$ref": "#/definitions/LogFilesDataSource" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "iisLogs": { - "description": "The list of IIS logs source configurations.", - "type": "array", - "items": { - "$ref": "#/definitions/IisLogsDataSource" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "windowsFirewallLogs": { - "description": "The list of Windows Firewall logs source configurations.", - "type": "array", - "items": { - "$ref": "#/definitions/WindowsFirewallLogsDataSource" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "prometheusForwarder": { - "description": "The list of Prometheus forwarder data source configurations.", - "type": "array", - "items": { - "$ref": "#/definitions/PrometheusForwarderDataSource" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "platformTelemetry": { - "description": "The list of platform telemetry configurations", - "type": "array", - "items": { - "$ref": "#/definitions/PlatformTelemetryDataSource" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "dataImports": { - "description": "Specifications of pull based data sources", - "allOf": [ - { - "$ref": "#/definitions/DataImportSources" - } - ], - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "LogAnalyticsDestination": { - "description": "Log Analytics destination.", - "type": "object", - "properties": { - "workspaceResourceId": { - "description": "The resource ID of the Log Analytics workspace.", - "type": "string", - "example": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace" - }, - "workspaceId": { - "description": "The Customer ID of the Log Analytics workspace.", - "type": "string", - "readOnly": true, - "example": "9ba8bc53-bd36-4156-8667-e983e7ae0e4f", - "x-ms-mutability": [ - "read" - ] - }, - "name": { - "description": "A friendly name for the destination. \r\nThis name should be unique across all destinations (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDest1" - } - } - }, - "MonitoringAccountDestination": { - "description": "Monitoring account destination.", - "type": "object", - "properties": { - "accountResourceId": { - "description": "The resource ID of the monitoring account.", - "type": "string", - "example": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/centralTeamAccount" - }, - "accountId": { - "description": "The immutable ID of the account.", - "type": "string", - "readOnly": true, - "example": "a6a097e1-15e9-42bc-8f48-fcddd804d0f3", - "x-ms-mutability": [ - "read" - ] - }, - "name": { - "description": "A friendly name for the destination. \r\nThis name should be unique across all destinations (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDest1" - } - } - }, - "AzureMonitorMetricsDestination": { - "description": "Azure Monitor Metrics destination.", - "type": "object", - "properties": { - "name": { - "description": "A friendly name for the destination. \r\nThis name should be unique across all destinations (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDest1" - } - } - }, - "EventHubDestination": { - "type": "object", - "properties": { - "eventHubResourceId": { - "description": "The resource ID of the event hub.", - "type": "string", - "example": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/amcs/providers/Microsoft.EventHub/namespaces/foo/eventhubs/bar" - }, - "name": { - "description": "A friendly name for the destination. \r\nThis name should be unique across all destinations (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDest1" - } - } - }, - "EventHubDirectDestination": { - "type": "object", - "properties": { - "eventHubResourceId": { - "description": "The resource ID of the event hub.", - "type": "string", - "example": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/amcs/providers/Microsoft.EventHub/namespaces/foo/eventhubs/bar" - }, - "name": { - "description": "A friendly name for the destination. \r\nThis name should be unique across all destinations (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDest1" - } - } - }, - "StorageBlobDestination": { - "type": "object", - "properties": { - "containerName": { - "description": "The container name of the Storage Blob.", - "type": "string", - "example": "foobar" - }, - "storageAccountResourceId": { - "description": "The resource ID of the storage account.", - "type": "string", - "example": "/subscriptions/ee63c5dc-9b88-42e3-8070-944a5226aea3/resourceGroups/foo/providers/Microsoft.Storage/storageAccounts/bar" - }, - "name": { - "description": "A friendly name for the destination. \r\nThis name should be unique across all destinations (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDest1" - } - } - }, - "StorageTableDestination": { - "type": "object", - "properties": { - "tableName": { - "description": "The name of the Storage Table.", - "type": "string", - "example": "foobar" - }, - "storageAccountResourceId": { - "description": "The resource ID of the storage account.", - "type": "string", - "example": "/subscriptions/ee63c5dc-9b88-42e3-8070-944a5226aea3/resourceGroups/foo/providers/Microsoft.Storage/storageAccounts/bar" - }, - "name": { - "description": "A friendly name for the destination. \r\nThis name should be unique across all destinations (regardless of type) within the data collection rule.", - "type": "string", - "example": "myDest1" - } - } - }, - "DestinationsSpec": { - "description": "Specification of destinations that can be used in data flows.", - "type": "object", - "properties": { - "logAnalytics": { - "description": "List of Log Analytics destinations.", - "type": "array", - "items": { - "$ref": "#/definitions/LogAnalyticsDestination" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "monitoringAccounts": { - "description": "List of monitoring account destinations.", - "type": "array", - "items": { - "$ref": "#/definitions/MonitoringAccountDestination" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "azureMonitorMetrics": { - "description": "Azure Monitor Metrics destination.", - "allOf": [ - { - "$ref": "#/definitions/AzureMonitorMetricsDestination" - } - ] - }, - "eventHubs": { - "description": "List of Event Hubs destinations.", - "type": "array", - "items": { - "$ref": "#/definitions/EventHubDestination" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "eventHubsDirect": { - "description": "List of Event Hubs Direct destinations.", - "type": "array", - "items": { - "$ref": "#/definitions/EventHubDirectDestination" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "storageBlobsDirect": { - "description": "List of Storage Blob Direct destinations. To be used only for sending data directly to store from the agent.", - "type": "array", - "items": { - "$ref": "#/definitions/StorageBlobDestination" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "storageTablesDirect": { - "description": "List of Storage Table Direct destinations.", - "type": "array", - "items": { - "$ref": "#/definitions/StorageTableDestination" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "storageAccounts": { - "description": "List of storage accounts destinations.", - "type": "array", - "items": { - "$ref": "#/definitions/StorageBlobDestination" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "DataFlow": { - "description": "Definition of which streams are sent to which destinations.", - "type": "object", - "properties": { - "streams": { - "description": "List of streams for this data flow.", - "type": "array", - "items": { - "enum": [ - "Microsoft-Event", - "Microsoft-InsightsMetrics", - "Microsoft-Perf", - "Microsoft-Syslog", - "Microsoft-WindowsEvent" - ], - "type": "string", - "x-ms-enum": { - "name": "KnownDataFlowStreams", - "modelAsString": true - } - } - }, - "destinations": { - "description": "List of destinations for this data flow.", - "type": "array", - "items": { - "type": "string" - } - }, - "transformKql": { - "description": "The KQL query to transform stream data.", - "type": "string" - }, - "outputStream": { - "description": "The output stream of the transform. Only required if the transform changes data to a different stream.", - "type": "string", - "example": "\"Microsoft-SecurityEvent\"" - }, - "builtInTransform": { - "description": "The builtIn transform to transform stream data", - "type": "string", - "example": "\"Syslog-CRON\"" - } - } - }, - "DataCollectionRule": { - "description": "Definition of what monitoring data to collect and where that data should be sent.", - "type": "object", - "properties": { - "description": { - "description": "Description of the data collection rule.", - "type": "string" - }, - "immutableId": { - "description": "The immutable ID of this data collection rule. This property is READ-ONLY.", - "type": "string", - "readOnly": true, - "example": "dcr-b74e0d383fc9415abaa584ec41adece3", - "x-ms-mutability": [ - "read" - ] - }, - "dataCollectionEndpointId": { - "description": "The resource ID of the data collection endpoint that this rule can be used with.", - "type": "string", - "example": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myCollectionEndpoint" - }, - "metadata": { - "description": "Metadata about the resource", - "allOf": [ - { - "$ref": "#/definitions/Metadata" - } - ], - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "streamDeclarations": { - "description": "Declaration of custom streams used in this rule.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StreamDeclaration" - } - }, - "dataSources": { - "description": "The specification of data sources. \r\nThis property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint.", - "allOf": [ - { - "$ref": "#/definitions/DataSourcesSpec" - } - ] - }, - "destinations": { - "description": "The specification of destinations.", - "allOf": [ - { - "$ref": "#/definitions/DestinationsSpec" - } - ] - }, - "dataFlows": { - "description": "The specification of data flows.", - "type": "array", - "items": { - "$ref": "#/definitions/DataFlow" - }, - "x-ms-identifiers": [] - }, - "provisioningState": { - "description": "The resource provisioning state.", - "enum": [ - "Creating", - "Updating", - "Deleting", - "Succeeded", - "Canceled", - "Failed" - ], - "type": "string", - "readOnly": true, - "example": "Creating", - "x-ms-enum": { - "name": "KnownDataCollectionRuleProvisioningState", - "modelAsString": true - }, - "x-ms-mutability": [ - "read" - ] - } - } - }, - "DataCollectionRuleResource": { - "description": "Definition of ARM tracked top level resource.", - "required": [ - "location" - ], - "type": "object", - "properties": { - "properties": { - "description": "Resource properties.", - "allOf": [ - { - "$ref": "#/definitions/DataCollectionRule" - } - ], - "x-ms-client-flatten": true - }, - "location": { - "description": "The geo-location where the resource lives.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "kind": { - "description": "The kind of the resource.", - "enum": [ - "Linux", - "Windows" - ], - "type": "string", - "example": "Linux", - "x-ms-enum": { - "name": "KnownDataCollectionRuleResourceKind", - "modelAsString": true - } - }, - "identity": { - "description": "Managed service identity of the resource.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" - } - ] - }, - "id": { - "description": "Fully qualified ID of the resource.", - "type": "string", - "readOnly": true, - "example": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule", - "x-ms-mutability": [ - "read" - ] - }, - "name": { - "description": "The name of the resource.", - "type": "string", - "readOnly": true, - "example": "myCollectionRule", - "x-ms-mutability": [ - "read" - ] - }, - "type": { - "description": "The type of the resource.", - "type": "string", - "readOnly": true, - "example": "Microsoft.Insights/dataCollectionRules", - "x-ms-mutability": [ - "read" - ] - }, - "etag": { - "description": "Resource entity tag (ETag).", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "systemData": { - "description": "Metadata pertaining to creation and last modification of the resource.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - ], - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - } - }, - "x-ms-azure-resource": true - }, - "DataCollectionRuleResourceListResult": { - "description": "A pageable list of resources.", - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "description": "A list of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/DataCollectionRuleResource" - } - }, - "nextLink": { - "description": "The URL to use for getting the next set of results.", - "type": "string" - } - } - }, - "ResourceForUpdate": { - "description": "Definition of ARM tracked top level resource properties for update operation.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "identity": { - "description": "Managed Service Identity.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" - } - ] - } - } - }, - "ErrorResponseCommonV2": { - "title": "Error response", - "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", - "type": "object", - "properties": { - "error": { - "description": "The error object.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail" - } - } - } - }, - "parameters": { - "DataCollectionRuleNameParameter": { - "in": "path", - "name": "dataCollectionRuleName", - "description": "The name of the data collection rule. The name is case insensitive.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-10-01/autoscale_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-10-01/autoscale_API.json deleted file mode 100644 index e7a03afff..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2022-10-01/autoscale_API.json +++ /dev/null @@ -1,1102 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MonitorManagementClient", - "version": "2022-10-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings": { - "get": { - "description": "Lists the autoscale settings for a resource group", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_ListByResourceGroup", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "Successful request for a list of autoscale settings", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResourceCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List autoscale settings": { - "$ref": "./examples/listAutoscaleSetting.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}": { - "put": { - "description": "Creates or updates an autoscale setting.", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - }, - "description": "Parameters supplied to the operation." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "Successful request to create or update an autoscale setting", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - } - }, - "201": { - "description": "Created autoscale setting", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - } - } - }, - "x-ms-examples": { - "Create or update an autoscale setting": { - "$ref": "./examples/createOrUpdateAutoscaleSetting.json" - } - } - }, - "delete": { - "description": "Deletes and autoscale setting", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_Delete", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "Successful request to delete an autoscale setting" - }, - "204": { - "description": "No content: Successful request to delete an autoscale setting, but the response is intentionally empty" - } - }, - "x-ms-examples": { - "Delete an autoscale setting": { - "$ref": "./examples/deleteAutoscaleSetting.json" - } - } - }, - "get": { - "description": "Gets an autoscale setting", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "Successful request to get one autoscale setting", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - } - } - }, - "x-ms-examples": { - "Get an autoscale setting": { - "$ref": "./examples/getAutoscaleSetting.json" - } - } - }, - "patch": { - "description": "Updates an existing AutoscaleSettingsResource. To update other fields use the CreateOrUpdate method.", - "operationId": "AutoscaleSettings_Update", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "autoscaleSettingResource", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AutoscaleSettingResourcePatch" - }, - "description": "Parameters supplied to the operation." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "An existing autoscale setting resource was successfully updated.", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResource" - } - } - }, - "x-ms-examples": { - "Patch an autoscale setting": { - "$ref": "./examples/patchAutoscaleSetting.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}/predictiveMetrics": { - "get": { - "tags": [ - "Metrics" - ], - "operationId": "PredictiveMetric_Get", - "description": "get predictive autoscale metric future data", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AutoscaleSettingNameParameter" - }, - { - "$ref": "#/parameters/TimespanParameter" - }, - { - "$ref": "#/parameters/IntervalParameter" - }, - { - "$ref": "#/parameters/MetricNamespaceParameter" - }, - { - "$ref": "#/parameters/MetricNamesParameter" - }, - { - "$ref": "#/parameters/AggregationParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "Successful request to get the list of metric values.", - "schema": { - "$ref": "#/definitions/PredictiveResponse" - } - } - }, - "x-ms-examples": { - "Get Metric for data": { - "$ref": "./examples/GetPredictiveMetric.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/autoscalesettings": { - "get": { - "description": "Lists the autoscale settings for a subscription", - "tags": [ - "AutoscaleSettings" - ], - "operationId": "AutoscaleSettings_ListBySubscription", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AutoscaleErrorResponse" - } - }, - "200": { - "description": "Successful request for a list of autoscale settings", - "schema": { - "$ref": "#/definitions/AutoscaleSettingResourceCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List autoscale settings by subs": { - "$ref": "./examples/listAutoscaleSettingBySubscription.json" - } - } - } - } - }, - "definitions": { - "ScaleCapacity": { - "type": "object", - "required": [ - "minimum", - "maximum", - "default" - ], - "properties": { - "minimum": { - "type": "string", - "description": "the minimum number of instances for the resource." - }, - "maximum": { - "type": "string", - "description": "the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription." - }, - "default": { - "type": "string", - "description": "the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default." - } - }, - "description": "The number of instances that can be used during this profile." - }, - "MetricTrigger": { - "type": "object", - "required": [ - "metricName", - "metricResourceUri", - "timeGrain", - "statistic", - "timeWindow", - "timeAggregation", - "operator", - "threshold" - ], - "properties": { - "metricName": { - "type": "string", - "description": "the name of the metric that defines what the rule monitors." - }, - "metricNamespace": { - "type": "string", - "description": "the namespace of the metric that defines what the rule monitors." - }, - "metricResourceUri": { - "type": "string", - "description": "the resource identifier of the resource the rule monitors." - }, - "metricResourceLocation": { - "type": "string", - "description": "the location of the resource the rule monitors." - }, - "timeGrain": { - "type": "string", - "format": "duration", - "description": "the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute." - }, - "statistic": { - "type": "string", - "description": "the metric statistic type. How the metrics from multiple instances are combined.", - "enum": [ - "Average", - "Min", - "Max", - "Sum", - "Count" - ], - "x-ms-enum": { - "name": "MetricStatisticType", - "modelAsString": false - } - }, - "timeWindow": { - "type": "string", - "format": "duration", - "description": "the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes." - }, - "timeAggregation": { - "type": "string", - "description": "time aggregation type. How the data that is collected should be combined over time. The default value is Average.", - "enum": [ - "Average", - "Minimum", - "Maximum", - "Total", - "Count", - "Last" - ], - "x-ms-enum": { - "name": "TimeAggregationType", - "modelAsString": false - } - }, - "operator": { - "type": "string", - "description": "the operator that is used to compare the metric data and the threshold.", - "enum": [ - "Equals", - "NotEquals", - "GreaterThan", - "GreaterThanOrEqual", - "LessThan", - "LessThanOrEqual" - ], - "x-ms-enum": { - "name": "ComparisonOperationType", - "modelAsString": false - } - }, - "threshold": { - "type": "number", - "format": "double", - "description": "the threshold of the metric that triggers the scale action." - }, - "dimensions": { - "type": "array", - "items": { - "$ref": "#/definitions/ScaleRuleMetricDimension" - }, - "x-ms-identifiers": [], - "description": "List of dimension conditions. For example: [{\"DimensionName\":\"AppName\",\"Operator\":\"Equals\",\"Values\":[\"App1\"]},{\"DimensionName\":\"Deployment\",\"Operator\":\"Equals\",\"Values\":[\"default\"]}]." - }, - "dividePerInstance": { - "type": "boolean", - "description": "a value indicating whether metric should divide per instance." - } - }, - "description": "The trigger that results in a scaling action." - }, - "ScaleAction": { - "type": "object", - "required": [ - "direction", - "type", - "cooldown" - ], - "properties": { - "direction": { - "type": "string", - "description": "the scale direction. Whether the scaling action increases or decreases the number of instances.", - "enum": [ - "None", - "Increase", - "Decrease" - ], - "x-ms-enum": { - "name": "ScaleDirection", - "modelAsString": false - } - }, - "type": { - "type": "string", - "description": "the type of action that should occur when the scale rule fires.", - "enum": [ - "ChangeCount", - "PercentChangeCount", - "ExactCount", - "ServiceAllowedNextValue" - ], - "x-ms-enum": { - "name": "ScaleType", - "modelAsString": false - } - }, - "value": { - "type": "string", - "description": "the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1.", - "default": "1" - }, - "cooldown": { - "type": "string", - "format": "duration", - "description": "the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format." - } - }, - "description": "The parameters for the scaling action." - }, - "ScaleRule": { - "type": "object", - "required": [ - "scaleAction", - "metricTrigger" - ], - "properties": { - "metricTrigger": { - "$ref": "#/definitions/MetricTrigger", - "description": "the trigger that results in a scaling action." - }, - "scaleAction": { - "$ref": "#/definitions/ScaleAction", - "description": "the parameters for the scaling action." - } - }, - "description": "A rule that provide the triggers and parameters for the scaling action." - }, - "TimeWindow": { - "type": "object", - "properties": { - "timeZone": { - "type": "string", - "description": "the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time" - }, - "start": { - "type": "string", - "format": "date-time", - "description": "the start time for the profile in ISO 8601 format." - }, - "end": { - "type": "string", - "format": "date-time", - "description": "the end time for the profile in ISO 8601 format." - } - }, - "required": [ - "start", - "end" - ], - "description": "A specific date-time for the profile." - }, - "RecurrentSchedule": { - "type": "object", - "required": [ - "timeZone", - "days", - "hours", - "minutes" - ], - "properties": { - "timeZone": { - "type": "string", - "description": "the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time" - }, - "days": { - "type": "array", - "items": { - "type": "string" - }, - "description": "the collection of days that the profile takes effect on. Possible values are Sunday through Saturday." - }, - "hours": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported)." - }, - "minutes": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "A collection of minutes at which the profile takes effect at." - } - }, - "description": "The scheduling constraints for when the profile begins." - }, - "Recurrence": { - "type": "object", - "required": [ - "frequency", - "schedule" - ], - "properties": { - "frequency": { - "type": "string", - "description": "the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set **schedule** to every day of the week. The frequency property specifies that the schedule is repeated weekly.", - "enum": [ - "None", - "Second", - "Minute", - "Hour", - "Day", - "Week", - "Month", - "Year" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "schedule": { - "$ref": "#/definitions/RecurrentSchedule", - "description": "the scheduling constraints for when the profile begins." - } - }, - "description": "The repeating times at which this profile begins. This element is not used if the FixedDate element is used." - }, - "AutoscaleProfile": { - "type": "object", - "required": [ - "rules", - "name", - "capacity" - ], - "properties": { - "name": { - "type": "string", - "description": "the name of the profile." - }, - "capacity": { - "$ref": "#/definitions/ScaleCapacity", - "description": "the number of instances that can be used during this profile." - }, - "rules": { - "type": "array", - "items": { - "$ref": "#/definitions/ScaleRule" - }, - "x-ms-identifiers": [], - "description": "the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified." - }, - "fixedDate": { - "$ref": "#/definitions/TimeWindow", - "description": "the specific date-time for the profile. This element is not used if the Recurrence element is used." - }, - "recurrence": { - "$ref": "#/definitions/Recurrence", - "description": "the repeating times at which this profile begins. This element is not used if the FixedDate element is used." - } - }, - "description": "Autoscale profile." - }, - "PredictiveAutoscalePolicy": { - "type": "object", - "required": [ - "scaleMode" - ], - "properties": { - "scaleMode": { - "type": "string", - "description": "the predictive autoscale mode", - "enum": [ - "Disabled", - "ForecastOnly", - "Enabled" - ], - "x-ms-enum": { - "name": "PredictiveAutoscalePolicyScaleMode", - "modelAsString": false - } - }, - "scaleLookAheadTime": { - "type": "string", - "format": "duration", - "description": "the amount of time to specify by which instances are launched in advance. It must be between 1 minute and 60 minutes in ISO 8601 format." - } - }, - "description": "The parameters for enabling predictive autoscale." - }, - "EmailNotification": { - "type": "object", - "properties": { - "sendToSubscriptionAdministrator": { - "type": "boolean", - "description": "a value indicating whether to send email to subscription administrator.", - "default": false - }, - "sendToSubscriptionCoAdministrators": { - "type": "boolean", - "description": "a value indicating whether to send email to subscription co-administrators.", - "default": false - }, - "customEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored." - } - }, - "description": "Email notification of an autoscale event." - }, - "WebhookNotification": { - "type": "object", - "properties": { - "serviceUri": { - "type": "string", - "description": "the service address to receive the notification." - }, - "properties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "a property bag of settings. This value can be empty." - } - }, - "description": "Webhook notification of an autoscale event." - }, - "AutoscaleNotification": { - "type": "object", - "required": [ - "operation" - ], - "properties": { - "operation": { - "type": "string", - "description": "the operation associated with the notification and its value must be \"scale\"", - "enum": [ - "Scale" - ], - "x-ms-enum": { - "name": "OperationType", - "modelAsString": false - } - }, - "email": { - "$ref": "#/definitions/EmailNotification", - "description": "the email notification." - }, - "webhooks": { - "type": "array", - "items": { - "$ref": "#/definitions/WebhookNotification" - }, - "x-ms-identifiers": [], - "description": "the collection of webhook notifications." - } - }, - "description": "Autoscale notification." - }, - "AutoscaleSetting": { - "type": "object", - "required": [ - "profiles" - ], - "properties": { - "profiles": { - "type": "array", - "maxItems": 20, - "items": { - "$ref": "#/definitions/AutoscaleProfile" - }, - "x-ms-identifiers": [], - "description": "the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified." - }, - "notifications": { - "type": "array", - "items": { - "$ref": "#/definitions/AutoscaleNotification" - }, - "x-ms-identifiers": [], - "description": "the collection of notifications." - }, - "enabled": { - "type": "boolean", - "description": "the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'false'.", - "default": false - }, - "predictiveAutoscalePolicy": { - "$ref": "#/definitions/PredictiveAutoscalePolicy", - "description": "the predictive autoscale policy mode." - }, - "name": { - "type": "string", - "description": "the name of the autoscale setting." - }, - "targetResourceUri": { - "type": "string", - "description": "the resource identifier of the resource that the autoscale setting should be added to." - }, - "targetResourceLocation": { - "type": "string", - "description": "the location of the resource that the autoscale setting should be added to." - } - }, - "description": "A setting that contains all of the configuration for the automatic scaling of a resource." - }, - "Resource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Azure resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters." - }, - "systemData": { - "readOnly": true, - "description": "The system metadata related to the response.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true, - "description": "The autoscale setting resource." - }, - "AutoscaleSettingResource": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AutoscaleSetting", - "description": "The autoscale setting of the resource." - } - }, - "description": "The autoscale setting resource." - }, - "AutoscaleSettingResourcePatch": { - "type": "object", - "description": "The autoscale setting object for patch operations.", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AutoscaleSetting", - "description": "The autoscale setting properties of the update operation." - } - } - }, - "AutoscaleSettingResourceCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AutoscaleSettingResource" - }, - "description": "the values for the autoscale setting resources." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of results." - } - }, - "required": [ - "value" - ], - "description": "Represents a collection of autoscale setting resources." - }, - "AutoscaleErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "error": { - "type": "object", - "description": "The error object.", - "properties": { - "code": { - "description": "One of a server-defined set of error codes.", - "type": "string" - }, - "message": { - "description": "A human-readable representation of the error.", - "type": "string" - }, - "target": { - "description": "The target of the particular error.", - "type": "string" - }, - "details": { - "description": "A human-readable representation of the error's details.", - "type": "string" - } - } - }, - "systemData": { - "readOnly": true, - "description": "The system metadata related to the response.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - } - }, - "ScaleRuleMetricDimension": { - "type": "object", - "required": [ - "DimensionName", - "Operator", - "Values" - ], - "properties": { - "DimensionName": { - "type": "string", - "description": "Name of the dimension." - }, - "Operator": { - "type": "string", - "description": "the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values", - "enum": [ - "Equals", - "NotEquals" - ], - "x-ms-enum": { - "name": "ScaleRuleMetricDimensionOperationType", - "modelAsString": true - } - }, - "Values": { - "type": "array", - "items": { - "type": "string" - }, - "description": "list of dimension values. For example: [\"App1\",\"App2\"]." - } - }, - "description": "Specifies an auto scale rule metric dimension." - }, - "PredictiveResponse": { - "type": "object", - "properties": { - "timespan": { - "type": "string", - "description": "The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." - }, - "interval": { - "type": "string", - "format": "duration", - "description": "The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made." - }, - "metricName": { - "type": "string", - "description": "The metrics being queried" - }, - "targetResourceId": { - "type": "string", - "description": "resource of the predictive metric." - }, - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/PredictiveValue" - }, - "x-ms-identifiers": [], - "description": "the value of the collection." - } - }, - "description": "The response to a metrics query." - }, - "PredictiveValue": { - "type": "object", - "required": [ - "timeStamp", - "value" - ], - "properties": { - "timeStamp": { - "type": "string", - "format": "date-time", - "description": "the timestamp for the metric value in ISO 8601 format." - }, - "value": { - "type": "number", - "format": "double", - "description": "Predictive value in this time bucket." - } - }, - "description": "Represents a predictive metric value in the given bucket." - } - }, - "parameters": { - "AutoscaleSettingNameParameter": { - "name": "autoscaleSettingName", - "in": "path", - "required": true, - "type": "string", - "description": "The autoscale setting name.", - "x-ms-parameter-location": "method" - }, - "TimespanParameter": { - "name": "timespan", - "in": "query", - "required": true, - "type": "string", - "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", - "x-ms-parameter-location": "method" - }, - "IntervalParameter": { - "name": "interval", - "in": "query", - "required": true, - "type": "string", - "format": "duration", - "description": "The interval (i.e. timegrain) of the query.", - "x-ms-parameter-location": "method" - }, - "MetricNamesParameter": { - "name": "metricName", - "in": "query", - "required": true, - "type": "string", - "description": "The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**", - "x-ms-parameter-location": "method" - }, - "AggregationParameter": { - "name": "aggregation", - "in": "query", - "required": true, - "type": "string", - "description": "The list of aggregation types (comma separated) to retrieve.", - "x-ms-parameter-location": "method" - }, - "MetricNamespaceParameter": { - "name": "metricNamespace", - "in": "query", - "required": true, - "type": "string", - "description": "Metric namespace to query metric definitions for.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2023-01-01/actionGroups_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2023-01-01/actionGroups_API.json deleted file mode 100644 index 209884439..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2023-01-01/actionGroups_API.json +++ /dev/null @@ -1,1223 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Action Groups API", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2023-01-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}": { - "put": { - "description": "Create a new action group or update an existing one.", - "operationId": "ActionGroups_CreateOrUpdate", - "x-ms-examples": { - "Create or update an action group": { - "$ref": "./examples/createOrUpdateActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "name": "actionGroup", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActionGroupResource" - }, - "description": "The action group to create or use for the update." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "An existing action group was successfully updated.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - }, - "201": { - "description": "A new action group was successfully created.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - }, - "default": { - "description": "An error occurred and the action group could not be created or updated.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "description": "Get an action group.", - "operationId": "ActionGroups_Get", - "x-ms-examples": { - "Get an action group": { - "$ref": "./examples/getActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - }, - "default": { - "description": "An error occurred and the action group could not be retrieved. 404: The action group does not exist.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "description": "Delete an action group.", - "operationId": "ActionGroups_Delete", - "x-ms-examples": { - "Delete an action group": { - "$ref": "./examples/deleteActionGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The action group was successfully deleted." - }, - "204": { - "description": "The action group does not exist. It may have already been deleted." - }, - "default": { - "description": "An error occurred and the action group could not be deleted.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "description": "Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.", - "operationId": "ActionGroups_Update", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "actionGroupPatch", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ActionGroupPatchBody" - }, - "description": "Parameters supplied to the operation." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "An existing action group was successfully updated.", - "schema": { - "$ref": "#/definitions/ActionGroupResource" - } - } - }, - "x-ms-examples": { - "Patch an action group": { - "$ref": "./examples/patchActionGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/createNotifications": { - "post": { - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "description": "Send test notifications to a set of provided receivers", - "operationId": "ActionGroups_CreateNotificationsAtActionGroupResourceLevel", - "x-ms-examples": { - "Create notifications at resource group level": { - "$ref": "./examples/postTestNotificationsAtActionGroupResourceLevel.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "notificationRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NotificationRequestBody" - }, - "description": "The notification request body which includes the contact details" - } - ], - "responses": { - "202": { - "description": "The notification request accepted", - "headers": { - "location": { - "type": "string", - "description": "The location header that has the polling uri." - } - } - }, - "200": { - "description": "The notification succeeded", - "schema": { - "$ref": "#/definitions/TestNotificationDetailsResponse" - } - }, - "default": { - "description": "An error occurred while sending the test notifications", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/notificationStatus/{notificationId}": { - "get": { - "description": "Get the test notifications by the notification id", - "operationId": "ActionGroups_GetTestNotificationsAtActionGroupResourceLevel", - "x-ms-examples": { - "Get notification details at resource group level": { - "$ref": "./examples/getTestNotificationsAtActionGroupResourceLevel.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "$ref": "#/parameters/NotificationIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The notification details", - "schema": { - "$ref": "#/definitions/TestNotificationDetailsResponse" - } - }, - "default": { - "description": "An error occurred while sending the test notifications", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/actionGroups": { - "get": { - "description": "Get a list of all action groups in a subscription.", - "operationId": "ActionGroups_ListBySubscriptionId", - "x-ms-examples": { - "List action groups at subscription level": { - "$ref": "./examples/listActionGroups.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/ActionGroupList" - } - }, - "default": { - "description": "An error occurred and the list of action groups could not be retrieved.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups": { - "get": { - "description": "Get a list of all action groups in a resource group.", - "operationId": "ActionGroups_ListByResourceGroup", - "x-ms-examples": { - "List action groups at resource group level": { - "$ref": "./examples/listActionGroups.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request succeeded.", - "schema": { - "$ref": "#/definitions/ActionGroupList" - } - }, - "default": { - "description": "An error occurred and the list of action groups could not be retrieved.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/subscribe": { - "post": { - "description": "Enable a receiver in an action group. This changes the receiver's status from Disabled to Enabled. This operation is only supported for Email or SMS receivers.", - "operationId": "ActionGroups_EnableReceiver", - "x-ms-examples": { - "Enable the receiver": { - "$ref": "./examples/enableReceiver.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ActionGroupNameParameter" - }, - { - "name": "enableRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/EnableRequest" - }, - "description": "The receiver to re-enable." - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The receiver was successfully enabled." - }, - "409": { - "description": "The receiver is already enabled in the action group.", - "x-ms-error-response": true - }, - "default": { - "description": "An error occurred and the receiver could not be enabled, e.g.: 404: The action group was not found or no matching receiver was found in the action group.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "AzureResource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Azure resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "additionalProperties": { - "type": "string" - }, - "type": "object", - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "type": "object", - "x-ms-azure-resource": true, - "description": "An azure resource object" - }, - "TestNotificationDetailsResponse": { - "description": "The details of the test notification results.", - "type": "object", - "properties": { - "context": { - "type": "object", - "$ref": "#/definitions/Context" - }, - "state": { - "type": "string", - "description": "The overall state" - }, - "completedTime": { - "type": "string", - "description": "The completed time" - }, - "createdTime": { - "type": "string", - "description": "The created time" - }, - "actionDetails": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/ActionDetail" - }, - "description": "The list of action detail" - } - }, - "required": [ - "state" - ] - }, - "ActionDetail": { - "description": "The action detail", - "type": "object", - "properties": { - "MechanismType": { - "type": "string", - "description": "The mechanism type" - }, - "Name": { - "type": "string", - "description": "The name of the action" - }, - "Status": { - "type": "string", - "description": "The status of the action" - }, - "SubState": { - "type": "string", - "description": "The substatus of the action" - }, - "SendTime": { - "type": "string", - "description": "The send time" - }, - "Detail": { - "type": "string", - "description": "The detail of the friendly error message" - } - } - }, - "Context": { - "description": "The context info", - "type": "object", - "properties": { - "notificationSource": { - "type": "string", - "description": "The source of the notification request" - }, - "contextType": { - "type": "string", - "description": "The context id type" - } - } - }, - "ActionGroupResource": { - "description": "An action group resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AzureResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ActionGroup", - "description": "The action groups properties of the resource." - } - } - }, - "ActionGroupList": { - "description": "A list of action groups.", - "type": "object", - "properties": { - "value": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/ActionGroupResource" - }, - "description": "The list of action groups." - }, - "nextLink": { - "type": "string", - "description": "Provides the link to retrieve the next set of elements." - } - } - }, - "NotificationRequestBody": { - "description": "The request body which contain contact detail metadata", - "type": "object", - "properties": { - "alertType": { - "type": "string", - "maxLength": 30, - "description": "The value of the supported alert type. Supported alert type values are: servicehealth, metricstaticthreshold, metricsdynamicthreshold, logalertv2, smartalert, webtestalert, logalertv1numresult, logalertv1metricmeasurement, resourcehealth, activitylog, actualcostbudget, forecastedbudget" - }, - "emailReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/EmailReceiver" - }, - "description": "The list of email receivers that are part of this action group." - }, - "smsReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/SmsReceiver" - }, - "description": "The list of SMS receivers that are part of this action group." - }, - "webhookReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/WebhookReceiver" - }, - "description": "The list of webhook receivers that are part of this action group." - }, - "itsmReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/ItsmReceiver" - }, - "description": "The list of ITSM receivers that are part of this action group." - }, - "azureAppPushReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/AzureAppPushReceiver" - }, - "description": "The list of AzureAppPush receivers that are part of this action group." - }, - "automationRunbookReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/AutomationRunbookReceiver" - }, - "description": "The list of AutomationRunbook receivers that are part of this action group." - }, - "voiceReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/VoiceReceiver" - }, - "description": "The list of voice receivers that are part of this action group." - }, - "logicAppReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/LogicAppReceiver" - }, - "description": "The list of logic app receivers that are part of this action group." - }, - "azureFunctionReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/AzureFunctionReceiver" - }, - "description": "The list of azure function receivers that are part of this action group." - }, - "armRoleReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/ArmRoleReceiver" - }, - "description": "The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported." - }, - "eventHubReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/EventHubReceiver" - }, - "description": "The list of event hub receivers that are part of this action group." - } - }, - "required": [ - "alertType" - ] - }, - "ActionGroup": { - "description": "An Azure action group.", - "type": "object", - "properties": { - "groupShortName": { - "type": "string", - "maxLength": 12, - "description": "The short name of the action group. This will be used in SMS messages." - }, - "enabled": { - "type": "boolean", - "default": true, - "description": "Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications." - }, - "emailReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/EmailReceiver" - }, - "description": "The list of email receivers that are part of this action group." - }, - "smsReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/SmsReceiver" - }, - "description": "The list of SMS receivers that are part of this action group." - }, - "webhookReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/WebhookReceiver" - }, - "description": "The list of webhook receivers that are part of this action group." - }, - "itsmReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/ItsmReceiver" - }, - "description": "The list of ITSM receivers that are part of this action group." - }, - "azureAppPushReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/AzureAppPushReceiver" - }, - "description": "The list of AzureAppPush receivers that are part of this action group." - }, - "automationRunbookReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/AutomationRunbookReceiver" - }, - "description": "The list of AutomationRunbook receivers that are part of this action group." - }, - "voiceReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/VoiceReceiver" - }, - "description": "The list of voice receivers that are part of this action group." - }, - "logicAppReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/LogicAppReceiver" - }, - "description": "The list of logic app receivers that are part of this action group." - }, - "azureFunctionReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/AzureFunctionReceiver" - }, - "description": "The list of azure function receivers that are part of this action group." - }, - "armRoleReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/ArmRoleReceiver" - }, - "description": "The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported." - }, - "eventHubReceivers": { - "x-ms-identifiers": [], - "type": "array", - "items": { - "$ref": "#/definitions/EventHubReceiver" - }, - "description": "The list of event hub receivers that are part of this action group." - } - }, - "required": [ - "groupShortName", - "enabled" - ] - }, - "EmailReceiver": { - "description": "An email receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the email receiver. Names must be unique across all receivers within an action group." - }, - "emailAddress": { - "type": "string", - "description": "The email address of this receiver." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ReceiverStatus", - "description": "The receiver status of the e-mail." - } - }, - "required": [ - "name", - "emailAddress" - ] - }, - "SmsReceiver": { - "description": "An SMS receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the SMS receiver. Names must be unique across all receivers within an action group." - }, - "countryCode": { - "type": "string", - "description": "The country code of the SMS receiver." - }, - "phoneNumber": { - "type": "string", - "description": "The phone number of the SMS receiver." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ReceiverStatus", - "description": "The status of the receiver." - } - }, - "required": [ - "name", - "countryCode", - "phoneNumber" - ] - }, - "WebhookReceiver": { - "description": "A webhook receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the webhook receiver. Names must be unique across all receivers within an action group." - }, - "serviceUri": { - "type": "string", - "description": "The URI where webhooks should be sent." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - }, - "useAadAuth": { - "type": "boolean", - "default": false, - "description": "Indicates whether or not use AAD authentication." - }, - "objectId": { - "type": "string", - "description": "Indicates the webhook app object Id for aad auth." - }, - "identifierUri": { - "type": "string", - "description": "Indicates the identifier uri for aad auth." - }, - "tenantId": { - "type": "string", - "description": "Indicates the tenant id for aad auth." - } - }, - "required": [ - "name", - "serviceUri" - ] - }, - "ItsmReceiver": { - "description": "An Itsm receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the Itsm receiver. Names must be unique across all receivers within an action group." - }, - "workspaceId": { - "type": "string", - "description": "OMS LA instance identifier." - }, - "connectionId": { - "type": "string", - "description": "Unique identification of ITSM connection among multiple defined in above workspace." - }, - "ticketConfiguration": { - "type": "string", - "description": "JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well." - }, - "region": { - "type": "string", - "description": "Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'" - } - }, - "required": [ - "name", - "workspaceId", - "connectionId", - "ticketConfiguration", - "region" - ] - }, - "EventHubReceiver": { - "description": "An Event hub receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the Event hub receiver. Names must be unique across all receivers within an action group." - }, - "eventHubNameSpace": { - "type": "string", - "description": "The Event Hub namespace" - }, - "eventHubName": { - "type": "string", - "description": "The name of the specific Event Hub queue" - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - }, - "tenantId": { - "type": "string", - "description": "The tenant Id for the subscription containing this event hub" - }, - "subscriptionId": { - "type": "string", - "description": "The Id for the subscription containing this event hub" - } - }, - "required": [ - "name", - "eventHubNameSpace", - "eventHubName", - "subscriptionId" - ] - }, - "AzureAppPushReceiver": { - "description": "The Azure mobile App push notification receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group." - }, - "emailAddress": { - "type": "string", - "description": "The email address registered for the Azure mobile app." - } - }, - "required": [ - "name", - "emailAddress" - ] - }, - "AutomationRunbookReceiver": { - "description": "The Azure Automation Runbook notification receiver.", - "type": "object", - "properties": { - "automationAccountId": { - "type": "string", - "description": "The Azure automation account Id which holds this runbook and authenticate to Azure resource." - }, - "runbookName": { - "type": "string", - "description": "The name for this runbook." - }, - "webhookResourceId": { - "type": "string", - "description": "The resource id for webhook linked to this runbook." - }, - "isGlobalRunbook": { - "type": "boolean", - "description": "Indicates whether this instance is global runbook." - }, - "name": { - "type": "string", - "description": "Indicates name of the webhook." - }, - "serviceUri": { - "type": "string", - "description": "The URI where webhooks should be sent." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - } - }, - "required": [ - "automationAccountId", - "runbookName", - "webhookResourceId", - "isGlobalRunbook" - ] - }, - "VoiceReceiver": { - "description": "A voice receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the voice receiver. Names must be unique across all receivers within an action group." - }, - "countryCode": { - "type": "string", - "description": "The country code of the voice receiver." - }, - "phoneNumber": { - "type": "string", - "description": "The phone number of the voice receiver." - } - }, - "required": [ - "name", - "countryCode", - "phoneNumber" - ] - }, - "LogicAppReceiver": { - "description": "A logic app receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the logic app receiver. Names must be unique across all receivers within an action group." - }, - "resourceId": { - "type": "string", - "description": "The azure resource id of the logic app receiver." - }, - "callbackUrl": { - "type": "string", - "description": "The callback url where http request sent to." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - } - }, - "required": [ - "name", - "resourceId", - "callbackUrl" - ] - }, - "AzureFunctionReceiver": { - "description": "An azure function receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the azure function receiver. Names must be unique across all receivers within an action group." - }, - "functionAppResourceId": { - "type": "string", - "description": "The azure resource id of the function app." - }, - "functionName": { - "type": "string", - "description": "The function name in the function app." - }, - "httpTriggerUrl": { - "type": "string", - "description": "The http trigger url where http request sent to." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - } - }, - "required": [ - "name", - "functionAppResourceId", - "functionName", - "httpTriggerUrl" - ] - }, - "ArmRoleReceiver": { - "description": "An arm role receiver.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the arm role receiver. Names must be unique across all receivers within an action group." - }, - "roleId": { - "type": "string", - "description": "The arm role id." - }, - "useCommonAlertSchema": { - "type": "boolean", - "default": false, - "description": "Indicates whether to use common alert schema." - } - }, - "required": [ - "name", - "roleId" - ] - }, - "ReceiverStatus": { - "type": "string", - "enum": [ - "NotSpecified", - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "ReceiverStatus", - "modelAsString": false - }, - "description": "Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications." - }, - "EnableRequest": { - "description": "Describes a receiver that should be resubscribed.", - "type": "object", - "properties": { - "receiverName": { - "type": "string", - "description": "The name of the receiver to resubscribe." - } - }, - "required": [ - "receiverName" - ] - }, - "ErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "ActionGroupPatchBody": { - "description": "An action group object for the body of patch operations.", - "type": "object", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ActionGroupPatch", - "description": "The action group settings for an update operation." - } - } - }, - "ActionGroupPatch": { - "description": "An Azure action group for patch operations.", - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "default": true, - "description": "Indicates whether this action group is enabled. If an action group is not enabled, then none of its actions will be activated." - } - } - } - }, - "parameters": { - "NotificationIdParameter": { - "name": "notificationId", - "in": "path", - "required": true, - "type": "string", - "description": "The notification id", - "x-ms-parameter-location": "method" - }, - "ActionGroupNameParameter": { - "name": "actionGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the action group.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Monitor/stable/2023-04-03/monitoringAccounts_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Monitor/stable/2023-04-03/monitoringAccounts_API.json deleted file mode 100644 index 34714889e..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Monitor/stable/2023-04-03/monitoringAccounts_API.json +++ /dev/null @@ -1,561 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Monitor Workspaces Control Plane API", - "description": "Provides operations for working with Azure Monitor Workspaces", - "version": "2023-04-03", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "contact": { - "email": "obsaccounts@microsoft.com" - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow" - } - }, - "tags": [ - { - "name": "AzureMonitorWorkspaces", - "description": "A management operation for microsoft.monitor/accounts" - } - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts": { - "get": { - "tags": [ - "AzureMonitorWorkspaces" - ], - "description": "Lists all Azure Monitor Workspaces in the specified resource group", - "operationId": "AzureMonitorWorkspaces_ListByResourceGroup", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request completed successfully", - "schema": { - "$ref": "#/definitions/AzureMonitorWorkspaceResourceListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List Azure Monitor Workspaces by resource group": { - "$ref": "./examples/AzureMonitorWorkspacesListByResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Monitor/accounts": { - "get": { - "tags": [ - "AzureMonitorWorkspaces" - ], - "description": "Lists all Azure Monitor Workspaces in the specified subscription", - "operationId": "AzureMonitorWorkspaces_ListBySubscription", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request completed successfully", - "schema": { - "$ref": "#/definitions/AzureMonitorWorkspaceResourceListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List Azure Monitor Workspaces by subscription": { - "$ref": "./examples/AzureMonitorWorkspacesListBySubscription.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}": { - "get": { - "tags": [ - "AzureMonitorWorkspaces" - ], - "description": "Returns the specified Azure Monitor Workspace", - "operationId": "AzureMonitorWorkspaces_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureMonitorWorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request completed successfully", - "schema": { - "$ref": "#/definitions/AzureMonitorWorkspaceResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Azure Monitor Workspace": { - "$ref": "./examples/AzureMonitorWorkspacesGet.json" - } - } - }, - "put": { - "tags": [ - "AzureMonitorWorkspaces" - ], - "description": "Creates or updates an Azure Monitor Workspace", - "operationId": "AzureMonitorWorkspaces_Create", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureMonitorWorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "azureMonitorWorkspaceProperties", - "description": "Properties that need to be specified to create a new Azure Monitor Workspace", - "required": true, - "schema": { - "$ref": "#/definitions/AzureMonitorWorkspaceResource" - } - } - ], - "responses": { - "200": { - "description": "Azure Monitor Workspace was successfully updated", - "schema": { - "$ref": "#/definitions/AzureMonitorWorkspaceResource" - } - }, - "201": { - "description": "Azure Monitor Workspace was successfully created", - "schema": { - "$ref": "#/definitions/AzureMonitorWorkspaceResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create or update an Azure Monitor Workspace": { - "$ref": "./examples/AzureMonitorWorkspacesCreate.json" - } - } - }, - "patch": { - "tags": [ - "AzureMonitorWorkspaces" - ], - "description": "Updates part of an Azure Monitor Workspace", - "operationId": "AzureMonitorWorkspaces_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureMonitorWorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "azureMonitorWorkspaceProperties", - "description": "The payload", - "schema": { - "$ref": "#/definitions/AzureMonitorWorkspaceResourceForUpdate" - } - } - ], - "responses": { - "200": { - "description": "Azure Monitor Workspace was successfully updated", - "schema": { - "$ref": "#/definitions/AzureMonitorWorkspaceResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Update an Azure Monitor Workspace": { - "$ref": "./examples/AzureMonitorWorkspacesUpdate.json" - } - } - }, - "delete": { - "tags": [ - "AzureMonitorWorkspaces" - ], - "description": "Deletes an Azure Monitor Workspace", - "operationId": "AzureMonitorWorkspaces_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AzureMonitorWorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Azure Monitor Workspace delete operation has been accepted and will complete asynchronously", - "headers": { - "Azure-AsyncOperation": { - "type": "string" - }, - "Location": { - "type": "string" - } - } - }, - "204": { - "description": "Azure Monitor Workspace does not exist" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete an Azure Monitor Workspace": { - "$ref": "./examples/AzureMonitorWorkspacesDelete.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - } - }, - "definitions": { - "Metrics": { - "description": "Properties related to the metrics container in the Azure Monitor Workspace", - "type": "object", - "properties": { - "prometheusQueryEndpoint": { - "description": "The Prometheus query endpoint for the Azure Monitor Workspace", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "internalId": { - "description": "An internal identifier for the metrics container. Only to be used by the system", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - } - } - }, - "IngestionSettings": { - "description": "Settings for data ingestion", - "type": "object", - "properties": { - "dataCollectionRuleResourceId": { - "description": "The Azure resource Id of the default data collection rule for this Azure Monitor Workspace.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "dataCollectionEndpointResourceId": { - "description": "The Azure resource Id of the default data collection endpoint for this Azure Monitor Workspace.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - } - } - }, - "AzureMonitorWorkspace": { - "description": "Properties of an Azure Monitor Workspace", - "type": "object", - "properties": { - "accountId": { - "description": "The immutable Id of the Azure Monitor Workspace. This property is read-only.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "metrics": { - "description": "Properties related to the metrics container in the Azure Monitor Workspace", - "allOf": [ - { - "$ref": "#/definitions/Metrics" - } - ], - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "provisioningState": { - "description": "The provisioning state of the Azure Monitor Workspace. Set to Succeeded if everything is healthy.", - "enum": [ - "Creating", - "Succeeded", - "Deleting", - "Failed", - "Canceled" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - }, - "x-ms-mutability": [ - "read" - ] - }, - "defaultIngestionSettings": { - "description": "The Data Collection Rule and Endpoint used for ingestion by default.", - "allOf": [ - { - "$ref": "#/definitions/IngestionSettings" - } - ], - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "privateEndpointConnections": { - "description": "List of private endpoint connections", - "type": "array", - "items": { - "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection" - }, - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-identifiers": [ - "id" - ] - }, - "publicNetworkAccess": { - "description": "Gets or sets allow or disallow public network access to Azure Monitor Workspace", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "PublicNetworkAccess", - "modelAsString": true - }, - "x-ms-mutability": [ - "read" - ] - } - } - }, - "AzureMonitorWorkspaceResource": { - "description": "An Azure Monitor Workspace definition", - "required": [ - "location" - ], - "type": "object", - "properties": { - "properties": { - "description": "Resource properties", - "allOf": [ - { - "$ref": "#/definitions/AzureMonitorWorkspace" - } - ], - "x-ms-client-flatten": true - }, - "etag": { - "description": "Resource entity tag (ETag)", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "x-ms-azure-resource": true - }, - "AzureMonitorWorkspaceResourceListResult": { - "description": "A pageable list of resources", - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "description": "A list of resources", - "type": "array", - "items": { - "$ref": "#/definitions/AzureMonitorWorkspaceResource" - } - }, - "nextLink": { - "description": "The URL to use for getting the next set of results", - "type": "string" - } - } - }, - "AzureMonitorWorkspaceResourceForUpdate": { - "description": "Definition of ARM tracked top level resource properties for the Update operation", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "parameters": { - "AzureMonitorWorkspaceNameParameter": { - "in": "path", - "name": "azureMonitorWorkspaceName", - "description": "The name of the Azure Monitor Workspace. The name is case insensitive", - "required": true, - "type": "string", - "pattern": "^(?!-)[a-zA-Z0-9-]+[^-]$", - "x-ms-parameter-location": "method" - } - } -} diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Monitor/stable/2023-04-03/operations_API.json b/swagger-specs/monitor/resource-manager/Microsoft.Monitor/stable/2023-04-03/operations_API.json deleted file mode 100644 index f1b5bc72d..000000000 --- a/swagger-specs/monitor/resource-manager/Microsoft.Monitor/stable/2023-04-03/operations_API.json +++ /dev/null @@ -1,89 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Monitor Workspaces Control Plane API", - "description": "Provides operations for working with Azure Monitor Workspaces", - "version": "2023-04-03", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "contact": { - "email": "obsaccounts@microsoft.com" - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow" - } - }, - "tags": [ - { - "name": "Operations", - "description": "List available operations API" - } - ], - "paths": { - "/providers/Microsoft.Monitor/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists available Operations for this Resource Provider", - "operationId": "MonitorOperations_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get operations list": { - "$ref": "./examples/OperationsGet.json" - } - } - } - } - } -} diff --git a/swagger-specs/monitor/resource-manager/api-set.json b/swagger-specs/monitor/resource-manager/api-set.json deleted file mode 100644 index 9698e26e8..000000000 --- a/swagger-specs/monitor/resource-manager/api-set.json +++ /dev/null @@ -1 +0,0 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Monitor/stable/2023-04-03/monitoringAccounts_API.json", "Microsoft.Monitor/stable/2023-04-03/operations_API.json", "Microsoft.Insights/stable/2022-10-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/2021-05-01-preview/diagnosticsSettings_API.json", "Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json", "Microsoft.Insights/stable/2023-01-01/actionGroups_API.json", "Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_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/2021-05-01/metricDefinitions_API.json", "Microsoft.Insights/stable/2021-05-01/metrics_API.json", "Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json", "Microsoft.Insights/stable/2018-03-01/metricAlert_API.json", "Microsoft.Insights/preview/2022-08-01-preview/scheduledQueryRule_API.json", "Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json", "Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json", "Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json", "Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json", "Microsoft.Insights/stable/2022-06-01/dataCollectionEndpoints_API.json", "Microsoft.Insights/stable/2022-06-01/dataCollectionRuleAssociations_API.json", "Microsoft.Insights/stable/2022-06-01/dataCollectionRules_API.json"], "name": "package-2023-04"} \ No newline at end of file diff --git a/swagger-specs/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json b/swagger-specs/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json deleted file mode 100644 index d0496da26..000000000 --- a/swagger-specs/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json +++ /dev/null @@ -1,2006 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft NetApp", - "description": "Microsoft NetApp Azure Resource Provider specification", - "version": "2017-08-15", - "x-ms-code-generation-settings": { - "name": "AzureNetAppFilesManagementClient" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "schemes": [ - "https" - ], - "host": "management.azure.com", - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.NetApp/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all of the available Microsoft.NetApp Rest API operations", - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "x-ms-pageable": { - "nextLinkName": null - }, - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroup" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "get": { - "description": "Lists all NetApp accounts in the resource group", - "tags": [ - "NetApp Accounts" - ], - "operationId": "Accounts_List", - "x-ms-pageable": { - "nextLinkName": null - }, - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/netAppAccountList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "Accounts_List": { - "$ref": "examples/Accounts_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroup" - }, - { - "$ref": "#/parameters/AccountName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "get": { - "description": "Get the NetApp account", - "tags": [ - "NetApp Accounts" - ], - "operationId": "Accounts_Get", - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/netAppAccount" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "Accounts_Get": { - "$ref": "examples/Accounts_Get.json" - } - } - }, - "put": { - "tags": [ - "NetApp Accounts" - ], - "operationId": "Accounts_CreateOrUpdate", - "description": "Create or update a NetApp account", - "parameters": [ - { - "name": "body", - "description": "NetApp Account object supplied in the body of the operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/netAppAccount" - } - } - ], - "responses": { - "200": { - "description": "OK - account updated", - "schema": { - "$ref": "#/definitions/netAppAccount" - } - }, - "201": { - "description": "Account created", - "schema": { - "$ref": "#/definitions/netAppAccount" - } - }, - "202": { - "description": "Accepted -- Create request accepted; operation will complete asynchronously" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Accounts_CreateOrUpdate": { - "$ref": "examples/Accounts_CreateOrUpdate.json" - } - } - }, - "delete": { - "tags": [ - "NetApp Accounts" - ], - "operationId": "Accounts_Delete", - "description": "Delete a NetApp account", - "responses": { - "202": { - "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" - }, - "204": { - "description": "NoContent -- Resource does not exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Accounts_Delete": { - "$ref": "examples/Accounts_Delete.json" - } - } - }, - "patch": { - "tags": [ - "NetApp Accounts" - ], - "operationId": "Accounts_Update", - "description": "Patch a NetApp account", - "parameters": [ - { - "name": "body", - "description": "NetApp Account object supplied in the body of the operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/netAppAccountPatch" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/netAppAccount" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "Accounts_Update": { - "$ref": "examples/Accounts_Update.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroup" - }, - { - "$ref": "#/parameters/AccountName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "get": { - "description": "Lists all capacity pools in the NetApp Account", - "tags": [ - "Capacity Pools" - ], - "operationId": "Pools_List", - "x-ms-pageable": { - "nextLinkName": null - }, - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/capacityPoolList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "Pools_List": { - "$ref": "examples/Pools_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroup" - }, - { - "$ref": "#/parameters/AccountName" - }, - { - "$ref": "#/parameters/PoolName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "get": { - "description": "Get a capacity pool", - "tags": [ - "Capacity Pools" - ], - "operationId": "Pools_Get", - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/capacityPool" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "Pools_Get": { - "$ref": "examples/Pools_Get.json" - } - } - }, - "put": { - "tags": [ - "Capacity Pools" - ], - "operationId": "Pools_CreateOrUpdate", - "description": "Create or Update a capacity pool", - "parameters": [ - { - "name": "body", - "description": "Capacity pool object supplied in the body of the operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/capacityPool" - } - } - ], - "responses": { - "200": { - "description": "OK - pool updated", - "schema": { - "$ref": "#/definitions/capacityPool" - } - }, - "201": { - "description": "Pool created", - "schema": { - "$ref": "#/definitions/capacityPool" - } - }, - "202": { - "description": "Accepted -- Create request accepted; operation will complete asynchronously" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Pools_CreateOrUpdate": { - "$ref": "examples/Pools_CreateOrUpdate.json" - } - } - }, - "patch": { - "tags": [ - "Capacity Pools" - ], - "operationId": "Pools_Update", - "description": "Patch a capacity pool", - "parameters": [ - { - "name": "body", - "description": "Capacity pool object supplied in the body of the operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/capacityPoolPatch" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/capacityPool" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "Pools_Update": { - "$ref": "examples/Pools_Update.json" - } - } - }, - "delete": { - "tags": [ - "Capacity Pools" - ], - "operationId": "Pools_Delete", - "description": "Delete a capacity pool", - "responses": { - "202": { - "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" - }, - "204": { - "description": "NoContent -- Resource does not exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Pools_Delete": { - "$ref": "examples/Pools_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroup" - }, - { - "$ref": "#/parameters/AccountName" - }, - { - "$ref": "#/parameters/PoolName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "get": { - "description": "List volumes", - "tags": [ - "Volumes" - ], - "operationId": "Volumes_List", - "x-ms-pageable": { - "nextLinkName": null - }, - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/volumeList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "Volumes_List": { - "$ref": "examples/Volumes_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroup" - }, - { - "$ref": "#/parameters/AccountName" - }, - { - "$ref": "#/parameters/PoolName" - }, - { - "$ref": "#/parameters/VolumeName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "get": { - "tags": [ - "Volumes" - ], - "operationId": "Volumes_Get", - "description": "Get a volume", - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/volume" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "Volumes_Get": { - "$ref": "examples/Volumes_Get.json" - } - } - }, - "put": { - "tags": [ - "Volumes" - ], - "operationId": "Volumes_CreateOrUpdate", - "description": "Create or update a volume", - "parameters": [ - { - "name": "body", - "description": "Volume object supplied in the body of the operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/volume" - } - } - ], - "responses": { - "200": { - "description": "Ok - volume updated", - "schema": { - "$ref": "#/definitions/volume" - } - }, - "201": { - "description": "Volume created", - "schema": { - "$ref": "#/definitions/volume" - } - }, - "202": { - "description": "Accepted -- Create request accepted; operation will complete asynchronously" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Volumes_CreateOrUpdate": { - "$ref": "examples/Volumes_CreateOrUpdate.json" - } - } - }, - "patch": { - "tags": [ - "Volumes" - ], - "operationId": "Volumes_Update", - "description": "Patch a volume", - "parameters": [ - { - "name": "body", - "description": "Volume object supplied in the body of the operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/volumePatch" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/volume" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "Volumes_Update": { - "$ref": "examples/Volumes_Update.json" - } - } - }, - "delete": { - "tags": [ - "Volumes" - ], - "operationId": "Volumes_Delete", - "description": "Delete a volume", - "responses": { - "202": { - "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" - }, - "204": { - "description": "NoContent -- Resource does not exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Volumes_Delete": { - "$ref": "examples/Volumes_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/mountTargets": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroup" - }, - { - "$ref": "#/parameters/AccountName" - }, - { - "$ref": "#/parameters/PoolName" - }, - { - "$ref": "#/parameters/VolumeName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "get": { - "tags": [ - "MountTargets" - ], - "operationId": "MountTargets_List", - "description": "List mount targets", - "x-ms-pageable": { - "nextLinkName": null - }, - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/mountTargetList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "MountTargets_List": { - "$ref": "examples/MountTargets_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroup" - }, - { - "$ref": "#/parameters/AccountName" - }, - { - "$ref": "#/parameters/PoolName" - }, - { - "$ref": "#/parameters/VolumeName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "get": { - "tags": [ - "Snapshots" - ], - "operationId": "Snapshots_List", - "description": "List snapshots", - "x-ms-pageable": { - "nextLinkName": null - }, - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/snapshotsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "Snapshots_List": { - "$ref": "examples/Snapshots_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroup" - }, - { - "$ref": "#/parameters/AccountName" - }, - { - "$ref": "#/parameters/PoolName" - }, - { - "$ref": "#/parameters/VolumeName" - }, - { - "$ref": "#/parameters/SnapshotName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "get": { - "tags": [ - "Snapshots" - ], - "operationId": "Snapshots_Get", - "description": "Get a snapshot", - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/snapshot" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "Snapshots_Get": { - "$ref": "examples/Snapshots_Get.json" - } - } - }, - "put": { - "tags": [ - "Snapshots" - ], - "operationId": "Snapshots_Create", - "description": "Create a snapshot", - "parameters": [ - { - "name": "body", - "description": "Snapshot object supplied in the body of the operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/snapshot" - } - } - ], - "responses": { - "201": { - "description": "Snapshot created", - "schema": { - "$ref": "#/definitions/snapshot" - } - }, - "202": { - "description": "Accepted -- Create request accepted; operation will complete asynchronously" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Snapshots_Create": { - "$ref": "examples/Snapshots_Create.json" - } - } - }, - "patch": { - "tags": [ - "Snapshots" - ], - "operationId": "Snapshots_Update", - "description": "Patch a snapshot", - "parameters": [ - { - "name": "body", - "description": "Snapshot object supplied in the body of the operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/snapshotPatch" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/snapshot" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "Snapshots_Update": { - "$ref": "examples/Snapshots_Update.json" - } - } - }, - "delete": { - "tags": [ - "Snapshots" - ], - "operationId": "Snapshots_Delete", - "description": "Delete snapshot", - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" - }, - "204": { - "description": "NoContent -- Resource does not exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Snapshots_Delete": { - "$ref": "examples/Snapshots_Delete.json" - } - } - } - } - }, - "definitions": { - "OperationListResult": { - "description": "Result of the request to list Cloud Volume operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of Storage operations supported by the Storage resource provider." - } - } - }, - "Operation": { - "description": "Microsoft.NetApp REST API operation definition.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "Display metadata associated with the operation.", - "properties": { - "provider": { - "description": "Service provider: Microsoft NetApp.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed etc.", - "type": "string" - }, - "operation": { - "description": "Type of operation: get, read, delete, etc.", - "type": "string" - }, - "description": { - "description": "Operation description.", - "type": "string" - } - } - }, - "origin": { - "type": "string", - "description": "The origin of operations." - }, - "properties": { - "$ref": "#/definitions/OperationProperties", - "description": "Properties of operation, include metric specifications.", - "x-ms-client-flatten": true - } - } - }, - "OperationProperties": { - "description": "Properties of operation, include metric specifications.", - "properties": { - "serviceSpecification": { - "$ref": "#/definitions/ServiceSpecification", - "description": "One property of operation, include metric specifications." - } - } - }, - "ServiceSpecification": { - "description": "One property of operation, include metric specifications.", - "properties": { - "metricSpecifications": { - "description": "Metric specifications of operation.", - "type": "array", - "items": { - "$ref": "#/definitions/MetricSpecification" - } - } - } - }, - "MetricSpecification": { - "description": "Metric specification of operation.", - "properties": { - "name": { - "type": "string", - "description": "Name of metric specification." - }, - "displayName": { - "type": "string", - "description": "Display name of metric specification." - }, - "displayDescription": { - "type": "string", - "description": "Display description of metric specification." - }, - "unit": { - "type": "string", - "description": "Unit could be Bytes or Count." - }, - "dimensions": { - "description": "Dimensions of blobs, including blob type and access tier.", - "type": "array", - "items": { - "$ref": "#/definitions/Dimension" - } - }, - "aggregationType": { - "type": "string", - "description": "Aggregation type could be Average." - }, - "fillGapWithZero": { - "type": "boolean", - "description": "The property to decide fill gap with zero or not." - }, - "category": { - "type": "string", - "description": "The category this metric specification belong to, could be Capacity." - }, - "resourceIdDimensionNameOverride": { - "type": "string", - "description": "Account Resource Id." - } - } - }, - "Dimension": { - "description": "Dimension of blobs, possibly be blob type or access tier.", - "properties": { - "name": { - "type": "string", - "description": "Display name of dimension." - }, - "displayName": { - "type": "string", - "description": "Display name of dimension." - } - } - }, - "netAppAccountList": { - "description": "List of NetApp account resources", - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "Multiple NetApp accounts", - "items": { - "$ref": "#/definitions/netAppAccount" - } - } - } - }, - "netAppAccount": { - "description": "NetApp account resource", - "type": "object", - "x-ms-azure-resource": true, - "required": [ - "location", - "properties" - ], - "properties": { - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - }, - "tags": { - "description": "Resource tags", - "$ref": "#/definitions/resourceTags" - }, - "properties": { - "description": "NetApp Account properties", - "$ref": "#/definitions/accountProperties", - "x-ms-client-flatten": true - } - } - }, - "netAppAccountPatch": { - "description": "NetApp account patch resource", - "type": "object", - "x-ms-azure-resource": true, - "properties": { - "location": { - "type": "string", - "description": "Resource location" - }, - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - }, - "tags": { - "description": "Resource tags", - "$ref": "#/definitions/resourceTags" - }, - "properties": { - "description": "NetApp Account properties", - "$ref": "#/definitions/accountProperties", - "x-ms-client-flatten": true - } - } - }, - "accountProperties": { - "description": "NetApp account properties", - "type": "object", - "properties": { - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "Azure lifecycle management" - }, - "activeDirectories": { - "description": "Active Directories", - "type": "array", - "items": { - "$ref": "#/definitions/activeDirectory" - } - } - } - }, - "activeDirectory": { - "description": "Active Directory", - "type": "object", - "properties": { - "activeDirectoryId": { - "type": "string", - "description": "Id of the Active Directory" - }, - "username": { - "type": "string", - "description": "Username of Active Directory domain administrator" - }, - "password": { - "type": "string", - "description": "Plain text password of Active Directory domain administrator" - }, - "domain": { - "type": "string", - "description": "Name of the Active Directory domain" - }, - "dNS": { - "type": "string", - "description": "Comma separated list of DNS server IP addresses for the Active Directory domain" - }, - "status": { - "type": "string", - "description": "Status of the Active Directory" - }, - "sMBServerName": { - "type": "string", - "description": "NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes" - }, - "organizationalUnit": { - "type": "string", - "description": "The Organizational Unit (OU) within the Windows Active Directory" - } - } - }, - "capacityPoolList": { - "description": "List of capacity pool resources", - "type": "object", - "properties": { - "value": { - "description": "List of Capacity pools", - "type": "array", - "items": { - "$ref": "#/definitions/capacityPool" - } - } - } - }, - "capacityPool": { - "description": "Capacity pool resource", - "type": "object", - "x-ms-azure-resource": true, - "required": [ - "location", - "properties" - ], - "properties": { - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - }, - "tags": { - "description": "Resource tags", - "$ref": "#/definitions/resourceTags" - }, - "properties": { - "description": "Capacity pool properties", - "$ref": "#/definitions/poolProperties", - "x-ms-client-flatten": true - } - } - }, - "poolProperties": { - "description": "Pool properties", - "type": "object", - "properties": { - "poolId": { - "title": "poolId", - "type": "string", - "readOnly": true, - "description": "UUID v4 used to identify the Pool", - "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", - "maxLength": 36, - "minLength": 36, - "example": "9760acf5-4638-11e7-9bdb-020073ca7778" - }, - "size": { - "title": "size", - "type": "integer", - "format": "int64", - "description": "Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104).", - "minimum": 4398046511104, - "maximum": 549755813888000, - "default": 4398046511104 - }, - "serviceLevel": { - "title": "serviceLevel", - "type": "string", - "description": "The service level of the file system", - "enum": [ - "Standard", - "Premium", - "Ultra" - ], - "x-ms-enum": { - "name": "ServiceLevel", - "modelAsString": true, - "values": [ - { - "value": "Standard", - "description": "Standard service level" - }, - { - "value": "Premium", - "description": "Premium service level" - }, - { - "value": "Ultra", - "description": "Ultra service level" - } - ] - }, - "example": "Ultra", - "default": "Premium" - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "Azure lifecycle management" - } - } - }, - "capacityPoolPatch": { - "description": "Capacity pool patch resource", - "type": "object", - "x-ms-azure-resource": true, - "properties": { - "location": { - "type": "string", - "description": "Resource location" - }, - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - }, - "tags": { - "description": "Resource tags", - "$ref": "#/definitions/resourceTags" - }, - "properties": { - "description": "Capacity pool properties", - "$ref": "#/definitions/poolPatchProperties", - "x-ms-client-flatten": true - } - } - }, - "poolPatchProperties": { - "description": "Patchable pool properties", - "type": "object", - "properties": { - "size": { - "title": "size", - "type": "integer", - "format": "int64", - "description": "Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104).", - "minimum": 4398046511104, - "maximum": 549755813888000, - "default": 4398046511104 - }, - "serviceLevel": { - "title": "serviceLevel", - "type": "string", - "description": "The service level of the file system", - "enum": [ - "Standard", - "Premium", - "Ultra" - ], - "x-ms-enum": { - "name": "ServiceLevel", - "modelAsString": true, - "values": [ - { - "value": "Standard", - "description": "Standard service level" - }, - { - "value": "Premium", - "description": "Premium service level" - }, - { - "value": "Ultra", - "description": "Ultra service level" - } - ] - }, - "example": "Ultra", - "default": "Premium" - } - } - }, - "volumeList": { - "description": "List of volume resources", - "type": "object", - "properties": { - "value": { - "description": "List of volumes", - "type": "array", - "items": { - "$ref": "#/definitions/volume" - } - } - } - }, - "volume": { - "description": "Volume resource", - "type": "object", - "x-ms-azure-resource": true, - "required": [ - "location", - "properties" - ], - "properties": { - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - }, - "tags": { - "description": "Resource tags", - "$ref": "#/definitions/resourceTags" - }, - "properties": { - "description": "Volume properties", - "$ref": "#/definitions/volumeProperties", - "x-ms-client-flatten": true - } - } - }, - "resourceTags": { - "description": "Resource tags", - "type": "object" - }, - "volumeProperties": { - "description": "Volume properties", - "type": "object", - "required": [ - "creationToken", - "serviceLevel" - ], - "properties": { - "fileSystemId": { - "title": "FileSystem ID", - "type": "string", - "readOnly": true, - "description": "Unique FileSystem Identifier.", - "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", - "maxLength": 36, - "minLength": 36, - "example": "9760acf5-4638-11e7-9bdb-020073ca7778" - }, - "creationToken": { - "title": "Creation Token or File Path", - "type": "string", - "description": "A unique file path for the volume. Used when creating mount targets", - "minimum": 16, - "maximum": 40, - "example": "some-amazing-filepath" - }, - "serviceLevel": { - "title": "serviceLevel", - "type": "string", - "description": "The service level of the file system", - "enum": [ - "Standard", - "Premium", - "Ultra" - ], - "x-ms-enum": { - "name": "ServiceLevel", - "modelAsString": true, - "values": [ - { - "value": "Standard", - "description": "Standard service level" - }, - { - "value": "Premium", - "description": "Premium service level" - }, - { - "value": "Ultra", - "description": "Ultra service level" - } - ] - }, - "example": "Ultra", - "default": "Premium" - }, - "usageThreshold": { - "title": "usageThreshold", - "type": "integer", - "format": "int64", - "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB.", - "minimum": 107374182400, - "maximum": 109951162777600, - "default": 107374182400, - "example": 107374182400 - }, - "exportPolicy": { - "description": "Export policy rule", - "properties": { - "rules": { - "type": "array", - "items": { - "$ref": "#/definitions/exportPolicyRule" - } - } - } - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "Azure lifecycle management" - }, - "subnetId": { - "type": "string", - "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" - } - } - }, - "exportPolicyRule": { - "description": "Volume Export Policy Rule", - "type": "object", - "properties": { - "ruleIndex": { - "type": "integer", - "description": "Order index" - }, - "unixReadOnly": { - "type": "boolean", - "description": "Read only access" - }, - "unixReadWrite": { - "type": "boolean", - "description": "Read and write access" - }, - "cifs": { - "type": "boolean", - "description": "Allows CIFS protocol" - }, - "nfsv3": { - "type": "boolean", - "description": "Allows NFSv3 protocol" - }, - "nfsv4": { - "type": "boolean", - "description": "Allows NFSv4 protocol" - }, - "allowedClients": { - "type": "string", - "description": "Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names" - } - } - }, - "volumePatch": { - "description": "Volume patch resource", - "type": "object", - "x-ms-azure-resource": true, - "properties": { - "location": { - "type": "string", - "description": "Resource location" - }, - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - }, - "tags": { - "description": "Resource tags", - "$ref": "#/definitions/resourceTags" - }, - "properties": { - "description": "Patchable volume properties", - "$ref": "#/definitions/volumePatchProperties", - "x-ms-client-flatten": true - } - } - }, - "volumePatchProperties": { - "description": "Patchable volume properties", - "type": "object", - "properties": { - "serviceLevel": { - "title": "serviceLevel", - "type": "string", - "description": "The service level of the file system", - "enum": [ - "Standard", - "Premium", - "Ultra" - ], - "x-ms-enum": { - "name": "ServiceLevel", - "modelAsString": true, - "values": [ - { - "value": "Standard", - "description": "Standard service level" - }, - { - "value": "Premium", - "description": "Premium service level" - }, - { - "value": "Ultra", - "description": "Ultra service level" - } - ] - }, - "example": "Ultra", - "default": "Premium" - }, - "usageThreshold": { - "title": "usageThreshold", - "type": "integer", - "format": "int64", - "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB.", - "minimum": 107374182400, - "maximum": 109951162777600, - "default": 107374182400, - "example": 107374182400 - }, - "exportPolicy": { - "description": "Export policy rule", - "properties": { - "rules": { - "type": "array", - "items": { - "$ref": "#/definitions/exportPolicyRule" - } - } - } - } - } - }, - "mountTargetList": { - "description": "List of Mount Targets", - "type": "object", - "properties": { - "value": { - "description": "A list of Mount targets", - "type": "array", - "items": { - "$ref": "#/definitions/mountTarget" - } - } - } - }, - "mountTarget": { - "description": "Mount Target", - "type": "object", - "required": [ - "location", - "properties" - ], - "properties": { - "location": { - "type": "string", - "description": "Resource location" - }, - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "tags": { - "description": "Resource tags", - "$ref": "#/definitions/resourceTags", - "x-ms-client-flatten": true - }, - "properties": { - "description": "Mount Target Properties", - "$ref": "#/definitions/mountTargetProperties", - "x-ms-client-flatten": true - } - } - }, - "mountTargetProperties": { - "description": "Mount target properties", - "type": "object", - "required": [ - "fileSystemId" - ], - "properties": { - "mountTargetId": { - "title": "mountTargetId", - "type": "string", - "readOnly": true, - "description": "UUID v4 used to identify the MountTarget", - "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", - "maxLength": 36, - "minLength": 36, - "example": "9760acf5-4638-11e7-9bdb-020073ca3333" - }, - "fileSystemId": { - "title": "fileSystemId", - "type": "string", - "description": "UUID v4 used to identify the MountTarget", - "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", - "maxLength": 36, - "minLength": 36, - "example": "9760acf5-4638-11e7-9bdb-020073ca3333" - }, - "ipAddress": { - "title": "ipAddress", - "description": "The mount target's IPv4 address", - "type": "string", - "readOnly": true, - "example": "1.2.3.4" - }, - "subnet": { - "title": "subnet", - "type": "string", - "description": "The subnet", - "example": "1.2.3.4" - }, - "startIp": { - "title": "startIp", - "description": "The start of IPv4 address range to use when creating a new mount target", - "type": "string", - "example": "1.2.3.4" - }, - "endIp": { - "title": "endIp", - "description": "The end of IPv4 address range to use when creating a new mount target", - "type": "string", - "example": "1.2.3.4" - }, - "gateway": { - "title": "gateway", - "description": "The gateway of the IPv4 address range to use when creating a new mount target", - "type": "string", - "example": "1.2.3.4" - }, - "netmask": { - "title": "netmask", - "description": "The netmask of the IPv4 address range to use when creating a new mount target", - "type": "string", - "example": "255.255.255.0" - }, - "smbServerFqdn": { - "title": "smbServerFQDN", - "description": "The SMB server's Fully Qualified Domain Name, FQDN", - "type": "string", - "example": "fullyqualified.domainname.com" - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "Azure lifecycle management" - } - } - }, - "snapshotsList": { - "description": "List of Snapshots", - "type": "object", - "properties": { - "value": { - "description": "A list of Snapshots", - "type": "array", - "items": { - "$ref": "#/definitions/snapshot" - } - } - } - }, - "snapshot": { - "description": "Snapshot of a Volume", - "type": "object", - "x-ms-azure-resource": true, - "required": [ - "location", - "properties" - ], - "properties": { - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - }, - "tags": { - "description": "Resource tags", - "$ref": "#/definitions/resourceTags", - "x-ms-client-flatten": true - }, - "properties": { - "description": "Snapshot Properties", - "$ref": "#/definitions/snapshotProperties", - "x-ms-client-flatten": true - } - } - }, - "snapshotPatch": { - "description": "Snapshot patch", - "type": "object", - "x-ms-azure-resource": true, - "properties": { - "tags": { - "description": "Resource tags", - "$ref": "#/definitions/resourceTags", - "x-ms-client-flatten": true - } - } - }, - "snapshotProperties": { - "description": "Snapshot properties", - "type": "object", - "required": [ - "fileSystemId" - ], - "properties": { - "snapshotId": { - "title": "snapshotId", - "type": "string", - "readOnly": true, - "description": "UUID v4 used to identify the Snapshot", - "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", - "maxLength": 36, - "minLength": 36, - "example": "9760acf5-4638-11e7-9bdb-020073ca3333" - }, - "fileSystemId": { - "title": "fileSystemId", - "type": "string", - "description": "UUID v4 used to identify the FileSystem", - "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", - "maxLength": 36, - "minLength": 36, - "example": "9760acf5-4638-11e7-9bdb-020073ca3333" - }, - "creationDate": { - "title": "name", - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The creation date of the snapshot", - "example": "2017-08-15 13:23:33" - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "Azure lifecycle management" - } - } - }, - "error": { - "description": "Error response describing why the operation failed.", - "type": "object", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "Error code", - "example": "ErrorCode" - }, - "message": { - "type": "string", - "description": "Detailed error message", - "example": "Detailed error message" - } - } - } - }, - "parameters": { - "SubscriptionId": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ResourceGroup": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group.", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - }, - "AccountName": { - "name": "accountName", - "type": "string", - "in": "path", - "required": true, - "description": "The name of the NetApp account", - "x-ms-parameter-location": "method" - }, - "PoolName": { - "name": "poolName", - "type": "string", - "in": "path", - "required": true, - "description": "The name of the capacity pool", - "x-ms-parameter-location": "method" - }, - "VolumeName": { - "name": "volumeName", - "type": "string", - "in": "path", - "required": true, - "description": "The name of the volume", - "x-ms-parameter-location": "method" - }, - "MountTargetName": { - "name": "mountTargetName", - "type": "string", - "in": "path", - "required": true, - "description": "The name of the mount target", - "x-ms-parameter-location": "method" - }, - "SnapshotName": { - "name": "snapshotName", - "type": "string", - "in": "path", - "required": true, - "description": "The name of the mount target", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "description": "Version of the API to be used with the client request.", - "in": "query", - "type": "string", - "required": true, - "default": "2017-08-15" - } - } -} diff --git a/swagger-specs/netapp/resource-manager/Microsoft.NetApp/stable/2023-11-01/netapp.json b/swagger-specs/netapp/resource-manager/Microsoft.NetApp/stable/2023-11-01/netapp.json new file mode 100644 index 000000000..8a783b13e --- /dev/null +++ b/swagger-specs/netapp/resource-manager/Microsoft.NetApp/stable/2023-11-01/netapp.json @@ -0,0 +1,9368 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft NetApp", + "description": "Microsoft NetApp Azure Resource Provider specification", + "version": "2023-11-01", + "x-ms-code-generation-settings": { + "name": "AzureNetAppFilesManagementClient" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "host": "management.azure.com", + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.NetApp/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Describes the Resource Provider", + "description": "Lists all of the available Microsoft.NetApp Rest API operations", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OperationList": { + "$ref": "examples/OperationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check resource name availability", + "description": "Check if a resource name is available.", + "operationId": "NetAppResource_CheckNameAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Name availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceNameAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "examples/CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check file path availability", + "description": "Check if a file path is available.", + "operationId": "NetAppResource_CheckFilePathAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "File path availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/FilePathAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckFilePathAvailability": { + "$ref": "examples/CheckFilePathAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkQuotaAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check quota availability", + "description": "Check if a quota is available.", + "operationId": "NetAppResource_CheckQuotaAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Quota availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckQuotaAvailability": { + "$ref": "examples/CheckQuotaAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current limits for quotas", + "operationId": "NetAppResourceQuotaLimits_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItemList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits/{quotaLimitName}": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current subscription quota limit", + "operationId": "NetAppResourceQuotaLimits_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/QuotaLimitName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfo": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResource_QueryRegionInfo", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfo_Query": { + "$ref": "examples/RegionInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides region specific information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfosList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_List": { + "$ref": "examples/RegionInfos_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos/default": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_Get": { + "$ref": "examples/RegionInfos_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/queryNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Describe a network sibling set", + "description": "Get details of the specified network sibling set.", + "operationId": "NetAppResource_QueryNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Network sibling set to query.", + "required": true, + "schema": { + "$ref": "#/definitions/QueryNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkSiblingSet_Query": { + "$ref": "examples/NetworkSiblingSet_Query.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/updateNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Update the network features of a network sibling set", + "description": "Update the network features of the specified network sibling set.", + "operationId": "NetAppResource_UpdateNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Update for the specified network sibling set.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NetworkFeatures_Update": { + "$ref": "examples/NetworkSiblingSet_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a subscription", + "description": "List and describe all NetApp accounts in the subscription.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a resource group", + "description": "List and describe all NetApp accounts in the resource group.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}": { + "get": { + "summary": "Describe a NetApp Account", + "description": "Get the NetApp account", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_Get": { + "$ref": "examples/Accounts_Get.json" + } + } + }, + "put": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "summary": "Create or update a NetApp account", + "description": "Create or update the specified NetApp account within the resource group", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "201": { + "description": "Account created", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_CreateOrUpdate": { + "$ref": "examples/Accounts_CreateOrUpdate.json" + }, + "Accounts_CreateOrUpdateWithActiveDirectory": { + "$ref": "examples/Accounts_CreateOrUpdateAD.json" + } + } + }, + "delete": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Delete", + "summary": "Delete a NetApp account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "Delete the specified NetApp account", + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Delete": { + "$ref": "examples/Accounts_Delete.json" + } + } + }, + "patch": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Update", + "summary": "Update a NetApp account", + "description": "Patch the specified NetApp account", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccountPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Update": { + "$ref": "examples/Accounts_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/renewCredentials": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_RenewCredentials", + "summary": "Renew identity credentials", + "description": "Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_RenewCredentials": { + "$ref": "examples/Accounts_RenewCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools": { + "get": { + "summary": "Describe all Capacity Pools", + "description": "List all capacity pools in the NetApp Account", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPoolList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_List": { + "$ref": "examples/Pools_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}": { + "get": { + "summary": "Describe a Capacity Pool", + "description": "Get details of the specified capacity pool", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "examples/Pools_Get.json" + } + } + }, + "put": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_CreateOrUpdate", + "summary": "Create or Update the specified capacity pool within the resource group", + "description": "Create or Update a capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - pool updated", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "201": { + "description": "Pool created", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_CreateOrUpdate": { + "$ref": "examples/Pools_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Update", + "summary": "Update a capacity pool", + "description": "Patch the specified capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPoolPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "examples/Pools_Update.json" + } + } + }, + "delete": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Delete", + "summary": "Delete a capacity pool", + "description": "Delete the specified capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Delete": { + "$ref": "examples/Pools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes": { + "get": { + "summary": "Describe all volumes", + "description": "List all volumes within the capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volumes" + ], + "operationId": "Volumes_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_List": { + "$ref": "examples/Volumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}": { + "get": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Get", + "summary": "Describe a volume", + "description": "Get the details of the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_Get": { + "$ref": "examples/Volumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_CreateOrUpdate", + "summary": "Create or Update a volume", + "description": "Create or update the specified volume within the capacity pool", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volume" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok - volume updated", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "201": { + "description": "Volume created", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Volumes_CreateOrUpdate": { + "$ref": "examples/Volumes_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Update", + "summary": "Update a volume", + "description": "Patch the specified volume", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Update": { + "$ref": "examples/Volumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Delete", + "summary": "Delete a volume", + "description": "Delete the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "in": "query", + "name": "forceDelete", + "type": "boolean", + "description": "An option to force delete the volume. Will cleanup resources connected to the particular volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Delete": { + "$ref": "examples/Volumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/populateAvailabilityZone": { + "post": { + "tags": [ + "Volumes" + ], + "summary": "Populate Availability Zone", + "description": "This operation will populate availability zone information for a volume", + "operationId": "Volumes_PopulateAvailabilityZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- populate availability zone accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_PopulateAvailabilityZones": { + "$ref": "examples/Volumes_PopulateAvailabilityZones.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revert": { + "post": { + "tags": [ + "Volumes Revert" + ], + "summary": "Revert a volume to one of its snapshots", + "description": "Revert a volume to the snapshot specified in the body", + "operationId": "Volumes_Revert", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Object for snapshot to revert supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeRevert" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Revert": { + "$ref": "examples/Volumes_Revert.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resetCifsPassword": { + "post": { + "tags": [ + "Reset Cifs Password" + ], + "summary": "Reset cifs password", + "description": "Reset cifs password from volume", + "operationId": "Volumes_ResetCifsPassword", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_ResetCifsPassword": { + "$ref": "examples/Volumes_ResetCifsPassword.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakFileLocks": { + "post": { + "tags": [ + "File Locks" + ], + "summary": "Break file locks", + "description": "Break all the file locks on a volume", + "operationId": "Volumes_BreakFileLocks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to provide the ability to clear file locks with selected options", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakFileLocksRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakFileLocks": { + "$ref": "examples/Volumes_BreakFileLocks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/getGroupIdListForLdapUser": { + "post": { + "tags": [ + "Group Id List for LDAP User" + ], + "summary": " Get Group Id List for LDAP User", + "description": "Returns the list of group Ids for a specific LDAP User", + "operationId": "Volumes_ListGetGroupIdListForLdapUser", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Returns group Id list for a specific LDAP user", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "GetGroupIdListForUser": { + "$ref": "examples/GroupIdListForLDAPUser.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Break volume replication", + "description": "Break the replication connection on the destination volume", + "operationId": "Volumes_BreakReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to force break the replication.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakReplicationRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakReplication": { + "$ref": "examples/Volumes_BreakReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reestablishReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Re-establish volume replication", + "description": "Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots", + "operationId": "Volumes_ReestablishReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "body for the id of the source volume.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/reestablishReplicationRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReestablishReplication": { + "$ref": "examples/Volumes_ReestablishReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/replicationStatus": { + "get": { + "tags": [ + "Volumes Replication" + ], + "summary": "Get volume replication status", + "description": "Get the status of the replication", + "operationId": "Volumes_ReplicationStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/replicationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ReplicationStatus": { + "$ref": "examples/Volumes_ReplicationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/listReplications": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "List replications for volume", + "description": "List all replications for a specified volume", + "operationId": "Volumes_ListReplications", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/listReplications" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ListReplications": { + "$ref": "examples/Volumes_ListReplications.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resyncReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Resync volume replication", + "description": "Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.", + "operationId": "Volumes_ResyncReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ResyncReplication": { + "$ref": "examples/Volumes_ResyncReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/deleteReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Delete volume replication", + "description": "Delete the replication connection on the destination volume, and send release to the source replication", + "operationId": "Volumes_DeleteReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_DeleteReplication": { + "$ref": "examples/Volumes_DeleteReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Authorize source volume replication", + "description": "Authorize the replication connection on the source volume", + "operationId": "Volumes_AuthorizeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Authorize request object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/authorizeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_AuthorizeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reinitializeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "ReInitialize volume replication", + "description": "Re-Initializes the replication connection on the destination volume", + "operationId": "Volumes_ReInitializeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReInitializeReplication": { + "$ref": "examples/Volumes_ReInitializeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/poolChange": { + "post": { + "tags": [ + "Pool Change" + ], + "summary": "Change pool for volume", + "description": "Moves volume to another pool", + "operationId": "Volumes_PoolChange", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Move volume to the pool supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/poolChangeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_PoolChange.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/relocate": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Relocate volume", + "description": "Relocates volume to a new stamp", + "operationId": "Volumes_Relocate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Relocate volume request", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/relocateVolumeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_Relocate": { + "$ref": "examples/Volumes_Relocate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Finalize volume relocation", + "description": "Finalizes the relocation of the volume and cleans up the old volume.", + "operationId": "Volumes_FinalizeRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_FinalizeRelocation": { + "$ref": "examples/Volumes_FinalizeRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revertRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Revert volume relocation", + "description": "Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.", + "operationId": "Volumes_RevertRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_RevertRelocation": { + "$ref": "examples/Volumes_RevertRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Describe all snapshots", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all snapshots associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_List": { + "$ref": "examples/Snapshots_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Describe a snapshot", + "description": "Get details of the specified snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_Get": { + "$ref": "examples/Snapshots_Get.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Create", + "summary": "Create a snapshot", + "description": "Create the specified snapshot within the given volume", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Snapshot created", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Create": { + "$ref": "examples/Snapshots_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Update", + "summary": "Update a snapshot", + "description": "Patch a snapshot", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Update": { + "$ref": "examples/Snapshots_Update.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Delete a snapshot", + "description": "Delete snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Delete": { + "$ref": "examples/Snapshots_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}/restoreFiles": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_RestoreFiles", + "summary": "Create a new Snapshot Restore Files request", + "description": "Restore the specified files from the specified snapshot to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_SingleFileRestore": { + "$ref": "examples/Snapshots_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies": { + "get": { + "operationId": "SnapshotPolicies_List", + "description": "List snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_List": { + "$ref": "examples/SnapshotPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}": { + "get": { + "operationId": "SnapshotPolicies_Get", + "description": "Get a snapshot Policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_Get": { + "$ref": "examples/SnapshotPolicies_Get.json" + } + } + }, + "put": { + "operationId": "SnapshotPolicies_Create", + "description": "Create a snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - snapshot Policy updated", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "201": { + "description": "Snapshot Policy created", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "SnapshotPolicies_Create": { + "$ref": "examples/SnapshotPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshot Policy" + ], + "operationId": "SnapshotPolicies_Update", + "description": "Patch a snapshot policy", + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicyPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Update": { + "$ref": "examples/SnapshotPolicies_Update.json" + } + } + }, + "delete": { + "operationId": "SnapshotPolicies_Delete", + "description": "Delete snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Delete": { + "$ref": "examples/SnapshotPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes": { + "get": { + "tags": [ + "Snapshot Policy List Volumes" + ], + "summary": "Get volumes for snapshot policy", + "description": "Get volumes associated with snapshot policy", + "operationId": "SnapshotPolicies_ListVolumes", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicyVolumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_ListVolumes": { + "$ref": "examples/SnapshotPolicies_ListVolumes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "List backup policies", + "description": "List backup policies for Netapp Account", + "operationId": "BackupPolicies_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupPolicies_List": { + "$ref": "examples/BackupPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "Get a backup Policy", + "description": "Get a particular backup Policy", + "operationId": "BackupPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_Get": { + "$ref": "examples/BackupPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Policy" + ], + "summary": "Create a backup policy", + "description": "Create a backup policy for Netapp Account", + "operationId": "BackupPolicies_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicy" + } + } + ], + "responses": { + "200": { + "description": "Backup Policy created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Create": { + "$ref": "examples/BackupPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backup Policy" + ], + "summary": "Patch a backup policy", + "description": "Patch a backup policy for Netapp Account", + "operationId": "BackupPolicies_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicyPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Update": { + "$ref": "examples/BackupPolicies_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backup Policy" + ], + "summary": "Delete a backup policy", + "description": "Delete backup policy", + "operationId": "BackupPolicies_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupPolicies_Delete": { + "$ref": "examples/BackupPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_ListByVolume", + "summary": "Get all quota rules for a volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all quota rules associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_List": { + "$ref": "examples/VolumeQuotaRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Get", + "summary": "Describe a quota rule", + "description": "Get details of the specified quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_Get": { + "$ref": "examples/VolumeQuotaRules_Get.json" + } + } + }, + "put": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Create", + "summary": "Create a quota rule", + "description": "Create the specified quota rule within the given volume", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - VolumeQuotaRule updated", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "201": { + "description": "Quota rule Created", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Create": { + "$ref": "examples/VolumeQuotaRules_Create.json" + } + } + }, + "patch": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Update", + "summary": "Update a quota rule", + "description": "Patch a quota rule", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRulePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Update": { + "$ref": "examples/VolumeQuotaRules_Update.json" + } + } + }, + "delete": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Delete", + "summary": "Delete a quota rule", + "description": "Delete quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Delete": { + "$ref": "examples/VolumeQuotaRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups": { + "get": { + "summary": "Describe all volume groups", + "description": "List all volume groups for given account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_ListByNetAppAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_List_SapHana": { + "$ref": "examples/VolumeGroups_List_SapHana.json" + }, + "VolumeGroups_List_Oracle": { + "$ref": "examples/VolumeGroups_List_Oracle.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}": { + "get": { + "summary": "Describe a Volume Group", + "description": "Get details of the specified volume group", + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_Get_SapHana": { + "$ref": "examples/VolumeGroups_Get_SapHana.json" + }, + "VolumeGroups_Get_Oracle": { + "$ref": "examples/VolumeGroups_Get_Oracle.json" + } + } + }, + "put": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Create", + "summary": "Create the specified volume group and volumes. Creating volume group will create all the volumes specified in request body implicitly. Once volumes are created using volume group, those will be treated as regular volumes thereafter.", + "description": "Create a volume group along with specified volumes", + "parameters": [ + { + "name": "body", + "description": "Volume Group object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Volume group created", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Create_SapHana": { + "$ref": "examples/VolumeGroups_Create_SapHana.json" + }, + "VolumeGroups_Create_Oracle": { + "$ref": "examples/VolumeGroups_Create_Oracle.json" + } + } + }, + "delete": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Delete", + "summary": "Delete a volume group", + "description": "Delete the specified volume group only if there are no volumes under volume group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Delete": { + "$ref": "examples/VolumeGroups_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes": { + "get": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_ListByVolume", + "summary": "List of all the subvolumes", + "description": "Returns a list of the subvolumes in the volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_List": { + "$ref": "examples/Subvolumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}": { + "get": { + "tags": [ + "Subvolumes" + ], + "summary": "Get the path associated with the subvolumeName", + "description": "Returns the path associated with the subvolumeName provided", + "operationId": "Subvolumes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_Get": { + "$ref": "examples/Subvolumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Subvolumes" + ], + "summary": "Create or clone a new subvolume", + "description": "Creates a subvolume in the path or clones the subvolume mentioned in the parentPath", + "operationId": "Subvolumes_Create", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - updated", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "201": { + "description": "Subvolume created", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Create": { + "$ref": "examples/Subvolumes_Create.json" + } + } + }, + "patch": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Update", + "summary": "Update a subvolume", + "description": "Patch a subvolume", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumePatchRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/subvolumeInfo" + }, + "description": "OK" + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Update": { + "$ref": "examples/Subvolumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Delete", + "summary": "Delete a subvolume", + "description": "Delete subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Delete": { + "$ref": "examples/Subvolumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}/getMetadata": { + "post": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_GetMetadata", + "summary": "Describe a subvolume", + "description": "Get details of the specified subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeModel" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Metadata": { + "$ref": "examples/Subvolumes_Metadata.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestBackupStatus/current": { + "get": { + "tags": [ + "Backups" + ], + "summary": "Get the latest backup status of a volume", + "description": "Get the latest status of the backup for a volume", + "operationId": "Backups_GetLatestStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_BackupStatus": { + "$ref": "examples/Volumes_LatestBackupStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestRestoreStatus/current": { + "get": { + "tags": [ + "Restore" + ], + "summary": "Get the latest restore status of a volume", + "description": "Get the latest status of the restore for a volume", + "operationId": "Backups_GetVolumeLatestRestoreStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/restoreStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_RestoreStatus": { + "$ref": "examples/Volumes_LatestRestoreStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups": { + "get": { + "tags": [ + "Backups" + ], + "summary": "List Backups", + "description": "List all backups Under a Backup Vault", + "operationId": "Backups_ListByVault", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "in": "query", + "name": "$filter", + "type": "string", + "description": "An option to specify the VolumeResourceId. If present, then only returns the backups under the specified volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_List": { + "$ref": "examples/BackupsUnderBackupVault_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}": { + "get": { + "summary": "Describe the Backup under Backup Vault", + "description": "Get the specified Backup under Backup Vault.", + "tags": [ + "Backups" + ], + "operationId": "Backups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Get": { + "$ref": "examples/BackupsUnderBackupVault_Get.json" + } + } + }, + "put": { + "tags": [ + "Backups" + ], + "summary": "Create a backup", + "description": "Create a backup under the Backup Vault", + "operationId": "Backups_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backup" + } + } + ], + "responses": { + "200": { + "description": "OK - backup created updated", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Create": { + "$ref": "examples/BackupsUnderBackupVault_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backups" + ], + "summary": "Patch a backup", + "description": "Patch a Backup under the Backup Vault", + "operationId": "Backups_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "schema": { + "$ref": "#/definitions/backupPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backup" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Update": { + "$ref": "examples/BackupsUnderBackupVault_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backups" + ], + "summary": "Delete backup", + "description": "Delete a Backup under the Backup Vault", + "operationId": "Backups_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Delete": { + "$ref": "examples/BackupsUnderBackupVault_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults": { + "get": { + "summary": "Describe all Backup Vaults", + "description": "List and describe all Backup Vaults in the NetApp account.", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_ListByNetAppAccount", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVaultsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_List": { + "$ref": "examples/BackupVaults_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}": { + "get": { + "summary": "Describe the Backup Vault", + "description": "Get the Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_Get": { + "$ref": "examples/BackupVaults_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Vaults" + ], + "summary": "Create or Update a Backup Vault", + "description": "Create or update the specified Backup Vault in the NetApp account", + "operationId": "BackupVaults_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "BackupVault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVault" + } + } + ], + "responses": { + "200": { + "description": "OK - backupVault updated", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "201": { + "description": "backupVault created", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupVault_CreateOrUpdate": { + "$ref": "examples/BackupVaults_Create.json" + } + } + }, + "patch": { + "summary": "Update NetApp Backup Vault", + "description": "Patch the specified NetApp Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup Vault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVaultPatch" + } + } + ], + "responses": { + "200": { + "description": "OK - Backup Vault updated.", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/backupVault" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Update": { + "$ref": "examples/BackupVaults_Update.json" + } + } + }, + "delete": { + "summary": "Delete NetApp Backup Vault", + "description": "Delete the specified Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Delete": { + "$ref": "examples/BackupVaults_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}/restoreFiles": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderBackupVault_RestoreFiles", + "summary": "Create a new Backup Restore Files request", + "description": "Restore the specified files from the specified backup to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Backups_SingleFileRestore": { + "$ref": "examples/BackupsUnderBackupVault_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderVolume_MigrateBackups", + "summary": "Create a new migrate request for backups under volume", + "description": "Migrate the backups under volume to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under volume payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderVolume_Migrate": { + "$ref": "examples/BackupsUnderVolume_Migrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderAccount_MigrateBackups", + "summary": "Create a new migrate request for backups under account", + "description": "Migrate the backups under a NetApp account to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under an account payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderAccount_Migrate": { + "$ref": "examples/BackupsUnderAccount_Migrate.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Cloud Volume operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of Storage operations supported by the Storage resource provider." + } + } + }, + "Operation": { + "description": "Microsoft.NetApp REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft NetApp.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Operation description.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "logSpecifications": { + "description": "Log specification of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "Unit could be Bytes or Count." + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "Average" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "internalMetricName": { + "type": "string", + "description": "The internal metric name." + }, + "enableRegionalMdmAccount": { + "description": "Whether or not the service is using regional MDM accounts.", + "type": "boolean" + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "The property to decide fill gap with zero or not." + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + }, + "isInternal": { + "description": "Whether the metric is internal.", + "type": "boolean" + } + } + }, + "LogSpecification": { + "description": "Log Definition of a single resource metric.", + "type": "object", + "properties": { + "name": { + "description": "Name of log specification.", + "type": "string" + }, + "displayName": { + "description": "Display name of log specification.", + "type": "string" + } + } + }, + "Dimension": { + "description": "Dimension of blobs, possibly be blob type or access tier.", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + } + } + }, + "CheckAvailabilityResponse": { + "description": "Information regarding availability of a resource.", + "type": "object", + "properties": { + "isAvailable": { + "description": "true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.", + "type": "boolean" + }, + "reason": { + "description": "Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "InAvailabilityReasonType", + "modelAsString": true + } + }, + "message": { + "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.", + "type": "string" + } + } + }, + "regionInfosList": { + "description": "List of regionInfo resources", + "type": "object", + "properties": { + "value": { + "description": "A list of regionInfo resources", + "type": "array", + "items": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "regionInfoResource": { + "description": "Information regarding regionInfo Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "regionInfo properties", + "$ref": "#/definitions/regionInfo", + "x-ms-client-flatten": true + } + } + }, + "regionInfo": { + "description": "Provides region specific information.", + "type": "object", + "properties": { + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information in the region.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2", + "T1AndT2", + "T1AndAcrossT2", + "T2AndAcrossT2", + "T1AndT2AndAcrossT2" + ], + "x-ms-enum": { + "name": "RegionStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 network connectivity." + }, + { + "value": "T1AndT2", + "description": "Standard T1 and T2 network connectivity." + }, + { + "value": "T1AndAcrossT2", + "description": "Standard T1 and AcrossT2 network connectivity." + }, + { + "value": "T2AndAcrossT2", + "description": "Standard T2 and AcrossT2 network connectivity." + }, + { + "value": "T1AndT2AndAcrossT2", + "description": "Standard T1, T2 and AcrossT2 network connectivity." + } + ] + }, + "example": "T2" + }, + "availabilityZoneMappings": { + "title": "Logical availability zone mappings.", + "description": "Provides logical availability zone mappings for the subscription for a region.", + "type": "array", + "x-ms-identifiers": [ + "availabilityZone" + ], + "items": { + "type": "object", + "properties": { + "availabilityZone": { + "description": "Logical availability zone.", + "type": "string", + "example": "1" + }, + "isAvailable": { + "description": "Available availability zone", + "type": "boolean", + "example": true + } + } + } + } + } + }, + "ResourceNameAvailabilityRequest": { + "description": "Resource name availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Resource name to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "FilePathAvailabilityRequest": { + "description": "File path availability request content - availability is based on the name and the subnetId.", + "required": [ + "name", + "subnetId" + ], + "type": "object", + "properties": { + "name": { + "description": "File path to verify.", + "type": "string" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + } + } + }, + "QuotaAvailabilityRequest": { + "description": "Quota availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the resource to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckQuotaNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "SubscriptionQuotaItemList": { + "description": "List of Subscription Quota Items", + "type": "object", + "properties": { + "value": { + "description": "A list of SubscriptionQuotaItems", + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + } + } + }, + "SubscriptionQuotaItem": { + "description": "Information regarding Subscription Quota Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "SubscriptionQuotaItem properties", + "$ref": "#/definitions/SubscriptionQuotaItemProperties", + "x-ms-client-flatten": true + } + } + }, + "SubscriptionQuotaItemProperties": { + "description": "SubscriptionQuotaItem Properties", + "type": "object", + "properties": { + "current": { + "description": "The current quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "default": { + "description": "The default quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "netAppAccountList": { + "description": "List of NetApp account resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Multiple NetApp accounts", + "items": { + "$ref": "#/definitions/netAppAccount" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "netAppAccount": { + "description": "NetApp account resource", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "netAppAccountPatch": { + "description": "NetApp account patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "accountProperties": { + "description": "NetApp account properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "activeDirectories": { + "description": "Active Directories", + "type": "array", + "items": { + "$ref": "#/definitions/activeDirectory" + }, + "x-ms-identifiers": [ + "activeDirectoryId" + ] + }, + "encryption": { + "description": "Encryption settings", + "$ref": "#/definitions/accountEncryption" + }, + "disableShowmount": { + "type": "boolean", + "readOnly": true, + "x-nullable": true, + "description": "Shows the status of disableShowmount for all volumes under the subscription, null equals false" + } + } + }, + "activeDirectory": { + "description": "Active Directory", + "type": "object", + "properties": { + "activeDirectoryId": { + "type": "string", + "x-nullable": true, + "description": "Id of the Active Directory" + }, + "username": { + "type": "string", + "description": "A domain user account with permission to create machine accounts" + }, + "password": { + "type": "string", + "x-ms-secret": true, + "maxLength": 64, + "description": "Plain text password of Active Directory domain administrator, value is masked in the response" + }, + "domain": { + "type": "string", + "description": "Name of the Active Directory domain" + }, + "dns": { + "type": "string", + "description": "Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$", + "example": "101.102.103.104,101.102.103.105" + }, + "status": { + "type": "string", + "description": "Status of the Active Directory", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "ActiveDirectoryStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "Active Directory created but not in use" + }, + { + "value": "InUse", + "description": "Active Directory in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "Active Directory Deleted" + }, + { + "value": "Error", + "description": "Error with the Active Directory" + }, + { + "value": "Updating", + "description": "Active Directory Updating" + } + ] + } + }, + "statusDetails": { + "type": "string", + "description": "Any details in regards to the Status of the Active Directory", + "readOnly": true + }, + "smbServerName": { + "type": "string", + "description": "NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes" + }, + "organizationalUnit": { + "type": "string", + "default": "CN=Computers", + "description": "The Organizational Unit (OU) within the Windows Active Directory" + }, + "site": { + "type": "string", + "description": "The Active Directory site the service will limit Domain Controller discovery to" + }, + "backupOperators": { + "description": "Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "administrators": { + "description": "Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "kdcIP": { + "type": "string", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$", + "description": "kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume.", + "example": "101.102.103.104" + }, + "adName": { + "type": "string", + "maxLength": 64, + "minLength": 1, + "description": "Name of the active directory machine. This optional parameter is used only while creating kerberos volume", + "example": "ADServerName" + }, + "serverRootCACertificate": { + "type": "string", + "maxLength": 10240, + "minLength": 1, + "description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.", + "x-ms-secret": true, + "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURuVENDQW9XZ0F3SUJBZ0lRR3FXdnRxeHBvSTFJV3Z4VGdJbElWREFOQmdrcWhraUc5dzBCQVFzRkFEQlYKTVJNd0VRWUtDWkltaVpQeUxHUUJHUllEWTI5dE1SY3dGUVlLQ1pJbWlaUHlMR1FCR1JZSGFHRnlhV3R5WWpFbApNQ01HQTFVRUF4TWNhR0Z5YVd0eVlpMVhTVTR0TWtKUFZrRkZTMEkwTkVJdFEwRXRNakFlRncweU1EQTFNRFV3Ck56TTVORGxhRncweU1EQTFNRFl3TnpRNU5EaGFNRlV4RXpBUkJnb0praWFKay9Jc1pBRVpGZ05qYjIweEZ6QVYKQmdvSmtpYUprL0lzWkFFWkZnZG9ZWEpwYTNKaU1TVXdJd1lEVlFRREV4eG9ZWEpwYTNKaUxWZEpUaTB5UWs5VwpRVVZMUWpRMFFpMURRUzB5TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFqMHByCnhaaXpNaDBqYnRwN1ZOc0JrRVJ2MVpZT0MzMEtqaGRWdEExRm1MeFM2cXlycmpMZUdXOXRSd2ZnUkR0eVBodTIKZVJTcVpTUjF6Z1hZR0s0Nys3Y3F0YnB2UElOektCb0dOWERIVTNxVWlleXJWSjFDVzRKNjJodUdrbUV1VVVkMApKMXBxNTVxbjk1SmRUbWh1dmZlTUxxeHB5c01nbGVnY281ZFhoN0hsQkhwaTNKMFN4ZnhVWmxKMVZiOFJZVEZhCkJiMGFlTVZaRzRKeVREaktiMlR1TmFXOG1aUE5vOFBMRDRocjdndFNZUEQvQ1dVVGV5QlpoZC9LTzNPczlWVEIKYmpLUGtWd0J2WEs2SlFMSGprNFBHS3VYZDhaWVFyajBtOWNIZDNmcWNYTXlQUnQ2TlJ4ak0yMTUxckFzSkVhNgpWZC9ta056akpXalBrT2VZUVFJREFRQUJvMmt3WnpBVEJna3JCZ0VFQVlJM0ZBSUVCaDRFQUVNQVFUQU9CZ05WCkhROEJBZjhFQkFNQ0FZWXdEd1lEVlIwVEFRSC9CQVV3QXdFQi96QWRCZ05WSFE0RUZnUVVDVEc2ODJSay9kMysKWGtHa0VMakRFMjI4ZjNnd0VBWUpLd1lCQkFHQ054VUJCQU1DQVFBd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQgpBR1RjTTNnWExIU05wS014RHEvUFpZbWZCMmNlN3VhMmxxbXpzZSt4QmthSTE0WXdzZE5ZQjZBVTNFWDM3QWpZCjd3bm9xQzY1N0U2RVhTODVDckoyNXJNTHo4OEtONGI3cUg5RUowSS9XVHg5YTdUT0ZENENWQThuL0xwNGh1Ym4KNlBFalY5NFlZWXBXTG1hTkkvbGFReWsxSHVJbDFSTCttVDFnSWQ4ZWZXZ1UvNmlVVEw3eGMrdjkyNHBuTHhISwpOSnNTV3c0NFk5a0R5SU9KOXFjWUlBN1lhTkxPZTRjSysvQlRvdDh0dVVKT1hHLzdBRmtxR2EyQVA4MmFZOStKCnkwSmU2OG5nTHJ1dVU4VHpneVpqdkFHcTRrVEVOdWFoaFdHVC9KWkEzOXhSNUV4MmNMUUplcE5NdnlZbUZ3Z1UKME8zYlA0OWNBVFVCMXoyQ3Y5aTRQbVk9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" + }, + "aesEncryption": { + "type": "boolean", + "description": "If enabled, AES encryption will be enabled for SMB communication." + }, + "ldapSigning": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be signed." + }, + "securityOperators": { + "type": "array", + "description": "Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "ldapOverTLS": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be secured via TLS." + }, + "allowLocalNfsUsersWithLdap": { + "type": "boolean", + "description": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes." + }, + "encryptDCConnections": { + "type": "boolean", + "description": "If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted." + }, + "ldapSearchScope": { + "description": "LDAP Search scope options", + "$ref": "#/definitions/ldapSearchScopeOpt" + }, + "preferredServersForLdapClient": { + "type": "string", + "maxLength": 32, + "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))?)?$", + "description": "Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed.", + "example": "101.102.103.104, 101.102.103.105" + } + } + }, + "ldapSearchScopeOpt": { + "type": "object", + "description": "LDAP search scope ", + "properties": { + "userDN": { + "type": "string", + "description": "This specifies the user DN, which overrides the base DN for user lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupDN": { + "type": "string", + "description": "This specifies the group DN, which overrides the base DN for group lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupMembershipFilter": { + "type": "string", + "description": "This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server.", + "maxLength": 255, + "example": "cn=*99" + } + } + }, + "accountEncryption": { + "type": "object", + "description": "Encryption settings", + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'." + }, + "identity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'." + } + } + }, + "KeyVaultProperties": { + "description": "Properties of key vault.", + "type": "object", + "required": [ + "keyVaultUri", + "keyName", + "keyVaultResourceId" + ], + "properties": { + "keyVaultId": { + "type": "string", + "description": "UUID v4 used to identify the Azure Key Vault configuration", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "keyVaultUri": { + "type": "string", + "description": "The Uri of KeyVault." + }, + "keyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyVaultResourceId": { + "type": "string", + "description": "The resource ID of KeyVault." + }, + "status": { + "type": "string", + "description": "Status of the KeyVault connection.", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "KeyVaultStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "KeyVault connection created but not in use" + }, + { + "value": "InUse", + "description": "KeyVault connection in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "KeyVault connection Deleted" + }, + { + "value": "Error", + "description": "Error with the KeyVault connection" + }, + { + "value": "Updating", + "description": "KeyVault connection Updating" + } + ] + } + } + } + }, + "EncryptionIdentity": { + "description": "Identity used to authenticate with key vault.", + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "The principal ID (object ID) of the identity used to authenticate with key vault. Read-only.", + "readOnly": true + }, + "userAssignedIdentity": { + "type": "string", + "description": "The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities." + } + } + }, + "capacityPoolList": { + "description": "List of capacity pool resources", + "type": "object", + "properties": { + "value": { + "description": "List of Capacity pools", + "type": "array", + "items": { + "$ref": "#/definitions/capacityPool" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "capacityPool": { + "description": "Capacity pool resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolProperties", + "x-ms-client-flatten": true + } + } + }, + "poolProperties": { + "description": "Pool properties", + "type": "object", + "required": [ + "size", + "serviceLevel" + ], + "properties": { + "poolId": { + "title": "poolId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Pool", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 1099511627776).", + "default": 4398046511104 + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "totalThroughputMibps": { + "type": "number", + "description": "Total throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "utilizedThroughputMibps": { + "type": "number", + "description": "Utilized throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "default": false, + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + }, + "encryptionType": { + "title": "encryptionType", + "type": "string", + "x-nullable": true, + "description": "Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "Single", + "Double" + ], + "x-ms-enum": { + "name": "encryptionType", + "modelAsString": true, + "values": [ + { + "value": "Single", + "description": "EncryptionType Single, volumes will use single encryption at rest" + }, + { + "value": "Double", + "description": "EncryptionType Double, volumes will use double encryption at rest" + } + ] + }, + "example": "Single", + "default": "Single" + } + } + }, + "capacityPoolPatch": { + "description": "Capacity pool patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "poolPatchProperties": { + "description": "Patchable pool properties", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 1099511627776).", + "default": 4398046511104 + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + } + } + }, + "volumeList": { + "description": "List of volume resources", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "volume": { + "description": "Volume resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "resourceIdentity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "principalId": { + "description": "Object id of the identity resource", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant id of the resource", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of Identity. Supported values are: 'None', 'SystemAssigned'", + "type": "string" + } + } + }, + "resourceTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags are a list of key-value pairs that describe the resource" + }, + "volumeProperties": { + "description": "Volume properties", + "type": "object", + "required": [ + "creationToken", + "usageThreshold", + "subnetId" + ], + "properties": { + "fileSystemId": { + "title": "FileSystem ID", + "type": "string", + "readOnly": true, + "description": "Unique FileSystem Identifier.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "creationToken": { + "title": "Creation Token or File Path", + "type": "string", + "description": "A unique file path for the volume. Used when creating mount targets", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-]{0,79}$", + "minLength": 1, + "maxLength": 80, + "example": "some-amazing-filepath" + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes.", + "minimum": 107374182400, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "snapshotId": { + "title": "Snapshot ID", + "type": "string", + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Snapshot.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1" + }, + "deleteBaseSnapshot": { + "type": "boolean", + "description": "If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false" + }, + "backupId": { + "title": "Backup ID", + "type": "string", + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Backup.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1" + }, + "baremetalTenantId": { + "title": "Baremetal Tenant ID", + "type": "string", + "readOnly": true, + "description": "Unique Baremetal Tenant Identifier.", + "example": "9560acf5-4e3a-12e7-9bdb-02007cca7779" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures" + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for the the group of volumes sharing networking resources.", + "type": "string", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information for the volume.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2" + ], + "readOnly": true, + "x-ms-enum": { + "name": "VolumeStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic storage to network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 storage to network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 storage to network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 storage to network connectivity." + } + ] + }, + "example": "T1" + }, + "mountTargets": { + "title": "mountTargets", + "type": "array", + "readOnly": true, + "description": "List of mount targets", + "items": { + "$ref": "#/definitions/mountTargetProperties" + }, + "x-ms-identifiers": [ + "fileSystemId" + ] + }, + "volumeType": { + "type": "string", + "description": "What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection", + "example": "DataProtection" + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "replication": { + "title": "Replication", + "description": "Replication properties", + "type": "object", + "$ref": "#/definitions/replicationObject" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + }, + "volumeRelocation": { + "title": "VolumeRelocation", + "description": "VolumeRelocation properties", + "type": "object", + "$ref": "#/definitions/volumeRelocationProperties" + } + } + }, + "isRestoring": { + "type": "boolean", + "description": "Restoring" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "default": true, + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true)." + }, + "kerberosEnabled": { + "type": "boolean", + "description": "Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later", + "x-ms-mutability": [ + "read", + "create" + ], + "example": false, + "default": false + }, + "securityStyle": { + "type": "string", + "description": "The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol", + "default": "unix", + "enum": [ + "ntfs", + "unix" + ], + "x-ms-enum": { + "name": "SecurityStyle", + "modelAsString": true + } + }, + "smbEncryption": { + "type": "boolean", + "description": "Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later", + "example": false, + "default": false + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + }, + "smbContinuouslyAvailable": { + "type": "boolean", + "description": "Enables continuously available share property for smb volume. Only applicable for SMB volume", + "example": false, + "default": false + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "x-nullable": true, + "example": 128.223 + }, + "actualThroughputMibps": { + "type": "number", + "description": "Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel", + "example": 164.221, + "readOnly": true + }, + "encryptionKeySource": { + "description": "Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'", + "type": "string", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "EncryptionKeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultPrivateEndpointResourceId": { + "type": "string", + "description": "The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'." + }, + "ldapEnabled": { + "type": "boolean", + "description": "Specifies whether LDAP is enabled or not for a given NFS volume.", + "example": false, + "default": false + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false, + "default": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 7, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "cloneProgress": { + "description": "When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning.", + "type": "integer", + "format": "int32", + "example": 10, + "x-nullable": true, + "readOnly": true + }, + "fileAccessLogs": { + "type": "string", + "description": "Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "fileAccessLogs", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "fileAccessLogs are enabled" + }, + { + "value": "Disabled", + "description": "fileAccessLogs are not enabled" + } + ] + }, + "example": "Disabled", + "default": "Disabled" + }, + "avsDataStore": { + "title": "avsDataStore", + "type": "string", + "description": "Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "avsDataStore", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "avsDataStore is enabled" + }, + { + "value": "Disabled", + "description": "avsDataStore is disabled" + } + ] + }, + "example": "Enabled", + "default": "Disabled" + }, + "dataStoreResourceId": { + "title": "dataStoreResourceId", + "description": "Data store resource unique identifier", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "maximumNumberOfFiles": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB.", + "example": 100000000 + }, + "volumeGroupName": { + "type": "string", + "description": "Volume Group Name", + "readOnly": true + }, + "capacityPoolResourceId": { + "type": "string", + "description": "Pool Resource Id used in case of creating a volume through volume group" + }, + "proximityPlacementGroup": { + "type": "string", + "description": "Proximity placement group associated with the volume", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.Compute/proximityPlacementGroups/testppg" + }, + "t2Network": { + "type": "string", + "description": "T2 network information", + "example": "Test-T2-Alias", + "readOnly": true + }, + "volumeSpecName": { + "type": "string", + "description": "Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log", + "example": "Data" + }, + "encrypted": { + "type": "boolean", + "description": "Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.", + "readOnly": true + }, + "placementRules": { + "title": "Volume placement rules", + "description": "Application specific placement rules for the particular volume", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "enableSubvolumes": { + "type": "string", + "description": "Flag indicating whether subvolume operations are enabled on the volume", + "example": "Enabled", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "enableSubvolumes", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "subvolumes are enabled" + }, + { + "value": "Disabled", + "description": "subvolumes are not enabled" + } + ] + } + }, + "provisionedAvailabilityZone": { + "title": "Provisioned Availability Zone", + "type": "string", + "readOnly": true, + "description": "The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.", + "example": "2", + "x-nullable": true + }, + "isLargeVolume": { + "title": "Is Large Volume", + "type": "boolean", + "description": "Specifies whether volume is a Large Volume or Regular Volume.", + "example": false, + "default": false + }, + "originatingResourceId": { + "title": "Originating Resource Id", + "type": "string", + "description": "Id of the snapshot or backup that the volume is restored from.", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.NetApp/netAppAccounts/accountOriginatingResourceId/capacityPools/originatingResourceIdPool/volumes/theOriginalVolume/snapshots/theSnapshot", + "readOnly": true, + "x-nullable": true + } + } + }, + "exportPolicyRule": { + "description": "Volume Export Policy Rule", + "type": "object", + "properties": { + "ruleIndex": { + "type": "integer", + "description": "Order index", + "format": "int32" + }, + "unixReadOnly": { + "type": "boolean", + "description": "Read only access" + }, + "unixReadWrite": { + "type": "boolean", + "description": "Read and write access" + }, + "kerberos5ReadOnly": { + "type": "boolean", + "description": "Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5ReadWrite": { + "type": "boolean", + "description": "Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadOnly": { + "type": "boolean", + "description": "Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadWrite": { + "type": "boolean", + "description": "Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadOnly": { + "type": "boolean", + "description": "Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadWrite": { + "type": "boolean", + "description": "Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "cifs": { + "type": "boolean", + "description": "Allows CIFS protocol" + }, + "nfsv3": { + "type": "boolean", + "description": "Allows NFSv3 protocol. Enable only for NFSv3 type volumes" + }, + "nfsv41": { + "type": "boolean", + "description": "Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes" + }, + "allowedClients": { + "type": "string", + "description": "Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names" + }, + "hasRootAccess": { + "type": "boolean", + "description": "Has root access to volume", + "example": true, + "default": true + }, + "chownMode": { + "type": "string", + "description": "This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.", + "default": "Restricted", + "enum": [ + "Restricted", + "Unrestricted" + ], + "x-ms-enum": { + "name": "ChownMode", + "modelAsString": true + } + } + } + }, + "replicationObject": { + "description": "Replication properties", + "type": "object", + "required": [ + "remoteVolumeResourceId" + ], + "properties": { + "replicationId": { + "type": "string", + "description": "Id", + "readOnly": true + }, + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume." + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "replication": { + "description": "Replication properties", + "type": "object", + "required": [ + "remoteVolumeResourceId" + ], + "properties": { + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume." + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "volumeRelocationProperties": { + "description": "Volume relocation properties", + "type": "object", + "properties": { + "relocationRequested": { + "type": "boolean", + "description": "Has relocation been requested for this volume" + }, + "readyToBeFinalized": { + "type": "boolean", + "readOnly": true, + "description": "Has relocation finished and is ready to be cleaned up" + } + } + }, + "volumeSnapshotProperties": { + "description": "Volume Snapshot Properties", + "type": "object", + "properties": { + "snapshotPolicyId": { + "type": "string", + "description": "Snapshot Policy ResourceId" + } + } + }, + "replicationStatus": { + "description": "Replication status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "description": "Replication health check" + }, + "relationshipStatus": { + "type": "string", + "description": "Status of the mirror relationship", + "enum": [ + "Idle", + "Transferring" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "description": "The status of the replication", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "totalProgress": { + "type": "string", + "description": "The progress of the replication" + }, + "errorMessage": { + "type": "string", + "description": "Displays error message if the replication is in an error state" + } + } + }, + "listReplications": { + "description": "List Replications", + "type": "object", + "properties": { + "value": { + "description": "A list of replications", + "type": "array", + "items": { + "$ref": "#/definitions/replication" + }, + "x-ms-identifiers": [] + } + } + }, + "volumePatch": { + "description": "Volume patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Patchable volume properties", + "$ref": "#/definitions/volumePatchProperties", + "x-ms-client-flatten": true + } + } + }, + "volumePatchProperties": { + "description": "Patchable volume properties", + "type": "object", + "properties": { + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes.", + "minimum": 107374182400, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "example": 128.22 + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + } + } + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 2, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots." + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + } + } + }, + "mountTarget": { + "description": "Mount Target", + "type": "object", + "required": [ + "location", + "properties" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Mount Target Properties", + "$ref": "#/definitions/mountTargetProperties", + "x-ms-client-flatten": true + } + } + }, + "mountTargetProperties": { + "description": "Mount target properties", + "type": "object", + "required": [ + "fileSystemId" + ], + "properties": { + "mountTargetId": { + "title": "mountTargetId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "fileSystemId": { + "title": "fileSystemId", + "type": "string", + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "ipAddress": { + "title": "ipAddress", + "description": "The mount target's IPv4 address", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "smbServerFqdn": { + "title": "smbServerFQDN", + "description": "The SMB server's Fully Qualified Domain Name, FQDN", + "type": "string", + "example": "fullyqualified.domainname.com" + } + } + }, + "snapshotsList": { + "description": "List of Snapshots", + "type": "object", + "properties": { + "value": { + "description": "A list of Snapshots", + "type": "array", + "items": { + "$ref": "#/definitions/snapshot" + } + } + } + }, + "snapshot": { + "description": "Snapshot of a Volume", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "description": "Snapshot Properties", + "$ref": "#/definitions/snapshotProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPatch": { + "description": "Snapshot patch", + "type": "object", + "properties": {} + }, + "snapshotProperties": { + "description": "Snapshot properties", + "type": "object", + "properties": { + "snapshotId": { + "title": "snapshotId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Snapshot", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "created": { + "title": "name", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the snapshot", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicyProperties": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "hourlySchedule": { + "title": "hourlySchedule", + "description": "Schedule for hourly snapshots", + "type": "object", + "$ref": "#/definitions/hourlySchedule" + }, + "dailySchedule": { + "title": "dailySchedule", + "description": "Schedule for daily snapshots", + "type": "object", + "$ref": "#/definitions/dailySchedule" + }, + "weeklySchedule": { + "title": "weeklySchedule", + "description": "Schedule for weekly snapshots", + "type": "object", + "$ref": "#/definitions/weeklySchedule" + }, + "monthlySchedule": { + "title": "monthlySchedule", + "description": "Schedule for monthly snapshots", + "type": "object", + "$ref": "#/definitions/monthlySchedule" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicy": { + "description": "Snapshot policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPoliciesList": { + "description": "List of Snapshot Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of snapshot policies", + "type": "array", + "items": { + "$ref": "#/definitions/snapshotPolicy" + } + } + } + }, + "snapshotPolicyDetails": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyPatch": { + "description": "Snapshot policy Details for create and update", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot Policy properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyVolumeList": { + "description": "Volumes associated with snapshot policy", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + } + } + }, + "hourlySchedule": { + "description": "Hourly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Hourly snapshot count to keep", + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "dailySchedule": { + "description": "Daily Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Daily snapshot count to keep", + "format": "int32" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "weeklySchedule": { + "description": "Weekly Schedule properties, make a snapshot every week at a specific day or days", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Weekly snapshot count to keep", + "format": "int32" + }, + "day": { + "type": "string", + "description": "Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english", + "example": "Sunday,Monday" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "monthlySchedule": { + "description": "Monthly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Monthly snapshot count to keep", + "format": "int32" + }, + "daysOfMonth": { + "type": "string", + "description": "Indicates which days of the month snapshot should be taken. A comma delimited string.", + "example": "1,11,21" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "volumeRevert": { + "description": "revert a volume to the snapshot", + "type": "object", + "properties": { + "snapshotId": { + "type": "string", + "description": "Resource id of the snapshot" + } + } + }, + "authorizeRequest": { + "description": "Authorize request", + "type": "object", + "properties": { + "remoteVolumeResourceId": { + "type": "string", + "description": "Resource id of the remote volume" + } + } + }, + "breakReplicationRequest": { + "description": "Break replication request", + "type": "object", + "properties": { + "forceBreakReplication": { + "type": "boolean", + "description": "If replication is in status transferring and you want to force break the replication, set to true" + } + } + }, + "reestablishReplicationRequest": { + "description": "Re-establish request object supplied in the body of the operation.", + "type": "object", + "properties": { + "sourceVolumeId": { + "type": "string", + "description": "Resource id of the source volume for the replication" + } + } + }, + "relocateVolumeRequest": { + "description": "Relocate volume request", + "type": "object", + "properties": { + "creationToken": { + "type": "string", + "description": "New creation token for the volume that controls the mount point name" + } + } + }, + "breakFileLocksRequest": { + "description": "Break file locks request", + "type": "object", + "properties": { + "clientIp": { + "type": "string", + "description": "To clear file locks on a volume for a particular client", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "example": "101.102.103.104" + }, + "confirmRunningDisruptiveOperation": { + "type": "boolean", + "description": "Break File locks could be a disruptive operation for application as locks on the volume will be broken, if want to process, set to true.", + "default": false + } + } + }, + "poolChangeRequest": { + "description": "Pool change request", + "type": "object", + "required": [ + "newPoolResourceId" + ], + "properties": { + "newPoolResourceId": { + "type": "string", + "description": "Resource id of the pool to move volume to" + } + } + }, + "backupPolicyProperties": { + "description": "Backup policy properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "readOnly": true, + "description": "Backup Policy Resource ID" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "dailyBackupsToKeep": { + "type": "integer", + "description": "Daily backups count to keep", + "format": "int32" + }, + "weeklyBackupsToKeep": { + "type": "integer", + "description": "Weekly backups count to keep", + "format": "int32" + }, + "monthlyBackupsToKeep": { + "type": "integer", + "description": "Monthly backups count to keep", + "format": "int32" + }, + "volumesAssigned": { + "type": "integer", + "readOnly": true, + "description": "Volumes using current backup policy", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "volumeBackups": { + "description": "A list of volumes assigned to this policy", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/volumeBackups" + }, + "x-ms-identifiers": [ + "volumeName" + ] + } + } + }, + "backupPolicy": { + "description": "Backup policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPoliciesList": { + "description": "List of Backup Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of backup policies", + "type": "array", + "items": { + "$ref": "#/definitions/backupPolicy" + } + } + } + }, + "backupPolicyPatch": { + "description": "Backup policy Details for create and update", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeBackups": { + "description": "Volume details using the backup policy", + "type": "object", + "readOnly": true, + "properties": { + "volumeName": { + "type": "string", + "description": "Volume name" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "backupsCount": { + "type": "integer", + "description": "Total count of backups for volume", + "format": "int32" + }, + "policyEnabled": { + "type": "boolean", + "description": "Policy enabled" + } + } + }, + "restoreStatus": { + "description": "Restore status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Restore health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the restore SnapMirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the restore", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy restore relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the restore is in an error state" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + } + } + }, + "getGroupIdListForLDAPUserRequest": { + "description": "Get group Id list for LDAP User request", + "type": "object", + "required": [ + "username" + ], + "properties": { + "username": { + "type": "string", + "description": "username is required to fetch the group to which user is part of", + "maxLength": 255, + "minLength": 1 + } + } + }, + "getGroupIdListForLDAPUserResponse": { + "description": "Group Id list for Ldap user", + "type": "object", + "properties": { + "groupIdsForLdapUser": { + "description": "Group Id list", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "123", + "224" + ] + } + } + }, + "cloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/cloudErrorBody", + "description": "Cloud error body." + } + }, + "description": "An error response from the service." + }, + "cloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "description": "An error response from the service." + }, + "serviceLevel": { + "title": "serviceLevel", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra", + "StandardZRS" + ], + "default": "Premium", + "x-ms-enum": { + "name": "ServiceLevel", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard service level" + }, + { + "value": "Premium", + "description": "Premium service level" + }, + { + "value": "Ultra", + "description": "Ultra service level" + }, + { + "value": "StandardZRS", + "description": "Zone redundant storage service level" + } + ] + } + }, + "volumeQuotaRulesList": { + "description": "List of Volume Quota Rules", + "type": "object", + "properties": { + "value": { + "description": "A list of Volume Quota Rules", + "type": "array", + "items": { + "$ref": "#/definitions/volumeQuotaRule" + } + } + } + }, + "volumeQuotaRule": { + "description": "Quota Rule of a Volume", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulePatch": { + "description": "Patchable Quota Rule of a Volume", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulesProperties": { + "description": "Volume Quota Rule properties", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/netappProvisioningState" + }, + "quotaSizeInKiBs": { + "type": "integer", + "description": "Size of quota", + "format": "int64", + "example": "100006" + }, + "quotaType": { + "title": "quotaType", + "type": "string", + "description": "Type of quota", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "DefaultUserQuota", + "DefaultGroupQuota", + "IndividualUserQuota", + "IndividualGroupQuota" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "DefaultUserQuota", + "description": "Default user quota" + }, + { + "value": "DefaultGroupQuota", + "description": "Default group quota" + }, + { + "value": "IndividualUserQuota", + "description": "Individual user quota" + }, + { + "value": "IndividualGroupQuota", + "description": "Individual group quota" + } + ] + }, + "example": "DefaultUserQuota" + }, + "quotaTarget": { + "type": "string", + "description": "UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running ", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "volumeGroupList": { + "description": "List of volume group resources", + "type": "object", + "properties": { + "value": { + "description": "List of volume Groups", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroup" + } + } + } + }, + "volumeGroup": { + "description": "Volume group resource", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupListProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupDetails": { + "description": "Volume group resource for create", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupMetaData": { + "description": "Volume group properties", + "type": "object", + "properties": { + "groupDescription": { + "type": "string", + "description": "Group Description", + "example": "group description" + }, + "applicationType": { + "type": "string", + "description": "Application Type", + "enum": [ + "SAP-HANA", + "ORACLE" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "example": "SAP-HANA" + }, + "applicationIdentifier": { + "type": "string", + "description": "Application specific identifier", + "example": "SH1" + }, + "globalPlacementRules": { + "title": "Global volume placement rules", + "description": "Application specific placement rules for the volume group", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "volumesCount": { + "type": "integer", + "format": "int64", + "description": "Number of volumes in volume group", + "example": 5, + "readOnly": true + } + } + }, + "volumeGroupProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + }, + "volumes": { + "description": "List of volumes from group", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroupVolumeProperties" + } + } + } + }, + "volumeGroupListProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + } + } + }, + "volumeGroupVolumeProperties": { + "description": "Volume resource", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "properties" + ], + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "placementKeyValuePairs": { + "description": "Application specific parameters for the placement of volumes in the volume group", + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Key for an application specific parameter for the placement of volumes in the volume group", + "example": "key1" + }, + "value": { + "type": "string", + "description": "Value for an application specific parameter for the placement of volumes in the volume group", + "example": "value1" + } + } + }, + "networkSiblingSet": { + "title": "Network sibling set", + "description": "Describes the contents of a network sibling set.", + "type": "object", + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures" + }, + "provisioningState": { + "$ref": "#/definitions/networkSiblingSetProvisioningState" + }, + "nicInfoList": { + "type": "array", + "x-ms-identifiers": [], + "description": "List of NIC information", + "items": { + "$ref": "#/definitions/nicInfo" + } + } + } + }, + "QueryNetworkSiblingSetRequest": { + "title": "QueryNetworkSiblingSetRequest", + "description": "Network sibling set query.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + } + } + }, + "UpdateNetworkSiblingSetRequest": { + "title": "UpdateNetworkSiblingSetRequest", + "description": "Network sibling set update.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId", + "networkSiblingSetStateId", + "networkFeatures" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures", + "description": "Network features available to the volume." + } + } + }, + "networkFeatures": { + "title": "Network features", + "description": "Network features available to the volume, or current state of update.", + "type": "string", + "enum": [ + "Basic", + "Standard", + "Basic_Standard", + "Standard_Basic" + ], + "x-ms-enum": { + "name": "NetworkFeatures", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Basic network features." + }, + { + "value": "Standard", + "description": "Standard network features." + }, + { + "value": "Basic_Standard", + "description": "Updating from Basic to Standard network features." + }, + { + "value": "Standard_Basic", + "description": "Updating from Standard to Basic network features." + } + ] + }, + "example": "Standard", + "default": "Basic" + }, + "networkSiblingSetProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the NetworkSiblingSet at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating" + ], + "x-ms-enum": { + "name": "NetworkSiblingSetProvisioningState", + "modelAsString": true + } + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for a group of volumes sharing networking resources in a subnet.", + "type": "string", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "networkSiblingSetStateId": { + "title": "Network sibling set state Id", + "description": "Network sibling set state Id identifying the current state of the sibling set.", + "type": "string", + "example": "12345_44420.8001578125" + }, + "nicInfo": { + "title": "NIC information", + "description": "NIC information and list of volumes for which the NIC has the primary mount ip address.", + "type": "object", + "properties": { + "ipAddress": { + "$ref": "#/definitions/ipAddress" + }, + "volumeResourceIds": { + "$ref": "#/definitions/volumeResourceIds" + } + } + }, + "ipAddress": { + "title": "ipAddress", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "volumeResourceIds": { + "title": "Volume resource Ids", + "type": "array", + "items": { + "title": "Resource Id of volume", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + } + }, + "subnetId": { + "title": "Subnet resource Id", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "snapshotRestoreFiles": { + "description": "Restore payload for Single File Snapshot Restore", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "filePaths" + ], + "properties": { + "filePaths": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 10, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "destinationPath": { + "description": "Destination folder where the files will be restored", + "type": "string", + "example": "/AVSdataStore" + } + } + }, + "subvolumesList": { + "description": "List of Subvolumes", + "type": "object", + "properties": { + "value": { + "description": "A list of Subvolumes", + "type": "array", + "items": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "subvolumeInfo": { + "description": "Subvolume Information properties", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumeProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchRequest": { + "description": "Subvolume Patch Request properties", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumePatchParams", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchParams": { + "description": "Parameters with which a subvolume can be updated", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "path": { + "title": "path", + "type": "string", + "description": "path to the subvolume", + "example": "/pathToSubvolume" + } + } + }, + "subvolumeProperties": { + "description": "This represents path associated with the subvolume", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "parentPath": { + "title": "name", + "x-nullable": true, + "type": "string", + "description": "parent path to the subvolume", + "example": "/parentPath" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "readOnly": true, + "example": "Available" + } + } + }, + "subvolumeModel": { + "description": "Result of the post subvolume and action is to get metadata of the subvolume.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "It represents the minimal properties of the subvolume.", + "$ref": "#/definitions/subvolumeModelProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumeModelProperties": { + "description": "Properties which represents actual subvolume model which is stored as a file in the system.", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "parentPath": { + "title": "parentpath", + "type": "string", + "description": "Path to the parent subvolume", + "example": "/parentPath" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Size of subvolume", + "example": 5 + }, + "bytesUsed": { + "title": "bytesUsed", + "type": "integer", + "format": "int64", + "description": "Bytes used", + "example": 5 + }, + "permissions": { + "title": "permissions", + "type": "string", + "description": "Permissions of the subvolume", + "example": "777" + }, + "creationTimeStamp": { + "title": "creationTimeStamp", + "type": "string", + "format": "date-time", + "description": "Creation time and date", + "example": "2017-08-15T13:23:33Z" + }, + "accessedTimeStamp": { + "title": "accessedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent access time and date", + "example": "2017-08-15T13:23:33Z" + }, + "modifiedTimeStamp": { + "title": "modifiedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent modification time and date", + "example": "2017-08-15T13:23:33Z" + }, + "changedTimeStamp": { + "title": "changedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent change time and date", + "example": "2017-08-15T13:23:33Z" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available" + } + } + }, + "netappProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the VolumeQuotaRule at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Patching", + "Deleting", + "Moving", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "coolAccessRetrievalPolicy": { + "type": "string", + "description": "coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage.", + "enum": [ + "Default", + "OnRead", + "Never" + ], + "x-ms-enum": { + "name": "coolAccessRetrievalPolicy", + "modelAsString": true + } + }, + "smbAccessBasedEnumeration": { + "title": "smbAccessBasedEnumeration", + "type": "string", + "description": "Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbAccessBasedEnumeration", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbAccessBasedEnumeration share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbAccessBasedEnumeration share setting is enabled" + } + ] + }, + "x-nullable": true, + "example": "Enabled" + }, + "smbNonBrowsable": { + "title": "smbNonBrowsable", + "type": "string", + "description": "Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbNonBrowsable", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbNonBrowsable share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbNonBrowsable share setting is enabled" + } + ] + }, + "example": "Enabled" + }, + "backupRestoreFiles": { + "description": "Restore payload for Single File Backup Restore", + "type": "object", + "required": [ + "fileList", + "destinationVolumeId" + ], + "properties": { + "fileList": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 8, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "restoreFilePath": { + "description": "Destination folder where the files will be restored. The path name should start with a forward slash. If it is omitted from request then restore is done at the root folder of the destination volume by default", + "type": "string", + "pattern": "^\\/.*$", + "example": "/AVSdataStore" + }, + "destinationVolumeId": { + "description": "Resource Id of the destination volume on which the files need to be restored", + "type": "string", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1" + } + } + }, + "volumeBackupProperties": { + "description": "Volume Backup Properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "description": "Backup Policy Resource ID" + }, + "policyEnforced": { + "type": "boolean", + "description": "Policy Enforced" + }, + "backupVaultId": { + "type": "string", + "description": "Backup Vault Resource ID" + } + } + }, + "backupsList": { + "description": "List of Backups", + "type": "object", + "properties": { + "value": { + "description": "A list of Backups", + "type": "array", + "items": { + "$ref": "#/definitions/backup" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backup": { + "description": "Backup under a Backup Vault", + "type": "object", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Backup Properties", + "$ref": "#/definitions/backupProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPatch": { + "description": "Backup patch", + "type": "object", + "properties": { + "properties": { + "description": "Backup Patch Properties", + "$ref": "#/definitions/backupPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "backupProperties": { + "description": "Backup properties", + "type": "object", + "required": [ + "volumeResourceId" + ], + "properties": { + "backupId": { + "title": "backupId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Backup", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "creationDate": { + "title": "creationDate", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the backup", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "size": { + "type": "integer", + "readOnly": true, + "description": "Size of backup in bytes", + "format": "int64" + }, + "label": { + "type": "string", + "description": "Label for backup" + }, + "backupType": { + "title": "backupType", + "type": "string", + "readOnly": true, + "description": "Type of backup Manual or Scheduled", + "enum": [ + "Manual", + "Scheduled" + ], + "x-ms-enum": { + "name": "backupType", + "modelAsString": true, + "values": [ + { + "value": "Manual", + "description": "Manual backup" + }, + { + "value": "Scheduled", + "description": "Scheduled backup" + } + ] + }, + "example": "Manual" + }, + "failureReason": { + "type": "string", + "readOnly": true, + "description": "Failure reason" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "x-ms-mutability": [ + "read", + "create" + ], + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "useExistingSnapshot": { + "type": "boolean", + "description": "Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups", + "example": true, + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "snapshotName": { + "type": "string", + "description": "The name of the snapshot", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "backupPolicyResourceId": { + "type": "string", + "readOnly": true, + "description": "ResourceId used to identify the backup policy", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies" + } + ] + } + } + } + }, + "backupPatchProperties": { + "description": "Backup patch properties", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Label for backup" + } + } + }, + "backupStatus": { + "description": "Backup status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Backup health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the backup mirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the backup", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy backup relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the backup is in an error state" + }, + "lastTransferSize": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the last transfer size" + }, + "lastTransferType": { + "type": "string", + "readOnly": true, + "description": "Displays the last transfer type" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + }, + "transferProgressBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total number of bytes transferred for the ongoing operation" + } + } + }, + "backupVaultsList": { + "description": "List of Backup Vaults", + "type": "object", + "properties": { + "value": { + "description": "A list of Backup Vaults", + "type": "array", + "items": { + "$ref": "#/definitions/backupVault" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backupVault": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Backup Vault Properties", + "$ref": "#/definitions/backupVaultProperties", + "x-ms-client-flatten": true + } + } + }, + "backupVaultPatch": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + } + } + }, + "backupVaultProperties": { + "description": "Backup Vault properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "backupsMigrationRequest": { + "description": "Migrate Backups Request", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "backupVaultId" + ], + "properties": { + "backupVaultId": { + "type": "string", + "description": "The ResourceId of the Backup Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + } + } + }, + "parameters": { + "AccountName": { + "name": "accountName", + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,127}$", + "in": "path", + "required": true, + "description": "The name of the NetApp account", + "x-ms-parameter-location": "method" + }, + "PoolName": { + "name": "poolName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the capacity pool", + "x-ms-parameter-location": "method" + }, + "VolumeName": { + "name": "volumeName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volume", + "x-ms-parameter-location": "method" + }, + "MountTargetName": { + "name": "mountTargetName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the mount target", + "x-ms-parameter-location": "method" + }, + "SnapshotName": { + "name": "snapshotName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot", + "x-ms-parameter-location": "method" + }, + "SnapshotPolicyName": { + "name": "snapshotPolicyName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot policy", + "x-ms-parameter-location": "method" + }, + "BackupPolicyName": { + "name": "backupPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Backup policy Name which uniquely identify backup policy.", + "x-ms-parameter-location": "method" + }, + "QuotaLimitName": { + "name": "quotaLimitName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the Quota Limit", + "x-ms-parameter-location": "method" + }, + "VolumeGroupName": { + "name": "volumeGroupName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volumeGroup", + "x-ms-parameter-location": "method" + }, + "SubvolumeName": { + "name": "subvolumeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subvolume.", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "VolumeQuotaRuleName": { + "name": "volumeQuotaRuleName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of volume quota rule", + "x-ms-parameter-location": "method" + }, + "BackupName": { + "name": "backupName", + "type": "string", + "in": "path", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_.]{0,255}$", + "required": true, + "description": "The name of the backup", + "x-ms-parameter-location": "method" + }, + "BackupVaultName": { + "name": "backupVaultName", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "type": "string", + "description": "The name of the Backup Vault", + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/netapp/resource-manager/api-set.json b/swagger-specs/netapp/resource-manager/api-set.json index 6efb264ee..223178ce9 100644 --- a/swagger-specs/netapp/resource-manager/api-set.json +++ b/swagger-specs/netapp/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.NetApp/preview/2017-08-15/netapp.json"], "name": "package-2017-08-15"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.NetApp/stable/2023-11-01/netapp.json"], "name": "package-netapp-2023-11-01"} \ No newline at end of file diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/applicationGateway.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/applicationGateway.json similarity index 98% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/applicationGateway.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/applicationGateway.json index 08be4d7de..c4c0074e8 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/applicationGateway.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/applicationGateway.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ @@ -1319,6 +1319,18 @@ "type": "integer", "format": "int32", "description": "Capacity (instance count) of an application gateway." + }, + "family": { + "type": "string", + "description": "Family of an application gateway SKU.", + "enum": [ + "Generation_1", + "Generation_2" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySkuFamily", + "modelAsString": true + } } }, "description": "SKU of an application gateway." @@ -2642,6 +2654,11 @@ "type": "string", "description": "Header name of the header configuration." }, + "headerValueMatcher": { + "type": "object", + "$ref": "#/definitions/HeaderValueMatcher", + "description": "An optional field under \"Rewrite Action\". It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud" + }, "headerValue": { "type": "string", "description": "Header value of the header configuration." @@ -2649,6 +2666,24 @@ }, "description": "Header configuration of the Actions set in Application Gateway." }, + "HeaderValueMatcher": { + "type": "object", + "properties": { + "pattern": { + "type": "string", + "description": "The pattern, either fixed string or regular expression, that evaluates if a header value should be selected for rewrite." + }, + "ignoreCase": { + "type": "boolean", + "description": "Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison." + }, + "negate": { + "type": "boolean", + "description": "Setting this value as truth will force to check the negation of the condition given by the user in the pattern field." + } + }, + "description": "An optional field under \"Rewrite Action\". It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud" + }, "ApplicationGatewayUrlConfiguration": { "properties": { "modifiedPath": { diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/applicationGatewayWafDynamicManifests.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/applicationGatewayWafDynamicManifests.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/applicationGatewayWafDynamicManifests.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/applicationGatewayWafDynamicManifests.json index 17fc26c2a..0e737208e 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/applicationGatewayWafDynamicManifests.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/applicationGatewayWafDynamicManifests.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/applicationSecurityGroup.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/applicationSecurityGroup.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/applicationSecurityGroup.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/applicationSecurityGroup.json index c3d860dd5..49070935f 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/applicationSecurityGroup.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/applicationSecurityGroup.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/availableDelegations.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/availableDelegations.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/availableDelegations.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/availableDelegations.json index 618191f7b..ce778cc5e 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/availableDelegations.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/availableDelegations.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/availableServiceAliases.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/availableServiceAliases.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/availableServiceAliases.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/availableServiceAliases.json index 19c552022..46b937171 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/availableServiceAliases.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/availableServiceAliases.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/azureFirewall.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/azureFirewall.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/azureFirewall.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/azureFirewall.json index dcee3de95..2eb3138bd 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/azureFirewall.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/azureFirewall.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/azureFirewallFqdnTag.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/azureFirewallFqdnTag.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/azureFirewallFqdnTag.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/azureFirewallFqdnTag.json index b82c620b0..d0b07cf3b 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/azureFirewallFqdnTag.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/azureFirewallFqdnTag.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/azureWebCategory.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/azureWebCategory.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/azureWebCategory.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/azureWebCategory.json index 03bd0d8cb..c5608840c 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/azureWebCategory.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/azureWebCategory.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/bastionHost.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/bastionHost.json similarity index 98% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/bastionHost.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/bastionHost.json index abc0375b0..56e435d13 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/bastionHost.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/bastionHost.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ @@ -125,6 +125,9 @@ }, "Get Developer Bastion Host": { "$ref": "./examples/BastionHostDeveloperGet.json" + }, + "Get Bastion Host With Zones": { + "$ref": "./examples/BastionHostGetWithZones.json" } } }, @@ -181,6 +184,9 @@ "Create Bastion Host": { "$ref": "./examples/BastionHostPut.json" }, + "Create Bastion Host With Zones": { + "$ref": "./examples/BastionHostPutWithZones.json" + }, "Create Developer Bastion Host": { "$ref": "./examples/BastionHostDeveloperPut.json" } @@ -802,6 +808,13 @@ "$ref": "#/definitions/BastionHostPropertiesFormat", "description": "Represents the bastion host resource." }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, "etag": { "type": "string", "readOnly": true, diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/checkDnsAvailability.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/checkDnsAvailability.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/checkDnsAvailability.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/checkDnsAvailability.json index 2f706caf0..65009f6c0 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/checkDnsAvailability.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/checkDnsAvailability.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/cloudServiceNetworkInterface.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/cloudServiceNetworkInterface.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/cloudServiceNetworkInterface.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/cloudServiceNetworkInterface.json index 104c97537..228a21f76 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/cloudServiceNetworkInterface.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/cloudServiceNetworkInterface.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/cloudServicePublicIpAddress.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/cloudServicePublicIpAddress.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/cloudServicePublicIpAddress.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/cloudServicePublicIpAddress.json index 7b65d75fd..00fe78a94 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/cloudServicePublicIpAddress.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/cloudServicePublicIpAddress.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/cloudServiceSwap.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/cloudServiceSwap.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/cloudServiceSwap.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/cloudServiceSwap.json index b1672ebe9..26ea3cece 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/cloudServiceSwap.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/cloudServiceSwap.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/customIpPrefix.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/customIpPrefix.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/customIpPrefix.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/customIpPrefix.json index 838760c13..922650a57 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/customIpPrefix.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/customIpPrefix.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/ddosCustomPolicy.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/ddosCustomPolicy.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/ddosCustomPolicy.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/ddosCustomPolicy.json index d5649b77f..bf242cf89 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/ddosCustomPolicy.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/ddosCustomPolicy.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/ddosProtectionPlan.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/ddosProtectionPlan.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/ddosProtectionPlan.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/ddosProtectionPlan.json index 81eade676..c40e76511 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/ddosProtectionPlan.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/ddosProtectionPlan.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/dscpConfiguration.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/dscpConfiguration.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/dscpConfiguration.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/dscpConfiguration.json index d45e596ce..084f067e2 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/dscpConfiguration.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/dscpConfiguration.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/endpointService.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/endpointService.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/endpointService.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/endpointService.json index 017d4124f..940b840ad 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/endpointService.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/endpointService.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/expressRouteCircuit.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/expressRouteCircuit.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/expressRouteCircuit.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/expressRouteCircuit.json index b4b452c05..c27e7764e 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/expressRouteCircuit.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/expressRouteCircuit.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ @@ -2248,6 +2248,10 @@ "readOnly": true, "type": "string", "description": "The authorization status of the Circuit." + }, + "enableDirectPortRateLimit": { + "type": "boolean", + "description": "Flag denoting rate-limiting status of the ExpressRoute direct-port circuit." } }, "description": "Properties of ExpressRouteCircuit." diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/expressRouteCrossConnection.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/expressRouteCrossConnection.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/expressRouteCrossConnection.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/expressRouteCrossConnection.json index 718d0d55a..140efb065 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/expressRouteCrossConnection.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/expressRouteCrossConnection.json @@ -3,7 +3,7 @@ "info": { "title": "ExpressRouteCrossConnection REST APIs", "description": "The Microsoft Azure ExpressRouteCrossConnection Resource Provider REST APIs describes the operations for the connectivity provider to provision ExpressRoute circuit, create and modify BGP peering entities and troubleshoot connectivity on customer's ExpressRoute circuit.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/expressRoutePort.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/expressRoutePort.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/expressRoutePort.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/expressRoutePort.json index eae7727d3..bebdf574a 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/expressRoutePort.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/expressRoutePort.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/expressRouteProviderPort.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/expressRouteProviderPort.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/expressRouteProviderPort.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/expressRouteProviderPort.json index 95a6ab38d..1e0150849 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/expressRouteProviderPort.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/expressRouteProviderPort.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/firewallPolicy.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/firewallPolicy.json similarity index 80% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/firewallPolicy.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/firewallPolicy.json index 83543792f..6b7ae84b9 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/firewallPolicy.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/firewallPolicy.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ @@ -939,6 +939,399 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/firewallPolicyDrafts/default": { + "put": { + "description": "Create or update a draft Firewall Policy.", + "operationId": "FirewallPolicyDrafts_CreateOrUpdate", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "pattern": "^[^_\\W][\\w-._]{0,79}(?/." + }, + "privateIPAddressPrefixLength": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 128, + "x-nullable": true, + "description": "The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address." }, "privateIPAllocationMethod": { "$ref": "./network.json#/definitions/IPAllocationMethod", diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManager.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManager.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManager.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManager.json index 15c83ae0a..181150899 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManager.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManager.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManager", "description": "The Microsoft Azure Virtual Network Manager API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerActiveConfiguration.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerActiveConfiguration.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerActiveConfiguration.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerActiveConfiguration.json index c268ea916..da955aca2 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerActiveConfiguration.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerActiveConfiguration.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagerActiveConfiguration", "description": "The Microsoft Azure Network Manager Active Configuration API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to list all active configuration by network manager.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerConnection.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerConnection.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerConnection.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerConnection.json index 21f483710..9c7882525 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerConnection.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerConnection.json @@ -3,7 +3,7 @@ "info": { "title": "ScopeConnections", "description": "The Microsoft Azure Virtual Network Manager API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerConnectivityConfiguration.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerConnectivityConfiguration.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerConnectivityConfiguration.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerConnectivityConfiguration.json index 7faa656ec..a30cad99a 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerConnectivityConfiguration.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerConnectivityConfiguration.json @@ -3,7 +3,7 @@ "info": { "title": "ConnectivityConfiguration", "description": "The Microsoft Azure Virtual Network Manager Connectivity Configuration API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerEffectiveConfiguration.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerEffectiveConfiguration.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerEffectiveConfiguration.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerEffectiveConfiguration.json index e968af062..47e55d237 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerEffectiveConfiguration.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerEffectiveConfiguration.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagerEffectiveConfiguration", "description": "The Microsoft Azure Network Manager effective configuration API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerGroup.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerGroup.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerGroup.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerGroup.json index 9ed7d29f9..d367fc101 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerGroup.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerGroup.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkGroup", "description": "The Microsoft Azure Network Group API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerScopeConnection.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerScopeConnection.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerScopeConnection.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerScopeConnection.json index 463df5f95..bf7772a66 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerScopeConnection.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerScopeConnection.json @@ -3,7 +3,7 @@ "info": { "title": "ScopeConnections", "description": "The Microsoft Azure Virtual Network Manager API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerSecurityAdminConfiguration.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerSecurityAdminConfiguration.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerSecurityAdminConfiguration.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerSecurityAdminConfiguration.json index bad8049df..1eaebdcdc 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerSecurityAdminConfiguration.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkManagerSecurityAdminConfiguration.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "SecurityAdminConfiguration", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkProfile.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkProfile.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkProfile.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkProfile.json index 3242ffcba..56d18dcdf 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkProfile.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkProfile.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkSecurityGroup.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkSecurityGroup.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkSecurityGroup.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkSecurityGroup.json index 0eca4c8e6..5650c0eca 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkSecurityGroup.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkSecurityGroup.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkVirtualAppliance.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json similarity index 85% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkVirtualAppliance.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json index 43f5451c3..005f2a426 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkVirtualAppliance.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ @@ -285,6 +285,81 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/restart": { + "post": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_Restart", + "description": "Restarts one or more VMs belonging to the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "NetworkVirtualApplianceInstanceIds", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceInstanceIds" + }, + "description": "Specifies a list of virtual machine instance IDs from the Network Virtual Appliance VM instances." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation restarts one or more Network Virtual Appliance VM resources.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceInstanceIds" + } + }, + "202": { + "description": "Request accepted. The operation restarts one or more Network Virtual Appliance VM resources.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Restart All NetworkVirtualAppliance VMs in VM Scale Set": { + "$ref": "./examples/NetworkVirtualApplianceEmptyRestart.json" + }, + "Restart Specific NetworkVirtualAppliance VMs in VM Scale Set": { + "$ref": "./examples/NetworkVirtualApplianceSpecificRestart.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances": { "get": { "tags": [ @@ -856,6 +931,20 @@ "$ref": "#/definitions/VirtualApplianceNicProperties" } }, + "networkProfile": { + "type": "object", + "readOnly": false, + "description": "Network Profile containing configurations for Public and Private NIC.", + "properties": { + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualApplianceNetworkInterfaceConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, "additionalNics": { "type": "array", "readOnly": false, @@ -941,6 +1030,20 @@ }, "VirtualApplianceNicProperties": { "properties": { + "nicType": { + "type": "string", + "readOnly": true, + "description": "NIC type - PublicNic, PrivateNic, or AdditionalNic.", + "enum": [ + "PublicNic", + "PrivateNic", + "AdditionalNic" + ], + "x-ms-enum": { + "name": "NicTypeInResponse", + "modelAsString": true + } + }, "name": { "type": "string", "readOnly": true, @@ -964,6 +1067,68 @@ }, "description": "Network Virtual Appliance NIC properties." }, + "VirtualApplianceNetworkInterfaceConfiguration": { + "type": "object", + "readOnly": false, + "description": "Represents a single NIC configuration.", + "properties": { + "type": { + "type": "string", + "description": "NIC type. This should be either PublicNic or PrivateNic.", + "enum": [ + "PublicNic", + "PrivateNic" + ], + "x-ms-enum": { + "name": "NicTypeInRequest", + "modelAsString": true + }, + "x-ms-client-name": "NicType" + }, + "properties": { + "$ref": "#/definitions/VirtualApplianceNetworkInterfaceConfigurationProperties" + } + } + }, + "VirtualApplianceNetworkInterfaceConfigurationProperties": { + "type": "object", + "readOnly": false, + "description": "Represents a single NIC configuration properties.", + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualApplianceIPConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualApplianceIPConfiguration": { + "type": "object", + "readOnly": false, + "description": "Represents a single IP configuration.", + "properties": { + "name": { + "type": "string", + "description": "Name of the IP configuration." + }, + "properties": { + "$ref": "#/definitions/VirtualApplianceIPConfigurationProperties" + } + } + }, + "VirtualApplianceIPConfigurationProperties": { + "type": "object", + "readOnly": false, + "description": "Represents a single IP configuration properties.", + "properties": { + "primary": { + "type": "boolean", + "description": "Whether or not this is primary IP configuration of the NIC." + } + } + }, "VirtualApplianceAdditionalNicProperties": { "type": "object", "title": "Network Virtual Appliance Additional Nic Properties", @@ -1223,6 +1388,18 @@ }, "InboundSecurityRuleProperties": { "properties": { + "ruleType": { + "type": "string", + "enum": [ + "AutoExpire", + "Permanent" + ], + "x-ms-enum": { + "name": "InboundSecurityRuleType", + "modelAsString": true + }, + "description": "Rule Type. This should be either AutoExpire or Permanent. Auto Expire Rule only creates NSG rules. Permanent Rule creates NSG rule and SLB LB Rule." + }, "rules": { "type": "array", "readOnly": false, @@ -1241,6 +1418,10 @@ }, "InboundSecurityRules": { "properties": { + "name": { + "type": "string", + "description": "Name of the rule." + }, "protocol": { "type": "string", "enum": [ @@ -1255,7 +1436,7 @@ }, "sourceAddressPrefix": { "type": "string", - "description": "The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed." + "description": "The CIDR or source IP range." }, "destinationPortRange": { "type": "integer", @@ -1263,6 +1444,22 @@ "minimum": 0, "maximum": 65535, "description": "NVA port ranges to be opened up. One needs to provide specific ports." + }, + "destinationPortRanges": { + "type": "array", + "readOnly": false, + "description": "NVA port ranges to be opened up. One can provide a range of ports. Allowed port value between 0 and 65535.", + "items": { + "type": "string" + } + }, + "appliesOn": { + "type": "array", + "readOnly": false, + "description": "Public IP name in case of Permanent Rule type & Interface Name in case of Auto Expire Rule type", + "items": { + "type": "string" + } } }, "description": "Properties of the Inbound Security Rules resource." @@ -1325,6 +1522,19 @@ } }, "description": "Properties of the partner managed resource." + }, + "NetworkVirtualApplianceInstanceIds": { + "type": "object", + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The network virtual appliance instance ids. Omitting the network virtual appliance instance ids will result in the operation being performed on all virtual machines belonging to the network virtual appliance." + } + }, + "description": "Specifies a list of virtual machine instance IDs from the Network Virtual Appliance VM instances." } } } diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkWatcher.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkWatcher.json similarity index 97% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkWatcher.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkWatcher.json index 695ebbdd4..6ec21b03d 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkWatcher.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkWatcher.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ @@ -1604,6 +1604,9 @@ }, "Create connection monitor V2": { "$ref": "./examples/NetworkWatcherConnectionMonitorV2Create.json" + }, + "Create connection monitor with Arc Network": { + "$ref": "./examples/NetworkWatcherConnectionMonitorCreateWithArcNetwork.json" } }, "x-ms-long-running-operation": true, @@ -2777,6 +2780,15 @@ "$ref": "#/definitions/PacketCaptureFilter" }, "description": "A list of packet capture filters." + }, + "continuousCapture": { + "description": "This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value. If we do not pass this parameter, it would be consider as 'null', default value is 'null'.", + "type": "boolean" + }, + "captureSettings": { + "type": "object", + "$ref": "#/definitions/PacketCaptureSettings", + "description": "The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values." } }, "required": [ @@ -2809,7 +2821,7 @@ "properties": { "storageId": { "type": "string", - "description": "The ID of the storage account to save the packet capture session. Required if no local file path is provided." + "description": "The ID of the storage account to save the packet capture session. Required if no localPath or filePath is provided." }, "storagePath": { "type": "string", @@ -2817,7 +2829,40 @@ }, "filePath": { "type": "string", - "description": "A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional." + "description": "This path is invalid if 'Continuous Capture' is provided with 'true' or 'false'. A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional." + }, + "localPath": { + "type": "string", + "description": "This path is valid if 'Continuous Capture' is provided with 'true' or 'false' and required if no storage ID is provided, otherwise optional. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures." + } + }, + "description": "The storage location for a packet capture session." + }, + "PacketCaptureSettings": { + "properties": { + "fileCount": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 10000, + "default": 10, + "description": "Number of file count. Default value of count is 10 and maximum number is 10000." + }, + "fileSizeInBytes": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "default": 104857600, + "description": "Number of bytes captured per packet. Default value in bytes 104857600 (100MB) and maximum in bytes 4294967295 (4GB)." + }, + "sessionTimeLimitInSeconds": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 604800, + "default": 86400, + "description": "Maximum duration of the capture session in seconds is 604800s (7 days) for a file. Default value in second 86400s (1 day)." } }, "description": "The storage location for a packet capture session." @@ -4234,7 +4279,8 @@ "MMAWorkspaceMachine", "MMAWorkspaceNetwork", "AzureArcVM", - "AzureVMSS" + "AzureVMSS", + "AzureArcNetwork" ], "x-ms-enum": { "name": "EndpointType", @@ -4244,19 +4290,19 @@ }, "resourceId": { "type": "string", - "description": "Resource ID of the connection monitor endpoint." + "description": "Resource ID of the connection monitor endpoint are supported for AzureVM, AzureVMSS, AzureVNet, AzureSubnet, MMAWorkspaceMachine, MMAWorkspaceNetwork, AzureArcVM endpoint type." }, "address": { "type": "string", - "description": "Address of the connection monitor endpoint (IP or domain name)." + "description": "Address of the connection monitor endpoint. Supported for AzureVM, ExternalAddress, ArcMachine, MMAWorkspaceMachine endpoint type." }, "filter": { "$ref": "#/definitions/ConnectionMonitorEndpointFilter", - "description": "Filter for sub-items within the endpoint." + "description": "Filter field is getting deprecated and should not be used. Instead use Include/Exclude scope fields for it." }, "scope": { "$ref": "#/definitions/ConnectionMonitorEndpointScope", - "description": "Endpoint scope." + "description": "Endpoint scope defines which target resource to monitor in case of compound resource endpoints like VMSS, AzureSubnet, AzureVNet, MMAWorkspaceNetwork, AzureArcNetwork." }, "coverageLevel": { "type": "string", @@ -4273,6 +4319,14 @@ "modelAsString": true }, "description": "Test coverage for the endpoint." + }, + "locationDetails": { + "$ref": "#/definitions/ConnectionMonitorEndpointLocationDetails", + "description": "Location details is optional and only being used for 'AzureArcNetwork' type endpoints, which contains region details." + }, + "subscriptionId": { + "type": "string", + "description": "Subscription ID for connection monitor endpoint. It's an optional parameter which is being used for 'AzureArcNetwork' type endpoint." } }, "required": [ @@ -4777,6 +4831,16 @@ } }, "description": "List of connection states snapshots." + }, + "ConnectionMonitorEndpointLocationDetails": { + "type": "object", + "properties": { + "region": { + "type": "string", + "description": "Region for connection monitor endpoint." + } + }, + "description": "Connection monitor endpoint location details only being used for 'AzureArcNetwork' type endpoints, which contains the region details." } } } diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/operation.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/operation.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/operation.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/operation.json index 8c586b663..b3d741cc1 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/operation.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/operation.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/privateEndpoint.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/privateEndpoint.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/privateEndpoint.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/privateEndpoint.json index 906e4c119..d035b1e5b 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/privateEndpoint.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/privateEndpoint.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/privateLinkService.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/privateLinkService.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/privateLinkService.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/privateLinkService.json index d703f997f..cd06f074b 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/privateLinkService.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/privateLinkService.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/publicIpAddress.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/publicIpAddress.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/publicIpAddress.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/publicIpAddress.json index c142c42c5..57dc49032 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/publicIpAddress.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/publicIpAddress.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/publicIpPrefix.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/publicIpPrefix.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/publicIpPrefix.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/publicIpPrefix.json index 0203f1461..371c894cf 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/publicIpPrefix.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/publicIpPrefix.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/routeFilter.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/routeFilter.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/routeFilter.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/routeFilter.json index 1692eb8d0..c38342c95 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/routeFilter.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/routeFilter.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/routeTable.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/routeTable.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/routeTable.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/routeTable.json index 8649351b0..01c9b6f5b 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/routeTable.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/routeTable.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/securityPartnerProvider.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/securityPartnerProvider.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/securityPartnerProvider.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/securityPartnerProvider.json index e7500663f..1c4bad627 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/securityPartnerProvider.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/securityPartnerProvider.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/serviceCommunity.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/serviceCommunity.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/serviceCommunity.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/serviceCommunity.json index 6c14c5815..2076f7b74 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/serviceCommunity.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/serviceCommunity.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/serviceEndpointPolicy.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/serviceEndpointPolicy.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/serviceEndpointPolicy.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/serviceEndpointPolicy.json index 8146c19b4..c3a1e5a05 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/serviceEndpointPolicy.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/serviceEndpointPolicy.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/serviceTags.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/serviceTags.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/serviceTags.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/serviceTags.json index b2daa5918..8c1948dcf 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/serviceTags.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/serviceTags.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/usage.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/usage.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/usage.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/usage.json index a1e0cb0a8..cb81d1096 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/usage.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/usage.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualNetwork.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualNetwork.json similarity index 97% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualNetwork.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualNetwork.json index 91af6180c..6cc56c72b 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualNetwork.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualNetwork.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ @@ -507,6 +507,9 @@ }, "Get subnet with a delegation": { "$ref": "./examples/SubnetGetWithDelegation.json" + }, + "Get subnet with sharing scope": { + "$ref": "./examples/SubnetGetWithSharingScope.json" } } }, @@ -587,6 +590,9 @@ }, "Create subnet with a delegation": { "$ref": "./examples/SubnetCreateWithDelegation.json" + }, + "Create subnet with sharing scope": { + "$ref": "./examples/SubnetCreateWithSharingScope.json" } } } @@ -1605,7 +1611,9 @@ "description": "Enable or Disable apply network policies on private end point in the subnet.", "enum": [ "Enabled", - "Disabled" + "Disabled", + "NetworkSecurityGroupEnabled", + "RouteTableEnabled" ], "x-ms-enum": { "name": "VirtualNetworkPrivateEndpointNetworkPolicies", @@ -1632,6 +1640,19 @@ }, "description": "Application gateway IP configurations of virtual network resource." }, + "sharingScope": { + "type": "string", + "default": null, + "description": "Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty.", + "enum": [ + "Tenant", + "DelegatedServices" + ], + "x-ms-enum": { + "name": "SharingScope", + "modelAsString": true + } + }, "defaultOutboundAccess": { "type": "boolean", "description": "Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet." @@ -1682,6 +1703,14 @@ "$ref": "./network.json#/definitions/SubResource", "description": "The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering)." }, + "localAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The local address space of the local virtual network that is peered." + }, + "localVirtualNetworkAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The current local address space of the local virtual network that is peered." + }, "remoteAddressSpace": { "$ref": "#/definitions/AddressSpace", "description": "The reference to the address space peered with the remote virtual network." @@ -1741,6 +1770,28 @@ "readOnly": true, "type": "string", "description": "The resourceGuid property of the Virtual Network peering resource." + }, + "peerCompleteVnets": { + "type": "boolean", + "description": "Whether complete virtual network address space is peered." + }, + "enableOnlyIPv6Peering": { + "type": "boolean", + "description": "Whether only Ipv6 address space is peered for subnet peering." + }, + "localSubnetNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of local subnet names that are subnet peered with remote virtual network." + }, + "remoteSubnetNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of remote subnet names from remote virtual network that are subnet peered." } }, "description": "Properties of the virtual network peering." diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualNetworkGateway.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualNetworkGateway.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualNetworkGateway.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualNetworkGateway.json index 4741ebbcb..b9c82168e 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualNetworkGateway.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualNetworkGateway.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualNetworkTap.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualNetworkTap.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualNetworkTap.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualNetworkTap.json index 448509568..34aa67f63 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualNetworkTap.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualNetworkTap.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualRouter.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualRouter.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualRouter.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualRouter.json index 2e57031d7..c206f9541 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualRouter.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualRouter.json @@ -3,7 +3,7 @@ "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualWan.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualWan.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualWan.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualWan.json index 326b98d86..7a57f15b5 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/virtualWan.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/virtualWan.json @@ -3,7 +3,7 @@ "info": { "title": "VirtualWANAsAServiceManagementClient", "description": "REST API for Azure VirtualWAN As a Service.", - "version": "2023-06-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ @@ -7744,6 +7744,11 @@ "$ref": "./network.json#/definitions/SubResource" }, "description": "List of egress NatRules." + }, + "dpdTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "Dead Peer Detection timeout in seconds for VpnLink connection." } }, "description": "Parameters for VpnConnection." diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/vmssNetworkInterface.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/vmssNetworkInterface.json similarity index 100% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/vmssNetworkInterface.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/vmssNetworkInterface.json diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/vmssPublicIpAddress.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/vmssPublicIpAddress.json similarity index 100% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/vmssPublicIpAddress.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/vmssPublicIpAddress.json diff --git a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json similarity index 99% rename from swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json rename to swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json index 9eff93804..f9aea7948 100644 --- a/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json +++ b/swagger-specs/network/resource-manager/Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-06-01", + "version": "2023-11-01", "title": "WebApplicationFirewallManagement", "description": "APIs to manage web application firewall rules." }, @@ -519,6 +519,13 @@ "description": "The rules that are applied to the logs for scrubbing." } } + }, + "jsChallengeCookieExpirationInMins": { + "description": "Web Application Firewall JavaScript Challenge Cookie Expiration time in minutes.", + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1440 } } }, diff --git a/swagger-specs/network/resource-manager/api-set.json b/swagger-specs/network/resource-manager/api-set.json index 53f62bf38..335e7881e 100644 --- a/swagger-specs/network/resource-manager/api-set.json +++ b/swagger-specs/network/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Network/stable/2023-06-01/applicationGateway.json", "Microsoft.Network/stable/2023-06-01/applicationGatewayWafDynamicManifests.json", "Microsoft.Network/stable/2023-06-01/applicationSecurityGroup.json", "Microsoft.Network/stable/2023-06-01/availableDelegations.json", "Microsoft.Network/stable/2023-06-01/availableServiceAliases.json", "Microsoft.Network/stable/2023-06-01/azureFirewall.json", "Microsoft.Network/stable/2023-06-01/azureFirewallFqdnTag.json", "Microsoft.Network/stable/2023-06-01/azureWebCategory.json", "Microsoft.Network/stable/2023-06-01/bastionHost.json", "Microsoft.Network/stable/2023-06-01/checkDnsAvailability.json", "Microsoft.Network/stable/2023-06-01/cloudServiceNetworkInterface.json", "Microsoft.Network/stable/2023-06-01/cloudServicePublicIpAddress.json", "Microsoft.Network/stable/2023-06-01/cloudServiceSwap.json", "Microsoft.Network/stable/2023-06-01/customIpPrefix.json", "Microsoft.Network/stable/2023-06-01/ddosCustomPolicy.json", "Microsoft.Network/stable/2023-06-01/ddosProtectionPlan.json", "Microsoft.Network/stable/2023-06-01/dscpConfiguration.json", "Microsoft.Network/stable/2023-06-01/endpointService.json", "Microsoft.Network/stable/2023-06-01/expressRouteCircuit.json", "Microsoft.Network/stable/2023-06-01/expressRouteCrossConnection.json", "Microsoft.Network/stable/2023-06-01/expressRoutePort.json", "Microsoft.Network/stable/2023-06-01/expressRouteProviderPort.json", "Microsoft.Network/stable/2023-06-01/firewallPolicy.json", "Microsoft.Network/stable/2023-06-01/ipAllocation.json", "Microsoft.Network/stable/2023-06-01/ipGroups.json", "Microsoft.Network/stable/2023-06-01/loadBalancer.json", "Microsoft.Network/stable/2023-06-01/natGateway.json", "Microsoft.Network/stable/2023-06-01/network.json", "Microsoft.Network/stable/2023-06-01/networkInterface.json", "Microsoft.Network/stable/2023-06-01/networkManager.json", "Microsoft.Network/stable/2023-06-01/networkManagerActiveConfiguration.json", "Microsoft.Network/stable/2023-06-01/networkManagerConnection.json", "Microsoft.Network/stable/2023-06-01/networkManagerConnectivityConfiguration.json", "Microsoft.Network/stable/2023-06-01/networkManagerEffectiveConfiguration.json", "Microsoft.Network/stable/2023-06-01/networkManagerGroup.json", "Microsoft.Network/stable/2023-06-01/networkManagerScopeConnection.json", "Microsoft.Network/stable/2023-06-01/networkManagerSecurityAdminConfiguration.json", "Microsoft.Network/stable/2023-06-01/networkProfile.json", "Microsoft.Network/stable/2023-06-01/networkSecurityGroup.json", "Microsoft.Network/stable/2023-06-01/networkVirtualAppliance.json", "Microsoft.Network/stable/2023-06-01/networkWatcher.json", "Microsoft.Network/stable/2023-06-01/operation.json", "Microsoft.Network/stable/2023-06-01/privateEndpoint.json", "Microsoft.Network/stable/2023-06-01/privateLinkService.json", "Microsoft.Network/stable/2023-06-01/publicIpAddress.json", "Microsoft.Network/stable/2023-06-01/publicIpPrefix.json", "Microsoft.Network/stable/2023-06-01/routeFilter.json", "Microsoft.Network/stable/2023-06-01/routeTable.json", "Microsoft.Network/stable/2023-06-01/securityPartnerProvider.json", "Microsoft.Network/stable/2023-06-01/serviceCommunity.json", "Microsoft.Network/stable/2023-06-01/serviceEndpointPolicy.json", "Microsoft.Network/stable/2023-06-01/serviceTags.json", "Microsoft.Network/stable/2023-06-01/usage.json", "Microsoft.Network/stable/2023-06-01/virtualNetwork.json", "Microsoft.Network/stable/2023-06-01/virtualNetworkGateway.json", "Microsoft.Network/stable/2023-06-01/virtualNetworkTap.json", "Microsoft.Network/stable/2023-06-01/virtualRouter.json", "Microsoft.Network/stable/2023-06-01/virtualWan.json", "Microsoft.Network/stable/2023-06-01/vmssNetworkInterface.json", "Microsoft.Network/stable/2023-06-01/vmssPublicIpAddress.json", "Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json"], "name": "package-2023-06"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.Network/stable/2023-11-01/applicationGateway.json", "Microsoft.Network/stable/2023-11-01/applicationGatewayWafDynamicManifests.json", "Microsoft.Network/stable/2023-11-01/applicationSecurityGroup.json", "Microsoft.Network/stable/2023-11-01/availableDelegations.json", "Microsoft.Network/stable/2023-11-01/availableServiceAliases.json", "Microsoft.Network/stable/2023-11-01/azureFirewall.json", "Microsoft.Network/stable/2023-11-01/azureFirewallFqdnTag.json", "Microsoft.Network/stable/2023-11-01/azureWebCategory.json", "Microsoft.Network/stable/2023-11-01/bastionHost.json", "Microsoft.Network/stable/2023-11-01/checkDnsAvailability.json", "Microsoft.Network/stable/2023-11-01/cloudServiceNetworkInterface.json", "Microsoft.Network/stable/2023-11-01/cloudServicePublicIpAddress.json", "Microsoft.Network/stable/2023-11-01/cloudServiceSwap.json", "Microsoft.Network/stable/2023-11-01/customIpPrefix.json", "Microsoft.Network/stable/2023-11-01/ddosCustomPolicy.json", "Microsoft.Network/stable/2023-11-01/ddosProtectionPlan.json", "Microsoft.Network/stable/2023-11-01/dscpConfiguration.json", "Microsoft.Network/stable/2023-11-01/endpointService.json", "Microsoft.Network/stable/2023-11-01/expressRouteCircuit.json", "Microsoft.Network/stable/2023-11-01/expressRouteCrossConnection.json", "Microsoft.Network/stable/2023-11-01/expressRoutePort.json", "Microsoft.Network/stable/2023-11-01/expressRouteProviderPort.json", "Microsoft.Network/stable/2023-11-01/firewallPolicy.json", "Microsoft.Network/stable/2023-11-01/ipAllocation.json", "Microsoft.Network/stable/2023-11-01/ipGroups.json", "Microsoft.Network/stable/2023-11-01/loadBalancer.json", "Microsoft.Network/stable/2023-11-01/natGateway.json", "Microsoft.Network/stable/2023-11-01/network.json", "Microsoft.Network/stable/2023-11-01/networkInterface.json", "Microsoft.Network/stable/2023-11-01/networkManager.json", "Microsoft.Network/stable/2023-11-01/networkManagerActiveConfiguration.json", "Microsoft.Network/stable/2023-11-01/networkManagerConnection.json", "Microsoft.Network/stable/2023-11-01/networkManagerConnectivityConfiguration.json", "Microsoft.Network/stable/2023-11-01/networkManagerEffectiveConfiguration.json", "Microsoft.Network/stable/2023-11-01/networkManagerGroup.json", "Microsoft.Network/stable/2023-11-01/networkManagerScopeConnection.json", "Microsoft.Network/stable/2023-11-01/networkManagerSecurityAdminConfiguration.json", "Microsoft.Network/stable/2023-11-01/networkProfile.json", "Microsoft.Network/stable/2023-11-01/networkSecurityGroup.json", "Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json", "Microsoft.Network/stable/2023-11-01/networkWatcher.json", "Microsoft.Network/stable/2023-11-01/operation.json", "Microsoft.Network/stable/2023-11-01/privateEndpoint.json", "Microsoft.Network/stable/2023-11-01/privateLinkService.json", "Microsoft.Network/stable/2023-11-01/publicIpAddress.json", "Microsoft.Network/stable/2023-11-01/publicIpPrefix.json", "Microsoft.Network/stable/2023-11-01/routeFilter.json", "Microsoft.Network/stable/2023-11-01/routeTable.json", "Microsoft.Network/stable/2023-11-01/securityPartnerProvider.json", "Microsoft.Network/stable/2023-11-01/serviceCommunity.json", "Microsoft.Network/stable/2023-11-01/serviceEndpointPolicy.json", "Microsoft.Network/stable/2023-11-01/serviceTags.json", "Microsoft.Network/stable/2023-11-01/usage.json", "Microsoft.Network/stable/2023-11-01/virtualNetwork.json", "Microsoft.Network/stable/2023-11-01/virtualNetworkGateway.json", "Microsoft.Network/stable/2023-11-01/virtualNetworkTap.json", "Microsoft.Network/stable/2023-11-01/virtualRouter.json", "Microsoft.Network/stable/2023-11-01/virtualWan.json", "Microsoft.Network/stable/2023-11-01/vmssNetworkInterface.json", "Microsoft.Network/stable/2023-11-01/vmssPublicIpAddress.json", "Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json"], "name": "package-2023-11"} \ No newline at end of file diff --git a/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/Clusters.json b/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/Clusters.json index 343c5b583..f018aba61 100644 --- a/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/Clusters.json +++ b/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/Clusters.json @@ -316,13 +316,22 @@ "$ref": "#/definitions/Cluster" } }, + "202": { + "description": "Accepted response definition.", + "headers": { + "Location": { + "type": "string" + } + } + }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } } }, diff --git a/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Clusters.json b/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/Clusters.json similarity index 88% rename from swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Clusters.json rename to swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/Clusters.json index 02b63bd60..3f7f66bd6 100644 --- a/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Clusters.json +++ b/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/Clusters.json @@ -3,7 +3,7 @@ "info": { "title": "Azure Log Analytics", "description": "Azure Log Analytics API reference", - "version": "2021-06-01" + "version": "2022-10-01" }, "host": "management.azure.com", "schemes": [ @@ -332,6 +332,7 @@ }, "definitions": { "ClusterProperties": { + "type": "object", "properties": { "clusterId": { "type": "string", @@ -358,15 +359,14 @@ }, "isDoubleEncryptionEnabled": { "type": "boolean", - "readOnly": false, "description": "Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true'", "x-ms-mutability": [ - "create" + "create", + "read" ] }, "isAvailabilityZonesEnabled": { "type": "boolean", - "readOnly": false, "description": "Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones." }, "billingType": { @@ -405,6 +405,7 @@ "description": "Cluster properties." }, "ClusterPatchProperties": { + "type": "object", "properties": { "keyVaultProperties": { "$ref": "#/definitions/keyVaultProperties", @@ -418,6 +419,7 @@ "description": "Log Analytics cluster patch properties." }, "ClusterPatch": { + "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, @@ -425,8 +427,8 @@ "description": "Log Analytics cluster properties." }, "identity": { - "$ref": "#/definitions/Identity", - "description": "The identity of the resource." + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "Resource's identity." }, "sku": { "$ref": "#/definitions/ClusterSku", @@ -449,10 +451,11 @@ "x-ms-azure-resource": true }, "Cluster": { + "type": "object", "properties": { "identity": { - "$ref": "#/definitions/Identity", - "description": "The identity of the resource." + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "Resource's identity." }, "sku": { "$ref": "#/definitions/ClusterSku", @@ -472,6 +475,7 @@ "description": "The top level Log Analytics cluster resource container." }, "ClusterListResult": { + "type": "object", "properties": { "nextLink": { "description": "The link used to get the next page of recommendations.", @@ -488,6 +492,7 @@ "description": "The list clusters operation response." }, "keyVaultProperties": { + "type": "object", "description": "The key vault properties.", "properties": { "keyVaultUri": { @@ -523,17 +528,25 @@ } }, "ClusterSku": { + "type": "object", "description": "The cluster sku definition.", "properties": { "capacity": { - "description": "The capacity value", + "description": "The capacity reservation level in Gigabytes for this cluster.", "type": "integer", "format": "int64", "enum": [ + 100, + 200, + 300, + 400, 500, 1000, 2000, - 5000 + 5000, + 10000, + 25000, + 50000 ], "x-ms-enum": { "name": "Capacity" @@ -541,7 +554,7 @@ }, "name": { "type": "string", - "description": "The name of the SKU.", + "description": "The SKU (tier) of a cluster.", "enum": [ "CapacityReservation" ], @@ -552,77 +565,31 @@ } } }, - "Identity": { - "properties": { - "principalId": { - "readOnly": true, - "type": "string", - "description": "The principal ID of resource identity." - }, - "tenantId": { - "readOnly": true, - "type": "string", - "description": "The tenant ID of resource." - }, - "type": { - "type": "string", - "description": "Type of managed service identity.", - "enum": [ - "SystemAssigned", - "UserAssigned", - "None" - ], - "x-ms-enum": { - "name": "IdentityType", - "modelAsString": false - } - }, - "userAssignedIdentities": { - "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/UserIdentityProperties" - } - } - }, - "required": [ - "type" - ], - "description": "Identity for the resource." - }, - "UserIdentityProperties": { - "type": "object", - "description": "User assigned identity properties.", - "properties": { - "principalId": { - "readOnly": true, - "description": "The principal id of user assigned identity.", - "type": "string" - }, - "clientId": { - "readOnly": true, - "description": "The client id of user assigned identity.", - "type": "string" - } - } - }, "AssociatedWorkspace": { "type": "object", "description": "The list of Log Analytics workspaces associated with the cluster.", "properties": { "workspaceId": { "readOnly": true, - "description": "The id of the assigned workspace.", + "description": "Associated workspace immutable id.", "type": "string" }, "workspaceName": { "readOnly": true, - "description": "The name id the assigned workspace.", + "description": "Associated workspace resource name.", "type": "string" }, "resourceId": { "readOnly": true, - "description": "The ResourceId id the assigned workspace.", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Associated workspace arm resource id, in the form of: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.", "type": "string" }, "associateDate": { @@ -633,6 +600,7 @@ } }, "CapacityReservationProperties": { + "type": "object", "description": "The Capacity Reservation properties.", "properties": { "lastSkuUpdate": { @@ -642,7 +610,7 @@ }, "minCapacity": { "readOnly": true, - "description": "Minimum CapacityReservation value in GB.", + "description": "Minimum CapacityReservation value in Gigabytes.", "type": "integer", "format": "int64" } diff --git a/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/Tables.json b/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/Tables.json index 8bd743433..9fd67db90 100644 --- a/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/Tables.json +++ b/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/Tables.json @@ -705,8 +705,8 @@ "type": "integer", "format": "int32", "minimum": 4, - "maximum": 2556, - "description": "The table total retention in days, between 4 and 2556. Setting this property to -1 will default to table retention." + "maximum": 4383, + "description": "The table total retention in days, between 4 and 4383. Setting this property to -1 will default to table retention." }, "archiveRetentionInDays": { "readOnly": true, diff --git a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json b/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2023-09-01/Operations.json similarity index 60% rename from swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json rename to swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2023-09-01/Operations.json index e0dc772f3..8112e3674 100644 --- a/swagger-specs/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json +++ b/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2023-09-01/Operations.json @@ -1,11 +1,9 @@ { "swagger": "2.0", "info": { - "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, - "version": "2015-04-01" + "title": "Azure Log Analytics", + "description": "Azure Log Analytics API reference", + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ @@ -36,18 +34,18 @@ } }, "paths": { - "/providers/Microsoft.Insights/operations": { + "/providers/Microsoft.OperationalInsights/operations": { "get": { + "x-ms-examples": { + "Get specific operation status": { + "$ref": "./examples/OperationsListByTenant.json" + } + }, "tags": [ "Operations" ], - "description": "Lists all of the available operations from Microsoft.Insights provider.", "operationId": "Operations_List", - "x-ms-examples": { - "Get a list of operations for a resource provider": { - "$ref": "./examples/OperationList.json" - } - }, + "description": "Lists all of the available OperationalInsights Rest API operations.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" @@ -55,18 +53,28 @@ ], "responses": { "200": { - "description": "OK. The request has succeeded.", + "description": "OK response definition.", "schema": { "$ref": "#/definitions/OperationListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } } }, "definitions": { "OperationListResult": { - "description": "Result of the request to list Microsoft.Insights operations. It contains a list of operations and a URL link to get the next set of results.", + "type": "object", + "description": "Result of the request to list solution operations.", "properties": { "value": { "type": "array", @@ -76,40 +84,47 @@ "x-ms-identifiers": [ "name" ], - "description": "List of operations supported by the Microsoft.Insights provider." + "description": "List of solution operations supported by the OperationsManagement resource provider." }, "nextLink": { "type": "string", + "readOnly": true, "description": "URL to get the next set of operation list results if there are any." } } }, "Operation": { - "description": "Microsoft Insights API operation definition.", "type": "object", + "description": "Supported operation of OperationalInsights resource provider.", "properties": { "name": { "description": "Operation name: {provider}/{resource}/{operation}", "type": "string" }, "display": { + "type": "object", "description": "Display metadata associated with the operation.", "properties": { "provider": { - "description": "Service provider: Microsoft.Insights", + "description": "Service provider: Microsoft OperationsManagement.", "type": "string" }, "resource": { - "description": "Resource on which the operation is performed: AlertRules, Autoscale, etc.", + "description": "Resource on which the operation is performed etc.", "type": "string" }, "operation": { - "description": "Operation type: Read, write, delete, etc.", + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of operation", "type": "string" } } } } } - } + }, + "parameters": {} } diff --git a/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Workspaces.json b/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2023-09-01/Workspaces.json similarity index 87% rename from swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Workspaces.json rename to swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2023-09-01/Workspaces.json index e03a04b98..7b4584676 100644 --- a/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Workspaces.json +++ b/swagger-specs/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2023-09-01/Workspaces.json @@ -3,7 +3,7 @@ "info": { "title": "Azure Log Analytics", "description": "Azure Log Analytics API reference", - "version": "2021-06-01" + "version": "2023-09-01" }, "host": "management.azure.com", "schemes": [ @@ -400,6 +400,7 @@ }, "definitions": { "WorkspaceSku": { + "type": "object", "properties": { "name": { "type": "string", @@ -431,7 +432,10 @@ 500, 1000, 2000, - 5000 + 5000, + 10000, + 25000, + 50000 ], "x-ms-enum": { "name": "CapacityReservationLevel" @@ -449,6 +453,7 @@ "description": "The SKU (tier) of a workspace." }, "WorkspaceCapping": { + "type": "object", "description": "The daily volume cap for ingestion.", "properties": { "dailyQuotaGb": { @@ -507,10 +512,12 @@ } }, "WorkspaceProperties": { + "type": "object", "properties": { "provisioningState": { "type": "string", "description": "The provisioning state of the workspace.", + "readOnly": true, "enum": [ "Creating", "Succeeded", @@ -572,16 +579,24 @@ "items": { "$ref": "#/definitions/PrivateLinkScopedResource" }, + "x-ms-identifiers": [ + "resourceId" + ], "description": "List of linked private link scope resources." }, "features": { "$ref": "#/definitions/WorkspaceFeatures", "description": "Workspace features." + }, + "defaultDataCollectionRuleResourceId": { + "type": "string", + "description": "The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}." } }, "description": "Workspace properties." }, "WorkspaceFeatures": { + "type": "object", "properties": { "enableDataExport": { "type": "boolean", @@ -607,12 +622,74 @@ "type": "boolean", "x-nullable": true, "description": "Disable Non-AAD based Auth." + }, + "unifiedSentinelBillingOnly": { + "type": "boolean", + "x-nullable": true, + "readOnly": true, + "description": "An indication if the specify workspace is limited to sentinel's unified billing model only." } }, "additionalProperties": true, "description": "Workspace features." }, + "Identity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "Type of managed service identity.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentityProperties" + } + } + }, + "required": [ + "type" + ], + "type": "object", + "description": "Identity for the resource." + }, + "UserIdentityProperties": { + "type": "object", + "description": "User assigned identity properties.", + "properties": { + "principalId": { + "readOnly": true, + "description": "The principal id of user assigned identity.", + "type": "string" + }, + "clientId": { + "readOnly": true, + "description": "The client id of user assigned identity.", + "type": "string" + } + } + }, "PrivateLinkScopedResource": { + "type": "object", "properties": { "resourceId": { "type": "string", @@ -626,12 +703,21 @@ "description": "The private link scope resource reference." }, "Workspace": { + "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/WorkspaceProperties", "description": "Workspace properties." }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, "etag": { "type": "string", "description": "The etag of the workspace." @@ -645,12 +731,17 @@ "description": "The top level Workspace resource container." }, "WorkspacePatch": { + "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/WorkspaceProperties", "description": "Workspace properties." }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, "tags": { "type": "object", "additionalProperties": { @@ -672,6 +763,7 @@ "description": "The top level Workspace resource container." }, "WorkspaceListResult": { + "type": "object", "properties": { "value": { "type": "array", diff --git a/swagger-specs/operationalinsights/resource-manager/api-set.json b/swagger-specs/operationalinsights/resource-manager/api-set.json index 0e9631d6e..1a020084f 100644 --- a/swagger-specs/operationalinsights/resource-manager/api-set.json +++ b/swagger-specs/operationalinsights/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.OperationalInsights/stable/2019-09-01/QueryPacks.json", "Microsoft.OperationalInsights/stable/2019-09-01/QueryPackQueries.json", "Microsoft.OperationalInsights/stable/2020-08-01/DataExports.json", "Microsoft.OperationalInsights/stable/2020-08-01/DataSources.json", "Microsoft.OperationalInsights/stable/2020-08-01/IntelligencePacks.json", "Microsoft.OperationalInsights/stable/2020-08-01/LinkedServices.json", "Microsoft.OperationalInsights/stable/2020-08-01/LinkedStorageAccounts.json", "Microsoft.OperationalInsights/stable/2020-08-01/ManagementGroups.json", "Microsoft.OperationalInsights/stable/2020-08-01/OperationStatuses.json", "Microsoft.OperationalInsights/stable/2020-08-01/SharedKeys.json", "Microsoft.OperationalInsights/stable/2020-08-01/Usages.json", "Microsoft.OperationalInsights/stable/2020-08-01/StorageInsightConfigs.json", "Microsoft.OperationalInsights/stable/2020-08-01/SavedSearches.json", "Microsoft.OperationalInsights/stable/2020-08-01/AvailableServiceTiers.json", "Microsoft.OperationalInsights/stable/2020-08-01/Gateways.json", "Microsoft.OperationalInsights/stable/2020-08-01/Schema.json", "Microsoft.OperationalInsights/stable/2020-08-01/WorkspacePurge.json", "Microsoft.OperationalInsights/stable/2021-06-01/Clusters.json", "Microsoft.OperationalInsights/stable/2022-10-01/Operations.json", "Microsoft.OperationalInsights/stable/2022-10-01/Workspaces.json", "Microsoft.OperationalInsights/stable/2022-10-01/Tables.json"], "name": "package-2022-10"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.OperationalInsights/stable/2023-09-01/Operations.json", "Microsoft.OperationalInsights/stable/2023-09-01/Workspaces.json", "Microsoft.OperationalInsights/stable/2022-10-01/Tables.json", "Microsoft.OperationalInsights/stable/2019-09-01/QueryPacks.json", "Microsoft.OperationalInsights/stable/2019-09-01/QueryPackQueries.json", "Microsoft.OperationalInsights/stable/2020-08-01/DataExports.json", "Microsoft.OperationalInsights/stable/2020-08-01/DataSources.json", "Microsoft.OperationalInsights/stable/2020-08-01/IntelligencePacks.json", "Microsoft.OperationalInsights/stable/2020-08-01/LinkedServices.json", "Microsoft.OperationalInsights/stable/2020-08-01/LinkedStorageAccounts.json", "Microsoft.OperationalInsights/stable/2020-08-01/ManagementGroups.json", "Microsoft.OperationalInsights/stable/2020-08-01/OperationStatuses.json", "Microsoft.OperationalInsights/stable/2020-08-01/SharedKeys.json", "Microsoft.OperationalInsights/stable/2020-08-01/Usages.json", "Microsoft.OperationalInsights/stable/2020-08-01/StorageInsightConfigs.json", "Microsoft.OperationalInsights/stable/2020-08-01/SavedSearches.json", "Microsoft.OperationalInsights/stable/2020-08-01/AvailableServiceTiers.json", "Microsoft.OperationalInsights/stable/2020-08-01/Gateways.json", "Microsoft.OperationalInsights/stable/2020-08-01/Schema.json", "Microsoft.OperationalInsights/stable/2020-08-01/WorkspacePurge.json", "Microsoft.OperationalInsights/stable/2022-10-01/Clusters.json"], "name": "package-2023-09"} \ No newline at end of file diff --git a/swagger-specs/playwrighttesting/data-plane/Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json b/swagger-specs/playwrighttesting/data-plane/Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json index d967a0c68..7389ac6f3 100644 --- a/swagger-specs/playwrighttesting/data-plane/Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json +++ b/swagger-specs/playwrighttesting/data-plane/Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json @@ -468,21 +468,81 @@ "readOnly": true }, "regionalAffinity": { - "$ref": "#/definitions/EnablementStatus", + "type": "string", "description": "This property sets the connection region for Playwright client workers to cloud-hosted browsers. If enabled, workers connect to browsers in the closest Azure region, ensuring lower latency. If disabled, workers connect to browsers in the Azure region in which the workspace was initially created.", "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + }, "readOnly": true }, "scalableExecution": { - "$ref": "#/definitions/EnablementStatus", + "type": "string", "description": "When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations.", "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + }, "readOnly": true }, "reporting": { - "$ref": "#/definitions/EnablementStatus", + "type": "string", "description": "When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting.", "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnablementStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The feature is Enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The feature is Disabled." + } + ] + }, "readOnly": true } }, @@ -587,30 +647,6 @@ "format": "uuid", "description": "Universally Unique Identifier" }, - "EnablementStatus": { - "type": "string", - "description": "The enablement status of a feature.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "EnablementStatus", - "modelAsString": true, - "values": [ - { - "name": "Enabled", - "value": "Enabled", - "description": "The feature is Enabled." - }, - { - "name": "Disabled", - "value": "Disabled", - "description": "The feature is Disabled." - } - ] - } - }, "PagedAccessToken": { "type": "object", "description": "Paged collection of AccessToken items", diff --git a/swagger-specs/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/openapi.json b/swagger-specs/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/openapi.json new file mode 100644 index 000000000..1f674e941 --- /dev/null +++ b/swagger-specs/programmableconnectivity/data-plane/Azure.ProgrammableConnectivity/preview/2024-02-09-preview/openapi.json @@ -0,0 +1,994 @@ +{ + "swagger": "2.0", + "info": { + "title": "Programmable Connectivity", + "version": "2024-02-09-preview", + "description": "Azure Programmable Connectivity (APC) provides a unified interface to the Network APIs of multiple Telecom Operators. Note that Operators may deprecate a Network API with less advance notice than the Azure standard, in which case APC will also deprecate that Network API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "An Azure Programmable Connectivity Endpoint providing access to Network APIs, for example https://{region}.apcgatewayapi.azure.com", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "OAuth2Auth": [ + "https://management.azure.com//.default" + ] + } + ], + "securityDefinitions": { + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://management.azure.com//.default": "" + } + } + }, + "tags": [], + "paths": { + "/device-location/location:verify": { + "post": { + "operationId": "DeviceLocation_Verify", + "description": "Verifies whether a device is within a specified location area, defined as an accuracy (radius) around a point, specified by longitude and latitude.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "$ref": "#/parameters/ApcGatewayIdHeader" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceLocationVerificationContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceLocationVerificationResult" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "DeviceLocation_Verify": { + "$ref": "./examples/DeviceLocation_Verify_MaximumSet_Gen.json" + } + } + } + }, + "/device-network/network:retrieve": { + "post": { + "operationId": "DeviceNetwork_Retrieve", + "description": "Retrieves the network a given device is on. Returns network in a networkCode format that can be used for other APIs.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "$ref": "#/parameters/ApcGatewayIdHeader" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkIdentifier" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkRetrievalResult" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "DeviceNetwork_Retrieve": { + "$ref": "./examples/DeviceNetwork_Retrieve_MaximumSet_Gen.json" + } + } + } + }, + "/number-verification/number:verify": { + "post": { + "operationId": "NumberVerification_VerifyWithoutCode", + "description": "Verifies the phone number (MSISDN) associated with a device. As part of the frontend authorization flow, the device is redirected to the operator network to authenticate directly.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "$ref": "#/parameters/ApcGatewayIdHeader" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NumberVerificationWithoutCodeContent" + } + } + ], + "responses": { + "302": { + "description": "Redirection", + "headers": { + "location": { + "type": "string", + "format": "uri", + "description": "The URI of the network's authorization endpoint, which should be followed by the front-end application." + }, + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "NumberVerification_VerifyWithoutCode": { + "$ref": "./examples/NumberVerification_VerifyWithoutCode_MaximumSet_Gen.json" + } + } + } + }, + "/sim-swap/sim-swap:retrieve": { + "post": { + "operationId": "SimSwap_Retrieve", + "description": "Provides timestamp of latest SIM swap", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "$ref": "#/parameters/ApcGatewayIdHeader" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SimSwapRetrievalContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SimSwapRetrievalResult" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SimSwap_Retrieve": { + "$ref": "./examples/SimSwap_Retrieve_MaximumSet_Gen.json" + } + } + } + }, + "/sim-swap/sim-swap:verify": { + "post": { + "operationId": "SimSwap_Verify", + "description": "Verifies if a SIM swap has been performed during a past period (defined in the request with 'maxAgeHours' attribute). Returns 'True' if a SIM swap has occured.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "$ref": "#/parameters/ApcGatewayIdHeader" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SimSwapVerificationContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SimSwapVerificationResult" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SimSwap_Verify": { + "$ref": "./examples/SimSwap_Verify_MaximumSet_Gen.json" + } + } + } + } + }, + "x-ms-paths": { + "/number-verification/number:verify?_overload=verifyWithCode": { + "post": { + "operationId": "NumberVerification_VerifyWithCode", + "description": "Verifies the phone number (MSISDN) associated with a device.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" + }, + { + "$ref": "#/parameters/ApcGatewayIdHeader" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NumberVerificationWithCodeContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/NumberVerificationResult" + }, + "headers": { + "x-ms-client-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, client-generated string identifier for the request." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "NumberVerification_VerifyWithCode": { + "$ref": "./examples/NumberVerification_VerifyWithCode_MaximumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "ApcError": { + "type": "object", + "description": "A custom error for APC.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + }, + "consentUrl": { + "type": "string", + "format": "uri", + "description": "The consent URL in case of a consent failure" + } + }, + "required": [ + "code", + "message" + ] + }, + "ApcErrorResponse": { + "type": "object", + "description": "A custom error response for APC.", + "properties": { + "error": { + "$ref": "#/definitions/ApcError", + "description": "Error returned by APC" + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "DeviceLocationEndpoint": { + "type": "object", + "description": "Static endpoint to access the Device Location API family.", + "properties": { + "location": { + "type": "string", + "description": "Static endpoint", + "enum": [ + "location" + ], + "x-ms-enum": { + "modelAsString": false + }, + "readOnly": true + } + }, + "required": [ + "location" + ] + }, + "DeviceLocationVerificationContent": { + "type": "object", + "description": "Request to verify Location", + "properties": { + "networkIdentifier": { + "$ref": "#/definitions/NetworkIdentifier", + "description": "Network to query for this device, or device information to enable network routing." + }, + "latitude": { + "type": "number", + "format": "double", + "description": "Latitude of location to be verified", + "minimum": -90, + "maximum": 90 + }, + "longitude": { + "type": "number", + "format": "double", + "description": "Longitude of location to be verified", + "minimum": -180, + "maximum": 180 + }, + "accuracy": { + "type": "integer", + "format": "int32", + "description": "Accuracy expected for location verification in kilometers", + "minimum": 2, + "maximum": 100 + }, + "device": { + "$ref": "#/definitions/LocationDevice", + "description": "The device to find the location for. Exactly one of Network Access Code, Phone Number, IPv4 address, or IPv6 address" + } + }, + "required": [ + "networkIdentifier", + "latitude", + "longitude", + "accuracy", + "device" + ] + }, + "DeviceLocationVerificationResult": { + "type": "object", + "description": "Response verifying location", + "properties": { + "verificationResult": { + "type": "boolean", + "description": "True if the location is in the specified area, False otherwise" + } + }, + "required": [ + "verificationResult" + ] + }, + "DeviceNetworkRetrievalEndpoint": { + "type": "object", + "description": "Static endpoint to access the Device Network API family.", + "properties": { + "network": { + "type": "string", + "description": "Static endpoint", + "enum": [ + "network" + ], + "x-ms-enum": { + "modelAsString": false + }, + "readOnly": true + } + }, + "required": [ + "network" + ] + }, + "Ipv4Address": { + "type": "object", + "description": "IPv4 device indicator", + "properties": { + "ipv4": { + "type": "string", + "description": "An IPv4 address. This may be specified as an exact address, or as a subnet in CIDR notation." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "User equipment port." + } + }, + "required": [ + "ipv4", + "port" + ] + }, + "Ipv4AddressModel": { + "type": "object", + "description": "IPv4 address and port of the device", + "properties": { + "ipv4Address": { + "$ref": "#/definitions/Ipv4Address", + "description": "The Ipv4 address" + } + } + }, + "Ipv6Address": { + "type": "object", + "description": "IPv6 device indicator", + "properties": { + "ipv6": { + "type": "string", + "description": "An IPv6 address. This may be specified as an exact address, or as a subnet in CIDR notation." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "User equipment port." + } + }, + "required": [ + "ipv6", + "port" + ] + }, + "Ipv6AddressModel": { + "type": "object", + "description": "IPv4 address and port of the device", + "properties": { + "ipv6Address": { + "$ref": "#/definitions/Ipv6Address", + "description": "The Ipv6 address" + } + } + }, + "LocationDevice": { + "type": "object", + "description": "Device information needed by operator to provide location information. Include exactly one of these properties to identify your device.", + "properties": { + "networkAccessIdentifier": { + "type": "string", + "description": "External identifier or network access identifier of the device" + }, + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + }, + "ipv4Address": { + "$ref": "#/definitions/Ipv4Address", + "description": "The Ipv4 address" + }, + "ipv6Address": { + "$ref": "#/definitions/Ipv6Address", + "description": "The Ipv6 address" + } + } + }, + "NetworkAccessIdentifierModel": { + "type": "object", + "description": "The network access ID/external ID of the device", + "properties": { + "networkAccessIdentifier": { + "type": "string", + "description": "External identifier or network access identifier of the device" + } + } + }, + "NetworkIdentifier": { + "type": "object", + "description": "Identifier for the network to be queried", + "properties": { + "identifierType": { + "type": "string", + "description": "The type of identifier for the network. one of: 'IPv4', 'IPv6', 'NetworkCode'" + }, + "identifier": { + "type": "string", + "description": "The network identifier, based on the identifierType: an IPv4 address, and IPv6 address, or a Network Code.\nA Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint." + } + }, + "required": [ + "identifierType", + "identifier" + ] + }, + "NetworkRetrievalResult": { + "type": "object", + "description": "The network that the device is on.", + "properties": { + "networkCode": { + "type": "string", + "description": "The identifier for the network. This can be used as the networkIdentifier for the service APIs.", + "pattern": "[a-z0-9-]+$" + } + }, + "required": [ + "networkCode" + ] + }, + "NumberDevice": { + "type": "object", + "description": "Device information to verify phone number. Include exactly one form of phone number.", + "properties": { + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + }, + "hashedPhoneNumber": { + "type": "string", + "description": "Hashed phone number. SHA-256 (in hexadecimal representation) of the mobile phone number in **E.164 format (starting with country code)**. Optionally prefixed with '+'." + } + } + }, + "NumberVerificationEndpoint": { + "type": "object", + "description": "Static endpoint to access Number Verification API family", + "properties": { + "number": { + "type": "string", + "description": "Static endpoint", + "enum": [ + "number" + ], + "x-ms-enum": { + "modelAsString": false + }, + "readOnly": true + } + }, + "required": [ + "number" + ] + }, + "NumberVerificationResult": { + "type": "object", + "description": "Response verifying number of device", + "properties": { + "verificationResult": { + "type": "boolean", + "description": "True if number if the phone number matches the device, False otherwise" + } + }, + "required": [ + "verificationResult" + ] + }, + "NumberVerificationWithCodeContent": { + "type": "object", + "description": "Request to verify number of device - second call", + "properties": { + "apcCode": { + "type": "string", + "description": "The code provided by APC in exchange for the operator code." + } + }, + "required": [ + "apcCode" + ] + }, + "NumberVerificationWithoutCodeContent": { + "type": "object", + "description": "Request to verify number of device - first call", + "properties": { + "networkIdentifier": { + "$ref": "#/definitions/NetworkIdentifier", + "description": "Identifier for the network to query for this device." + }, + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + }, + "hashedPhoneNumber": { + "type": "string", + "description": "Hashed phone number. SHA-256 (in hexadecimal representation) of the mobile phone number in **E.164 format (starting with country code)**. Optionally prefixed with '+'." + }, + "redirectUri": { + "type": "string", + "format": "uri", + "description": "Redirect URI to backend application." + } + }, + "required": [ + "networkIdentifier", + "redirectUri" + ] + }, + "PhoneNumberModel": { + "type": "object", + "description": "The phone number of the device.", + "properties": { + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + } + } + }, + "SimSwapDevice": { + "type": "object", + "description": "Device information needed by operator to find sim swap information.", + "properties": { + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + } + } + }, + "SimSwapEndpoint": { + "type": "object", + "description": "Static endpoint to access the Sim Swap API family", + "properties": { + "simSwap": { + "type": "string", + "description": "Static endpoint", + "enum": [ + "sim-swap" + ], + "x-ms-enum": { + "modelAsString": false + }, + "readOnly": true + } + }, + "required": [ + "simSwap" + ] + }, + "SimSwapRetrievalContent": { + "type": "object", + "description": "Request to retrieve SimSwap date", + "properties": { + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + }, + "networkIdentifier": { + "$ref": "#/definitions/NetworkIdentifier", + "description": "Network to query for this device" + } + }, + "required": [ + "networkIdentifier" + ] + }, + "SimSwapRetrievalResult": { + "type": "object", + "description": "Response with SimSwap date", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Datetime of most recent swap for SIM" + } + } + }, + "SimSwapVerificationContent": { + "type": "object", + "description": "Request to verify SimSwap in period", + "properties": { + "phoneNumber": { + "type": "string", + "description": "Phone number in E.164 format (starting with country code), and optionally prefixed with '+'", + "pattern": "^\\+?[0-9]{5,15}$" + }, + "maxAgeHours": { + "type": "integer", + "format": "int32", + "description": "Maximum lookback for SimSwap verification", + "default": 240, + "minimum": 1, + "maximum": 2400 + }, + "networkIdentifier": { + "$ref": "#/definitions/NetworkIdentifier", + "description": "Identifier for the network to query for this device." + } + }, + "required": [ + "networkIdentifier" + ] + }, + "SimSwapVerificationResult": { + "type": "object", + "description": "Response verifying SimSwap in period", + "properties": { + "verificationResult": { + "type": "boolean", + "description": "True if the SIM has swapped in the specified period, False otherwise" + } + }, + "required": [ + "verificationResult" + ] + } + }, + "parameters": { + "ApcGatewayIdHeader": { + "name": "apc-gateway-id", + "in": "header", + "description": "The identifier of the APC Gateway resource which should handle this request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-client-name": "apcGatewayId" + }, + "Azure.Core.ClientRequestIdHeader": { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method", + "x-ms-client-name": "clientRequestId" + }, + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/swagger-specs/programmableconnectivity/data-plane/api-set.json b/swagger-specs/programmableconnectivity/data-plane/api-set.json new file mode 100644 index 000000000..90f8fba61 --- /dev/null +++ b/swagger-specs/programmableconnectivity/data-plane/api-set.json @@ -0,0 +1 @@ +{"addition_input_file_paths": [], "input_files": ["Azure.ProgrammableConnectivity/preview/2024-02-09-preview/openapi.json"], "name": "package-2024-02-09-preview"} \ No newline at end of file diff --git a/swagger-specs/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/swagger-specs/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 9a893b74e..22ad76fcf 100644 --- a/swagger-specs/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/swagger-specs/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -1,115 +1,150 @@ { "swagger": "2.0", "info": { - "title": "Purview Data Map Service REST API Document", - "description": "Purview Data Map Service is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At the same time, Data Map helps organizations get more value from their existing investments. This spec defines REST API of Purview Data Map Service.", - "version": "2023-09-01" + "title": "Azure Analytics Purview Data Map", + "version": "2023-09-01", + "description": "Purview Data Map Service is a fully managed cloud service whose users can\ndiscover the data sources they need and understand the data sources they find.\nAt the same time, Data Map helps organizations get more value from their\nexisting investments. This spec defines REST API of Purview Data Map Service.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] }, + "schemes": [ + "https" + ], "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", + "hostTemplate": "{endpoint}/datamap/api", "useSchemePrefix": false, "parameters": [ { - "$ref": "#/parameters/endpoint" + "name": "endpoint", + "in": "path", + "required": true, + "type": "string" } ] }, - "basePath": "/datamap/api", - "schemes": [ - "https" + "produces": [ + "application/json" ], "consumes": [ "application/json" ], - "produces": [ - "application/json" + "security": [ + { + "OAuth2Auth": [ + "https://purview.azure.net/.default" + ] + } ], "securityDefinitions": { - "azure_auth": { + "OAuth2Auth": { + "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow." + "https://purview.azure.net/.default": "" + } } }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], + "tags": [], "paths": { "/atlas/v2/entity": { "post": { - "tags": [ - "Entity" - ], - "description": "Create or update an entity.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName.\nMap and array of collections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", "operationId": "Entity_CreateOrUpdate", - "x-ms-examples": { - "Entity_Create": { - "$ref": "./examples/Entity_Create.json" + "description": "Create or update an entity.\nExisting entity is matched using its unique guid if\nsupplied or by its unique attributes eg: qualifiedName.\nMap and array of\ncollections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", + "parameters": [ + { + "$ref": "#/parameters/AtlasApiVersionParameter" }, - "Entity_Update": { - "$ref": "./examples/Entity_Update.json" + { + "name": "businessAttributeUpdateBehavior", + "in": "query", + "description": "Used to define the update behavior for business attributes when updating\nentities.", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "Ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "Replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "Merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", + "required": false, + "type": "string" }, - "Entity_AddCustomAttribute": { - "$ref": "./examples/Entity_AddCustomAttribute.json" - } - }, - "parameters": [ { + "name": "body", "in": "body", - "name": "entity", - "description": "Atlas entity with extended information.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntityWithExtInfo" } - }, - { - "$ref": "#/parameters/businessAttributeUpdateBehavior" - }, - { - "$ref": "#/parameters/collectionId" - }, - { - "$ref": "#/parameters/atlasAPIVersion" } ], "responses": { "200": { - "description": "Created with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddCustomAttribute": { + "$ref": "./examples/Entity_AddCustomAttribute.json" + }, + "Entity_Create": { + "$ref": "./examples/Entity_Create.json" + }, + "Entity_CreateOrUpdateWithRichText": { + "$ref": "./examples/Entity_CreateOrUpdateWithRichText.json" + }, + "Entity_Update": { + "$ref": "./examples/Entity_Update.json" + } } } }, "/atlas/v2/entity/bulk": { "get": { - "tags": [ - "Entity" - ], - "description": "List entities in bulk identified by its GUIDs.", "operationId": "Entity_ListByGuids", - "x-ms-examples": { - "Entity_ListByGuids": { - "$ref": "./examples/Entity_ListByGuids.json" - } - }, + "description": "List entities in bulk identified by its GUIDs.", "parameters": [ + { + "$ref": "#/parameters/AtlasApiVersionParameter" + }, { "name": "guid", "in": "query", @@ -119,91 +154,122 @@ "items": { "type": "string" }, - "collectionFormat": "multi", - "x-ms-client-name": "guids" - }, - { - "$ref": "#/parameters/minExtInfo" + "collectionFormat": "multi" }, { - "$ref": "#/parameters/ignoreRelationships" + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/atlasAPIVersion" + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" } ], "responses": { "200": { - "description": "OK.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasEntitiesWithExtInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_ListByGuids": { + "$ref": "./examples/Entity_ListByGuids.json" + } } }, "post": { - "tags": [ - "Entity" - ], - "description": "Create or update entities in bulk.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName.\nMap and array of collections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", "operationId": "Entity_BulkCreateOrUpdate", - "x-ms-examples": { - "Entity_BulkCreateOrUpdate": { - "$ref": "./examples/Entity_BulkCreateOrUpdate.json" - } - }, + "description": "Create or update entities in bulk.\nExisting entity is matched using its unique\nguid if supplied or by its unique attributes eg: qualifiedName.\nMap and array\nof collections are not well supported. E.g., array>,\narray>.\nFor each contact type, the maximum number of contacts\nis 20.", "parameters": [ { - "in": "body", - "name": "entities", - "description": "An array of entities to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/collectionId" + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/atlasAPIVersion" + "name": "businessAttributeUpdateBehavior", + "in": "query", + "description": "Used to define the update behavior for business attributes when updating\nentities.", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "Ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "Replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "Merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } }, { - "$ref": "#/parameters/businessAttributeUpdateBehavior" + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } } ], "responses": { "200": { - "description": "Ok.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_BulkCreateOrUpdate": { + "$ref": "./examples/Entity_BulkCreateOrUpdate.json" + } } }, "delete": { - "tags": [ - "Entity" - ], - "description": "Delete a list of entities in bulk identified by their GUIDs or unique attributes.", "operationId": "Entity_BulkDelete", - "x-ms-examples": { - "Entity_BulkDelete": { - "$ref": "./examples/Entity_BulkDelete.json" - } - }, + "description": "Delete a list of entities in bulk identified by their GUIDs or unique\nattributes.", "parameters": [ { "name": "guid", @@ -214,1406 +280,1397 @@ "items": { "type": "string" }, - "collectionFormat": "multi", - "x-ms-client-name": "guids" + "collectionFormat": "multi" } ], "responses": { "200": { - "description": "Deleted with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_BulkDelete": { + "$ref": "./examples/Entity_BulkDelete.json" + } } } }, "/atlas/v2/entity/bulk/classification": { "post": { - "tags": [ - "Entity" - ], - "description": "Associate a classification to multiple entities in bulk.", "operationId": "Entity_AddClassification", - "x-ms-examples": { - "Entity_AddClassificationToEntityByGuids": { - "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" - } - }, + "description": "Associate a classification to multiple entities in bulk.", "parameters": [ { + "name": "body", "in": "body", - "name": "request", - "description": "The request to associate a classification to multiple entities.", "required": true, "schema": { - "$ref": "#/definitions/ClassificationAssociateRequest" + "$ref": "#/definitions/ClassificationAssociateOptions" } } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddClassificationToEntityByGuids": { + "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" + } } } }, - "/atlas/v2/entity/guid/{guid}": { - "get": { - "tags": [ - "Entity" - ], - "operationId": "Entity_Get", - "x-ms-examples": { - "Entity_Get": { - "$ref": "./examples/Entity_Get.json" - } - }, - "description": "Get complete definition of an entity given its GUID.", + "/atlas/v2/entity/bulk/setClassifications": { + "post": { + "operationId": "Entity_BulkSetClassifications", + "description": "Set classifications on entities in bulk.", "parameters": [ { - "$ref": "#/parameters/guid" - }, - { - "$ref": "#/parameters/minExtInfo" - }, - { - "$ref": "#/parameters/ignoreRelationships" + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityHeaders" + } } ], "responses": { "200": { - "description": "OK.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" + "type": "array", + "items": { + "type": "string" + } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "description": "Update entity partially - create or update entity attribute identified by its GUID.\nSupports only primitive attribute type and entity references.\nIt does not support updating complex types like arrays, and maps.\nNull updates are not possible.", - "operationId": "Entity_PartialUpdateAttributeByGuid", + }, "x-ms-examples": { - "Entity_PartialUpdateEntityAttributeByGuid": { - "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" + "Entity_BulkSetClassifications": { + "$ref": "./examples/Entity_BulkSetClassifications.json" } - }, + } + } + }, + "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Entity_ListByUniqueAttributes", + "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following\nformat\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE:\nThe attrName should be an unique attribute for the given entity-type.\nThe REST\nrequest would look something like this\n\nGET\n/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote:\nat least one unique attribute must be provided.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" }, { - "name": "name", + "name": "minExtInfo", "in": "query", - "description": "The name of the attribute.", - "required": true, - "type": "string" + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" }, { - "in": "body", - "name": "body", - "description": "The value of the attribute.", - "required": true, - "schema": { - "type": "object" - } + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + }, + { + "name": "attr_N:qualifiedName", + "in": "query", + "description": "Qualified name of an entity. E.g. to find 2 entities you can set\nattrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an\nexample. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "Updated with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Entity" - ], - "description": "Delete an entity identified by its GUID.", - "operationId": "Entity_Delete", + }, "x-ms-examples": { - "Entity_Delete": { - "$ref": "./examples/Entity_Delete.json" + "Entity_ListByUniqueAttributes": { + "$ref": "./examples/Entity_ListByUniqueAttributes.json" } - }, + } + } + }, + "/atlas/v2/entity/businessmetadata/import": { + "post": { + "operationId": "Entity_ImportBusinessMetadata", + "description": "Upload the file for creating Business Metadata in BULK", + "consumes": [ + "multipart/form-data" + ], "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/BusinessMetadataOptions" } ], "responses": { "200": { - "description": "Deleted with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/BulkImportResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_ImportBusinessMetadata": { + "$ref": "./examples/Entity_ImportBusinessMetadata.json" + } } } }, - "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { + "/atlas/v2/entity/businessmetadata/import/template": { "get": { - "tags": [ - "Entity" - ], - "description": "Get classification for a given entity represented by a GUID.", - "operationId": "Entity_GetClassification", - "x-ms-examples": { - "Entity_GetClassification": { - "$ref": "./examples/Entity_GetClassification.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/guid" - }, - { - "$ref": "#/parameters/classificationName" - } + "operationId": "Entity_GetSampleBusinessMetadataTemplate", + "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", + "produces": [ + "application/octet-stream", + "application/json" ], + "parameters": [], "responses": { "200": { - "description": "The classification for the given entity GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasClassification" + "type": "file" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Entity" - ], - "description": "Delete a given classification from an existing entity represented by a GUID.", - "operationId": "Entity_RemoveClassification", + }, "x-ms-examples": { - "Entity_RemoveClassification": { - "$ref": "./examples/Entity_RemoveClassification.json" + "Entity_GetSampleBusinessMetadataTemplate": { + "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" } - }, + } + } + }, + "/atlas/v2/entity/guid/{guid}": { + "get": { + "operationId": "Entity_Get", + "description": "Get complete definition of an entity given its GUID.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/classificationName" + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" } ], "responses": { - "204": { - "description": "No Content." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/guid/{guid}/classifications": { - "get": { - "tags": [ - "Entity" - ], - "description": "List classifications for a given entity represented by a GUID.", - "operationId": "Entity_GetClassifications", + }, "x-ms-examples": { - "Entity_GetClassifications": { - "$ref": "./examples/Entity_GetClassifications.json" + "Entity_Get": { + "$ref": "./examples/Entity_Get.json" } - }, + } + }, + "put": { + "operationId": "Entity_PartialUpdateAttributeByGuid", + "description": "Update entity partially - create or update entity attribute identified by its\nGUID.\nSupports only primitive attribute type and entity references.\nIt does not support updating complex types like arrays, and maps.\nNull updates are not possible.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "query", + "description": "The name of the attribute.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The value of the attribute.", + "required": true, + "schema": {} } ], "responses": { "200": { - "description": "An array of classifications for the given entity GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasClassifications" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_PartialUpdateAttributeByGuid": { + "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" + } } }, - "post": { - "tags": [ - "Entity" + "delete": { + "operationId": "Entity_Delete", + "description": "Delete an entity identified by its GUID.", + "parameters": [ + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } ], - "description": "Add classifications to an existing entity represented by a GUID.", - "operationId": "Entity_AddClassifications", - "x-ms-examples": { - "Entity_AddClassifications": { - "$ref": "./examples/Entity_AddClassifications.json" + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, + "x-ms-examples": { + "Entity_Delete": { + "$ref": "./examples/Entity_Delete.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/businessmetadata": { + "post": { + "operationId": "Entity_AddOrUpdateBusinessMetadata", + "description": "Add business metadata to an entity.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "isOverwrite", + "in": "query", + "description": "Whether to overwrite the existing business metadata on the entity or not,\ndefault is false.", + "required": false, + "type": "boolean", + "x-ms-client-name": "overwrite" }, { + "name": "body", "in": "body", - "name": "classifications", - "description": "An array of classifications to be added.", + "description": "BusinessMetadata payload", "required": true, "schema": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" + "type": "object", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" } } } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "description": "Update classifications to an existing entity represented by a guid.", - "operationId": "Entity_UpdateClassifications", + }, "x-ms-examples": { - "Entity_UpdateClassifications": { - "$ref": "./examples/Entity_UpdateClassifications.json" + "Entity_AddOrUpdate_BusinessMetadata": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessMetadata.json" } - }, + } + }, + "delete": { + "operationId": "Entity_RemoveBusinessMetadata", + "description": "Remove business metadata from an entity.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { + "name": "body", "in": "body", - "name": "classifications", - "description": "An array of classifications to be updated.", + "description": "Business metadata payload", "required": true, "schema": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" + "type": "object", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" } } } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_RemoveBusinessMetadata": { + "$ref": "./examples/Entity_RemoveBusinessMetadata.json" + } } } }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { - "get": { - "tags": [ - "Entity" - ], - "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:\nattr:\\=.\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this:\nGET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "operationId": "Entity_GetByUniqueAttributes", - "x-ms-examples": { - "Entity_GetByUniqueAttributes": { - "$ref": "./examples/Entity_GetByUniqueAttributes.json" - } - }, + "/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}": { + "post": { + "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", + "description": "Add or update business metadata attributes.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "$ref": "#/parameters/minExtInfo" + "name": "businessMetadataName", + "in": "path", + "description": "BusinessMetadata name", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ignoreRelationships" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, - "type": "string" + "name": "body", + "in": "body", + "description": "Business metadata attribute payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": {} + } } ], "responses": { - "200": { - "description": "AtlasEntityWithExtInfo.", - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "description": "Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:\n\nattr:=.\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this:\nPUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "operationId": "Entity_PartialUpdateByUniqueAttributes", + }, "x-ms-examples": { - "Entity_PartialUpdateEntityByUniqueAttributes": { - "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" + "Entity_AddOrUpdate_BusinessAttribute": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" } - }, + } + }, + "delete": { + "operationId": "Entity_RemoveBusinessMetadataAttributes", + "description": "Delete business metadata attributes from an entity.", "parameters": [ { - "$ref": "#/parameters/typeName" + "name": "businessMetadataName", + "in": "path", + "description": "BusinessMetadata name", + "required": true, + "type": "string" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, "type": "string" }, { + "name": "body", "in": "body", - "name": "atlasEntityWithExtInfo", - "description": "Atlas entity with extended information.", + "description": "Business metadata attribute payload", "required": true, "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" + "type": "object", + "additionalProperties": {} } } ], "responses": { - "200": { - "description": "Updated with EntityMutationResponse.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Entity" - ], - "description": "Delete an entity identified by its type and unique attributes.\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:\nattr:\\=\\.\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this:\nDELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "operationId": "Entity_DeleteByUniqueAttribute", + }, "x-ms-examples": { - "Entity_DeleteByUniqueAttribute": { - "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" + "Entity_RemoveBusinessAttribute": { + "$ref": "./examples/Entity_RemoveBusinessAttribute.json" } - }, + } + } + }, + "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { + "get": { + "operationId": "Entity_GetClassification", + "description": "Get classification for a given entity represented by a GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, "type": "string" } ], "responses": { "200": { - "description": "Deleted with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/AtlasClassification" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_GetClassification": { + "$ref": "./examples/Entity_GetClassification.json" + } } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { + }, "delete": { - "tags": [ - "Entity" - ], - "description": "Delete a given classification from an entity identified by its type and unique attributes.", - "operationId": "Entity_RemoveClassificationByUniqueAttribute", - "x-ms-examples": { - "Entity_RemoveClassificationByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" - } - }, + "operationId": "Entity_RemoveClassification", + "description": "Delete a given classification from an existing entity represented by a GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "$ref": "#/parameters/classificationName" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, "type": "string" } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_RemoveClassification": { + "$ref": "./examples/Entity_RemoveClassification.json" + } } } }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { - "post": { - "tags": [ - "Entity" - ], - "description": "Add classification to the entity identified by its type and unique attributes.", - "operationId": "Entity_AddClassificationsByUniqueAttribute", - "x-ms-examples": { - "Entity_AddClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" - } - }, + "/atlas/v2/entity/guid/{guid}/classifications": { + "get": { + "operationId": "Entity_GetClassifications", + "description": "List classifications for a given entity represented by a GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, - "type": "string" - }, - { - "in": "body", - "name": "atlasClassificationArray", - "description": "An array of classification to be added.", + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", "required": true, - "schema": { - "type": "array", - "description": "An array of classification.", - "items": { - "$ref": "#/definitions/AtlasClassification" - } - } + "type": "string" } ], "responses": { - "204": { - "description": "No Content." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassifications" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_GetClassifications": { + "$ref": "./examples/Entity_GetClassifications.json" + } } }, "put": { - "tags": [ - "Entity" - ], - "description": "Update classification on an entity identified by its type and unique attributes.", - "operationId": "Entity_UpdateClassificationsByUniqueAttribute", - "x-ms-examples": { - "Entity_UpdateClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" - } - }, + "operationId": "Entity_UpdateClassifications", + "description": "Update classifications to an existing entity represented by a guid.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, "type": "string" }, { + "name": "body", "in": "body", - "name": "atlasClassificationArray", - "description": "An array of classification to be updated.", + "description": "An array of classifications to be updated.", "required": true, "schema": { "type": "array", - "description": "An array of classification.", "items": { "$ref": "#/definitions/AtlasClassification" - } + }, + "x-ms-identifiers": [] } } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/bulk/setClassifications": { - "post": { - "tags": [ - "Entity" - ], - "description": "Set classifications on entities in bulk.", - "operationId": "Entity_BulkSetClassifications", + }, "x-ms-examples": { - "Entity_BulkSetClassifications": { - "$ref": "./examples/Entity_BulkSetClassifications.json" + "Entity_UpdateClassifications": { + "$ref": "./examples/Entity_UpdateClassifications.json" } - }, + } + }, + "post": { + "operationId": "Entity_AddClassifications", + "description": "Add classifications to an existing entity represented by a GUID.", "parameters": [ { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", "in": "body", - "name": "entityHeaders", - "description": "Atlas entity headers.", + "description": "An array of classifications to be added.", "required": true, "schema": { - "$ref": "#/definitions/AtlasEntityHeaders" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] } } ], "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "description": "Response that indicates each classification mutation result.", - "items": { - "type": "string" - } - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddClassifications": { + "$ref": "./examples/Entity_AddClassifications.json" + } } } }, - "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { + "/atlas/v2/entity/guid/{guid}/header": { "get": { - "tags": [ - "Entity" - ], - "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE: The attrName should be an unique attribute for the given entity-type.\nThe REST request would look something like this\n\nGET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote: at least one unique attribute must be provided.", - "operationId": "Entity_ListByUniqueAttributes", - "x-ms-examples": { - "Entity_ListByUniqueAttributes": { - "$ref": "./examples/Entity_ListByUniqueAttributes.json" - } - }, + "operationId": "Entity_GetHeader", + "description": "Get entity header given its GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "$ref": "#/parameters/minExtInfo" - }, - { - "$ref": "#/parameters/ignoreRelationships" - }, - { - "name": "attr_N:qualifiedName", - "in": "query", - "description": "Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, "type": "string" } ], "responses": { "200": { - "description": "OK.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + "$ref": "#/definitions/AtlasEntityHeader" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/guid/{guid}/header": { - "get": { - "tags": [ - "Entity" - ], - "description": "Get entity header given its GUID.", - "operationId": "Entity_GetHeader", + }, "x-ms-examples": { "Entity_GetHeader": { "$ref": "./examples/Entity_GetHeader.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/guid" - } - ], - "responses": { - "200": { - "schema": { - "$ref": "#/definitions/AtlasEntityHeader" - }, - "description": "AtlasEntityHeader" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } } } }, - "/atlas/v2/entity/guid/{guid}/businessmetadata": { - "delete": { - "tags": [ - "Entity" - ], - "description": "Remove business metadata from an entity.", - "operationId": "Entity_RemoveBusinessMetadata", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_RemoveBusinessMetadata": { - "$ref": "./examples/Entity_RemoveBusinessMetadata.json" - } - }, + "/atlas/v2/entity/guid/{guid}/labels": { + "put": { + "operationId": "Entity_AddLabel", + "description": "Add given labels to a given entity.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "businessMetadata", - "required": false, + "name": "body", "in": "body", + "description": "set of labels to be added", + "required": false, "schema": { - "$ref": "#/definitions/BusinessMetadata" + "type": "array", + "items": { + "type": "string" + } } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddLabel": { + "$ref": "./examples/Entity_AddLabel.json" + } } }, "post": { - "tags": [ - "Entity" - ], - "description": "Add business metadata to an entity.", - "operationId": "Entity_AddOrUpdateBusinessMetadata", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_AddOrUpdateBusinessMetadata": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" - } - }, + "operationId": "Entity_SetLabels", + "description": "Set labels to a given entity.", "parameters": [ { - "$ref": "#/parameters/guid" - }, - { - "in": "query", - "type": "boolean", - "name": "isOverwrite", - "description": "Whether to overwrite the existing business metadata on the entity or not, default is false.", - "required": false + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "businessMetadata", - "required": false, + "name": "body", "in": "body", + "description": "set of labels to be set to the entity", + "required": false, "schema": { - "$ref": "#/definitions/BusinessMetadata" + "type": "array", + "items": { + "type": "string" + } } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_SetLabels": { + "$ref": "./examples/Entity_SetLabels.json" + } } - } - }, - "/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}": { + }, "delete": { - "tags": [ - "Entity" - ], - "description": "Delete business metadata attributes from an entity.", - "operationId": "Entity_RemoveBusinessMetadataAttributes", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_RemoveBusinessAttribute": { - "$ref": "./examples/Entity_RemoveBusinessAttribute.json" - } - }, + "operationId": "Entity_RemoveLabels", + "description": "Delete given labels to a given entity.", "parameters": [ { - "name": "bmName", + "name": "guid", "in": "path", - "type": "string", - "description": "BusinessMetadata name", - "required": true - }, - { - "$ref": "#/parameters/guid" + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "businessMetadataAttributes", - "required": false, + "name": "body", "in": "body", + "description": "set of labels to be deleted", + "required": false, "schema": { - "$ref": "#/definitions/BusinessMetadataAttributes" + "type": "array", + "items": { + "type": "string" + } } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "post": { - "tags": [ - "Entity" - ], - "description": "Add or update business metadata attributes.", - "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", - "consumes": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_AddOrUpdateBusinessAttribute": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" + "Entity_RemoveLabels": { + "$ref": "./examples/Entity_RemoveLabels.json" } - }, + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Entity_GetByUniqueAttributes", + "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following format:\nattr:\\=.\n\nNOTE: The\nattrName and attrValue should be unique across entities, eg.\nqualifiedName.\n\nThe REST request would look something like this:\nGET\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "name": "bmName", + "name": "typeName", "in": "path", - "type": "string", - "description": "BusinessMetadata name", - "required": true + "description": "The name of the type.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/guid" + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" }, { - "name": "businessMetadataAttributes", + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", "required": false, - "in": "body", - "schema": { - "$ref": "#/definitions/BusinessMetadataAttributes" - } + "type": "boolean" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" } ], "responses": { - "204": { - "description": "Success" + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/businessmetadata/import/template": { - "get": { - "tags": [ - "Entity" - ], - "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", - "operationId": "Entity_GetSampleBusinessMetadataTemplate", - "produces": [ - "application/octet-stream" - ], + }, "x-ms-examples": { - "Entity_GetSampleBusinessMetadataTemplate": { - "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" + "Entity_GetByUniqueAttributes": { + "$ref": "./examples/Entity_GetByUniqueAttributes.json" } - }, - "parameters": [], + } + }, + "put": { + "operationId": "Entity_PartialUpdateByUniqueAttributes", + "description": "Update entity partially - Allow a subset of attributes to be updated on an\nentity which is identified by its type and unique attribute eg:\nReferenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\n\nattr:=.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nPUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + } + ], "responses": { "200": { + "description": "The request has succeeded.", "schema": { - "description": "Template File", - "type": "file" - }, - "description": "Template File" + "$ref": "#/definitions/EntityMutationResult" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/businessmetadata/import": { - "post": { - "tags": [ - "Entity" - ], - "description": "Upload the file for creating Business Metadata in BULK", - "operationId": "Entity_ImportBusinessMetadata", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_ImportBusinessMetadata": { - "$ref": "./examples/Entity_ImportBusinessMetadata.json" + "Entity_PartialUpdateByUniqueAttributes": { + "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" } - }, + } + }, + "delete": { + "operationId": "Entity_DeleteByUniqueAttribute", + "description": "Delete an entity identified by its type and unique attributes.\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\nattr:\\=\\.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nDELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "name": "uploadedInputStream", - "in": "formData", - "type": "file", - "description": "InputStream of file" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" } ], "responses": { "200": { + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/BulkImportResponse", - "description": "If Business Metadata creation was successful" - }, - "description": "If Business Metadata creation was successful" + "$ref": "#/definitions/EntityMutationResult" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_DeleteByUniqueAttribute": { + "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" + } } } }, - "/atlas/v2/entity/guid/{guid}/labels": { + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { "delete": { - "tags": [ - "Entity" - ], - "description": "Delete given labels to a given entity.", - "operationId": "Entity_RemoveLabels", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_RemoveLabels": { - "$ref": "./examples/Entity_Label.json" - } - }, + "operationId": "Entity_RemoveClassificationByUniqueAttribute", + "description": "Delete a given classification from an entity identified by its type and unique\nattributes.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" }, { - "name": "body", + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, - "in": "body", - "schema": { - "description": "set of labels to be deleted", - "type": "array", - "items": { - "type": "string" - } - }, - "description": "set of labels to be deleted" + "type": "string", + "x-ms-client-name": "attribute" } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "post": { - "tags": [ - "Entity" - ], - "description": "Set labels to a given entity.", - "operationId": "Entity_SetLabels", - "consumes": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_SetLabel": { - "$ref": "./examples/Entity_Label.json" + "Entity_RemoveClassificationByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" } - }, + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { + "put": { + "operationId": "Entity_UpdateClassificationsByUniqueAttribute", + "description": "Update classification on an entity identified by its type and unique attributes.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" }, { "name": "body", - "required": false, "in": "body", + "description": "An array of classification to be updated.", + "required": true, "schema": { - "description": "set of labels to be set to the entity", "type": "array", "items": { - "type": "string" - } - }, - "description": "set of labels to be set to the entity" + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "description": "Add given labels to a given entity.", - "operationId": "Entity_AddLabel", - "consumes": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_AddLabel": { - "$ref": "./examples/Entity_Label.json" + "Entity_UpdateClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" } - }, + } + }, + "post": { + "operationId": "Entity_AddClassificationsByUniqueAttribute", + "description": "Add classification to the entity identified by its type and unique attributes.", "parameters": [ { - "$ref": "#/parameters/guid" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" }, { - "name": "body", + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, + "type": "string", + "x-ms-client-name": "attribute" + }, + { + "name": "body", "in": "body", + "description": "An array of classification to be added.", + "required": true, "schema": { - "description": "set of labels to be added", "type": "array", "items": { - "type": "string" - } - }, - "description": "set of labels to be added" + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" + } } } }, "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels": { - "delete": { - "tags": [ - "Entity" - ], - "operationId": "Entity_RemoveLabelsByUniqueAttribute", - "description": "Delete given labels to a given entity identified by its type and unique attribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_RemoveLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" - } - }, + "put": { + "operationId": "Entity_AddLabelsByUniqueAttribute", + "description": "Add given labels to a given entity identified by its type and unique\nattributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: PUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/typeName" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" }, { "name": "attr:qualifiedName", "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, - "type": "string" + "type": "string", + "x-ms-client-name": "attribute" }, { "name": "body", - "required": false, "in": "body", + "description": "set of labels to be added", + "required": false, "schema": { - "description": "set of labels to be deleted", "type": "array", "items": { "type": "string" } - }, - "description": "set of labels to be deleted" + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" + } } }, "post": { - "tags": [ - "Entity" - ], "operationId": "Entity_SetLabelsByUniqueAttribute", - "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf labels is null/empty, existing labels will all be removed.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=.\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_SetLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" - } - }, + "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf\nlabels is null/empty, existing labels will all be removed.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: POST\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/typeName" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" }, { "name": "attr:qualifiedName", "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, - "type": "string" + "type": "string", + "x-ms-client-name": "attribute" }, { "name": "body", - "required": false, "in": "body", + "description": "set of labels to be set", + "required": false, "schema": { - "description": "set of labels to be set", "type": "array", "items": { "type": "string" } - }, - "description": "set of labels to be set" + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "operationId": "Entity_AddLabelsByUniqueAttribute", - "description": "Add given labels to a given entity identified by its type and unique attributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=.\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "consumes": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_AddLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" + "Entity_SetLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" } - }, + } + }, + "delete": { + "operationId": "Entity_RemoveLabelsByUniqueAttribute", + "description": "Delete given labels to a given entity identified by its type and unique\nattribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels\nin labels set are non-existing labels, they will be ignored, only existing\nlabels will be removed. In addition to the typeName path parameter, attribute\nkey-value pair(s) can be provided in the following format:\nattr:=. NOTE: The attrName and attrValue should be unique\nacross entities, eg. qualifiedName. The REST request would look something like\nthis: DELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/typeName" + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" }, { "name": "attr:qualifiedName", "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, - "type": "string" + "type": "string", + "x-ms-client-name": "attribute" }, { "name": "body", - "required": false, "in": "body", + "description": "set of labels to be deleted", + "required": false, "schema": { - "description": "set of labels to be added", "type": "array", "items": { "type": "string" } - }, - "description": "set of labels to be added" + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/entity/moveTo": { - "post": { - "tags": [ - "Entity" - ], - "description": "Move existing entities to the target collection.", - "operationId": "Entity_MoveEntitiesToCollection", - "x-ms-examples": { - "Collection_MoveEntitiesToCollection": { - "$ref": "./examples/Entity_MoveEntitiesToCollection.json" - } }, - "parameters": [ - { - "$ref": "#/parameters/requiredCollectionId" - }, - { - "$ref": "#/parameters/purviewAPIVersion" - }, - { - "in": "body", - "name": "moveEntitiesRequest", - "description": "Entity guids to be moved to target collection.", - "required": true, - "schema": { - "$ref": "#/definitions/MoveEntitiesRequest" - } - } - ], - "responses": { - "200": { - "description": "Created with EntityMutationResponse.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } + "x-ms-examples": { + "Entity_RemoveLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" } } } }, "/atlas/v2/glossary": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", "operationId": "Glossary_List", - "x-ms-examples": { - "Glossary_List": { - "$ref": "./examples/Glossary_List.json" - } - }, + "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", "parameters": [ { - "$ref": "#/parameters/limit" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/offset" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/sort" + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/ignoreTermsAndCategories" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/atlasAPIVersion" + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" } ], "responses": { "200": { - "description": "An array of existing glossaries fitting the search criteria or empty list if nothing matches.", + "description": "The request has succeeded.", "schema": { "type": "array", "items": { "$ref": "#/definitions/AtlasGlossary" - } + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_List": { + "$ref": "./examples/Glossary_List.json" + } } }, "post": { - "tags": [ - "Glossary" - ], - "description": "Create a glossary.", "operationId": "Glossary_Create", - "x-ms-examples": { - "Glossary_Create": { - "$ref": "./examples/Glossary_Create.json" - } - }, + "description": "Create a glossary.", "parameters": [ { + "name": "body", "in": "body", - "name": "atlasGlossary", - "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing the anchor attribute when creating the Term/Category.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossary" @@ -1622,2179 +1679,2242 @@ ], "responses": { "200": { - "description": "OK. If glossary creation was successful.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasGlossary" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_Create": { + "$ref": "./examples/Glossary_Create.json" + } } } }, - "/atlas/v2/glossary/categories": { - "post": { - "tags": [ - "Glossary" - ], - "description": "Create glossary category in bulk.", - "operationId": "Glossary_CreateCategories", - "x-ms-examples": { - "Glossary_CreateCategories": { - "$ref": "./examples/Glossary_CreateCategories.json" - } - }, + "/atlas/v2/glossary/{glossaryId}": { + "get": { + "operationId": "Glossary_Get", + "description": "Get a specific Glossary by its GUID.", "parameters": [ { - "in": "body", - "name": "glossaryCategory", - "description": "An array of glossary category definitions to be created.", + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", "required": true, - "schema": { - "type": "array", - "description": "An array of glossary category definitions.", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - } + "type": "string" } ], "responses": { "200": { - "description": "OK. If bulk glossary category creation was successful.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "An array of glossary category created successfully in bulk.", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } + "$ref": "#/definitions/AtlasGlossary" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/category": { - "post": { - "tags": [ - "Glossary" - ], - "description": "Create a glossary category.", - "operationId": "Glossary_CreateCategory", + }, "x-ms-examples": { - "Glossary_CreateCategory": { - "$ref": "./examples/Glossary_CreateCategory.json" + "Glossary_Get": { + "$ref": "./examples/Glossary_Get.json" } - }, + } + }, + "put": { + "operationId": "Glossary_Update", + "description": "Update the given glossary.", "parameters": [ { + "$ref": "#/parameters/AtlasApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" + }, + { + "name": "body", "in": "body", - "name": "glossaryCategory", - "description": "The glossary category definition. A category must be anchored to a Glossary when creating.\nOptionally, terms belonging to the category and the hierarchy can also be defined during creation.", "required": true, "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" + "$ref": "#/definitions/AtlasGlossary" } } ], "responses": { "200": { - "description": "OK. If glossary category creation was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" + "$ref": "#/definitions/AtlasGlossary" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/category/{categoryGuid}": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get specific glossary category by its GUID.", - "operationId": "Glossary_GetCategory", + }, "x-ms-examples": { - "Glossary_GetCategory": { - "$ref": "./examples/Glossary_GetCategory.json" + "Glossary_Update": { + "$ref": "./examples/Glossary_Update.json" } - }, + } + }, + "delete": { + "operationId": "Glossary_Delete", + "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend\nseparate delete terms and categories.", "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" } ], "responses": { - "200": { - "description": "OK. If glossary category exists for given GUID.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Glossary" - ], - "description": "Update the given glossary category by its GUID.", - "operationId": "Glossary_UpdateCategory", + }, "x-ms-examples": { - "Glossary_UpdateCategory": { - "$ref": "./examples/Glossary_UpdateCategory.json" + "Glossary_Delete": { + "$ref": "./examples/Glossary_Delete.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/categoryGuid" - }, + } + } + }, + "/atlas/v2/glossary/{glossaryId}/categories": { + "get": { + "operationId": "Glossary_ListCategories", + "description": "Get the categories belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", + "parameters": [ { - "in": "body", - "name": "glossaryCategory", - "description": "The glossary category to be updated.", + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. If glossary category partial update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Glossary" - ], - "description": "Delete a glossary category.", - "operationId": "Glossary_DeleteCategory", + }, "x-ms-examples": { - "Glossary_DeleteCategory": { - "$ref": "./examples/Glossary_DeleteCategory.json" + "Glossary_ListCategories": { + "$ref": "./examples/Glossary_ListCategories.json" } - }, + } + } + }, + "/atlas/v2/glossary/{glossaryId}/categories/headers": { + "get": { + "operationId": "Glossary_ListCategoriesHeaders", + "description": "Get the category headers belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { - "204": { - "description": "OK. If glossary category deletion is successful." + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_ListCategoriesHeaders": { + "$ref": "./examples/Glossary_ListCategoriesHeaders.json" + } } } }, - "/atlas/v2/glossary/category/{categoryGuid}/partial": { - "put": { - "tags": [ - "Glossary" - ], - "description": "Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.", - "operationId": "Glossary_PartialUpdateCategory", - "x-ms-examples": { - "Glossary_PartialUpdateCategory": { - "$ref": "./examples/Glossary_PartialUpdateCategory.json" - } - }, + "/atlas/v2/glossary/{glossaryId}/detailed": { + "get": { + "operationId": "Glossary_GetDetailed", + "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.", "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "in": "body", - "name": "partialUpdates", - "description": "A map containing keys as attribute names and values as corresponding attribute values for partial update.", + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", "required": true, - "schema": { - "type": "object", - "description": "A map containing keys as attribute names and values as corresponding attribute values." - } + "type": "string" } ], "responses": { "200": { - "description": "OK. If glossary category partial update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" + "$ref": "#/definitions/AtlasGlossaryExtInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_GetDetailed": { + "$ref": "./examples/Glossary_GetDetailed.json" + } } } }, - "/atlas/v2/glossary/category/{categoryGuid}/related": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.", - "operationId": "Glossary_ListRelatedCategories", - "x-ms-examples": { - "Glossary_ListRelatedCategories": { - "$ref": "./examples/Glossary_ListRelatedCategories.json" - } - }, + "/atlas/v2/glossary/{glossaryId}/partial": { + "put": { + "operationId": "Glossary_PartialUpdate", + "description": "Update the glossary partially. Some properties such as qualifiedName are not\nallowed to be updated.\n\nSo far we only supports partial updating\nshortDescription, longDescription, language and usage for glossary. \n\nRecommend\nusing 'ignoreTermsAndCategories=true' to reduce response body size.", "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/limit" + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/offset" + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/sort" + "name": "body", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues.", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } ], "responses": { "200": { - "description": "OK. Gets an array of related categories.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/RelatedCategoryHeaders" + "$ref": "#/definitions/AtlasGlossary" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_PartialUpdate": { + "$ref": "./examples/Glossary_PartialUpdate.json" + } } } }, - "/atlas/v2/glossary/category/{categoryGuid}/terms": { + "/atlas/v2/glossary/{glossaryId}/terms": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get all terms associated with the specific category.", - "operationId": "Glossary_ListCategoryTerms", - "x-ms-examples": { - "Glossary_ListCategoryTerms": { - "$ref": "./examples/Glossary_ListCategoryTerms.json" - } - }, + "operationId": "Glossary_ListTerms", + "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get\npagination result.", "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "$ref": "#/parameters/AtlasApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/limit" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/offset" + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/sort" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "An array of terms for the given category or an empty list.", + "description": "The request has succeeded.", "schema": { "type": "array", - "description": "An array of terms for the given category or an empty list.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_ListTerms": { + "$ref": "./examples/Glossary_ListTerms.json" + } } } }, - "/atlas/v2/glossary/term": { - "post": { - "tags": [ - "Glossary" - ], - "description": "Create a glossary term.", - "operationId": "Glossary_CreateTerm", - "x-ms-examples": { - "Glossary_CreateTerm": { - "$ref": "./examples/Glossary_CreateTerm.json" - }, - "Glossary_CreateTermWithTemplate": { - "$ref": "./examples/Glossary_CreateTermWithTemplate.json" - } - }, + "/atlas/v2/glossary/{glossaryId}/terms/headers": { + "get": { + "operationId": "Glossary_ListTermHeaders", + "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset\nto get pagination result.", "parameters": [ { - "in": "body", - "name": "glossaryTerm", - "description": "The glossary term definition. A term must be anchored to a Glossary at the time of creation.\nOptionally it can be categorized as well.", + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } + "type": "string" }, { - "$ref": "#/parameters/includeTermHierarchy" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. If glossary term creation was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_ListTermHeaders": { + "$ref": "./examples/Glossary_ListTermHeaders.json" + } } } }, - "/atlas/v2/glossary/term/{termGuid}": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get a specific glossary term by its GUID. ", - "operationId": "Glossary_GetTerm", - "x-ms-examples": { - "Glossary_GetTerm": { - "$ref": "./examples/Glossary_GetTerm.json" - }, - "Glossary_GetTerm_WithoutAssets": { - "$ref": "./examples/Glossary_GetTermWithoutAssets.json" - } - }, + "/atlas/v2/glossary/categories": { + "post": { + "operationId": "Glossary_CreateCategories", + "description": "Create glossary category in bulk.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/termGuid" + "name": "body", + "in": "body", + "description": "An array of glossary category definitions to be created.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] + } } ], "responses": { "200": { - "description": "OK. If glossary term exists for given GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Glossary" - ], - "description": "Update the given glossary term by its GUID.", - "operationId": "Glossary_UpdateTerm", + }, "x-ms-examples": { - "Glossary_UpdateTerm": { - "$ref": "./examples/Glossary_UpdateTerm.json" + "Glossary_CreateCategories": { + "$ref": "./examples/Glossary_CreateCategories.json" } - }, + } + } + }, + "/atlas/v2/glossary/category": { + "post": { + "operationId": "Glossary_CreateCategory", + "description": "Create a glossary category.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/termGuid" - }, - { + "name": "body", "in": "body", - "name": "glossaryTerm", - "description": "The glossary term to be updated.", "required": true, "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "$ref": "#/definitions/AtlasGlossaryCategory" } - }, - { - "$ref": "#/parameters/includeTermHierarchy" } ], "responses": { "200": { - "description": "OK. If glossary term update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "$ref": "#/definitions/AtlasGlossaryCategory" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Glossary" - ], - "description": "Delete a glossary term.", - "operationId": "Glossary_DeleteTerm", + }, "x-ms-examples": { - "Glossary_DeleteTerm": { - "$ref": "./examples/Glossary_DeleteTerm.json" + "Glossary_CreateCategory": { + "$ref": "./examples/Glossary_CreateCategory.json" } - }, + } + } + }, + "/atlas/v2/glossary/category/{categoryId}": { + "get": { + "operationId": "Glossary_GetCategory", + "description": "Get specific glossary category by its GUID.", "parameters": [ { - "$ref": "#/parameters/termGuid" + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" } ], "responses": { - "204": { - "description": "OK. If glossary term delete was successful." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/term/{termGuid}/partial": { - "put": { - "tags": [ - "Glossary" - ], - "description": "Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.", - "operationId": "Glossary_PartialUpdateTerm", + }, "x-ms-examples": { - "Glossary_PartialUpdateTerm": { - "$ref": "./examples/Glossary_PartialUpdateTerm.json" + "Glossary_GetCategory": { + "$ref": "./examples/Glossary_GetCategory.json" } - }, + } + }, + "put": { + "operationId": "Glossary_UpdateCategory", + "description": "Update the given glossary category by its GUID.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/termGuid" - }, - { - "$ref": "#/parameters/includeTermHierarchy" + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" }, { + "name": "body", "in": "body", - "name": "partialUpdates", - "description": "A map containing keys as attribute names and values as corresponding attribute values to be updated.", "required": true, "schema": { - "type": "object", - "description": "A map containing keys as attribute names and values as corresponding attribute values." + "$ref": "#/definitions/AtlasGlossaryCategory" } } ], "responses": { "200": { - "description": "OK. If glossary partial update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "$ref": "#/definitions/AtlasGlossaryCategory" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_UpdateCategory": { + "$ref": "./examples/Glossary_UpdateCategory.json" + } } - } - }, - "/atlas/v2/glossary/terms": { - "post": { - "tags": [ - "Glossary" + }, + "delete": { + "operationId": "Glossary_DeleteCategory", + "description": "Delete a glossary category.", + "parameters": [ + { + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + } ], - "description": "Create glossary terms in bulk.", - "operationId": "Glossary_CreateTerms", - "x-ms-examples": { - "Glossary_CreateTerms": { - "$ref": "./examples/Glossary_CreateTerms.json" + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, + "x-ms-examples": { + "Glossary_DeleteCategory": { + "$ref": "./examples/Glossary_DeleteCategory.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryId}/partial": { + "put": { + "operationId": "Glossary_PartialUpdateCategory", + "description": "Update the glossary category partially. So far we only supports partial\nupdating shortDescription and longDescription for category.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" }, { + "name": "body", "in": "body", - "name": "glossaryTerm", - "description": "An array of glossary term definitions to be created in bulk.", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues for partial update.", "required": true, "schema": { - "type": "array", - "description": "An array of glossary term definitions.", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "type": "object", + "additionalProperties": { + "type": "string" } } - }, - { - "$ref": "#/parameters/includeTermHierarchy" } ], "responses": { "200": { - "description": "OK. If bulk glossary terms creation was successful.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "If bulk glossary terms creation was successful.", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } + "$ref": "#/definitions/AtlasGlossaryCategory" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_PartialUpdateCategory": { + "$ref": "./examples/Glossary_PartialUpdateCategory.json" + } } } }, - "/atlas/v2/glossary/terms/{termGuid}/assignedEntities": { + "/atlas/v2/glossary/category/{categoryId}/related": { "get": { - "tags": [ - "Glossary" - ], - "description": "List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListEntitiesAssignedWithTerm", - "x-ms-examples": { - "Glossary_ListEntitiesAssignedWithTerm": { - "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" - } - }, + "operationId": "Glossary_ListRelatedCategories", + "description": "Get all related categories (parent and children). Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", "parameters": [ { - "$ref": "#/parameters/termGuid" + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/limit" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/offset" + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/sort" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. An array of related objects (if any) for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "An array of related objects (if any) for the given glossary or an empty list.", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" + "type": "object", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "type": "array", + "x-ms-identifiers": [] } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "post": { - "tags": [ - "Glossary" - ], - "description": "Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls.\n\n[Entities Create Or Update operation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP) is an alternative to assign a term to multiple entities.", - "operationId": "Glossary_AssignTermToEntities", + }, "x-ms-examples": { - "Glossary_AssignTermToEntities": { - "$ref": "./examples/Glossary_AssignTermToEntities.json" + "Glossary_ListRelatedCategories": { + "$ref": "./examples/Glossary_ListRelatedCategories.json" } - }, + } + } + }, + "/atlas/v2/glossary/category/{categoryId}/terms": { + "get": { + "operationId": "Glossary_ListCategoryTerms", + "description": "Get all terms associated with the specific category.", "parameters": [ { - "$ref": "#/parameters/termGuid" + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" }, { - "in": "body", - "name": "relatedObjectIds", - "description": "An array of related object IDs to which the term has to be associated.", - "required": true, + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", "schema": { "type": "array", - "description": "An array of related object IDs to which the term has to be associated.", "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] } - } - ], - "responses": { - "204": { - "description": "OK. If the term assignment was successful." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Glossary" - ], - "description": "Delete the term assignment for the given list of related objects.", - "operationId": "Glossary_DeleteTermAssignmentFromEntities", + }, "x-ms-examples": { - "Glossary_RemoveTermAssignmentFromEntities": { - "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" + "Glossary_ListCategoryTerms": { + "$ref": "./examples/Glossary_ListCategoryTerms.json" } - }, + } + } + }, + "/atlas/v2/glossary/term": { + "post": { + "operationId": "Glossary_CreateTerm", + "description": "Create a glossary term.", "parameters": [ { - "$ref": "#/parameters/termGuid" + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" }, { + "name": "body", "in": "body", - "name": "relatedObjectIds", - "description": "An array of related object IDs from which the term has to be dissociated.", "required": true, "schema": { - "type": "array", - "description": "An array of related object IDs from which the term has to be dissociated.", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - } + "$ref": "#/definitions/AtlasGlossaryTerm" } } ], "responses": { - "204": { - "description": "OK. If glossary term dissociation was successful." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_CreateTerm": { + "$ref": "./examples/Glossary_CreateTerm.json" + }, + "Glossary_CreateTermWithTemplate": { + "$ref": "./examples/Glossary_CreateTermWithTemplate.json" + } } } }, - "/atlas/v2/glossary/terms/{termGuid}/related": { + "/atlas/v2/glossary/term/{termId}": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.", - "operationId": "Glossary_ListRelatedTerms", - "x-ms-examples": { - "Glossary_ListRelatedTerms": { - "$ref": "./examples/Glossary_ListRelatedTerms.json" - } - }, + "operationId": "Glossary_GetTerm", + "description": "Get a specific glossary term by its GUID. ", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/termGuid" - }, - { - "$ref": "#/parameters/limit" - }, - { - "$ref": "#/parameters/offset" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/sort" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. An array of related glossary terms for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/RelatedTermHeaders" + "$ref": "#/definitions/AtlasGlossaryTerm" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get a specific Glossary by its GUID.", - "operationId": "Glossary_Get", - "x-ms-examples": { - "Glossary_Get": { - "$ref": "./examples/Glossary_Get.json" - } }, - "parameters": [ - { - "$ref": "#/parameters/glossaryGuid" - } - ], - "responses": { - "200": { - "description": "OK. If glossary with given guid exists.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } + "x-ms-examples": { + "Glossary_GetTerm": { + "$ref": "./examples/Glossary_GetTerm.json" }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } + "Glossary_GetTermWithoutAssets": { + "$ref": "./examples/Glossary_GetTermWithoutAssets.json" } } }, "put": { - "tags": [ - "Glossary" - ], - "description": "Update the given glossary.", - "operationId": "Glossary_Update", - "x-ms-examples": { - "Glossary_Update": { - "$ref": "./examples/Glossary_Update.json" - } - }, + "operationId": "Glossary_UpdateTerm", + "description": "Update the given glossary term by its GUID.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/glossaryGuid" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ignoreTermsAndCategories" + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" }, { + "name": "body", "in": "body", - "name": "updatedGlossary", - "description": "The glossary definition to be updated.", "required": true, "schema": { - "$ref": "#/definitions/AtlasGlossary" + "$ref": "#/definitions/AtlasGlossaryTerm" } } ], "responses": { "200": { - "description": "OK. If glossary update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossary" + "$ref": "#/definitions/AtlasGlossaryTerm" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_UpdateTerm": { + "$ref": "./examples/Glossary_UpdateTerm.json" + } } }, "delete": { - "tags": [ - "Glossary" - ], - "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories.", - "operationId": "Glossary_Delete", - "x-ms-examples": { - "Glossary_Delete": { - "$ref": "./examples/Glossary_Delete.json" - } - }, + "operationId": "Glossary_DeleteTerm", + "description": "Delete a glossary term.", "parameters": [ { - "$ref": "#/parameters/glossaryGuid" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" } ], "responses": { "204": { - "description": "OK. If glossary delete was successful." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_DeleteTerm": { + "$ref": "./examples/Glossary_DeleteTerm.json" + } } } }, - "/atlas/v2/glossary/{glossaryGuid}/categories": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListCategories", - "x-ms-examples": { - "Glossary_ListCategories": { - "$ref": "./examples/Glossary_ListCategories.json" - } - }, + "/atlas/v2/glossary/term/{termId}/partial": { + "put": { + "operationId": "Glossary_PartialUpdateTerm", + "description": "Update the glossary term partially. So far we only supports partial updating\nshortDescription, longDescription, abbreviation, usage and status for term.", "parameters": [ { - "$ref": "#/parameters/glossaryGuid" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/limit" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/offset" + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/sort" + "name": "body", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues to be updated.", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } ], "responses": { "200": { - "description": "OK. An array of glossary categories for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "An array of glossary categories for the given glossary or an empty list.", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } + "$ref": "#/definitions/AtlasGlossaryTerm" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_PartialUpdateTerm": { + "$ref": "./examples/Glossary_PartialUpdateTerm.json" + } } } }, - "/atlas/v2/glossary/{glossaryGuid}/categories/headers": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListCategoriesHeaders", - "x-ms-examples": { - "Glossary_ListCategoriesHeaders": { - "$ref": "./examples/Glossary_ListCategoriesHeaders.json" - } - }, + "/atlas/v2/glossary/terms": { + "post": { + "operationId": "Glossary_CreateTerms", + "description": "Create glossary terms in bulk.", "parameters": [ { - "$ref": "#/parameters/glossaryGuid" - }, - { - "$ref": "#/parameters/limit" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/offset" + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/sort" + "name": "body", + "in": "body", + "description": "An array of glossary term definitions to be created in bulk.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] + } } ], "responses": { "200": { - "description": "OK. An array of glossary category headers for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { "type": "array", - "description": "An array of glossary category headers for the given glossary or an empty list.", "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - } + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_CreateTerms": { + "$ref": "./examples/Glossary_CreateTerms.json" + } } } }, - "/atlas/v2/glossary/{glossaryGuid}/detailed": { + "/atlas/v2/glossary/terms/{termId}/assignedEntities": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get a specific glossary with detailed information. This API is not recommend.\n\nRecommend to fetch terms/categories details separately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", - "operationId": "Glossary_GetDetailed", - "x-ms-examples": { - "Glossary_GetDetailed": { - "$ref": "./examples/Glossary_GetDetailed.json" - } - }, + "operationId": "Glossary_ListEntitiesAssignedWithTerm", + "description": "List all related objects assigned with the specified term. Recommend using\nlimit/offset to get pagination result.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/glossaryGuid" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. If glossary exists for given GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryExtInfo" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/partial": { - "put": { - "tags": [ - "Glossary" - ], - "description": "Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated.\n\nSo far we only supports partial updating shortDescription, longDescription, language and usage for glossary. \n\nRecommend using 'ignoreTermsAndCategories=true' to reduce response body size.", - "operationId": "Glossary_PartialUpdate", + }, "x-ms-examples": { - "Glossary_PartialUpdate": { - "$ref": "./examples/Glossary_PartialUpdate.json" + "Glossary_ListEntitiesAssignedWithTerm": { + "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" } - }, + } + }, + "post": { + "operationId": "Glossary_AssignTermToEntities", + "description": "Assign the given term to the provided list of related objects. Recommend using\nsmall batches with multiple API calls.\n\n[Entities Create Or Update\noperation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP)\nis an alternative to assign a term to multiple entities.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/glossaryGuid" - }, - { - "$ref": "#/parameters/ignoreTermsAndCategories" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { + "name": "body", "in": "body", - "name": "partialUpdates", - "description": "A map containing keys as attribute names and values as corresponding attribute values.", + "description": "An array of related object IDs to which the term has to be associated.", "required": true, "schema": { - "type": "object", - "description": "A map containing keys as attribute names and values as corresponding attribute values." + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] } } ], "responses": { - "200": { - "description": "OK. If glossary partial update was successful.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/terms": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListTerms", + }, "x-ms-examples": { - "Glossary_ListTerms": { - "$ref": "./examples/Glossary_ListTerms.json" + "Glossary_AssignTermToEntities": { + "$ref": "./examples/Glossary_AssignTermToEntities.json" } - }, + } + }, + "delete": { + "operationId": "Glossary_DeleteTermAssignmentFromEntities", + "description": "Delete the term assignment for the given list of related objects.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/glossaryGuid" - }, - { - "$ref": "#/parameters/limit" - }, - { - "$ref": "#/parameters/offset" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/sort" - } - ], - "responses": { - "200": { - "description": "OK. An array of glossary terms for the given glossary or an empty list.", + "name": "body", + "in": "body", + "description": "An array of related object IDs from which the term has to be dissociated.", + "required": true, "schema": { "type": "array", - "description": "An array of glossary terms for the given glossary or an empty list.", "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_RemoveTermAssignmentFromEntities": { + "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" + } } } }, - "/atlas/v2/glossary/{glossaryGuid}/terms/headers": { + "/atlas/v2/glossary/terms/{termId}/related": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListTermHeaders", - "x-ms-examples": { - "Glossary_ListTermHeaders": { - "$ref": "./examples/Glossary_ListTermHeaders.json" - } - }, + "operationId": "Glossary_ListRelatedTerms", + "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", "parameters": [ { - "$ref": "#/parameters/glossaryGuid" + "$ref": "#/parameters/AtlasApiVersionParameter" + }, + { + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/limit" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/offset" + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/sort" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. An array of glossary terms for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "An array of glossary terms for the given glossary or an empty list.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "type": "object", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "type": "array", + "x-ms-identifiers": [] } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/search/query": { - "post": { - "tags": [ - "Discovery" - ], - "description": "Get data using search.", - "operationId": "Discovery_Query", + }, "x-ms-examples": { - "Discovery_Query": { - "$ref": "./examples/Discovery_Query.json" - }, - "Discovery_Query_And": { - "$ref": "./examples/Discovery_Query_And.json" - }, - "Discovery_Query_Not": { - "$ref": "./examples/Discovery_Query_Not.json" - }, - "Discovery_Query_AndOrNested": { - "$ref": "./examples/Discovery_Query_AndOrNested.json" - }, - "Discovery_Query_SystemTime": { - "$ref": "./examples/Discovery_Query_SystemTime.json" - }, - "Discovery_Query_BusinessMetadataAttribute": { - "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" - }, - "Discovery_Query_Attribute": { - "$ref": "./examples/Discovery_Query_Attribute.json" - }, - "Discovery_Query_Classification": { - "$ref": "./examples/Discovery_Query_Classification.json" - }, - "Discovery_Query_FileExtension": { - "$ref": "./examples/Discovery_Query_FileExtension.json" - }, - "Discovery_Query_Id": { - "$ref": "./examples/Discovery_Query_Id.json" - }, - "Discovery_Query_EntityType": { - "$ref": "./examples/Discovery_Query_Type.json" - }, - "Discovery_Query_AssetType": { - "$ref": "./examples/Discovery_Query_AssetType.json" - }, - "Discovery_Query_Term": { - "$ref": "./examples/Discovery_Query_TermAssignment.json" - }, - "Discovery_Query_Facet": { - "$ref": "./examples/Discovery_Query_Facet.json" - }, - "Discovery_Query_Taxonomy": { - "$ref": "./examples/Discovery_Query_Taxonomy.json" - }, - "Discovery_Query_Collection": { - "$ref": "./examples/Discovery_Query_Collection.json" - }, - "Discovery_Query_GlossaryTerm": { - "$ref": "./examples/Discovery_Query_GlossaryTerm.json" - }, - "Discovery_Query_ObjectType": { - "$ref": "./examples/Discovery_Query_ObjectType.json" - }, - "Discovery_Query_PaginationFirstPage": { - "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" - }, - "Discovery_Query_PaginationContinuationPage": { - "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" - }, - "Discovery_Query_PaginationLastPage": { - "$ref": "./examples/Discovery_Query_PaginationLastPage.json" + "Glossary_ListRelatedTerms": { + "$ref": "./examples/Glossary_ListRelatedTerms.json" } - }, + } + } + }, + "/atlas/v2/lineage/{guid}": { + "get": { + "operationId": "Lineage_Get", + "description": "Get lineage info of the entity specified by GUID.", "parameters": [ { - "in": "body", - "name": "searchRequest", - "description": "An object specifying the search criteria.", + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", "required": true, - "schema": { - "$ref": "#/definitions/SearchRequest" - } + "type": "string" + }, + { + "name": "depth", + "in": "query", + "description": "The number of hops for lineage.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] + } } ], "responses": { "200": { - "description": "OK. On successful lookup of the advanced search.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/SearchResult" + "$ref": "#/definitions/AtlasLineageInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Lineage_Get": { + "$ref": "./examples/Lineage_Get.json" + } } } }, - "/search/suggest": { - "post": { - "tags": [ - "Discovery" - ], - "description": "Get search suggestions by query criteria.", - "operationId": "Discovery_Suggest", - "x-ms-examples": { - "Discovery_Suggest": { - "$ref": "./examples/Discovery_Suggest.json" - } - }, + "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Lineage_GetByUniqueAttribute", + "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter,\nattribute key-value pair(s) can be provided in the following\nformat\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be\nunique across entities, eg. qualifiedName.\n\nThe REST request would look\nsomething like this:\n\nGET\n/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "in": "body", - "name": "suggestRequest", - "description": "An object specifying the suggest criteria.", + "name": "typeName", + "in": "path", + "description": "The name of the type.", "required": true, - "schema": { - "$ref": "#/definitions/SuggestRequest" + "type": "string" + }, + { + "name": "depth", + "in": "query", + "description": "The number of hops for lineage.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] } }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" } ], "responses": { "200": { - "description": "OK. On successful lookup of the suggestions.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/SuggestResult" + "$ref": "#/definitions/AtlasLineageInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Lineage_GetByUniqueAttribute": { + "$ref": "./examples/Lineage_GetByUniqueAttribute.json" + } } } }, - "/search/autocomplete": { - "post": { - "tags": [ - "Discovery" - ], - "description": "Get auto complete options.", - "operationId": "Discovery_AutoComplete", - "x-ms-examples": { - "Discovery_AutoComplete": { - "$ref": "./examples/Discovery_AutoComplete.json" - } - }, + "/atlas/v2/relationship": { + "put": { + "operationId": "Relationship_Update", + "description": "Update an existing relationship between entities.", "parameters": [ { + "name": "body", "in": "body", - "name": "autoCompleteRequest", - "description": "An object specifying the autocomplete criteria.", "required": true, "schema": { - "$ref": "#/definitions/AutoCompleteRequest" + "$ref": "#/definitions/AtlasRelationship" } - }, - { - "$ref": "#/parameters/purviewAPIVersion" } ], "responses": { "200": { - "description": "OK. On successful lookup of the auto complete options.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AutoCompleteResult" + "$ref": "#/definitions/AtlasRelationship" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/lineage/{guid}": { - "get": { - "tags": [ - "Lineage" - ], - "description": "Get lineage info of the entity specified by GUID.", - "operationId": "Lineage_Get", + }, "x-ms-examples": { - "Lineage_Get": { - "$ref": "./examples/Lineage_Get.json" + "Relationship_Update": { + "$ref": "./examples/Relationship_Update.json" } - }, + } + }, + "post": { + "operationId": "Relationship_Create", + "description": "Create a new relationship between entities.", "parameters": [ { - "$ref": "#/parameters/guid" - }, - { - "$ref": "#/parameters/depth" - }, - { - "$ref": "#/parameters/direction" + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } } ], "responses": { "200": { - "description": "OK. If the request is valid.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasLineageInfo" + "$ref": "#/definitions/AtlasRelationship" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Relationship_Create": { + "$ref": "./examples/Relationship_Create.json" + } } } }, - "/lineage/{guid}/next/": { + "/atlas/v2/relationship/guid/{guid}": { "get": { - "tags": [ - "Lineage" - ], - "description": "Return immediate next page lineage info about entity with pagination", - "operationId": "Lineage_GetNextPage", - "x-ms-examples": { - "Lineage_GetNextPage": { - "$ref": "./examples/Lineage_GetNextPage.json" - } - }, + "operationId": "Relationship_Get", + "description": "Get relationship information between entities by its GUID.", "parameters": [ { - "$ref": "#/parameters/guid" - }, - { - "$ref": "#/parameters/direction" - }, - { - "$ref": "#/parameters/offset" - }, - { - "$ref": "#/parameters/limit" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "extendedInfo", + "in": "query", + "description": "Limits whether includes extended information.", + "required": false, + "type": "boolean" } ], "responses": { "200": { - "description": "OK. If the input is valid.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasLineageInfo" + "$ref": "#/definitions/AtlasRelationshipWithExtInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { - "get": { - "tags": [ - "Lineage" - ], - "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this:\n\nGET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "operationId": "Lineage_GetByUniqueAttribute", + }, "x-ms-examples": { - "Lineage_GetByUniqueAttribute": { - "$ref": "./examples/Lineage_GetByUniqueAttribute.json" + "Relationship_Get": { + "$ref": "./examples/Relationship_Get.json" } - }, - "produces": [ - "application/json" - ], + } + }, + "delete": { + "operationId": "Relationship_Delete", + "description": "Delete a relationship between entities by its GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "$ref": "#/parameters/depth" - }, - { - "$ref": "#/parameters/direction" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, "type": "string" } ], "responses": { - "200": { - "schema": { - "$ref": "#/definitions/AtlasLineageInfo", - "description": "If Lineage exists for the given entity" - }, - "description": "If Lineage exists for the given entity" + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Relationship_Delete": { + "$ref": "./examples/Relationship_Delete.json" + } } } }, - "/atlas/v2/relationship": { - "post": { - "tags": [ - "Relationship" - ], - "description": "Create a new relationship between entities.", - "operationId": "Relationship_Create", - "x-ms-examples": { - "Relationship_Create": { - "$ref": "./examples/Relationship_Create.json" - } - }, + "/atlas/v2/types/businessmetadatadef/guid/{guid}": { + "get": { + "operationId": "Type_GetBusinessMetadataDefByGuid", + "description": "Get the businessMetadata definition for the given guid.", "parameters": [ { - "in": "body", - "name": "relationship", - "description": "The AtlasRelationship object containing the information for the relationship to be created.", + "name": "guid", + "in": "path", + "description": "businessMetadata guid", "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } + "type": "string" } ], "responses": { "200": { - "description": "OK. The relationship is created.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasRelationship" + "$ref": "#/definitions/AtlasBusinessMetadataDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Relationship" - ], - "description": "Update an existing relationship between entities.", - "operationId": "Relationship_Update", + }, "x-ms-examples": { - "Relationship_Update": { - "$ref": "./examples/Relationship_Update.json" + "Type_GetBusinessMetadataDefByGuid": { + "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" } - }, + } + } + }, + "/atlas/v2/types/businessmetadatadef/name/{name}": { + "get": { + "operationId": "Type_GetBusinessMetadataDefByName", + "description": "Get the businessMetadata definition by it's name (unique).", "parameters": [ { - "in": "body", - "name": "relationship", - "description": "The AtlasRelationship object containing the information for the relationship to be created.", + "name": "name", + "in": "path", + "description": "businessMetadata name", "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } + "type": "string" } ], "responses": { "200": { - "description": "OK. The relationship is updated.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasRelationship" + "$ref": "#/definitions/AtlasBusinessMetadataDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetBusinessMetadataDefByName": { + "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" + } } } }, - "/atlas/v2/relationship/guid/{guid}": { + "/atlas/v2/types/classificationdef/guid/{guid}": { "get": { - "tags": [ - "Relationship" - ], - "description": "Get relationship information between entities by its GUID.", - "operationId": "Relationship_Get", - "x-ms-examples": { - "Relationship_Get": { - "$ref": "./examples/Relationship_Get.json" - } - }, + "operationId": "Type_GetClassificationDefByGuid", + "description": "Get the classification definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/relationshipGuid" - }, - { - "$ref": "#/parameters/extendedInfo" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the classification.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasRelationshipWithExtInfo" + "$ref": "#/definitions/AtlasClassificationDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Relationship" - ], - "description": "Delete a relationship between entities by its GUID.", - "operationId": "Relationship_Delete", + }, "x-ms-examples": { - "Relationship_Delete": { - "$ref": "./examples/Relationship_Delete.json" + "Type_GetClassificationDefByGuid": { + "$ref": "./examples/Type_GetClassificationDefByGuid.json" } - }, + } + } + }, + "/atlas/v2/types/classificationdef/name/{name}": { + "get": { + "operationId": "Type_GetClassificationDefByName", + "description": "Get the classification definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/relationshipGuid" + "name": "name", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" } ], "responses": { - "204": { - "description": "OK. The relationship is deleted." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassificationDef" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetClassificationDefByName": { + "$ref": "./examples/Type_GetClassificationDefByName.json" + } } } }, - "/atlas/v2/types/businessmetadatadef/guid/{guid}": { + "/atlas/v2/types/entitydef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the businessMetadata definition for the given guid.", - "operationId": "Type_GetBusinessMetadataDefByGuid", - "x-ms-examples": { - "Type_GetBusinessMetadataDefByGuid": { - "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" - } - }, - "produces": [ - "application/json" - ], + "operationId": "Type_GetEntityDefByGuid", + "description": "Get the Entity definition for the given GUID.", "parameters": [ { "name": "guid", "in": "path", - "type": "string", - "description": "businessMetadata guid", - "required": true + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" } ], "responses": { "200": { + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef", - "description": "On successful lookup of the the businessMetadata definition by it's guid" - }, - "description": "On successful lookup of the the businessMetadata definition by it's guid" + "$ref": "#/definitions/AtlasEntityDef" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetEntityDefByGuid": { + "$ref": "./examples/Type_GetEntityDefByGuid.json" + } } } }, - "/atlas/v2/types/businessmetadatadef/name/{name}": { + "/atlas/v2/types/entitydef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the businessMetadata definition by it's name (unique).", - "operationId": "Type_GetBusinessMetadataDefByName", - "x-ms-examples": { - "Type_GetBusinessMetadataDefByName": { - "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" - } - }, - "produces": [ - "application/json" - ], + "operationId": "Type_GetEntityDefByName", + "description": "Get the entity definition by its name (unique).", "parameters": [ { "name": "name", "in": "path", - "type": "string", - "description": "businessMetadata name", - "required": true + "description": "The name of the entity.", + "required": true, + "type": "string" } ], "responses": { "200": { + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef", - "description": "On successful lookup of the the businessMetadata definition by it's name" - }, - "description": "On successful lookup of the the businessMetadata definition by it's name" + "$ref": "#/definitions/AtlasEntityDef" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetEntityDefByName": { + "$ref": "./examples/Type_GetEntityDefByName.json" + } } } }, - "/atlas/v2/types/classificationdef/guid/{guid}": { + "/atlas/v2/types/enumdef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the classification definition for the given GUID.", - "operationId": "Type_GetClassificationDefByGuid", - "x-ms-examples": { - "Type_GetClassificationDefByGuid": { - "$ref": "./examples/Type_GetClassificationDefByGuid.json" - } - }, + "operationId": "Type_GetEnumDefByGuid", + "description": "Get the enum definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/classificationDefGuid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the enum.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the classification definition by its GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasClassificationDef" + "$ref": "#/definitions/AtlasEnumDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetEnumDefByGuid": { + "$ref": "./examples/Type_GetEnumDefByGuid.json" + } } } }, - "/atlas/v2/types/classificationdef/name/{name}": { + "/atlas/v2/types/enumdef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the classification definition by its name (unique).", - "operationId": "Type_GetClassificationDefByName", - "x-ms-examples": { - "Type_GetClassificationDefByName": { - "$ref": "./examples/Type_GetClassificationDefByName.json" - } - }, + "operationId": "Type_GetEnumDefByName", + "description": "Get the enum definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/classificationDefName" + "name": "name", + "in": "path", + "description": "The name of the enum.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the classification definition by its name.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasClassificationDef" + "$ref": "#/definitions/AtlasEnumDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetEnumDefByName": { + "$ref": "./examples/Type_GetEnumDefByName.json" + } } } }, - "/atlas/v2/types/entitydef/guid/{guid}": { + "/atlas/v2/types/relationshipdef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the Entity definition for the given GUID.", - "operationId": "Type_GetEntityDefByGuid", - "x-ms-examples": { - "Type_GetEntityDefByGuid": { - "$ref": "./examples/Type_GetEntityDefByGuid.json" - } - }, + "operationId": "Type_GetRelationshipDefByGuid", + "description": "Get the relationship definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/entityDefGuid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the entity definition by its GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasEntityDef" + "$ref": "#/definitions/AtlasRelationshipDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetRelationshipDefByGuid": { + "$ref": "./examples/Type_GetRelationshipDefByGuid.json" + } } } }, - "/atlas/v2/types/entitydef/name/{name}": { + "/atlas/v2/types/relationshipdef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the entity definition by its name (unique).", - "operationId": "Type_GetEntityDefByName", - "x-ms-examples": { - "Type_GetEntityDefByName": { - "$ref": "./examples/Type_GetEntityDefByName.json" - } - }, + "operationId": "Type_GetRelationshipDefByName", + "description": "Get the relationship definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/entityDefName" + "name": "name", + "in": "path", + "description": "The name of the relationship.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the entity definition by its name.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasEntityDef" + "$ref": "#/definitions/AtlasRelationshipDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetRelationshipDefByName": { + "$ref": "./examples/Type_GetRelationshipDefByName.json" + } } } }, - "/atlas/v2/types/enumdef/guid/{guid}": { + "/atlas/v2/types/structdef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the enum definition for the given GUID.", - "operationId": "Type_GetEnumDefByGuid", - "x-ms-examples": { - "Type_GetEnumDefByGuid": { - "$ref": "./examples/Type_GetEnumDefByGuid.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/enumDefGuid" - } - ], - "responses": { - "200": { - "description": "OK. On successful lookup of the the enum definition by its GUID.", - "schema": { - "$ref": "#/definitions/AtlasEnumDef" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/atlas/v2/types/enumdef/name/{name}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the enum definition by its name (unique).", - "operationId": "Type_GetEnumDefByName", - "x-ms-examples": { - "Type_GetEnumDefByName": { - "$ref": "./examples/Type_GetEnumDefByName.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/enumDefName" - } - ], - "responses": { - "200": { - "description": "OK. On successful lookup of the the enum definition by its name.", - "schema": { - "$ref": "#/definitions/AtlasEnumDef" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/atlas/v2/types/relationshipdef/guid/{guid}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the relationship definition for the given GUID.", - "operationId": "Type_GetRelationshipDefByGuid", - "x-ms-examples": { - "Type_GetRelationshipDefByGuid": { - "$ref": "./examples/Type_GetRelationshipDefByGuid.json" - } - }, + "operationId": "Type_GetStructDefByGuid", + "description": "Get the struct definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/relationshipDefGuid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the struct.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the relationship definition by its GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasRelationshipDef" + "$ref": "#/definitions/AtlasStructDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/types/relationshipdef/name/{name}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the relationship definition by its name (unique).", - "operationId": "Type_GetRelationshipDefByName", - "x-ms-examples": { - "Type_GetRelationshipDefByName": { - "$ref": "./examples/Type_GetRelationshipDefByName.json" - } }, - "parameters": [ - { - "$ref": "#/parameters/relationshipDefName" - } - ], - "responses": { - "200": { - "description": "OK. On successful lookup of the the relationship definition by its name.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipDef" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/atlas/v2/types/structdef/guid/{guid}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the struct definition for the given GUID.", - "operationId": "Type_GetStructDefByGuid", "x-ms-examples": { "Type_GetStructDefByGuid": { "$ref": "./examples/Type_GetStructDefByGuid.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/structDefGuid" - } - ], - "responses": { - "200": { - "description": "OK. On successful lookup of the the struct definition by its GUID.", - "schema": { - "$ref": "#/definitions/AtlasStructDef" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } } } }, "/atlas/v2/types/structdef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the struct definition by its name (unique).", "operationId": "Type_GetStructDefByName", - "x-ms-examples": { - "Type_GetStructDefByName": { - "$ref": "./examples/Type_GetStructDefByName.json" - } - }, + "description": "Get the struct definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/structDefName" + "name": "name", + "in": "path", + "description": "The name of the struct.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the struct definition by its name.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasStructDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetStructDefByName": { + "$ref": "./examples/Type_GetStructDefByName.json" + } } } }, "/atlas/v2/types/typedef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the type definition for the given GUID.", "operationId": "Type_GetByGuid", - "x-ms-examples": { - "Type_GetByGuid": { - "$ref": "./examples/Type_GetByGuid.json" - } - }, + "description": "Get the type definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/typeDefGuid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the type.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the type definition by its GUID.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypeDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetByGuid": { + "$ref": "./examples/Type_GetByGuid.json" + } } } }, "/atlas/v2/types/typedef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the type definition by its name (unique).", "operationId": "Type_GetByName", - "x-ms-examples": { - "Type_GetByName": { - "$ref": "./examples/Type_GetByName.json" - } - }, + "description": "Get the type definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/typeDefName" + "name": "name", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the type definition by its name.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypeDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetByName": { + "$ref": "./examples/Type_GetByName.json" + } } }, "delete": { - "tags": [ - "Type" - ], - "description": "Delete API for type identified by its name.", "operationId": "Type_Delete", - "x-ms-examples": { - "Type_Delete": { - "$ref": "./examples/Type_Delete.json" - } - }, + "description": "Delete API for type identified by its name.", "parameters": [ { - "$ref": "#/parameters/typeDefName" + "name": "name", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" } ], "responses": { "204": { - "description": "On successful deletion of the requested type definitions" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_Delete": { + "$ref": "./examples/Type_Delete.json" + } } } }, "/atlas/v2/types/typedefs": { "get": { - "tags": [ - "Type" - ], - "description": "List all type definitions in bulk.", "operationId": "Type_List", - "x-ms-examples": { - "Type_List": { - "$ref": "./examples/Type_List.json" - }, - "Type_ListEnumDefs": { - "$ref": "./examples/Type_ListEnumDefs.json" - }, - "Type_ListTermTemplateDefs": { - "$ref": "./examples/Type_ListTermTemplateDefs.json" - } - }, + "description": "List all type definitions in bulk.", "parameters": [ { - "$ref": "#/parameters/includeTermTemplate" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/type" + "name": "includeTermTemplate", + "in": "query", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "type", + "in": "query", + "description": "Typedef name as search filter when get typedefs.", + "required": false, + "type": "string", + "enum": [ + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" + ], + "x-ms-enum": { + "name": "TypeCategory", + "modelAsString": true, + "values": [ + { + "name": "Primitive", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "ObjectIdType", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, + { + "name": "Enum", + "value": "ENUM", + "description": "enum" + }, + { + "name": "Struct", + "value": "STRUCT", + "description": "struct" + }, + { + "name": "Classification", + "value": "CLASSIFICATION", + "description": "classification" + }, + { + "name": "Entity", + "value": "ENTITY", + "description": "entity" + }, + { + "name": "Array", + "value": "ARRAY", + "description": "array" + }, + { + "name": "Map", + "value": "MAP", + "description": "map" + }, + { + "name": "Relationship", + "value": "RELATIONSHIP", + "description": "relationship" + }, + { + "name": "TermTemplate", + "value": "TERM_TEMPLATE", + "description": "term template" + } + ] + } } ], "responses": { "200": { - "description": "OK. AtlasTypesDef with type definitions matching the search criteria or else returns empty list of type definitions.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypesDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "post": { - "tags": [ - "Type" - ], - "description": "Create all atlas type definitions in bulk, only new definitions will be created.\nAny changes to the existing definitions will be discarded.", - "operationId": "Type_BulkCreate", + }, "x-ms-examples": { - "Type_BulkCreate": { - "$ref": "./examples/Type_BulkCreate.json" + "Type_List": { + "$ref": "./examples/Type_List.json" }, - "Type_BulkCreateBusinessMetadataDefs": { - "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" + "Type_ListEnumDefs": { + "$ref": "./examples/Type_ListEnumDefs.json" + }, + "Type_ListTermTemplateDefs": { + "$ref": "./examples/Type_ListTermTemplateDefs.json" } - }, + } + }, + "put": { + "operationId": "Type_BulkUpdate", + "description": "Update all types in bulk, changes detected in the type definitions would be\npersisted.", "parameters": [ { + "name": "body", "in": "body", - "name": "typesDef", - "description": "A composite wrapper object with corresponding lists of the type definition.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -3803,35 +3923,31 @@ ], "responses": { "200": { - "description": "OK. On successful update of requested type definitions.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypesDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Type" - ], - "description": "Update all types in bulk, changes detected in the type definitions would be persisted.", - "operationId": "Type_BulkUpdate", + }, "x-ms-examples": { "Type_BulkUpdate": { "$ref": "./examples/Type_BulkUpdate.json" } - }, + } + }, + "post": { + "operationId": "Type_BulkCreate", + "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", "parameters": [ { + "name": "body", "in": "body", - "name": "typesDef", - "description": "A composite object that captures all type definition changes.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -3840,35 +3956,34 @@ ], "responses": { "200": { - "description": "OK. On successful update of requested type definitions.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypesDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_BulkCreate": { + "$ref": "./examples/Type_BulkCreate.json" + }, + "Type_BulkCreateBusinessMetadataDefs": { + "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" + } } }, "delete": { - "tags": [ - "Type" - ], - "description": "Delete API for all types in bulk.", "operationId": "Type_BulkDelete", - "x-ms-examples": { - "Type_BulkDelete": { - "$ref": "./examples/Type_BulkDelete.json" - } - }, + "description": "Delete API for all types in bulk.", "parameters": [ { + "name": "body", "in": "body", - "name": "typesDef", - "description": "A composite object that captures all types to be deleted", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -3877,480 +3992,748 @@ ], "responses": { "204": { - "description": "OK. On successful deletion of the requested type definitions." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_BulkDelete": { + "$ref": "./examples/Type_BulkDelete.json" + } } } }, "/atlas/v2/types/typedefs/headers": { "get": { - "tags": [ - "Type" - ], - "description": "List all type definitions returned as a list of minimal information header.", "operationId": "Type_ListHeaders", - "x-ms-examples": { - "Type_ListHeaders": { - "$ref": "./examples/Type_ListHeaders.json" - } - }, + "description": "List all type definitions returned as a list of minimal information header.", "parameters": [ { - "$ref": "#/parameters/includeTermTemplate" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { - "$ref": "#/parameters/type" + "name": "includeTermTemplate", + "in": "query", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "type", + "in": "query", + "description": "Typedef name as search filter when get typedefs.", + "required": false, + "type": "string", + "enum": [ + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" + ], + "x-ms-enum": { + "name": "TypeCategory", + "modelAsString": true, + "values": [ + { + "name": "Primitive", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "ObjectIdType", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, + { + "name": "Enum", + "value": "ENUM", + "description": "enum" + }, + { + "name": "Struct", + "value": "STRUCT", + "description": "struct" + }, + { + "name": "Classification", + "value": "CLASSIFICATION", + "description": "classification" + }, + { + "name": "Entity", + "value": "ENTITY", + "description": "entity" + }, + { + "name": "Array", + "value": "ARRAY", + "description": "array" + }, + { + "name": "Map", + "value": "MAP", + "description": "map" + }, + { + "name": "Relationship", + "value": "RELATIONSHIP", + "description": "relationship" + }, + { + "name": "TermTemplate", + "value": "TERM_TEMPLATE", + "description": "term template" + } + ] + } } ], "responses": { "200": { - "description": "An array of AtlasTypeDefHeader matching the search criteria\nor an empty list if no match.", + "description": "The request has succeeded.", "schema": { "type": "array", - "description": "An array of AtlasTypeDefHeader matching the search criteria\nor an empty list if no match.", "items": { "$ref": "#/definitions/AtlasTypeDefHeader" - } + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_ListHeaders": { + "$ref": "./examples/Type_ListHeaders.json" + } } } }, - "/types/termtemplatedef/guid/{guid}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the term template definition for the given GUID.", - "operationId": "Type_GetTermTemplateDefByGuid", - "x-ms-examples": { - "Type_GetTermTemplateDefByGuid": { - "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" - } - }, + "/entity/moveTo": { + "post": { + "operationId": "Entity_MoveEntitiesToCollection", + "description": "Move existing entities to the target collection.", "parameters": [ { - "$ref": "#/parameters/termTemplateDefGuid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MoveEntitiesOptions" + } } ], "responses": { "200": { - "description": "OK. On successful lookup of the the term template definition by its GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TermTemplateDef" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_MoveEntitiesToCollection": { + "$ref": "./examples/Entity_MoveEntitiesToCollection.json" + } } } }, - "/types/termtemplatedef/name/{name}": { + "/lineage/{guid}/next": { "get": { - "tags": [ - "Type" - ], - "description": "Get the term template definition by its name (unique).", - "operationId": "Type_GetTermTemplateDefByName", - "x-ms-examples": { - "Type_GetTermTemplateDefByName": { - "$ref": "./examples/Type_GetTermTemplateDefByName.json" - } - }, + "operationId": "Lineage_GetNextPage", + "description": "Return immediate next page lineage info about entity with pagination", "parameters": [ { - "$ref": "#/parameters/termTemplateDefName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] + } + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the term template definition by its name.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TermTemplateDef" + "$ref": "#/definitions/AtlasLineageInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Lineage_GetNextPage": { + "$ref": "./examples/Lineage_GetNextPage.json" + } } } - } - }, - "definitions": { - "AtlasAttributeDef": { - "type": "object", - "properties": { - "cardinality": { - "$ref": "#/definitions/Cardinality" - }, - "constraints": { - "type": "array", - "description": "An array of constraints.", - "items": { - "$ref": "#/definitions/AtlasConstraintDef" + }, + "/search/autocomplete": { + "post": { + "operationId": "Discovery_AutoComplete", + "description": "Get auto complete options.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutoCompleteOptions" + } } - }, - "defaultValue": { - "type": "string", - "description": "The default value of the attribute." - }, - "description": { - "type": "string", - "description": "The description of the attribute." - }, - "includeInNotification": { - "type": "boolean", - "description": "Determines if it is included in notification." - }, - "isIndexable": { - "type": "boolean", - "description": "Determines if it is indexable." - }, - "isOptional": { - "type": "boolean", - "description": "Determines if it is optional." - }, - "isUnique": { - "type": "boolean", - "description": "Determines if it unique." - }, - "name": { - "type": "string", - "description": "The name of the attribute." - }, - "options": { - "type": "object", - "description": "The options for the attribute.", - "additionalProperties": { - "type": "string" + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AutoCompleteResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "valuesMaxCount": { - "type": "integer", - "format": "int32", - "description": "The maximum count of the values." - }, - "valuesMinCount": { - "type": "integer", - "format": "int32", - "description": "The minimum count of the values." - } - }, - "title": "AtlasAttributeDef", - "description": "class that captures details of a struct-attribute." - }, - "AtlasBaseModelObject": { - "type": "object", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." + "x-ms-examples": { + "Discovery_AutoComplete": { + "$ref": "./examples/Discovery_AutoComplete.json" + } } - }, - "title": "AtlasBaseModelObject", - "description": "The base model object." + } }, - "AtlasBaseTypeDef": { - "type": "object", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory" - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat" - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" + "/search/query": { + "post": { + "operationId": "Discovery_Query", + "description": "Get data using search.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, - "serviceType": { - "readOnly": false, - "description": "The service type.", - "type": "string" - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "number", - "description": "The version of the record." - }, - "lastModifiedTS": { - "$ref": "#/definitions/LastModifiedTS" - } - }, - "title": "AtlasBaseTypeDef", - "description": "Base class that captures common-attributes for all types." - }, - "AtlasBusinessMetadataDef": { - "type": "object", - "title": "AtlasBusinessMetadataDef", - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" + "x-ms-examples": { + "Discovery_Query": { + "$ref": "./examples/Discovery_Query.json" + }, + "Discovery_Query_And": { + "$ref": "./examples/Discovery_Query_And.json" + }, + "Discovery_Query_AndOrNested": { + "$ref": "./examples/Discovery_Query_AndOrNested.json" + }, + "Discovery_Query_AssetType": { + "$ref": "./examples/Discovery_Query_AssetType.json" + }, + "Discovery_Query_Attribute": { + "$ref": "./examples/Discovery_Query_Attribute.json" + }, + "Discovery_Query_BusinessMetadataAttribute": { + "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" + }, + "Discovery_Query_Classification": { + "$ref": "./examples/Discovery_Query_Classification.json" + }, + "Discovery_Query_Collection": { + "$ref": "./examples/Discovery_Query_Collection.json" + }, + "Discovery_Query_Facet": { + "$ref": "./examples/Discovery_Query_Facet.json" + }, + "Discovery_Query_FileExtension": { + "$ref": "./examples/Discovery_Query_FileExtension.json" + }, + "Discovery_Query_GlossaryTerm": { + "$ref": "./examples/Discovery_Query_GlossaryTerm.json" + }, + "Discovery_Query_Id": { + "$ref": "./examples/Discovery_Query_Id.json" + }, + "Discovery_Query_Not": { + "$ref": "./examples/Discovery_Query_Not.json" + }, + "Discovery_Query_ObjectType": { + "$ref": "./examples/Discovery_Query_ObjectType.json" + }, + "Discovery_Query_PaginationContinuationPage": { + "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" + }, + "Discovery_Query_PaginationFirstPage": { + "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" + }, + "Discovery_Query_PaginationLastPage": { + "$ref": "./examples/Discovery_Query_PaginationLastPage.json" + }, + "Discovery_Query_SystemTime": { + "$ref": "./examples/Discovery_Query_SystemTime.json" + }, + "Discovery_Query_Taxonomy": { + "$ref": "./examples/Discovery_Query_Taxonomy.json" + }, + "Discovery_Query_TermAssignment": { + "$ref": "./examples/Discovery_Query_TermAssignment.json" + }, + "Discovery_Query_Type": { + "$ref": "./examples/Discovery_Query_Type.json" + } } - ], - "description": "class that captures details of a struct-type." + } }, - "AtlasClassification": { - "type": "object", - "title": "AtlasClassification", - "properties": { - "entityGuid": { - "type": "string", - "description": "The GUID of the entity." - }, - "entityStatus": { - "$ref": "#/definitions/Status" - }, - "removePropagationsOnEntityDelete": { - "type": "boolean", - "description": "Determines if propagations will be removed on entity deletion." + "/search/suggest": { + "post": { + "operationId": "Discovery_Suggest", + "description": "Get search suggestions by query criteria.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SuggestOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SuggestResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } }, - "validityPeriods": { - "type": "array", - "description": "An array of time boundaries indicating validity periods.", - "items": { - "$ref": "#/definitions/TimeBoundary" + "x-ms-examples": { + "Discovery_Suggest": { + "$ref": "./examples/Discovery_Suggest.json" } } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStruct" - } - ], - "description": "An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity." + } }, - "AtlasClassificationDef": { - "type": "object", - "title": "AtlasClassificationDef", - "properties": { - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that classifications can\nonly be applied to those entityTypes.\n
    \n
  • Any subtypes of the entity types inherit the restriction
    • \n
  • Any classificationDef subtypes inherit the parents entityTypes restrictions
    • \n
  • Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes
    • \n
  • An empty entityTypes list when there are no parent restrictions means there are no restrictions
    • \n
  • An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs
    • \n
", - "items": { + "/types/termtemplatedef/guid/{guid}": { + "get": { + "operationId": "Type_GetTermTemplateDefByGuid", + "description": "Get the term template definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the term template.", + "required": true, "type": "string" } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" + "x-ms-examples": { + "Type_GetTermTemplateDefByGuid": { + "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" } } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" - } - ], - "description": "class that captures details of a classification-type." - }, - "AtlasClassifications": { - "type": "object", - "title": "AtlasClassifications", - "allOf": [ - { - "$ref": "#/definitions/PList" - } - ], - "description": "REST serialization friendly list." + } }, - "AtlasConstraintDef": { - "type": "object", - "properties": { - "params": { - "type": "object", - "description": "The parameters of the constraint definition.", - "additionalProperties": {} + "/types/termtemplatedef/name/{name}": { + "get": { + "operationId": "Type_GetTermTemplateDefByName", + "description": "Get the term template definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The unique name of the term template.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } }, - "type": { - "type": "string", - "description": "The type of the constraint." - } - }, - "title": "AtlasConstraintDef", - "description": "class that captures details of a constraint." - }, - "AtlasEntitiesWithExtInfo": { - "type": "object", - "title": "AtlasEntitiesWithExtInfo", - "properties": { - "entities": { - "type": "array", - "description": "An array of entities.", - "items": { - "$ref": "#/definitions/AtlasEntity" + "x-ms-examples": { + "Type_GetTermTemplateDefByName": { + "$ref": "./examples/Type_GetTermTemplateDefByName.json" } } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasEntityExtInfo" - } - ], - "description": "An instance of an entity along with extended info - like hive_table, hive_database." - }, - "AtlasEntity": { + } + } + }, + "definitions": { + "AtlasAttributeDef": { "type": "object", - "title": "AtlasEntity", + "description": "class that captures details of a struct-attribute.", "properties": { - "businessAttributes": { - "readOnly": false, - "description": "Business Attributes", - "type": "object", - "additionalProperties": { - "type": "object" - } + "cardinality": { + "$ref": "#/definitions/CardinalityValue", + "description": "single-valued attribute or multi-valued attribute." }, - "classifications": { + "constraints": { "type": "array", - "description": "An array of classifications.", + "description": "An array of constraints.", "items": { - "$ref": "#/definitions/AtlasClassification" - } - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." + "$ref": "#/definitions/AtlasConstraintDef" + }, + "x-ms-identifiers": [] }, - "createdBy": { + "defaultValue": { "type": "string", - "description": "The user who created the record." + "description": "The default value of the attribute." }, - "customAttributes": { - "readOnly": false, - "description": "Custom Attribute", + "description": { + "type": "string", + "description": "The description of the attribute." + }, + "includeInNotification": { + "type": "boolean", + "description": "Determines if it is included in notification." + }, + "isIndexable": { + "type": "boolean", + "description": "Determines if it is indexable." + }, + "isOptional": { + "type": "boolean", + "description": "Determines if it is optional." + }, + "isUnique": { + "type": "boolean", + "description": "Determines if it unique." + }, + "name": { + "type": "string", + "description": "The name of the attribute." + }, + "options": { "type": "object", + "description": "The options for the attribute.", "additionalProperties": { "type": "string" } }, - "guid": { + "typeName": { "type": "string", - "description": "The GUID of the entity." + "description": "The name of the type." }, - "homeId": { + "valuesMaxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum count of the values." + }, + "valuesMinCount": { + "type": "integer", + "format": "int32", + "description": "The minimum count of the values." + } + } + }, + "AtlasBusinessMetadataDef": { + "type": "object", + "description": "class that captures details of a struct-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { "type": "string", - "description": "The home ID of the entity." + "description": "The user who created the record." }, - "collectionId": { - "readOnly": true, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { "type": "string", - "description": "The collection ID of the entity." + "description": "The description of the type definition." }, - "isIncomplete": { - "readOnly": false, - "description": "Whether it is a shell entity", - "type": "boolean" + "guid": { + "type": "string", + "description": "The GUID of the type definition." }, - "labels": { - "readOnly": false, - "description": "labels", - "type": "array", - "items": { + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { "type": "string" } }, - "meanings": { + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { "type": "array", - "description": "An array of term assignment headers indicating the meanings of the entity.", + "description": "An array of attribute definitions.", "items": { - "$ref": "#/definitions/AtlasTermAssignmentHeader" - } + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasClassification": { + "type": "object", + "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} }, - "provenanceType": { - "readOnly": false, - "description": "Used to record the provenance of an instance of an entity or relationship.", - "type": "number" + "typeName": { + "type": "string", + "description": "The name of the type." }, - "proxy": { + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "entityGuid": { + "type": "string", + "description": "The GUID of the entity." + }, + "entityStatus": { + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + }, + "removePropagationsOnEntityDelete": { "type": "boolean", - "description": "Determines if there's a proxy." + "description": "Determines if propagations will be removed on entity deletion." }, - "relationshipAttributes": { + "validityPeriods": { + "type": "array", + "description": "An array of time boundaries indicating validity periods.", + "items": { + "$ref": "#/definitions/TimeBoundary" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasClassificationDef": { + "type": "object", + "description": "class that captures details of a classification-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { "type": "object", - "description": "The attributes of relationship.", - "additionalProperties": {} + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } }, - "status": { - "$ref": "#/definitions/Status" + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." }, "updateTime": { "type": "integer", @@ -4362,41 +4745,29 @@ "description": "The user who updated the record." }, "version": { - "type": "number", - "description": "The version of the entity." + "type": "integer", + "format": "int64", + "description": "The version of the record." }, - "contacts": { - "type": "object", - "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/ContactBasic" - } + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", + "items": { + "type": "string" } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStruct" - } - ], - "description": "An instance of an entity - like hive_table, hive_database." - }, - "TermTemplateDef": { - "type": "object", - "title": "TermTemplateDef", - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" - } - ], - "description": "term template definition for glossary term." - }, - "AtlasEntityDef": { - "type": "object", - "title": "AtlasEntityDef", - "properties": { + }, "subTypes": { "type": "array", "description": "An array of sub types.", @@ -4410,244 +4781,174 @@ "items": { "type": "string" } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" - } - ], - "description": "class that captures details of a entity-type." - }, - "AtlasEntityExtInfo": { - "type": "object", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } } - }, - "title": "AtlasEntityExtInfo", - "description": "An instance of an entity along with extended info - like hive_table, hive_database." + } }, - "AtlasEntityHeader": { + "AtlasClassifications": { "type": "object", - "title": "AtlasEntityHeader", + "description": "REST serialization friendly list.", "properties": { - "classificationNames": { + "list": { "type": "array", - "description": "An array of classification names.", - "items": { - "type": "string" - } - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - } + "description": "An array of objects.", + "items": {} }, - "displayText": { - "type": "string", - "description": "The display text." + "pageSize": { + "type": "integer", + "format": "int32", + "description": "The size of the page." }, - "guid": { + "sortBy": { "type": "string", - "description": "The GUID of the record." - }, - "isIncomplete": { - "readOnly": false, - "description": "Whether it is a shell entity", - "type": "boolean" - }, - "labels": { - "readOnly": false, - "description": "labels", - "type": "array", - "items": { - "type": "string" - } + "description": "The sorted by field." }, - "meaningNames": { - "type": "array", - "description": "An array of meanings.", - "items": { - "type": "string" - } + "sortType": { + "$ref": "#/definitions/SortType", + "description": "to specify whether the result should be sorted? If yes, whether asc or desc." }, - "meanings": { - "type": "array", - "description": "An array of term assignment headers.", - "items": { - "$ref": "#/definitions/AtlasTermAssignmentHeader" - } + "startIndex": { + "type": "integer", + "format": "int32", + "description": "The start index of the page." }, - "status": { - "$ref": "#/definitions/Status" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStruct" + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count of items." } - ], - "description": "An instance of an entity - like hive_table, hive_database." + } }, - "AtlasEntityHeaders": { + "AtlasConstraintDef": { "type": "object", - "title": "AtlasEntityHeaders", + "description": "class that captures details of a constraint.", "properties": { - "guidHeaderMap": { - "readOnly": false, - "description": "The description of the guid header map,", + "params": { "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - } - }, - "description": "An instance of an entity header map." - }, - "AtlasEntityWithExtInfo": { - "type": "object", - "title": "AtlasEntityWithExtInfo", - "properties": { - "entity": { - "$ref": "#/definitions/AtlasEntity" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasEntityExtInfo" + "description": "The parameters of the constraint definition.", + "additionalProperties": {} + }, + "type": { + "type": "string", + "description": "The type of the constraint." } - ], - "description": "An instance of an entity along with extended info - like hive_table, hive_database." + } }, - "AtlasEnumDef": { + "AtlasEntitiesWithExtInfo": { "type": "object", - "title": "AtlasEnumDef", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", "properties": { - "defaultValue": { - "type": "string", - "description": "The default value." + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } }, - "elementDefs": { + "entities": { "type": "array", - "description": "An array of enum element definitions.", + "description": "An array of entities.", "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasBaseTypeDef" + "$ref": "#/definitions/AtlasEntity" + }, + "x-ms-identifiers": [] } - ], - "description": "class that captures details of an enum-type." + } }, - "AtlasEnumElementDef": { + "AtlasEntity": { "type": "object", + "description": "An instance of an entity - like hive_table, hive_database.", "properties": { - "description": { - "type": "string", - "description": "The description of the enum element definition." - }, - "ordinal": { - "type": "number", - "description": "The ordinal of the enum element definition." + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} }, - "value": { + "typeName": { "type": "string", - "description": "The value of the enum element definition." - } - }, - "title": "AtlasEnumElementDef", - "description": "class that captures details of an enum-element." - }, - "AtlasGlossary": { - "type": "object", - "title": "AtlasGlossary", - "properties": { - "categories": { - "type": "array", - "description": "An array of categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - } + "description": "The name of the type." }, - "language": { + "lastModifiedTS": { "type": "string", - "description": "The language of the glossary." + "description": "ETag for concurrency control." }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "businessAttributes": { + "type": "object", + "description": "Business attributes", + "additionalProperties": {} }, - "usage": { - "type": "string", - "description": "The usage of the glossary." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasGlossaryBaseObject" - } - ], - "description": "The glossary object." - }, - "AtlasGlossaryBaseObject": { - "type": "object", - "title": "AtlasGlossaryBaseObject", - "properties": { "classifications": { "type": "array", "description": "An array of classifications.", "items": { "$ref": "#/definitions/AtlasClassification" - } + }, + "x-ms-identifiers": [] }, - "longDescription": { + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { "type": "string", - "description": "The long version description." + "description": "The user who created the record." }, - "name": { + "customAttributes": { + "type": "object", + "description": "Custom Attribute", + "additionalProperties": { + "type": "string" + } + }, + "guid": { "type": "string", - "description": "The name of the glossary object." + "description": "The GUID of the entity." }, - "qualifiedName": { + "homeId": { "type": "string", - "description": "The qualified name of the glossary object." + "description": "The home ID of the entity." }, - "shortDescription": { + "collectionId": { "type": "string", - "description": "The short version of description." + "description": "The collection ID of the entity.", + "readOnly": true }, - "lastModifiedTS": { - "$ref": "#/definitions/LastModifiedTS" + "isIncomplete": { + "type": "boolean", + "description": "Whether it is a shell entity" }, - "createTime": { + "labels": { + "type": "array", + "description": "labels", + "items": { + "type": "string" + } + }, + "meanings": { + "type": "array", + "description": "An array of term assignment headers indicating the meanings of the entity.", + "items": { + "$ref": "#/definitions/AtlasTermAssignmentHeader" + }, + "x-ms-identifiers": [] + }, + "provenanceType": { "type": "integer", - "format": "int64", - "description": "The created time of the record." + "format": "int32", + "description": "Used to record the provenance of an instance of an entity or relationship." }, - "createdBy": { - "type": "string", - "description": "The user who created the record." + "proxy": { + "type": "boolean", + "description": "Determines if there's a proxy." + }, + "relationshipAttributes": { + "type": "object", + "description": "The attributes of relationship.", + "additionalProperties": {} + }, + "status": { + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." }, "updateTime": { "type": "integer", @@ -4657,533 +4958,377 @@ "updatedBy": { "type": "string", "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the entity." + }, + "contacts": { + "type": "object", + "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/ContactInfo" + }, + "type": "array" + } } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasBaseModelObject" - } - ], - "description": "The glossary base object." + } }, - "AtlasGlossaryCategory": { + "AtlasEntityDef": { "type": "object", - "title": "AtlasGlossaryCategory", + "description": "class that captures details of a entity-type.", "properties": { - "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader" + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." }, - "childrenCategories": { - "type": "array", - "description": "An array of children categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - } + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." }, - "parentCategory": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" + "createdBy": { + "type": "string", + "description": "The user who created the record." }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasGlossaryBaseObject" - } - ], - "description": "The glossary category." - }, - "AtlasGlossaryExtInfo": { - "type": "object", - "title": "AtlasGlossaryExtInfo", - "properties": { - "categoryInfo": { - "type": "object", - "description": "The glossary category information.", - "additionalProperties": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." }, - "termInfo": { - "type": "object", - "description": "The glossary term information.", - "additionalProperties": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasGlossary" - } - ], - "description": "The extended information of glossary." - }, - "AtlasGlossaryHeader": { - "type": "object", - "properties": { - "displayText": { + "description": { "type": "string", - "description": "The display text." + "description": "The description of the type definition." }, - "glossaryGuid": { + "guid": { "type": "string", - "description": "The GUID of the glossary." + "description": "The GUID of the type definition." }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - } - }, - "title": "AtlasGlossaryHeader", - "description": "The glossary header with basic information." - }, - "AtlasGlossaryTerm": { - "type": "object", - "title": "AtlasGlossaryTerm", - "properties": { - "abbreviation": { + "name": { "type": "string", - "description": "The abbreviation of the term." - }, - "templateName": { - "type": "array", - "items": { - "type": "object" - } - }, - "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader" + "description": "The name of the type definition." }, - "antonyms": { - "type": "array", - "description": "An array of related term headers as antonyms.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" } }, - "status": { - "$ref": "#/definitions/TermStatus" - }, - "nickName": { + "serviceType": { "type": "string", - "description": "The nick name of the term." + "description": "The service type." }, - "hierarchyInfo": { - "type": "array", - "description": "The hierarchy information of the term.", - "items": { - "$ref": "#/definitions/PurviewObjectId" - } + "typeVersion": { + "type": "string", + "description": "The version of the type." }, - "resources": { - "type": "array", - "description": "An array of resource link for term", - "items": { - "$ref": "#/definitions/ResourceLink" - } + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." }, - "contacts": { - "type": "object", - "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/ContactBasic" - } - } + "updatedBy": { + "type": "string", + "description": "The user who updated the record." }, - "attributes": { - "$ref": "#/definitions/TermCustomAttributes" + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." }, - "assignedEntities": { - "type": "array", - "description": "An array of related object IDs.", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - } + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." }, - "categories": { + "attributeDefs": { "type": "array", - "description": "An array of term categorization headers.", + "description": "An array of attribute definitions.", "items": { - "$ref": "#/definitions/AtlasTermCategorizationHeader" - } + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] }, - "classifies": { + "subTypes": { "type": "array", - "description": "An array of related term headers.", + "description": "An array of sub types.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "type": "string" } }, - "examples": { + "superTypes": { "type": "array", - "description": "An array of examples.", + "description": "An array of super types.", "items": { "type": "string" } }, - "isA": { + "relationshipAttributeDefs": { "type": "array", - "description": "An array of related term headers indicating the is-a relationship.", + "description": "An array of relationship attributes.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasEntityHeader": { + "type": "object", + "description": "An instance of an entity - like hive_table, hive_database.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} }, - "preferredTerms": { - "type": "array", - "description": "An array of preferred related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "typeName": { + "type": "string", + "description": "The name of the type." }, - "preferredToTerms": { - "type": "array", - "description": "An array of related term headers that are preferred to.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." }, - "replacedBy": { + "classificationNames": { "type": "array", - "description": "An array of related term headers that are replaced by.", + "description": "An array of classification names.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "type": "string" } }, - "replacementTerms": { + "classifications": { "type": "array", - "description": "An array of related term headers for replacement.", + "description": "An array of classifications.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] }, - "seeAlso": { - "type": "array", - "description": "An array of related term headers for see also.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "displayText": { + "type": "string", + "description": "The display text." }, - "synonyms": { - "type": "array", - "description": "An array of related term headers as synonyms.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "guid": { + "type": "string", + "description": "The GUID of the record." }, - "translatedTerms": { - "type": "array", - "description": "An array of translated related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } + "isIncomplete": { + "type": "boolean", + "description": "Whether it is a shell entity" }, - "translationTerms": { + "labels": { "type": "array", - "description": "An array of related term headers for translation.", + "description": "labels", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "type": "string" } }, - "usage": { - "type": "string", - "description": "The usage of the term." - }, - "validValues": { + "meaningNames": { "type": "array", - "description": "An array of related term headers as valid values.", + "description": "An array of meanings.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "type": "string" } }, - "validValuesFor": { + "meanings": { "type": "array", - "description": "An array of related term headers as valid values for other records.", + "description": "An array of term assignment headers.", "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasGlossaryBaseObject" - } - ], - "description": "The glossary term." - }, - "ResourceLink": { - "title": "ResourceLink", - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Display name for url." + "$ref": "#/definitions/AtlasTermAssignmentHeader" + }, + "x-ms-identifiers": [] }, - "url": { - "type": "string", - "description": "web url. http or https" + "status": { + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." } } }, - "ContactBasic": { - "title": "ContactBasic", + "AtlasEntityHeaders": { "type": "object", + "description": "An instance of an entity header map.", "properties": { - "id": { - "type": "string", - "description": "Azure Active Directory object Id." - }, - "info": { - "type": "string", - "description": "additional information to describe this contact." + "guidHeaderMap": { + "type": "object", + "description": "The description of the guid header map,", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } } } }, - "TermStatus": { - "type": "string", - "title": "Status", - "description": "Status of the AtlasGlossaryTerm", - "enum": [ - "Draft", - "Approved", - "Alert", - "Expired" - ], - "x-ms-enum": { - "name": "TermStatus", - "modelAsString": true - } - }, - "TermCustomAttributes": { - "title": "attributes", - "description": "The custom attributes of the term, which is map>.\nThe key of the first layer map is term template name.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TermCustomAttributesExtraProperties" - } - }, - "TermCustomAttributesExtraProperties": { - "type": "object", - "description": "The term attribute name and attribute value, which is map", - "additionalProperties": { - "description": "The value of custom term attribute" - } - }, - "AtlasLineageInfo": { + "AtlasEntityWithExtInfo": { "type": "object", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", "properties": { - "baseEntityGuid": { - "type": "string", - "description": "The GUID of the base entity." - }, - "guidEntityMap": { - "type": "object", - "description": "The GUID entity map.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "widthCounts": { + "referredEntities": { "type": "object", - "description": "The entity count in specific direction.", + "description": "The referred entities.", "additionalProperties": { - "$ref": "#/definitions/AtlasLineageInfoExtraProperties" + "$ref": "#/definitions/AtlasEntity" } }, - "lineageDepth": { - "type": "integer", - "format": "int32", - "description": "The depth of lineage." + "entity": { + "$ref": "#/definitions/AtlasEntity", + "description": "An instance of an entity - like hive_table, hive_database." + } + } + }, + "AtlasEnumDef": { + "type": "object", + "description": "class that captures details of an enum-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." }, - "lineageWidth": { + "createTime": { "type": "integer", - "format": "int32", - "description": "The width of lineage." + "format": "int64", + "description": "The created time of the record." }, - "childrenCount": { - "type": "integer", - "format": "int32", - "description": "The number of children node." + "createdBy": { + "type": "string", + "description": "The user who created the record." }, - "lineageDirection": { - "$ref": "#/definitions/LineageDirection" + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." }, - "parentRelations": { - "type": "array", - "description": "An array of parentRelations relations.", - "items": { - "$ref": "#/definitions/ParentRelation" - } + "description": { + "type": "string", + "description": "The description of the type definition." }, - "relations": { - "type": "array", - "description": "An array of lineage relations.", - "items": { - "$ref": "#/definitions/LineageRelation" - } - } - }, - "title": "AtlasLineageInfo", - "description": "The lineage information." - }, - "AtlasLineageInfoExtraProperties": { - "type": "object", - "description": "The lineage direction", - "additionalProperties": { - "description": "The entity guid." - } - }, - "AtlasObjectId": { - "type": "object", - "properties": { "guid": { "type": "string", - "description": "The GUID of the object." + "description": "The GUID of the type definition." }, - "typeName": { + "name": { "type": "string", - "description": "The name of the type." + "description": "The name of the type definition." }, - "uniqueAttributes": { + "options": { "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - } - }, - "title": "AtlasObjectId", - "description": "Reference to an object-instance of a type - like entity." - }, - "PurviewObjectId": { - "type": "object", - "properties": { - "name": { - "type": "string" + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } }, - "displayText": { - "type": "string" + "serviceType": { + "type": "string", + "description": "The service type." }, - "itemPath": { - "type": "string" + "typeVersion": { + "type": "string", + "description": "The version of the type." }, - "resourceId": { - "type": "string" + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." }, - "properties": { - "type": "object", - "additionalProperties": {} - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasObjectId" - } - ], - "title": "PurviewObjectId" - }, - "AtlasRelatedCategoryHeader": { - "type": "object", - "properties": { - "categoryGuid": { + "updatedBy": { "type": "string", - "description": "The GUID of the category." + "description": "The user who updated the record." }, - "description": { - "type": "string", - "description": "The description of the category header." + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." }, - "displayText": { + "lastModifiedTS": { "type": "string", - "description": "The display text." + "description": "ETag for concurrency control." }, - "parentCategoryGuid": { + "defaultValue": { "type": "string", - "description": "The GUID of the parent category." + "description": "The default value." }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + }, + "x-ms-identifiers": [] } - }, - "title": "AtlasRelatedCategoryHeader", - "description": "The header of the related category." + } }, - "AtlasRelatedObjectId": { + "AtlasEnumElementDef": { "type": "object", - "title": "AtlasRelatedObjectId", + "description": "class that captures details of an enum-element.", "properties": { - "displayText": { + "description": { "type": "string", - "description": "The display text." - }, - "entityStatus": { - "$ref": "#/definitions/Status" + "description": "The description of the enum element definition." }, - "relationshipType": { - "type": "string" + "ordinal": { + "type": "integer", + "format": "int32", + "description": "The ordinal of the enum element definition." }, - "relationshipAttributes": { - "$ref": "#/definitions/AtlasStruct" + "value": { + "type": "string", + "description": "The value of the enum element definition." + } + } + }, + "AtlasErrorResponse": { + "type": "object", + "description": "An error response from the service", + "properties": { + "requestId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The request ID." }, - "relationshipGuid": { + "errorCode": { "type": "string", - "description": "The GUID of the relationship." + "description": "The error code." }, - "relationshipStatus": { - "$ref": "#/definitions/Status_AtlasRelationship" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasObjectId" + "errorMessage": { + "type": "string", + "description": "The error message." } - ], - "description": "Reference to an object-instance of AtlasEntity type used in relationship attribute values" + } }, - "AtlasRelatedTermHeader": { + "AtlasGlossary": { "type": "object", + "description": "The glossary object.", "properties": { - "description": { + "guid": { "type": "string", - "description": "The description of the related term." + "description": "The GUID of the object." }, - "displayText": { - "type": "string", - "description": "The display text." + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] }, - "expression": { + "longDescription": { "type": "string", - "description": "The expression of the term." + "description": "The long version description." }, - "relationGuid": { + "name": { "type": "string", - "description": "The GUID of the relationship." + "description": "The name of the glossary object." }, - "status": { - "$ref": "#/definitions/AtlasTermRelationshipStatus" + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." }, - "steward": { + "shortDescription": { "type": "string", - "description": "The steward of the term." + "description": "The short version of description." }, - "termGuid": { + "lastModifiedTS": { "type": "string", - "description": "The GUID of the term." - } - }, - "title": "AtlasRelatedTermHeader", - "description": "The header of the related term." - }, - "AtlasRelationship": { - "type": "object", - "title": "AtlasRelationship", - "properties": { + "description": "ETag for concurrency control." + }, "createTime": { "type": "integer", "format": "int64", @@ -5193,31 +5338,85 @@ "type": "string", "description": "The user who created the record." }, - "end1": { - "$ref": "#/definitions/AtlasObjectId" + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." }, - "end2": { - "$ref": "#/definitions/AtlasObjectId" + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "categories": { + "type": "array", + "description": "An array of categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + }, + "language": { + "type": "string", + "description": "The language of the glossary." + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, + "usage": { + "type": "string", + "description": "The usage of the glossary." + } + } + }, + "AtlasGlossaryCategory": { + "type": "object", + "description": "The glossary category.", + "properties": { "guid": { "type": "string", - "description": "The GUID of the relationship." + "description": "The GUID of the object." }, - "homeId": { + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { "type": "string", - "description": "The home ID of the relationship." + "description": "The long version description." }, - "label": { + "name": { "type": "string", - "description": "The label of the relationship." + "description": "The name of the glossary object." }, - "provenanceType": { - "readOnly": false, - "description": "Used to record the provenance of an instance of an entity or relationship", - "type": "number" + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." }, - "status": { - "$ref": "#/definitions/Status_AtlasRelationship" + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." }, "updateTime": { "type": "integer", @@ -5228,2039 +5427,2824 @@ "type": "string", "description": "The user who updated the record." }, - "version": { - "type": "number", - "description": "The version of the relationship." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStruct" - } - ], - "description": "Atlas relationship instance." - }, - "AtlasRelationshipDef": { - "type": "object", - "title": "AtlasRelationshipDef", - "properties": { - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef" + "anchor": { + "$ref": "#/definitions/AtlasGlossaryHeader", + "description": "The glossary header with basic information." }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef" + "childrenCategories": { + "type": "array", + "description": "An array of children categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory" + "parentCategory": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader", + "description": "The header of the related category." }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] } - ], - "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\n

\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.\nThe name and the guid are the 2 ways that the RelationshipDef is identified.\n

\nRelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally\nwhether the end is a container.\n

\nRelationshipDefs can have AttributeDefs - though only primitive types are allowed.
\nRelationshipDefs have a relationshipCategory specifying the UML type of relationship required
\nThe way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as their types.\n

\nRelationshipDefs introduce new attributes to the entity instances. For example\n

\nEntityDef A might have attributes attr1,attr2,attr3
\nEntityDef B might have attributes attr4,attr5,attr6
\nRelationshipDef AtoB might define 2 ends
\n\n

\n   end1:  type A, name attr7\n   end2:  type B, name attr8
\n\n

\nWhen an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7
\nWhen an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8\n

\nIn this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into\nthe entity instances" + } }, - "AtlasRelationshipEndDef": { + "AtlasGlossaryExtInfo": { "type": "object", + "description": "The extended information of glossary.", "properties": { - "cardinality": { - "$ref": "#/definitions/Cardinality" - }, - "description": { + "guid": { "type": "string", - "description": "The description of the relationship end definition." + "description": "The GUID of the object." }, - "isContainer": { - "type": "boolean", - "description": "Determines if it is container." + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] }, - "isLegacyAttribute": { - "type": "boolean", - "description": "Determines if it is a legacy attribute." + "longDescription": { + "type": "string", + "description": "The long version description." }, "name": { "type": "string", - "description": "The name of the relationship end definition." + "description": "The name of the glossary object." }, - "type": { + "qualifiedName": { "type": "string", - "description": "The type of the relationship end." - } - }, - "title": "AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an\nattribute name, cardinality and whether it is the container end of the relationship." - }, - "AtlasRelationshipAttributeDef": { - "type": "object", - "properties": { - "isLegacyAttribute": { - "type": "boolean", - "description": "Determines if it is a legacy attribute." + "description": "The qualified name of the glossary object." }, - "relationshipTypeName": { + "shortDescription": { "type": "string", - "description": "The name of the relationship type." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasAttributeDef" - } - ], - "title": "AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an\nattribute name, cardinality and whether it is the container end of the relationship." - }, - "AtlasRelationshipWithExtInfo": { - "type": "object", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entity header.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "relationship": { - "$ref": "#/definitions/AtlasRelationship" - } - }, - "title": "AtlasRelationshipWithExtInfo", - "description": "The relationship with extended information." - }, - "AtlasStruct": { - "type": "object", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} + "description": "The short version of description." }, - "typeName": { + "lastModifiedTS": { "type": "string", - "description": "The name of the type." + "description": "ETag for concurrency control." }, - "lastModifiedTS": { - "$ref": "#/definitions/LastModifiedTS" - } - }, - "title": "AtlasStruct", - "description": "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." - }, - "AtlasStructDef": { - "type": "object", - "title": "AtlasStructDef", - "properties": { - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasBaseTypeDef" - } - ], - "description": "class that captures details of a struct-type." - }, - "AtlasTermAssignmentHeader": { - "type": "object", - "properties": { - "confidence": { + "createTime": { "type": "integer", - "format": "int32", - "description": "The confidence of the term assignment." + "format": "int64", + "description": "The created time of the record." }, "createdBy": { "type": "string", "description": "The user who created the record." }, - "description": { - "type": "string", - "description": "The description of the term assignment." + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." }, - "displayText": { + "updatedBy": { "type": "string", - "description": "The display text." + "description": "The user who updated the record." }, - "expression": { - "type": "string", - "description": "The expression of the term assignment." + "categories": { + "type": "array", + "description": "An array of categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] }, - "relationGuid": { + "language": { "type": "string", - "description": "The GUID of the relationship." + "description": "The language of the glossary." }, - "status": { - "$ref": "#/definitions/AtlasTermAssignmentStatus" + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "steward": { + "usage": { "type": "string", - "description": "The steward of the term." + "description": "The usage of the glossary." }, - "termGuid": { - "type": "string", - "description": "The GUID of the term." + "categoryInfo": { + "type": "object", + "description": "The glossary category information.", + "additionalProperties": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "termInfo": { + "type": "object", + "description": "The glossary term information.", + "additionalProperties": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } } - }, - "title": "AtlasTermAssignmentHeader", - "description": "The header for term assignment." + } }, - "AtlasTermAssignmentStatus": { - "type": "string", - "title": "AtlasTermAssignmentStatus", - "description": "The status of terms assignment.", - "enum": [ - "DISCOVERED", - "PROPOSED", - "IMPORTED", - "VALIDATED", - "DEPRECATED", - "OBSOLETE", - "OTHER" - ], - "x-ms-enum": { - "name": "AtlasTermAssignmentStatus", - "modelAsString": true - } - }, - "AtlasTermCategorizationHeader": { + "AtlasGlossaryHeader": { "type": "object", + "description": "The glossary header with basic information.", "properties": { - "categoryGuid": { - "type": "string", - "description": "The GUID of the category." - }, - "description": { - "type": "string", - "description": "The description of the record." - }, "displayText": { "type": "string", "description": "The display text." }, + "glossaryGuid": { + "type": "string", + "description": "The GUID of the glossary." + }, "relationGuid": { "type": "string", "description": "The GUID of the relationship." - }, - "status": { - "$ref": "#/definitions/AtlasTermRelationshipStatus" } - }, - "title": "AtlasTermCategorizationHeader", - "description": "The basic information for term categorization." - }, - "AtlasTermRelationshipStatus": { - "type": "string", - "title": "AtlasTermRelationshipStatus", - "description": "The status of term relationship.", - "enum": [ - "DRAFT", - "ACTIVE", - "DEPRECATED", - "OBSOLETE", - "OTHER" - ], - "x-ms-enum": { - "name": "AtlasTermRelationshipStatus", - "modelAsString": true } }, - "AtlasTypeDefHeader": { + "AtlasGlossaryTerm": { "type": "object", + "description": "The glossary term.", "properties": { - "category": { - "$ref": "#/definitions/TypeCategory" - }, "guid": { "type": "string", - "description": "The GUID of the type definition." + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." }, "name": { "type": "string", - "description": "The name of the type definition." - } - }, - "title": "AtlasTypeDefHeader", - "description": "The basic information of the type definition." - }, - "AtlasTypesDef": { - "type": "object", - "properties": { - "businessMetadataDefs": { - "readOnly": false, - "description": "businessMetadataDefs", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "abbreviation": { + "type": "string", + "description": "The abbreviation of the term." + }, + "templateName": { "type": "array", - "items": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - } + "description": "The name of the template.", + "items": {} }, - "classificationDefs": { + "anchor": { + "$ref": "#/definitions/AtlasGlossaryHeader", + "description": "The glossary header with basic information." + }, + "antonyms": { "type": "array", - "description": "An array of classification definitions.", + "description": "An array of related term headers as antonyms.", "items": { - "$ref": "#/definitions/AtlasClassificationDef" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "entityDefs": { + "status": { + "$ref": "#/definitions/TermStatus", + "description": "Status of the AtlasGlossaryTerm" + }, + "nickName": { + "type": "string", + "description": "The nick name of the term." + }, + "hierarchyInfo": { "type": "array", - "description": "An array of entity definitions.", + "description": "The hierarchy information of the term.", "items": { - "$ref": "#/definitions/AtlasEntityDef" - } + "$ref": "#/definitions/PurviewObjectId" + }, + "x-ms-identifiers": [] }, - "enumDefs": { + "resources": { "type": "array", - "description": "An array of enum definitions.", + "description": "An array of resource link for term", "items": { - "$ref": "#/definitions/AtlasEnumDef" + "$ref": "#/definitions/ResourceLink" + }, + "x-ms-identifiers": [] + }, + "contacts": { + "type": "object", + "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/ContactInfo" + }, + "type": "array" } }, - "relationshipDefs": { - "type": "array", - "description": "An array of relationship definitions.", - "items": { - "$ref": "#/definitions/AtlasRelationshipDef" + "attributes": { + "type": "object", + "description": "The custom attributes of the term, which is map>.\nThe\nkey of the first layer map is term template name.", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" } }, - "structDefs": { + "assignedEntities": { "type": "array", - "description": "An array of struct definitions.", + "description": "An array of related object IDs.", "items": { - "$ref": "#/definitions/AtlasStructDef" - } + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] }, - "termTemplateDefs": { + "categories": { "type": "array", - "description": "An array of term template definitions.", + "description": "An array of term categorization headers.", "items": { - "$ref": "#/definitions/TermTemplateDef" - } - } - }, - "title": "AtlasTypesDef", - "description": "The definitions of types." - }, - "AtlasExtraTypeDef": { - "type": "object", - "properties": { - "entityTypes": { + "$ref": "#/definitions/AtlasTermCategorizationHeader" + }, + "x-ms-identifiers": [] + }, + "classifies": { "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that classifications can\nonly be applied to those entityTypes.\n

    \n
  • Any subtypes of the entity types inherit the restriction
    • \n
  • Any classificationDef subtypes inherit the parents entityTypes restrictions
    • \n
  • Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes
    • \n
  • An empty entityTypes list when there are no parent restrictions means there are no restrictions
    • \n
  • An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs
    • \n
", + "description": "An array of related term headers.", "items": { - "type": "string" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "subTypes": { + "examples": { "type": "array", - "description": "An array of sub types.", + "description": "An array of examples.", "items": { "type": "string" } }, - "superTypes": { + "isA": { "type": "array", - "description": "An array of super types.", + "description": "An array of related term headers indicating the is-a relationship.", "items": { - "type": "string" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "relationshipAttributeDefs": { + "preferredTerms": { "type": "array", - "description": "An array of relationship attributes.", + "description": "An array of preferred related term headers.", "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "defaultValue": { - "type": "string", - "description": "The default value." + "preferredToTerms": { + "type": "array", + "description": "An array of related term headers that are preferred to.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "elementDefs": { + "replacedBy": { "type": "array", - "description": "An array of enum element definitions.", + "description": "An array of related term headers that are replaced by.", "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef" + "replacementTerms": { + "type": "array", + "description": "An array of related term headers for replacement.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef" + "seeAlso": { + "type": "array", + "description": "An array of related term headers for see also.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory" + "synonyms": { + "type": "array", + "description": "An array of related term headers as synonyms.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." + "translatedTerms": { + "type": "array", + "description": "An array of translated related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "attributeDefs": { + "translationTerms": { "type": "array", - "description": "An array of attribute definitions.", + "description": "An array of related term headers for translation.", "items": { - "$ref": "#/definitions/AtlasAttributeDef" - } - } - }, - "title": "AtlasExtraTypeDef", - "description": "Extra properties for a type." - }, - "AtlasTypeDef": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AtlasBaseTypeDef" - }, - { - "$ref": "#/definitions/AtlasExtraTypeDef" - } - ], - "title": "AtlasTypeDef", - "description": "The definitions of type." - }, - "ImportInfo": { - "type": "object", - "title": "ImportInfo", - "properties": { - "childObjectName": { - "readOnly": false, - "description": "childObjectName", - "type": "string" - }, - "importStatus": { - "readOnly": false, - "$ref": "#/definitions/ImportStatus", - "description": "importStatus" - }, - "parentObjectName": { - "readOnly": false, - "description": "parentObjectName", - "type": "string" + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] }, - "remarks": { - "readOnly": false, - "description": "remarks", - "type": "string" - } - }, - "example": { - "childObjectName": "...", - "importStatus": "SUCCESS", - "parentObjectName": "...", - "remarks": "..." - }, - "description": "ImportInfo" - }, - "ImportStatus": { - "type": "string", - "title": "ImportStatus", - "enum": [ - "SUCCESS", - "FAILED" - ], - "description": "ImportStatus", - "x-ms-enum": { - "name": "importStatus", - "modelAsString": true - } - }, - "BulkImportResponse": { - "type": "object", - "title": "BulkImportResponse", - "properties": { - "failedImportInfoList": { - "readOnly": false, - "description": "failed importInfoList", - "type": "array", - "items": { - "$ref": "#/definitions/ImportInfo" - } + "usage": { + "type": "string", + "description": "The usage of the term." }, - "successImportInfoList": { - "readOnly": false, - "description": "successful importInfoList", + "validValues": { "type": "array", + "description": "An array of related term headers as valid values.", "items": { - "$ref": "#/definitions/ImportInfo" - } - } - }, - "example": { - "failedImportInfoList": [ - { - "childObjectName": "...", - "importStatus": "SUCCESS", - "parentObjectName": "...", - "remarks": "..." - }, - { - "childObjectName": "...", - "importStatus": "SUCCESS", - "parentObjectName": "...", - "remarks": "..." - } - ], - "successImportInfoList": [ - { - "childObjectName": "...", - "importStatus": "FAILED", - "parentObjectName": "...", - "remarks": "..." + "$ref": "#/definitions/AtlasRelatedTermHeader" }, - { - "childObjectName": "...", - "importStatus": "FAILED", - "parentObjectName": "...", - "remarks": "..." - } - ] - }, - "description": "example" - }, - "Cardinality": { - "type": "string", - "title": "Cardinality", - "description": "single-valued attribute or multi-valued attribute.", - "enum": [ - "SINGLE", - "LIST", - "SET" - ], - "x-ms-enum": { - "name": "Cardinality", - "modelAsString": true - } - }, - "ClassificationAssociateRequest": { - "type": "object", - "properties": { - "classification": { - "$ref": "#/definitions/AtlasClassification" + "x-ms-identifiers": [] }, - "entityGuids": { - "type": "array", - "description": "The GUID of the entity.", - "items": { - "type": "string" - } - } - }, - "title": "ClassificationAssociateRequest", - "description": "The request for classification association." - }, - "MoveEntitiesRequest": { - "type": "object", - "properties": { - "entityGuids": { + "validValuesFor": { "type": "array", - "description": "An array of entity guids to be moved to target collection.", + "description": "An array of related term headers as valid values for other records.", "items": { - "type": "string" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] } } }, - "DateFormat": { + "AtlasLineageInfo": { "type": "object", - "title": "DateFormat", + "description": "The lineage information.", "properties": { - "availableLocales": { - "type": "array", - "description": "An array of available locales.", - "items": { - "type": "string" - } - }, - "calendar": { - "type": "number" - }, - "dateInstance": { - "$ref": "#/definitions/DateFormat" - }, - "dateTimeInstance": { - "$ref": "#/definitions/DateFormat" - }, - "instance": { - "$ref": "#/definitions/DateFormat" - }, - "lenient": { - "type": "boolean", - "description": "Determines the leniency of the date format." - }, - "numberFormat": { - "$ref": "#/definitions/NumberFormat" - }, - "timeInstance": { - "$ref": "#/definitions/DateFormat" + "baseEntityGuid": { + "type": "string", + "description": "The GUID of the base entity." }, - "timeZone": { - "$ref": "#/definitions/TimeZone" - } - }, - "description": "The date format." - }, - "EntityMutationResponse": { - "type": "object", - "properties": { - "guidAssignments": { + "guidEntityMap": { "type": "object", - "description": "A map of GUID assignments with entities.", + "description": "The GUID entity map.", "additionalProperties": { - "type": "string" + "$ref": "#/definitions/AtlasEntityHeader" } }, - "mutatedEntities": { + "widthCounts": { "type": "object", - "description": "The entity headers of mutated entities.", + "description": "The entity count in specific direction.", "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasEntityHeader" - } + "additionalProperties": {}, + "type": "object" } }, - "partialUpdatedEntities": { + "lineageDepth": { + "type": "integer", + "format": "int32", + "description": "The depth of lineage." + }, + "lineageWidth": { + "type": "integer", + "format": "int32", + "description": "The width of lineage." + }, + "childrenCount": { + "type": "integer", + "format": "int32", + "description": "The number of children node." + }, + "lineageDirection": { + "$ref": "#/definitions/LineageDirection", + "description": "The enum of lineage direction." + }, + "parentRelations": { "type": "array", - "description": "An array of entity headers that partially updated.", + "description": "An array of parentRelations relations.", "items": { - "$ref": "#/definitions/AtlasEntityHeader" - } + "$ref": "#/definitions/ParentRelation" + }, + "x-ms-identifiers": [] + }, + "relations": { + "type": "array", + "description": "An array of lineage relations.", + "items": { + "$ref": "#/definitions/LineageRelation" + }, + "x-ms-identifiers": [] } - }, - "title": "EntityMutationResponse", - "description": "The mutation response of entity." - }, - "LineageDirection": { - "type": "string", - "title": "LineageDirection", - "description": "The enum of lineage direction.", - "enum": [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "x-ms-enum": { - "name": "LineageDirection", - "modelAsString": true } }, - "LineageRelation": { + "AtlasObjectId": { "type": "object", + "description": "Reference to an object-instance of a type - like entity.", "properties": { - "fromEntityId": { + "guid": { "type": "string", - "description": "The GUID of from-entity." + "description": "The GUID of the object." }, - "relationshipId": { + "typeName": { "type": "string", - "description": "The GUID of relationship." + "description": "The name of the type." }, - "toEntityId": { - "type": "string", - "description": "The GUID of to-entity." + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} } - }, - "title": "LineageRelation", - "description": "The lineage relation with GUID of the from and to entity." + } }, - "ParentRelation": { + "AtlasRelatedCategoryHeader": { "type": "object", + "description": "The header of the related category.", "properties": { - "childEntityId": { + "categoryGuid": { "type": "string", - "description": "The GUID of child entity." + "description": "The GUID of the category." }, - "relationshipId": { + "description": { "type": "string", - "description": "The GUID of relationship." + "description": "The description of the category header." }, - "parentEntityId": { + "displayText": { "type": "string", - "description": "The GUID of parent entity." + "description": "The display text." + }, + "parentCategoryGuid": { + "type": "string", + "description": "The GUID of the parent category." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." } - }, - "title": "ParentRelation", - "description": "The lineage parents relation with GUID of the parent entity and to child entity." + } }, - "NumberFormat": { + "AtlasRelatedObjectId": { "type": "object", - "title": "NumberFormat", + "description": "Reference to an object-instance of AtlasEntity type used in relationship\nattribute values", "properties": { - "availableLocales": { - "type": "array", - "description": "The number format.", - "items": { - "type": "string" - } + "guid": { + "type": "string", + "description": "The GUID of the object." }, - "currency": { + "typeName": { "type": "string", - "description": "The currency." + "description": "The name of the type." }, - "currencyInstance": { - "$ref": "#/definitions/NumberFormat" + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} }, - "groupingUsed": { - "type": "boolean", - "description": "Determines if grouping is used." + "displayText": { + "type": "string", + "description": "The display text." }, - "instance": { - "$ref": "#/definitions/NumberFormat" - }, - "integerInstance": { - "$ref": "#/definitions/NumberFormat" - }, - "maximumFractionDigits": { - "type": "integer", - "format": "int32", - "description": "The maximum of fraction digits." - }, - "maximumIntegerDigits": { - "type": "integer", - "format": "int32", - "description": "The maximum of integer digits." - }, - "minimumFractionDigits": { - "type": "integer", - "format": "int32", - "description": "The minimum of fraction digits." - }, - "minimumIntegerDigits": { - "type": "integer", - "format": "int32", - "description": "The minimum of integer digits." - }, - "numberInstance": { - "$ref": "#/definitions/NumberFormat" - }, - "parseIntegerOnly": { - "type": "boolean", - "description": "Determines if only integer is parsed." - }, - "percentInstance": { - "$ref": "#/definitions/NumberFormat" - }, - "roundingMode": { - "$ref": "#/definitions/RoundingMode" - } - }, - "description": "The number format." - }, - "TermGuid": { - "type": "string", - "title": "termGuid", - "description": "The globally unique identifier for glossary term." - }, - "PList": { - "type": "object", - "properties": { - "list": { - "type": "array", - "description": "An array of objects.", - "items": { - "type": "object", - "properties": {} - } - }, - "pageSize": { - "type": "integer", - "format": "int32", - "description": "The size of the page." + "entityStatus": { + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." }, - "sortBy": { + "relationshipType": { "type": "string", - "description": "The sorted by field." + "description": "Relationship type" }, - "sortType": { - "$ref": "#/definitions/SortType" + "relationshipAttributes": { + "$ref": "#/definitions/AtlasStruct", + "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification." }, - "startIndex": { - "type": "integer", - "format": "int64", - "description": "The start index of the page." + "relationshipGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the relationship." }, - "totalCount": { - "type": "integer", - "format": "int64", - "description": "The total count of items." + "relationshipStatus": { + "$ref": "#/definitions/StatusAtlasRelationship", + "description": "The enum of relationship status." } - }, - "title": "PList", - "description": "Paginated-list, for returning search results." - }, - "RelationshipCategory": { - "type": "string", - "title": "RelationshipCategory", - "description": "The Relationship category determines the style of relationship around containment and lifecycle.\nUML terminology is used for the values.\n

\nASSOCIATION is a relationship with no containment.
\nCOMPOSITION and AGGREGATION are containment relationships.\n

\nThe difference being in the lifecycles of the container and its children. In the COMPOSITION case,\nthe children cannot exist without the container. For AGGREGATION, the life cycles\nof the container and children are totally independent.", - "enum": [ - "ASSOCIATION", - "AGGREGATION", - "COMPOSITION" - ], - "x-ms-enum": { - "name": "RelationshipCategory", - "modelAsString": true - } - }, - "RoundingMode": { - "type": "string", - "title": "RoundingMode", - "description": "The enum of rounding mode.", - "enum": [ - "UP", - "DOWN", - "CEILING", - "FLOOR", - "HALF_UP", - "HALF_DOWN", - "HALF_EVEN", - "UNNECESSARY" - ], - "x-ms-enum": { - "name": "RoundingMode", - "modelAsString": true - } - }, - "SortType": { - "type": "string", - "title": "SortType", - "description": "to specify whether the result should be sorted? If yes, whether asc or desc.", - "enum": [ - "NONE", - "ASC", - "DESC" - ], - "x-ms-enum": { - "name": "SortType", - "modelAsString": true - } - }, - "Status": { - "type": "string", - "title": "Status", - "description": "Status of the entity - can be active or deleted. Deleted entities are not removed.", - "enum": [ - "ACTIVE", - "DELETED" - ], - "x-ms-enum": { - "name": "Status", - "modelAsString": true - } - }, - "Status_AtlasRelationship": { - "type": "string", - "title": "Status", - "description": "The enum of relationship status.", - "enum": [ - "ACTIVE", - "DELETED" - ], - "x-ms-enum": { - "name": "Status_AtlasRelationship", - "modelAsString": true } }, - "TimeBoundary": { + "AtlasRelatedTermHeader": { "type": "object", + "description": "The header of the related term.", "properties": { - "endTime": { + "description": { "type": "string", - "description": "The end of the time boundary." + "description": "The description of the related term." }, - "startTime": { + "displayText": { "type": "string", - "description": "The start of the time boundary." + "description": "The display text." }, - "timeZone": { + "expression": { "type": "string", - "description": "The timezone of the time boundary." - } - }, - "title": "TimeBoundary", - "description": "Captures time-boundary details" - }, - "TimeZone": { - "type": "object", - "properties": { - "dstSavings": { - "type": "integer", - "format": "int32", - "description": "The value of the daylight saving time." + "description": "The expression of the term." }, - "id": { + "relationGuid": { "type": "string", - "description": "The ID of the timezone." - }, - "availableIds": { - "type": "array", - "description": "An array of available IDs.", - "items": { - "type": "string" - } + "description": "The GUID of the relationship." }, - "default": { - "$ref": "#/definitions/TimeZone" + "status": { + "$ref": "#/definitions/AtlasTermRelationshipStatus", + "description": "The status of term relationship." }, - "displayName": { + "steward": { "type": "string", - "description": "The display name of the timezone." + "description": "The steward of the term." }, - "rawOffset": { - "type": "integer", - "format": "int32", - "description": "The raw offset of the timezone." + "termGuid": { + "type": "string", + "description": "The GUID of the term." } - }, - "title": "TimeZone", - "description": "The timezone information." - }, - "TypeCategory": { - "type": "string", - "title": "TypeCategory", - "description": "The enum of type category.", - "enum": [ - "PRIMITIVE", - "OBJECT_ID_TYPE", - "ENUM", - "STRUCT", - "CLASSIFICATION", - "ENTITY", - "ARRAY", - "MAP", - "RELATIONSHIP", - "TERM_TEMPLATE" - ], - "x-ms-enum": { - "name": "TypeCategory", - "modelAsString": true } }, - "SuggestResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SuggestResultValue" - } - } - }, - "title": "SuggestResult", - "description": "The result item of the search suggest." - }, - "SuggestResultValue": { + "AtlasRelationship": { "type": "object", + "description": "Atlas relationship instance.", "properties": { - "@search.score": { - "type": "number", - "format": "float", - "description": "The search score calculated by the search engine. The results are ordered by search score by default." + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} }, - "@search.text": { + "typeName": { "type": "string", - "description": "The target text that contains the keyword as prefix. The keyword is wrapped with emphasis mark." + "description": "The name of the type." }, - "objectType": { + "lastModifiedTS": { "type": "string", - "description": "The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term." + "description": "ETag for concurrency control." }, "createTime": { "type": "integer", "format": "int64", - "description": "The create time of the record. The Unix epoch format." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The last update time of the record. The Unix epoch format." + "description": "The created time of the record." }, - "id": { + "createdBy": { "type": "string", - "description": "The GUID of the record." + "description": "The user who created the record." }, - "name": { - "type": "string", - "description": "The name of the record." + "end1": { + "$ref": "#/definitions/AtlasObjectId", + "description": "Reference to an object-instance of a type - like entity." }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the record." + "end2": { + "$ref": "#/definitions/AtlasObjectId", + "description": "Reference to an object-instance of a type - like entity." }, - "entityType": { + "guid": { "type": "string", - "description": "The type name of the asset." + "description": "The GUID of the relationship." }, - "description": { + "homeId": { "type": "string", - "description": "The description of the asset." + "description": "The home ID of the relationship." }, - "endorsement": { + "label": { "type": "string", - "description": "The endorsement of the asset." + "description": "The label of the relationship." }, - "owner": { - "type": "string", - "description": "The owner of the record." + "provenanceType": { + "type": "integer", + "format": "int32", + "description": "Used to record the provenance of an instance of an entity or relationship" }, - "classification": { - "type": "array", - "description": "The classifications of the record.", - "items": { - "type": "string" - } + "status": { + "$ref": "#/definitions/StatusAtlasRelationship", + "description": "The enum of relationship status." }, - "label": { - "type": "array", - "description": "The labels of the asset.", - "items": { - "type": "string" - } - }, - "term": { - "type": "array", - "description": "The terms assigned to the asset.", - "items": { - "$ref": "#/definitions/TermSearchResultValue" - } - }, - "contact": { - "type": "array", - "description": "The contacts of the asset.", - "items": { - "$ref": "#/definitions/ContactSearchResultValue" - } - }, - "assetType": { - "type": "array", - "description": "The asset types of the asset.", - "items": { - "type": "string" - } - }, - "glossaryType": { - "type": "string", - "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory." - }, - "glossary": { - "type": "string", - "description": "The glossary name of the term." - }, - "termStatus": { - "type": "string", - "description": "The status of the term." - }, - "termTemplate": { - "type": "array", - "description": "The term template names used by the term.", - "items": { - "type": "string" - } - }, - "longDescription": { - "type": "string", - "description": "The definition of the term." - } - }, - "title": "SuggestResultValue", - "description": "The value item of the search suggest." - }, - "SearchResult": { - "type": "object", - "properties": { - "@search.count": { + "updateTime": { "type": "integer", - "format": "int32", - "description": "The total number of search results (not the number of documents in a single page)." - }, - "@search.count.approximate": { - "type": "boolean", - "description": "'True' if the '@search.count' is an approximate value and vise versa." + "format": "int64", + "description": "The update time of the record." }, - "continuationToken": { + "updatedBy": { "type": "string", - "description": "The token used to get next batch of data. Absent if there's no more data." - }, - "@search.facets": { - "$ref": "#/definitions/SearchFacetResultValue" + "description": "The user who updated the record." }, - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchResultValue" - } + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the relationship." } - }, - "title": "SearchResult", - "description": "The result of the search result." + } }, - "SearchFacetResultValue": { + "AtlasRelationshipAttributeDef": { "type": "object", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", "properties": { - "entityType": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "cardinality": { + "$ref": "#/definitions/CardinalityValue", + "description": "single-valued attribute or multi-valued attribute." }, - "assetType": { + "constraints": { "type": "array", + "description": "An array of constraints.", "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "$ref": "#/definitions/AtlasConstraintDef" + }, + "x-ms-identifiers": [] }, - "classification": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "defaultValue": { + "type": "string", + "description": "The default value of the attribute." }, - "term": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "description": { + "type": "string", + "description": "The description of the attribute." }, - "contactId": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "includeInNotification": { + "type": "boolean", + "description": "Determines if it is included in notification." }, - "contactType": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "isIndexable": { + "type": "boolean", + "description": "Determines if it is indexable." }, - "label": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "isOptional": { + "type": "boolean", + "description": "Determines if it is optional." }, - "glossaryType": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "isUnique": { + "type": "boolean", + "description": "Determines if it unique." }, - "termStatus": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "name": { + "type": "string", + "description": "The name of the attribute." }, - "termTemplate": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" + "options": { + "type": "object", + "description": "The options for the attribute.", + "additionalProperties": { + "type": "string" } - } - }, - "title": "Context", - "description": "A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets." - }, - "SearchFacetItemValue": { - "type": "object", - "properties": { - "count": { + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "valuesMaxCount": { "type": "integer", "format": "int32", - "description": "The count of the facet item." + "description": "The maximum count of the values." }, - "value": { - "type": "string", - "description": "The name of the facet item." - } - }, - "title": "SearchFacetItemValue", - "description": "The content of a search facet result item." - }, - "SearchFacetItem": { - "type": "object", - "properties": { - "count": { + "valuesMinCount": { "type": "integer", "format": "int32", - "description": "The count of the facet item." + "description": "The minimum count of the values." }, - "facet": { - "type": "string", - "description": "The name of the facet item." + "isLegacyAttribute": { + "type": "boolean", + "description": "Determines if it is a legacy attribute." }, - "sort": { - "type": "object" + "relationshipTypeName": { + "type": "string", + "description": "The name of the relationship type." } - }, - "title": "SearchFacetItemValue", - "description": "The content of a search facet result item." - }, - "SearchOrderItem": { - "type": "object", - "description": "See examples for the usage of search order." + } }, - "SearchResultValue": { + "AtlasRelationshipDef": { "type": "object", + "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the\nRelationshipDef has a guid.\nThe name and the guid are the 2 ways that the\nRelationshipDef is identified.\nRelationshipDefs have 2 ends, each of which\nspecify cardinality, an EntityDef type name and name and optionally\nwhether the\nend is a container.\nRelationshipDefs can have AttributeDefs - though only\nprimitive types are allowed. \nRelationshipDefs have a relationshipCategory\nspecifying the UML type of relationship required \nThe way EntityDefs and\nRelationshipDefs are intended to be used is that EntityDefs will define\nAttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as\ntheir types.\nRelationshipDefs introduce new attributes to the entity\ninstances. For example\nEntityDef A might have attributes attr1,attr2,attr3\n\nEntityDef B might have attributes attr4,attr5,attr6 \nRelationshipDef\nAtoB might define 2 ends \n\nend1: type A, name attr7\nend2: type B, name attr8 \n\nWhen an instance of EntityDef A is created, it\nwill have attributes attr1,attr2,attr3,attr7 \nWhen an instance of EntityDef\nB is created, it will have attributes attr4,attr5,attr6,attr8\n\nIn this way\nrelationshipDefs can be authored separately from entityDefs and can inject\nrelationship attributes into\nthe entity instances", "properties": { - "@search.score": { - "type": "number", - "format": "float", - "description": "The search score calculated by the search engine. The results are ordered by search score by default." - }, - "@search.highlights": { - "$ref": "#/definitions/SearchHighlights" - }, - "objectType": { - "type": "string", - "description": "The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term." + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." }, "createTime": { "type": "integer", "format": "int64", - "description": "The create time of the record. The Unix epoch format." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The last update time of the record. The Unix epoch format." - }, - "id": { - "type": "string", - "description": "The GUID of the record." - }, - "name": { - "type": "string", - "description": "The name of the record." + "description": "The created time of the record." }, - "qualifiedName": { + "createdBy": { "type": "string", - "description": "The qualified name of the record." + "description": "The user who created the record." }, - "entityType": { - "type": "string", - "description": "The type name of the asset." + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." }, "description": { "type": "string", - "description": "The description of the asset." + "description": "The description of the type definition." }, - "endorsement": { + "guid": { "type": "string", - "description": "The endorsement of the asset." + "description": "The GUID of the type definition." }, - "owner": { + "name": { "type": "string", - "description": "The owner of the record." + "description": "The name of the type definition." }, - "classification": { - "type": "array", - "description": "The classifications of the record.", - "items": { + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { "type": "string" } }, - "label": { - "type": "array", - "description": "The labels of the asset.", - "items": { - "type": "string" - } - }, - "term": { - "type": "array", - "description": "The terms assigned to the asset.", - "items": { - "$ref": "#/definitions/TermSearchResultValue" - } + "serviceType": { + "type": "string", + "description": "The service type." }, - "contact": { - "type": "array", - "description": "The contacts of the asset.", - "items": { - "$ref": "#/definitions/ContactSearchResultValue" - } + "typeVersion": { + "type": "string", + "description": "The version of the type." }, - "assetType": { - "type": "array", - "description": "The asset types of the asset.", - "items": { - "type": "string" - } + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." }, - "glossaryType": { + "updatedBy": { "type": "string", - "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory." + "description": "The user who updated the record." }, - "glossary": { - "type": "string", - "description": "The glossary name of the term." + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." }, - "termStatus": { + "lastModifiedTS": { "type": "string", - "description": "The status of the term." + "description": "ETag for concurrency control." }, - "termTemplate": { + "attributeDefs": { "type": "array", - "description": "The term template names used by the term.", + "description": "An array of attribute definitions.", "items": { - "type": "string" - } + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] }, - "longDescription": { + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\nASSOCIATION is a relationship with no containment. \nCOMPOSITION and AGGREGATION are containment relationships.\nThe difference being in the lifecycles of the container and its children. \nIn the COMPOSITION case, the children cannot exist without the container.\nFor AGGREGATION, the life cycles of the container and children are totally independent." + }, + "relationshipLabel": { "type": "string", - "description": "The definition of the term." + "description": "The label of the relationship." } - }, - "title": "SearchResultValue", - "description": "The value item of the search result." + } }, - "SearchHighlights": { + "AtlasRelationshipEndDef": { "type": "object", - "description": "A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights.", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", "properties": { - "id": { - "type": "array", - "items": { - "type": "string" - } + "cardinality": { + "$ref": "#/definitions/CardinalityValue", + "description": "single-valued attribute or multi-valued attribute." }, - "qualifiedName": { - "type": "array", - "items": { - "type": "string" - } + "description": { + "type": "string", + "description": "The description of the relationship end definition." + }, + "isContainer": { + "type": "boolean", + "description": "Determines if it is container." + }, + "isLegacyAttribute": { + "type": "boolean", + "description": "Determines if it is a legacy attribute." }, "name": { - "type": "array", - "items": { - "type": "string" - } + "type": "string", + "description": "The name of the relationship end definition." }, - "description": { - "type": "array", - "items": { - "type": "string" + "type": { + "type": "string", + "description": "The type of the relationship end." + } + } + }, + "AtlasRelationshipWithExtInfo": { + "type": "object", + "description": "The relationship with extended information.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entity header.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" } }, - "entityType": { - "type": "array", - "items": { - "type": "string" - } + "relationship": { + "$ref": "#/definitions/AtlasRelationship", + "description": "Atlas relationship instance." } - }, - "title": "SearchHighlights" + } }, - "TermSearchResultValue": { + "AtlasStruct": { "type": "object", + "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification.", "properties": { - "name": { - "type": "string", - "description": "The name of the term." + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} }, - "glossaryName": { + "typeName": { "type": "string", - "description": "The name of the glossary which contains the term." + "description": "The name of the type." }, - "guid": { + "lastModifiedTS": { "type": "string", - "description": "The GUID of the term." + "description": "ETag for concurrency control." } - }, - "title": "Context", - "description": "The context." + } }, - "ContactSearchResultValue": { + "AtlasStructDef": { "type": "object", + "description": "class that captures details of a struct-type.", "properties": { - "id": { - "type": "string", - "description": "The GUID of the contact." + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." }, - "info": { + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { "type": "string", - "description": "The description of the contact." + "description": "The user who created the record." }, - "contactType": { + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { "type": "string", - "description": "The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term." - } - }, - "title": "contact", - "description": "The contact in the search and suggest result." - }, - "AutoCompleteRequest": { - "type": "object", - "properties": { - "keywords": { + "description": "The description of the type definition." + }, + "guid": { "type": "string", - "description": "The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters." + "description": "The GUID of the type definition." }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The number of autocomplete results we hope to return. The default value is 50. The value must be a number between 1 and 100." + "name": { + "type": "string", + "description": "The name of the type definition." }, - "filter": { + "options": { "type": "object", - "description": "The filter for the autocomplete request." - } - }, - "title": "AutoCompleteRequest", - "description": "The query of autocomplete request." - }, - "AutoCompleteResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AutoCompleteResultValue" + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" } - } - }, - "title": "AutoCompleteResult", - "description": "The result of the autocomplete request." - }, - "AutoCompleteResultValue": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "The completed term or phrase." }, - "queryPlusText": { + "serviceType": { "type": "string", - "description": "The completed search query text." - } - }, - "title": "AutoCompleteResultValue", - "description": "The value item of the autocomplete suggest." - }, - "SearchRequest": { - "type": "object", - "properties": { - "keywords": { + "description": "The service type." + }, + "typeVersion": { "type": "string", - "description": "The keywords applied to all searchable fields." + "description": "The version of the type." }, - "limit": { + "updateTime": { "type": "integer", - "format": "int32", - "description": "The limit of the number of the search result. default value is 50; maximum value is 1000." + "format": "int64", + "description": "The update time of the record." }, - "continuationToken": { + "updatedBy": { "type": "string", - "description": "The token used to get next batch of data. Default 'Null' to get the first batch, and will return new token in each response unless there's no more data." + "description": "The user who updated the record." }, - "orderby": { - "type": "array", - "description": "The sort order of search results, can specify multiple fields.", - "items": { - "$ref": "#/definitions/SearchOrderItem" - } + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." }, - "filter": { - "type": "object", - "description": "The filter for the search. See examples for the usage of supported filters." + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." }, - "facets": { + "attributeDefs": { "type": "array", + "description": "An array of attribute definitions.", "items": { - "$ref": "#/definitions/SearchFacetItem" - } - }, - "taxonomySetting": { - "type": "object", - "properties": { - "assetTypes": { - "type": "array", - "items": { - "type": "string" - } - }, - "facet": { - "$ref": "#/definitions/SearchFacetItem" - } - } + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] } - }, - "title": "SearchRequest", - "description": "The search query of advanced search request." + } }, - "SuggestRequest": { + "AtlasTermAssignmentHeader": { "type": "object", + "description": "The header for term assignment.", "properties": { - "keywords": { - "type": "string", - "description": "The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode." - }, - "limit": { + "confidence": { "type": "integer", "format": "int32", - "description": "The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100." + "description": "The confidence of the term assignment." }, - "filter": { - "type": "object", - "description": "The filter for the search." + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "description": { + "type": "string", + "description": "The description of the term assignment." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "expression": { + "type": "string", + "description": "The expression of the term assignment." + }, + "relationGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermAssignmentStatus", + "description": "The status of terms assignment." + }, + "steward": { + "type": "string", + "description": "The steward of the term." + }, + "termGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the term." } - }, - "title": "SuggestRequest", - "description": "The query of suggest request." + } }, - "LastModifiedTS": { + "AtlasTermAssignmentStatus": { "type": "string", - "title": "lastModifiedTS", - "description": "ETag for concurrency control." + "description": "Status for term assignment", + "enum": [ + "DISCOVERED", + "PROPOSED", + "IMPORTED", + "VALIDATED", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermAssignmentStatus", + "modelAsString": true, + "values": [ + { + "name": "Discovered", + "value": "DISCOVERED", + "description": "The status is discovered." + }, + { + "name": "Proposed", + "value": "PROPOSED", + "description": "The status is proposed." + }, + { + "name": "Imported", + "value": "IMPORTED", + "description": "The status is imported." + }, + { + "name": "Validated", + "value": "VALIDATED", + "description": "The status is validated." + }, + { + "name": "Deprecated", + "value": "DEPRECATED", + "description": "The status is deprecated." + }, + { + "name": "Obsolete", + "value": "OBSOLETE", + "description": "The status is obsolete." + }, + { + "name": "Other", + "value": "OTHER", + "description": "Other status." + } + ] + } }, - "ErrorResponse": { - "description": "An error response from the service", + "AtlasTermCategorizationHeader": { "type": "object", + "description": "The basic information for term categorization.", "properties": { - "requestId": { - "type": "string", - "description": "The request ID." + "categoryGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the category." }, - "errorCode": { + "description": { "type": "string", - "description": "The error code." + "description": "The description of the record." }, - "errorMessage": { + "displayText": { "type": "string", - "description": "The error message." + "description": "The display text." + }, + "relationGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermRelationshipStatus", + "description": "The status of term relationship." } } }, - "RelatedCategoryHeaders": { - "type": "object", - "description": "An array of related categories.", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - } + "AtlasTermRelationshipStatus": { + "type": "string", + "description": "Status for atlas term relationship", + "enum": [ + "DRAFT", + "ACTIVE", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermRelationshipStatus", + "modelAsString": true, + "values": [ + { + "name": "Draft", + "value": "DRAFT", + "description": "draft" + }, + { + "name": "Active", + "value": "ACTIVE", + "description": "active" + }, + { + "name": "Deprecated", + "value": "DEPRECATED", + "description": "deprecated" + }, + { + "name": "Obsolete", + "value": "OBSOLETE", + "description": "obsolete" + }, + { + "name": "Other", + "value": "OTHER", + "description": "other" + } + ] } }, - "RelatedTermHeaders": { + "AtlasTypeDef": { "type": "object", - "description": "An array of related glossary terms for the given glossary or an empty list.", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "description": "The definitions of type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + }, + "relationshipAttributeDefs": { + "type": "array", + "description": "An array of relationship attributes.", + "items": { + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value." + }, + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + }, + "x-ms-identifiers": [] + }, + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\n\nASSOCIATION is a relationship with no containment. \nCOMPOSITION and AGGREGATION are containment relationships.\n\nThe difference being in the lifecycles of the container and its children. \nIn the COMPOSITION case, the children cannot exist without the container. \nFor AGGREGATION, the life cycles of the container and children are totally independent." + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] } } }, - "BusinessMetadata": { + "AtlasTypeDefHeader": { "type": "object", - "additionalProperties": { - "type": "object" - }, - "description": "BusinessMetadata" + "description": "The basic information of the type definition.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + } + } }, - "BusinessMetadataAttributes": { + "AtlasTypesDef": { "type": "object", - "additionalProperties": { - "type": "object" - }, - "description": "BusinessMetadataAttributes" - } - }, - "parameters": { - "endpoint": { - "name": "endpoint", - "description": "The datamap endpoint of your Purview account. Example: https://{accountName}.purview.azure.com", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "format": "url", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "guid": { - "name": "guid", - "description": "The globally unique identifier of the entity.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "classificationName": { - "name": "classificationName", - "description": "The name of the classification.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "typeName": { - "name": "typeName", - "description": "The name of the type.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "categoryGuid": { - "name": "categoryGuid", - "description": "The globally unique identifier of the category.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "description": "The definitions of types.", + "properties": { + "businessMetadataDefs": { + "type": "array", + "description": "businessMetadataDefs", + "items": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + }, + "x-ms-identifiers": [] + }, + "classificationDefs": { + "type": "array", + "description": "An array of classification definitions.", + "items": { + "$ref": "#/definitions/AtlasClassificationDef" + }, + "x-ms-identifiers": [] + }, + "entityDefs": { + "type": "array", + "description": "An array of entity definitions.", + "items": { + "$ref": "#/definitions/AtlasEntityDef" + }, + "x-ms-identifiers": [] + }, + "enumDefs": { + "type": "array", + "description": "An array of enum definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumDef" + }, + "x-ms-identifiers": [] + }, + "relationshipDefs": { + "type": "array", + "description": "An array of relationship definitions.", + "items": { + "$ref": "#/definitions/AtlasRelationshipDef" + }, + "x-ms-identifiers": [] + }, + "structDefs": { + "type": "array", + "description": "An array of struct definitions.", + "items": { + "$ref": "#/definitions/AtlasStructDef" + }, + "x-ms-identifiers": [] + }, + "termTemplateDefs": { + "type": "array", + "description": "An array of term template definitions.", + "items": { + "$ref": "#/definitions/TermTemplateDef" + }, + "x-ms-identifiers": [] + } + } }, - "limit": { - "name": "limit", - "description": "The page size - by default there is no paging.", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" + "AutoCompleteOptions": { + "type": "object", + "description": "The payload of autocomplete request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support autocomplete operation. It must\nbe at least 1 character, and no more than 100 characters." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The number of autocomplete results we hope to return. The default value is 50.\nThe value must be a number between 1 and 100." + }, + "filter": { + "description": "The filter for the autocomplete request." + } + } }, - "offset": { - "name": "offset", - "description": "The offset for pagination purpose.", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" + "AutoCompleteResult": { + "type": "object", + "description": "The result of the autocomplete request.", + "properties": { + "value": { + "type": "array", + "description": "The result value", + "items": { + "$ref": "#/definitions/AutoCompleteResultValue" + }, + "x-ms-identifiers": [] + } + } }, - "sort": { - "name": "sort", - "description": "The sort order, ASC (default) or DESC.", - "in": "query", - "required": false, - "type": "string", - "default": "ASC", - "x-ms-parameter-location": "method" + "AutoCompleteResultValue": { + "type": "object", + "description": "The value item of the autocomplete suggest.", + "properties": { + "text": { + "type": "string", + "description": "The completed term or phrase." + }, + "queryPlusText": { + "type": "string", + "description": "The completed search query text." + } + } }, - "termGuid": { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, + "Azure.Core.uuid": { "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "format": "uuid", + "description": "Universally Unique Identifier" }, - "fileId": { - "name": "fileId", - "in": "path", - "description": "The globally unique identifier for file.", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "BulkImportResult": { + "type": "object", + "description": "Bulk import result", + "properties": { + "failedImportInfoList": { + "type": "array", + "description": "failed importInfoList", + "items": { + "$ref": "#/definitions/ImportInfo" + }, + "x-ms-identifiers": [] + }, + "successImportInfoList": { + "type": "array", + "description": "successful importInfoList", + "items": { + "$ref": "#/definitions/ImportInfo" + }, + "x-ms-identifiers": [] + } + } }, - "glossaryGuid": { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "BusinessMetadataOptions": { + "type": "object", + "description": "Business metadata to send to the service", + "properties": { + "file": { + "type": "string", + "format": "byte", + "description": "InputStream of file" + } + }, + "required": [ + "file" + ] }, - "operationGuid": { - "name": "operationGuid", - "in": "path", - "description": "The globally unique identifier for async operation job.", - "required": true, + "CardinalityValue": { "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "description": "Cardinality", + "enum": [ + "SINGLE", + "LIST", + "SET" + ], + "x-ms-enum": { + "name": "CardinalityValue", + "modelAsString": true, + "values": [ + { + "name": "Single", + "value": "SINGLE", + "description": "single" + }, + { + "name": "List", + "value": "LIST", + "description": "list" + }, + { + "name": "Set", + "value": "SET", + "description": "set" + } + ] + } }, - "glossaryName": { - "name": "glossaryName", - "in": "path", - "description": "The name of the glossary.", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" + "ClassificationAssociateOptions": { + "type": "object", + "description": "The request payload for classification association.", + "properties": { + "classification": { + "$ref": "#/definitions/AtlasClassification", + "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity." + }, + "entityGuids": { + "type": "array", + "description": "The GUID of the entity.", + "items": { + "type": "string" + } + } + } }, - "searchLimit": { - "name": "limit", - "description": "Limits the result set to only include the specified number of entries.", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" + "ContactInfo": { + "type": "object", + "description": "ContactInfo", + "properties": { + "id": { + "type": "string", + "description": "Azure Active Directory object Id." + }, + "info": { + "type": "string", + "description": "additional information to describe this contact." + } + } + }, + "ContactSearchResultValue": { + "type": "object", + "description": "The contact in the search and suggest result.", + "properties": { + "id": { + "type": "string", + "description": "The GUID of the contact." + }, + "info": { + "type": "string", + "description": "The description of the contact." + }, + "contactType": { + "type": "string", + "description": "The type of the contact. It can be Expert or Owner for an entity. It can be\nExpert or Steward for a glossary term." + } + } + }, + "DateFormat": { + "type": "object", + "description": "The date format.", + "properties": { + "availableLocales": { + "type": "array", + "description": "An array of available locales.", + "items": { + "type": "string" + } + }, + "calendar": { + "type": "number", + "format": "float", + "description": "Calendar" + }, + "dateInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "dateTimeInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "instance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "lenient": { + "type": "boolean", + "description": "Determines the leniency of the date format." + }, + "numberFormat": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "timeInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "timeZone": { + "$ref": "#/definitions/TimeZone", + "description": "The timezone information." + } + } + }, + "EntityMutationResult": { + "type": "object", + "description": "The mutation response result of entity.", + "properties": { + "guidAssignments": { + "type": "object", + "description": "A map of GUID assignments with entities.", + "additionalProperties": { + "type": "string" + } + }, + "mutatedEntities": { + "type": "object", + "description": "The entity headers of mutated entities.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasEntityHeader" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "partialUpdatedEntities": { + "type": "array", + "description": "An array of entity headers that partially updated.", + "items": { + "$ref": "#/definitions/AtlasEntityHeader" + }, + "x-ms-identifiers": [] + } + } + }, + "EntityStatus": { + "type": "string", + "description": "Status - can be active or deleted", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "EntityStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "ACTIVE", + "description": "The status is active." + }, + { + "name": "Deleted", + "value": "DELETED", + "description": "The status is deleted." + } + ] + } + }, + "ImportInfo": { + "type": "object", + "description": "ImportInfo", + "properties": { + "childObjectName": { + "type": "string", + "description": "childObjectName" + }, + "importStatus": { + "$ref": "#/definitions/ImportStatus", + "description": "importStatus" + }, + "parentObjectName": { + "type": "string", + "description": "parentObjectName" + }, + "remarks": { + "type": "string", + "description": "remarks" + } + } + }, + "ImportStatus": { + "type": "string", + "description": "Status for import", + "enum": [ + "SUCCESS", + "FAILED" + ], + "x-ms-enum": { + "name": "ImportStatus", + "modelAsString": true, + "values": [ + { + "name": "Success", + "value": "SUCCESS", + "description": "Success" + }, + { + "name": "Failed", + "value": "FAILED", + "description": "Failed" + } + ] + } + }, + "LineageDirection": { + "type": "string", + "description": "Lineage direction", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] + } + }, + "LineageRelation": { + "type": "object", + "description": "The lineage relation with GUID of the from and to entity.", + "properties": { + "fromEntityId": { + "type": "string", + "description": "The GUID of from-entity." + }, + "relationshipId": { + "type": "string", + "description": "The GUID of relationship." + }, + "toEntityId": { + "type": "string", + "description": "The GUID of to-entity." + } + } + }, + "MoveEntitiesOptions": { + "type": "object", + "description": "MoveEntitiesOptions", + "properties": { + "entityGuids": { + "type": "array", + "description": "An array of entity guids to be moved to target collection.", + "items": { + "type": "string" + } + } + } + }, + "NumberFormat": { + "type": "object", + "description": "The number format.", + "properties": { + "availableLocales": { + "type": "array", + "description": "The number format.", + "items": { + "type": "string" + } + }, + "currency": { + "type": "string", + "description": "The currency." + }, + "currencyInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "groupingUsed": { + "type": "boolean", + "description": "Determines if grouping is used." + }, + "instance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "integerInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "maximumFractionDigits": { + "type": "integer", + "format": "int32", + "description": "The maximum of fraction digits." + }, + "maximumIntegerDigits": { + "type": "integer", + "format": "int32", + "description": "The maximum of integer digits." + }, + "minimumFractionDigits": { + "type": "integer", + "format": "int32", + "description": "The minimum of fraction digits." + }, + "minimumIntegerDigits": { + "type": "integer", + "format": "int32", + "description": "The minimum of integer digits." + }, + "numberInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "parseIntegerOnly": { + "type": "boolean", + "description": "Determines if only integer is parsed." + }, + "percentInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "roundingMode": { + "$ref": "#/definitions/RoundingMode", + "description": "The enum of rounding mode." + } + } + }, + "ParentRelation": { + "type": "object", + "description": "The lineage parents relation with GUID of the parent entity and to child entity.", + "properties": { + "childEntityId": { + "type": "string", + "description": "The GUID of child entity." + }, + "relationshipId": { + "type": "string", + "description": "The GUID of relationship." + }, + "parentEntityId": { + "type": "string", + "description": "The GUID of parent entity." + } + } + }, + "PurviewObjectId": { + "type": "object", + "description": "PurviewObjectId", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + }, + "name": { + "type": "string", + "description": "Name" + }, + "displayText": { + "type": "string", + "description": "Display text" + }, + "itemPath": { + "type": "string", + "description": "Item path" + }, + "resourceId": { + "type": "string", + "description": "Resource Id" + }, + "properties": { + "type": "object", + "description": "Dictionary of ", + "additionalProperties": {} + } + } + }, + "QueryOptions": { + "type": "object", + "description": "The search query of advanced search request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all searchable fields." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit of the number of the search result. default value is 50; maximum\nvalue is 1000." + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, and will return new token in each response unless there's no more data." + }, + "orderby": { + "type": "array", + "description": "The sort order of search results, can specify multiple fields.", + "items": {} + }, + "filter": { + "description": "The filter for the search. See examples for the usage of supported filters." + }, + "facets": { + "type": "array", + "description": "The facets for search. See examples for the usage of supported facets.", + "items": { + "$ref": "#/definitions/SearchFacetItem" + }, + "x-ms-identifiers": [] + }, + "taxonomySetting": { + "$ref": "#/definitions/SearchTaxonomySetting", + "description": "The taxonomy setting for search." + } + } + }, + "QueryResult": { + "type": "object", + "description": "The result of the search result.", + "properties": { + "@search.count": { + "type": "integer", + "format": "int32", + "description": "The total number of search results (not the number of documents in a single\npage).", + "x-ms-client-name": "searchCount" + }, + "@search.count.approximate": { + "type": "boolean", + "description": "'True' if the '@search.count' is an approximate value and vise versa.", + "x-ms-client-name": "searchCountApproximate" + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Absent if there's no more data." + }, + "@search.facets": { + "$ref": "#/definitions/SearchFacetResultValue", + "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", + "x-ms-client-name": "searchFacets" + }, + "value": { + "type": "array", + "description": "Search result value", + "items": { + "$ref": "#/definitions/SearchResultValue" + } + } + } + }, + "RelationshipCategory": { + "type": "string", + "description": "Relationship Category", + "enum": [ + "ASSOCIATION", + "AGGREGATION", + "COMPOSITION" + ], + "x-ms-enum": { + "name": "RelationshipCategory", + "modelAsString": true, + "values": [ + { + "name": "Association", + "value": "ASSOCIATION", + "description": "association" + }, + { + "name": "Aggregation", + "value": "AGGREGATION", + "description": "aggregation" + }, + { + "name": "Composition", + "value": "COMPOSITION", + "description": "composition" + } + ] + } + }, + "ResourceLink": { + "type": "object", + "description": "ResourceLink", + "properties": { + "displayName": { + "type": "string", + "description": "Display name for url." + }, + "url": { + "type": "string", + "description": "web url. http or https" + } + } + }, + "RoundingMode": { + "type": "string", + "description": "Rounding Mode", + "enum": [ + "UP", + "DOWN", + "CEILING", + "FLOOR", + "HALF_UP", + "HALF_DOWN", + "HALF_EVEN", + "UNNECESSARY" + ], + "x-ms-enum": { + "name": "RoundingMode", + "modelAsString": true, + "values": [ + { + "name": "Up", + "value": "UP", + "description": "up" + }, + { + "name": "Down", + "value": "DOWN", + "description": "down" + }, + { + "name": "Ceiling", + "value": "CEILING", + "description": "ceiling" + }, + { + "name": "Floor", + "value": "FLOOR", + "description": "floor" + }, + { + "name": "HalfUp", + "value": "HALF_UP", + "description": "half up" + }, + { + "name": "HalfDown", + "value": "HALF_DOWN", + "description": "half down" + }, + { + "name": "HalfEven", + "value": "HALF_EVEN", + "description": "half even" + }, + { + "name": "Unnecessary", + "value": "UNNECESSARY", + "description": "unnecessary" + } + ] + } + }, + "SearchFacetItem": { + "type": "object", + "description": "The content of a search facet result item.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "facet": { + "type": "string", + "description": "The name of the facet item." + }, + "sort": { + "$ref": "#/definitions/SearchFacetSort", + "description": "Define the sorting criteria for items" + } + } + }, + "SearchFacetItemValue": { + "type": "object", + "description": "The content of a search facet result item.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "value": { + "type": "string", + "description": "The name of the facet item." + } + } + }, + "SearchFacetResultValue": { + "type": "object", + "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", + "properties": { + "entityType": { + "type": "array", + "description": "Entity type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "assetType": { + "type": "array", + "description": "Asset type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "classification": { + "type": "array", + "description": "Classification", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "term": { + "type": "array", + "description": "Term", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "contactId": { + "type": "array", + "description": "Contact id", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "contactType": { + "type": "array", + "description": "Contact type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "label": { + "type": "array", + "description": "Label", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "glossaryType": { + "type": "array", + "description": "Glossary type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "termStatus": { + "type": "array", + "description": "Term status", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "termTemplate": { + "type": "array", + "description": "Term template", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + } + } + }, + "SearchFacetSort": { + "type": "object", + "description": "The sorting criteria", + "properties": { + "count": { + "$ref": "#/definitions/SearchSortOrder", + "description": "Order by count" + }, + "value": { + "$ref": "#/definitions/SearchSortOrder", + "description": "Order by value" + } + } + }, + "SearchHighlights": { + "type": "object", + "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", + "properties": { + "id": { + "type": "array", + "description": "Id", + "items": { + "type": "string" + } + }, + "qualifiedName": { + "type": "array", + "description": "Qualified name", + "items": { + "type": "string" + } + }, + "name": { + "type": "array", + "description": "Name", + "items": { + "type": "string" + } + }, + "description": { + "type": "array", + "description": "Description", + "items": { + "type": "string" + } + }, + "entityType": { + "type": "array", + "description": "Entity type", + "items": { + "type": "string" + } + } + } + }, + "SearchResultValue": { + "type": "object", + "description": "The value item of the search result.", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", + "x-ms-client-name": "searchScore" + }, + "@search.highlights": { + "$ref": "#/definitions/SearchHighlights", + "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", + "x-ms-client-name": "searchHighlights" + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to\ndistinguish whether a record is an asset or a term." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The create time of the record. The Unix epoch format." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The last update time of the record. The Unix epoch format." + }, + "id": { + "type": "string", + "description": "The GUID of the record." + }, + "name": { + "type": "string", + "description": "The name of the record." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the record." + }, + "entityType": { + "type": "string", + "description": "The type name of the asset." + }, + "description": { + "type": "string", + "description": "The description of the asset." + }, + "endorsement": { + "type": "string", + "description": "The endorsement of the asset." + }, + "owner": { + "type": "string", + "description": "The owner of the record." + }, + "classification": { + "type": "array", + "description": "The classifications of the record.", + "items": { + "type": "string" + } + }, + "label": { + "type": "array", + "description": "The labels of the asset.", + "items": { + "type": "string" + } + }, + "term": { + "type": "array", + "description": "The terms assigned to the asset.", + "items": { + "$ref": "#/definitions/TermSearchResultValue" + }, + "x-ms-identifiers": [] + }, + "contact": { + "type": "array", + "description": "The contacts of the asset.", + "items": { + "$ref": "#/definitions/ContactSearchResultValue" + } + }, + "assetType": { + "type": "array", + "description": "The asset types of the asset.", + "items": { + "type": "string" + } + }, + "glossaryType": { + "type": "string", + "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or\nAtlasGlossaryCategory." + }, + "glossary": { + "type": "string", + "description": "The glossary name of the term." + }, + "termStatus": { + "type": "string", + "description": "The status of the term." + }, + "termTemplate": { + "type": "array", + "description": "The term template names used by the term.", + "items": { + "type": "string" + } + }, + "longDescription": { + "type": "string", + "description": "The definition of the term." + } + } + }, + "SearchSortOrder": { + "type": "string", + "description": "Search sort order", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "SearchSortOrder", + "modelAsString": true, + "values": [ + { + "name": "Ascend", + "value": "asc", + "description": "Use ascending order for sorting" + }, + { + "name": "Descend", + "value": "desc", + "description": "Use descending order for sorting" + } + ] + } + }, + "SearchTaxonomySetting": { + "type": "object", + "description": "Taxonomy setting for search request", + "properties": { + "assetTypes": { + "type": "array", + "description": "Asset types", + "items": { + "type": "string" + } + }, + "facet": { + "$ref": "#/definitions/SearchFacetItem", + "description": "The content of a search facet result item." + } + } + }, + "SortType": { + "type": "string", + "description": "Type for sorting", + "enum": [ + "NONE", + "ASC", + "DESC" + ], + "x-ms-enum": { + "name": "SortType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "NONE", + "description": "No sorting order" + }, + { + "name": "Ascend", + "value": "ASC", + "description": "Use ascending order for sorting" + }, + { + "name": "Descend", + "value": "DESC", + "description": "Use descending order for sorting" + } + ] + } + }, + "StatusAtlasRelationship": { + "type": "string", + "description": "Status for atlas relationship", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "StatusAtlasRelationship", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "ACTIVE", + "description": "active" + }, + { + "name": "Deleted", + "value": "DELETED", + "description": "deleted" + } + ] + } + }, + "SuggestOptions": { + "type": "object", + "description": "The payload of suggest request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support suggest operation. It must be\nat least 1 character, and no more than 100 characters. In the index schema we\ndefined a default suggester which lists all the supported fields and specifies\na search mode." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions we hope to return. The default value is 5. The value\nmust be a number between 1 and 100." + }, + "filter": { + "description": "The filter for the search." + } + } + }, + "SuggestResult": { + "type": "object", + "description": "The result item of the search suggest.", + "properties": { + "value": { + "type": "array", + "description": "The result value", + "items": { + "$ref": "#/definitions/SuggestResultValue" + } + } + } + }, + "SuggestResultValue": { + "type": "object", + "description": "The value item of the search suggest.", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", + "x-ms-client-name": "searchScore" + }, + "@search.text": { + "type": "string", + "description": "The target text that contains the keyword as prefix. The keyword is wrapped\nwith emphasis mark.", + "x-ms-client-name": "searchText" + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to\ndistinguish whether a record is an asset or a term." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The create time of the record. The Unix epoch format." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The last update time of the record. The Unix epoch format." + }, + "id": { + "type": "string", + "description": "The GUID of the record." + }, + "name": { + "type": "string", + "description": "The name of the record." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the record." + }, + "entityType": { + "type": "string", + "description": "The type name of the asset." + }, + "description": { + "type": "string", + "description": "The description of the asset." + }, + "endorsement": { + "type": "string", + "description": "The endorsement of the asset." + }, + "owner": { + "type": "string", + "description": "The owner of the record." + }, + "classification": { + "type": "array", + "description": "The classifications of the record.", + "items": { + "type": "string" + } + }, + "label": { + "type": "array", + "description": "The labels of the asset.", + "items": { + "type": "string" + } + }, + "term": { + "type": "array", + "description": "The terms assigned to the asset.", + "items": { + "$ref": "#/definitions/TermSearchResultValue" + }, + "x-ms-identifiers": [] + }, + "contact": { + "type": "array", + "description": "The contacts of the asset.", + "items": { + "$ref": "#/definitions/ContactSearchResultValue" + } + }, + "assetType": { + "type": "array", + "description": "The asset types of the asset.", + "items": { + "type": "string" + } + }, + "glossaryType": { + "type": "string", + "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or\nAtlasGlossaryCategory." + }, + "glossary": { + "type": "string", + "description": "The glossary name of the term." + }, + "termStatus": { + "type": "string", + "description": "The status of the term." + }, + "termTemplate": { + "type": "array", + "description": "The term template names used by the term.", + "items": { + "type": "string" + } + }, + "longDescription": { + "type": "string", + "description": "The definition of the term." + } + } + }, + "TermSearchResultValue": { + "type": "object", + "description": "The context.", + "properties": { + "name": { + "type": "string", + "description": "The name of the term." + }, + "glossaryName": { + "type": "string", + "description": "The name of the glossary which contains the term." + }, + "guid": { + "type": "string", + "description": "The GUID of the term." + } + } + }, + "TermStatus": { + "type": "string", + "description": "Status for term", + "enum": [ + "Draft", + "Approved", + "Alert", + "Expired" + ], + "x-ms-enum": { + "name": "TermStatus", + "modelAsString": true, + "values": [ + { + "name": "Draft", + "value": "Draft", + "description": "draft" + }, + { + "name": "Approved", + "value": "Approved", + "description": "approved" + }, + { + "name": "Alert", + "value": "Alert", + "description": "alert" + }, + { + "name": "Expired", + "value": "Expired", + "description": "expired" + } + ] + } + }, + "TermTemplateDef": { + "type": "object", + "description": "Term template definition for glossary term.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } }, - "searchKeyword": { - "name": "keyword", - "description": "The keyword to get auto complete.", - "in": "query", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" + "TimeBoundary": { + "type": "object", + "description": "Captures time-boundary details", + "properties": { + "endTime": { + "type": "string", + "description": "The end of the time boundary." + }, + "startTime": { + "type": "string", + "description": "The start of the time boundary." + }, + "timeZone": { + "type": "string", + "description": "The timezone of the time boundary." + } + } }, - "depth": { - "name": "depth", - "description": "The number of hops for lineage.", - "in": "query", - "required": false, - "type": "integer", - "default": 3, - "format": "int32", - "x-ms-parameter-location": "method" + "TimeZone": { + "type": "object", + "description": "The timezone information.", + "properties": { + "dstSavings": { + "type": "integer", + "format": "int32", + "description": "The value of the daylight saving time." + }, + "id": { + "type": "string", + "description": "The ID of the timezone." + }, + "availableIds": { + "type": "array", + "description": "An array of available IDs.", + "items": { + "type": "string" + } + }, + "default": { + "$ref": "#/definitions/TimeZone", + "description": "The timezone information." + }, + "displayName": { + "type": "string", + "description": "The display name of the timezone." + }, + "rawOffset": { + "type": "integer", + "format": "int32", + "description": "The raw offset of the timezone." + } + } }, - "direction": { - "name": "direction", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "in": "query", - "required": true, + "TypeCategory": { "type": "string", + "description": "Type Category", "enum": [ - "BOTH", - "INPUT", - "OUTPUT" + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" ], "x-ms-enum": { - "name": "direction", - "modelAsString": true - }, - "x-ms-parameter-location": "method" - }, - "extendedInfo": { - "name": "extendedInfo", - "description": "Limits whether includes extended information.", + "name": "TypeCategory", + "modelAsString": true, + "values": [ + { + "name": "Primitive", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "ObjectIdType", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, + { + "name": "Enum", + "value": "ENUM", + "description": "enum" + }, + { + "name": "Struct", + "value": "STRUCT", + "description": "struct" + }, + { + "name": "Classification", + "value": "CLASSIFICATION", + "description": "classification" + }, + { + "name": "Entity", + "value": "ENTITY", + "description": "entity" + }, + { + "name": "Array", + "value": "ARRAY", + "description": "array" + }, + { + "name": "Map", + "value": "MAP", + "description": "map" + }, + { + "name": "Relationship", + "value": "RELATIONSHIP", + "description": "relationship" + }, + { + "name": "TermTemplate", + "value": "TERM_TEMPLATE", + "description": "term template" + } + ] + } + } + }, + "parameters": { + "AtlasApiVersionParameter": { + "name": "api-version", "in": "query", + "description": "The API version to use for this operation.", "required": false, - "type": "boolean", - "x-ms-parameter-location": "method" - }, - "relationshipGuid": { - "name": "guid", - "description": "The globally unique identifier of the relationship.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "classificationDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the classification.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "classificationDefName": { - "name": "name", - "description": "The name of the classification.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "entityDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the entity.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "entityDefName": { - "name": "name", - "description": "The name of the entity.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "termTemplateDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the term template.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "termTemplateDefName": { - "name": "name", - "description": "The name of the term template.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "enumDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the enum.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "enumDefName": { - "name": "name", - "description": "The name of the enum.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "relationshipDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the relationship.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "relationshipDefName": { - "name": "name", - "description": "The name of the relationship.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "structDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the struct.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "structDefName": { - "name": "name", - "description": "The name of the struct.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "typeDefGuid": { - "name": "guid", - "description": "The globally unique identifier of the type.", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "typeDefName": { - "name": "name", - "description": "The name of the type.", - "in": "path", - "required": true, "type": "string", "minLength": 1, - "maxLength": 4096, - "x-ms-parameter-location": "method" - }, - "userId": { - "name": "userId", - "description": "The user ID.", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "principalId": { - "name": "principalId", - "description": "The principal ID.", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "minExtInfo": { - "name": "minExtInfo", - "description": "Whether to return minimal information for referred entities.", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - }, - "ignoreRelationships": { - "name": "ignoreRelationships", - "description": "Whether to ignore relationship attributes.", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - }, - "includeTermTemplate": { - "name": "includeTermTemplate", - "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true when search filter type=term_template", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - }, - "includeTermHierarchy": { - "name": "includeTermHierarchy", - "description": "Whether include term hierarchy", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - }, - "extInfo": { - "name": "extInfo", - "description": "Whether include extended information like contact display name and attribute values", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - }, - "ignoreTermsAndCategories": { - "name": "ignoreTermsAndCategories", - "description": "Whether ignore terms and categories", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" }, - "purviewAPIVersion": { + "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", - "description": "The version of the API.", "in": "query", + "description": "The API version to use for this operation.", "required": true, "type": "string", - "x-ms-parameter-location": "method" - }, - "atlasAPIVersion": { - "name": "api-version", - "description": "The version of the API.", - "in": "query", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "type": { - "name": "type", - "description": "Typedef name as search filter when get typedefs.", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" - ], - "x-ms-enum": { - "name": "type", - "modelAsString": true - }, - "x-ms-parameter-location": "method" + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" }, - "requiredCollectionId": { - "name": "collectionId", - "description": "The collection where entities will be moved to.", - "in": "query", + "BusinessMetadataOptions": { + "name": "file", + "in": "formData", + "description": "InputStream of file", "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "collectionId": { - "name": "collectionId", - "description": "The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection.", - "in": "query", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "forceDeleteEntityAssignment": { - "name": "forceDeleteEntityAssignment", - "description": "Whether delete entity assignment", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - }, - "forceDeleteChild": { - "name": "forceDeleteChild", - "description": "Whether delete child terms together with the parent term", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - }, - "businessAttributeUpdateBehavior": { - "name": "businessAttributeUpdateBehavior", - "description": "Used to define the update behavior for business attributes when updating entities.", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "businessAttributeUpdateBehavior", - "modelAsString": true - }, + "type": "file", "x-ms-parameter-location": "method" } } diff --git a/swagger-specs/purview/resource-manager/Microsoft.Purview/stable/2021-12-01/purview.json b/swagger-specs/purview/resource-manager/Microsoft.Purview/preview/2023-05-01-preview/purview.json similarity index 87% rename from swagger-specs/purview/resource-manager/Microsoft.Purview/stable/2021-12-01/purview.json rename to swagger-specs/purview/resource-manager/Microsoft.Purview/preview/2023-05-01-preview/purview.json index 41346bd8a..8fbb30804 100644 --- a/swagger-specs/purview/resource-manager/Microsoft.Purview/stable/2021-12-01/purview.json +++ b/swagger-specs/purview/resource-manager/Microsoft.Purview/preview/2023-05-01-preview/purview.json @@ -1,44 +1,37 @@ { "swagger": "2.0", "info": { - "version": "2021-12-01", "title": "PurviewManagementClient", - "description": "Creates a Microsoft.Purview management client." + "description": "Creates a Microsoft.Purview management client.", + "version": "2023-05-01-preview" }, "host": "management.azure.com", "schemes": [ "https" ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts": { "get": { "tags": [ "Account" ], - "summary": "Gets the accounts resources by resource group.", - "description": "List accounts in ResourceGroup", - "operationId": "Accounts_ListByResourceGroup", + "summary": "Gets the accounts resources by subscription.", + "description": "List accounts in Subscription", + "operationId": "Accounts_ListBySubscription", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" }, - { - "$ref": "#/parameters/resourceGroupName" - }, { "$ref": "#/parameters/api-version" }, { - "name": "$skipToken", "in": "query", + "name": "$skipToken", "description": "The skip token.", - "required": false, "type": "string" } ], @@ -60,32 +53,37 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "Accounts_ListByResourceGroup": { - "$ref": "./examples/Accounts_ListByResourceGroup.json" + "Accounts_ListBySubscription": { + "$ref": "./examples/Accounts_ListBySubscription.json" } } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts": { "get": { "tags": [ "Account" ], - "summary": "Gets the accounts resources by subscription.", - "description": "List accounts in Subscription", - "operationId": "Accounts_ListBySubscription", + "summary": "Gets the accounts resources by resource group.", + "description": "List accounts in ResourceGroup", + "operationId": "Accounts_ListByResourceGroup", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" }, + { + "$ref": "#/parameters/resourceGroupName" + }, { "$ref": "#/parameters/api-version" }, { - "name": "$skipToken", "in": "query", + "name": "$skipToken", "description": "The skip token.", - "required": false, "type": "string" } ], @@ -107,8 +105,8 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "Accounts_ListBySubscription": { - "$ref": "./examples/Accounts_ListBySubscription.json" + "Accounts_ListByResourceGroup": { + "$ref": "./examples/Accounts_ListByResourceGroup.json" } } } @@ -121,6 +119,9 @@ "summary": "Gets the account resource.", "description": "Get an account", "operationId": "Accounts_Get", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -159,9 +160,15 @@ "tags": [ "Account" ], - "summary": "Create or update an account resource", + "summary": "Create or update an account resource.", "description": "Creates or updates an account", "operationId": "Accounts_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -173,16 +180,16 @@ "$ref": "#/parameters/accountName" }, { - "name": "account", + "$ref": "#/parameters/api-version" + }, + { "in": "body", + "name": "account", "description": "The account.", "required": true, "schema": { "$ref": "#/definitions/Account" } - }, - { - "$ref": "#/parameters/api-version" } ], "responses": { @@ -193,7 +200,7 @@ } }, "201": { - "description": "Success", + "description": "Created", "schema": { "$ref": "#/definitions/Account" } @@ -205,12 +212,12 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { "Accounts_CreateOrUpdate": { "$ref": "./examples/Accounts_CreateOrUpdate.json" } - } + }, + "x-ms-long-running-operation": true }, "delete": { "tags": [ @@ -219,6 +226,9 @@ "summary": "Deletes the account resource.", "description": "Deletes an account resource", "operationId": "Accounts_Delete", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -241,7 +251,7 @@ "description": "Accepted" }, "204": { - "description": "Success" + "description": "No Content" }, "default": { "description": "An error response received from the provider.", @@ -250,12 +260,12 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { "Accounts_Delete": { "$ref": "./examples/Accounts_Delete.json" } - } + }, + "x-ms-long-running-operation": true }, "patch": { "tags": [ @@ -264,6 +274,12 @@ "summary": "Patches the account resource.", "description": "Updates an account", "operationId": "Accounts_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -275,16 +291,16 @@ "$ref": "#/parameters/accountName" }, { - "name": "accountUpdateParameters", + "$ref": "#/parameters/api-version" + }, + { "in": "body", + "name": "accountUpdateParameters", "description": "The account update parameters.", "required": true, "schema": { "$ref": "#/definitions/AccountUpdateParameters" } - }, - { - "$ref": "#/parameters/api-version" } ], "responses": { @@ -307,22 +323,28 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { "Accounts_Update": { "$ref": "./examples/Accounts_Update.json" } - } + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listkeys": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/addRootCollectionAdmin": { "post": { "tags": [ "Account" ], - "summary": "Lists the keys asynchronous.", - "description": "List the authorization keys associated with this account.", - "operationId": "Accounts_ListKeys", + "summary": "Add the administrator for root collection.", + "description": "Add the administrator for root collection associated with this account.", + "operationId": "Accounts_AddRootCollectionAdmin", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -335,14 +357,20 @@ }, { "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "collectionAdminUpdate", + "description": "The collection admin update payload.", + "required": true, + "schema": { + "$ref": "#/definitions/CollectionAdminUpdate" + } } ], "responses": { "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AccessKeys" - } + "description": "Success" }, "default": { "description": "An error response received from the provider.", @@ -352,20 +380,23 @@ } }, "x-ms-examples": { - "Accounts_ListKeys": { - "$ref": "./examples/Accounts_ListKeys.json" + "Accounts_AddRootCollectionAdmin": { + "$ref": "./examples/Accounts_AddRootCollectionAdmin.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/addRootCollectionAdmin": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listkeys": { "post": { "tags": [ "Account" ], - "summary": "Add the administrator for root collection.", - "description": "Add the administrator for root collection associated with this account.", - "operationId": "Accounts_AddRootCollectionAdmin", + "summary": "Lists the keys asynchronous.", + "description": "List the authorization keys associated with this account.", + "operationId": "Accounts_ListKeys", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -376,22 +407,16 @@ { "$ref": "#/parameters/accountName" }, - { - "name": "collectionAdminUpdate", - "in": "body", - "description": "The collection admin update payload.", - "required": true, - "schema": { - "$ref": "#/definitions/CollectionAdminUpdate" - } - }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { - "description": "Success" + "description": "Success", + "schema": { + "$ref": "#/definitions/AccessKeys" + } }, "default": { "description": "An error response received from the provider.", @@ -401,8 +426,8 @@ } }, "x-ms-examples": { - "Accounts_AddRootCollectionAdmin": { - "$ref": "./examples/Accounts_AddRootCollectionAdmin.json" + "Accounts_ListKeys": { + "$ref": "./examples/Accounts_ListKeys.json" } } } @@ -415,18 +440,21 @@ "summary": "Gets the default account information set for the scope.", "description": "Get the default account for the scope.", "operationId": "DefaultAccounts_Get", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "scopeTenantId", "in": "query", + "name": "scopeTenantId", "description": "The tenant ID.", "required": true, "type": "string", "format": "uuid" }, { - "name": "scopeType", "in": "query", + "name": "scopeType", "description": "The scope for the default account.", "required": true, "type": "string", @@ -440,10 +468,9 @@ } }, { - "name": "scope", "in": "query", + "name": "scope", "description": "The Id of the scope object, for example if the scope is \"Subscription\" then it is the ID of that subscription.", - "required": false, "type": "string" }, { @@ -471,49 +498,6 @@ } } }, - "/providers/Microsoft.Purview/setDefaultAccount": { - "post": { - "tags": [ - "DefaultAccount" - ], - "summary": "Sets the default account for the scope.", - "description": "Sets the default account for the scope.", - "operationId": "DefaultAccounts_Set", - "parameters": [ - { - "name": "defaultAccountPayload", - "in": "body", - "description": "The payload containing the default account information and the scope.", - "required": true, - "schema": { - "$ref": "#/definitions/DefaultAccountPayload" - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DefaultAccountPayload" - } - }, - "default": { - "description": "An error response received from the provider.", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - } - } - }, - "x-ms-examples": { - "DefaultAccounts_Set": { - "$ref": "./examples/DefaultAccounts_Set.json" - } - } - } - }, "/providers/Microsoft.Purview/removeDefaultAccount": { "post": { "tags": [ @@ -522,18 +506,21 @@ "summary": "Removes the default account from the scope.", "description": "Removes the default account from the scope.", "operationId": "DefaultAccounts_Remove", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "scopeTenantId", "in": "query", + "name": "scopeTenantId", "description": "The tenant ID.", "required": true, "type": "string", "format": "uuid" }, { - "name": "scopeType", "in": "query", + "name": "scopeType", "description": "The scope for the default account.", "required": true, "type": "string", @@ -547,10 +534,9 @@ } }, { - "name": "scope", "in": "query", + "name": "scope", "description": "The Id of the scope object, for example if the scope is \"Subscription\" then it is the ID of that subscription.", - "required": false, "type": "string" }, { @@ -562,7 +548,7 @@ "description": "Success" }, "204": { - "description": "Success" + "description": "No Content" }, "default": { "description": "An error response received from the provider.", @@ -578,42 +564,39 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listFeatures": { + "/providers/Microsoft.Purview/setDefaultAccount": { "post": { "tags": [ - "Feature" + "DefaultAccount" + ], + "summary": "Sets the default account for the scope.", + "description": "Sets the default account for the scope.", + "operationId": "DefaultAccounts_Set", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" ], - "summary": "Gets a list of features and their status for the account.\r\nStatus of enabled features will be true. Status of disabled features will be false.\r\nFeatures that don't exist will be excluded from the results.", - "description": "Gets details from a list of feature names.", - "operationId": "Features_AccountGet", "parameters": [ { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/accountName" + "$ref": "#/parameters/api-version" }, { - "name": "featureRequest", "in": "body", - "description": "Request body with feature names.", + "name": "defaultAccountPayload", + "description": "The payload containing the default account information and the scope.", "required": true, "schema": { - "$ref": "#/definitions/BatchFeatureRequest" + "$ref": "#/definitions/DefaultAccountPayload" } - }, - { - "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchFeatureStatus" + "$ref": "#/definitions/DefaultAccountPayload" } }, "default": { @@ -624,8 +607,8 @@ } }, "x-ms-examples": { - "Features_AccountGet": { - "$ref": "./examples/Features_AccountGet.json" + "DefaultAccounts_Set": { + "$ref": "./examples/DefaultAccounts_Set.json" } } } @@ -638,28 +621,34 @@ "summary": "Gets a list of features and their status for the location and subscription.\r\nStatus of enabled features will be true. Status of disabled features will be false.\r\nFeatures that don't exist will be excluded from the results.", "description": "Gets details from a list of feature names.", "operationId": "Features_SubscriptionGet", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { - "name": "locations", "in": "path", + "name": "locations", "description": "Location of feature.", "required": true, "type": "string" }, { - "name": "featureRequest", + "$ref": "#/parameters/api-version" + }, + { "in": "body", + "name": "featureRequest", "description": "Request body with feature names.", "required": true, "schema": { "$ref": "#/definitions/BatchFeatureRequest" } - }, - { - "$ref": "#/parameters/api-version" } ], "responses": { @@ -683,14 +672,20 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listFeatures": { + "post": { "tags": [ - "KafkaConfiguration" + "Feature" + ], + "summary": "Gets a list of features and their status for the account.\r\nStatus of enabled features will be true. Status of disabled features will be false.\r\nFeatures that don't exist will be excluded from the results.", + "description": "Gets details from a list of feature names.", + "operationId": "Features_AccountGet", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" ], - "summary": "Gets the kafka configuration.", - "description": "Gets the kafka configuration for the account", - "operationId": "KafkaConfigurations_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -702,24 +697,23 @@ "$ref": "#/parameters/accountName" }, { - "name": "kafkaConfigurationName", - "in": "path", - "description": "Name of kafka configuration.", - "required": true, - "type": "string", - "maxLength": 63, - "minLength": 3, - "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + "$ref": "#/parameters/api-version" }, { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { + "in": "body", + "name": "featureRequest", + "description": "Request body with feature names.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchFeatureRequest" + } + } + ], + "responses": { + "200": { "description": "Success", "schema": { - "$ref": "#/definitions/KafkaConfiguration" + "$ref": "#/definitions/BatchFeatureStatus" } }, "default": { @@ -730,18 +724,23 @@ } }, "x-ms-examples": { - "KafkaConfigurations_Get": { - "$ref": "./examples/KafkaConfigurations_Get.json" + "Features_AccountGet": { + "$ref": "./examples/Features_AccountGet.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/ingestionPrivateEndpointConnections": { + "get": { "tags": [ - "KafkaConfiguration" + "IngestionPrivateEndpoint" + ], + "summary": "Lists all ingestion private endpoint connections.", + "description": "Lists all ingestion private endpoint connections", + "operationId": "IngestionPrivateEndpointConnections_List", + "produces": [ + "application/json" ], - "summary": "Create or update the kafka configuration.", - "description": "Create or update Kafka Configuration", - "operationId": "KafkaConfigurations_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -752,40 +751,15 @@ { "$ref": "#/parameters/accountName" }, - { - "name": "kafkaConfigurationName", - "in": "path", - "description": "The kafka configuration name.", - "required": true, - "type": "string", - "maxLength": 63, - "minLength": 3, - "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" - }, - { - "name": "kafkaConfiguration", - "in": "body", - "description": "The kafka configuration of the account.", - "required": true, - "schema": { - "$ref": "#/definitions/KafkaConfiguration" - } - }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { - "description": "Create or Update Successful", - "schema": { - "$ref": "#/definitions/KafkaConfiguration" - } - }, - "201": { - "description": "Create or Update Successful", + "description": "Success", "schema": { - "$ref": "#/definitions/KafkaConfiguration" + "$ref": "#/definitions/PrivateEndpointConnectionList" } }, "default": { @@ -795,19 +769,30 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "KafkaConfigurations_CreateOrUpdate": { - "$ref": "./examples/KafkaConfigurations_CreateOrUpdate.json" + "IngestionPrivateEndpointConnections_List": { + "$ref": "./examples/IngestionPrivateEndpointConnections_List.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/ingestionPrivateEndpointConnectionStatus": { + "post": { "tags": [ - "KafkaConfiguration" + "IngestionPrivateEndpoint" + ], + "summary": "Updates ingestion private endpoint connection status.", + "description": "Update ingestion private endpoint connection status", + "operationId": "IngestionPrivateEndpointConnections_UpdateStatus", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" ], - "summary": "Deletes the kafka configuration on the account.", - "description": "Deletes a KafkaConfiguration resource.", - "operationId": "KafkaConfigurations_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -819,25 +804,24 @@ "$ref": "#/parameters/accountName" }, { - "name": "kafkaConfigurationName", - "in": "path", - "description": "Name of kafka configuration.", - "required": true, - "type": "string", - "maxLength": 63, - "minLength": 3, - "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + "$ref": "#/parameters/api-version" }, { - "$ref": "#/parameters/api-version" + "in": "body", + "name": "request", + "description": "The ingestion private endpoint connection status update request.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionStatusUpdateRequest" + } } ], "responses": { "200": { - "description": "Success" - }, - "204": { - "description": "Success" + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionStatusUpdateResponse" + } }, "default": { "description": "An error response received from the provider.", @@ -847,8 +831,8 @@ } }, "x-ms-examples": { - "KafkaConfigurations_Delete": { - "$ref": "./examples/KafkaConfigurations_Delete.json" + "IngestionPrivateEndpointConnections_UpdateStatus": { + "$ref": "./examples/IngestionPrivateEndpointConnections_UpdateStatus.json" } } } @@ -861,6 +845,9 @@ "summary": "Gets the list of Kafka configurations for the account.", "description": "Lists the Kafka configurations in the Account", "operationId": "KafkaConfigurations_ListByAccount", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -875,10 +862,9 @@ "$ref": "#/parameters/api-version" }, { - "name": "$skipToken", "in": "query", + "name": "$skipToken", "description": "The skip token.", - "required": false, "type": "string" } ], @@ -906,51 +892,17 @@ } } }, - "/providers/Microsoft.Purview/operations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations/{kafkaConfigurationName}": { "get": { "tags": [ - "Operation" - ], - "summary": "Lists the available operations", - "description": "List of available operations", - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/api-version" - } + "KafkaConfiguration" ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OperationList" - } - }, - "default": { - "description": "An error response received from the provider.", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections": { - "get": { - "tags": [ - "PrivateEndpointConnection" + "summary": "Gets the kafka configuration.", + "description": "Gets the kafka configuration for the account", + "operationId": "KafkaConfigurations_Get", + "produces": [ + "application/json" ], - "summary": "Gets private endpoint connections.", - "description": "Get private endpoint connections for account", - "operationId": "PrivateEndpointConnections_ListByAccount", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -962,21 +914,24 @@ "$ref": "#/parameters/accountName" }, { - "$ref": "#/parameters/api-version" + "in": "path", + "name": "kafkaConfigurationName", + "description": "Name of kafka configuration.", + "required": true, + "type": "string", + "maxLength": 63, + "minLength": 3, + "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { - "name": "$skipToken", - "in": "query", - "description": "The skip token.", - "required": false, - "type": "string" + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/PrivateEndpointConnectionList" + "$ref": "#/definitions/KafkaConfiguration" } }, "default": { @@ -986,24 +941,25 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "PrivateEndpointConnections_ListByAccount": { - "$ref": "./examples/PrivateEndpointConnections_ListByAccount.json" + "KafkaConfigurations_Get": { + "$ref": "./examples/KafkaConfigurations_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { - "get": { + }, + "put": { "tags": [ - "PrivateEndpointConnection" + "KafkaConfiguration" + ], + "summary": "Create or update the kafka configuration.", + "description": "Create or update Kafka Configuration", + "operationId": "KafkaConfigurations_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" ], - "summary": "Gets private endpoint connection information.", - "description": "Get a private endpoint connection", - "operationId": "PrivateEndpointConnections_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1015,21 +971,39 @@ "$ref": "#/parameters/accountName" }, { - "name": "privateEndpointConnectionName", "in": "path", - "description": "Name of the private endpoint connection.", + "name": "kafkaConfigurationName", + "description": "The kafka configuration name.", "required": true, - "type": "string" + "type": "string", + "maxLength": 63, + "minLength": 3, + "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "kafkaConfiguration", + "description": "The kafka configuration of the account.", + "required": true, + "schema": { + "$ref": "#/definitions/KafkaConfiguration" + } } ], "responses": { "200": { - "description": "Success", + "description": "Create or Update Successful", "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" + "$ref": "#/definitions/KafkaConfiguration" + } + }, + "201": { + "description": "Create or Update Successful", + "schema": { + "$ref": "#/definitions/KafkaConfiguration" } }, "default": { @@ -1040,18 +1014,21 @@ } }, "x-ms-examples": { - "PrivateEndpointConnections_Get": { - "$ref": "./examples/PrivateEndpointConnections_Get.json" + "KafkaConfigurations_CreateOrUpdate": { + "$ref": "./examples/KafkaConfigurations_CreateOrUpdate.json" } } }, - "put": { + "delete": { "tags": [ - "PrivateEndpointConnection" + "KafkaConfiguration" + ], + "summary": "Deletes the kafka configuration on the account.", + "description": "Deletes a KafkaConfiguration resource.", + "operationId": "KafkaConfigurations_Delete", + "produces": [ + "application/json" ], - "summary": "Approves/Rejects private endpoint connection request.", - "description": "Create or update a private endpoint connection", - "operationId": "PrivateEndpointConnections_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1063,20 +1040,14 @@ "$ref": "#/parameters/accountName" }, { - "name": "privateEndpointConnectionName", "in": "path", - "description": "Name of the private endpoint connection.", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "The request.", + "name": "kafkaConfigurationName", + "description": "Name of kafka configuration.", "required": true, - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } + "type": "string", + "maxLength": 63, + "minLength": 3, + "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "$ref": "#/parameters/api-version" @@ -1084,16 +1055,227 @@ ], "responses": { "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } + "description": "Success" }, - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } + "204": { + "description": "No Content" + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "KafkaConfigurations_Delete": { + "$ref": "./examples/KafkaConfigurations_Delete.json" + } + } + } + }, + "/providers/Microsoft.Purview/operations": { + "get": { + "tags": [ + "Operation" + ], + "summary": "Lists the available operations", + "description": "List of available operations", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Gets private endpoint connections.", + "description": "Get private endpoint connections for account", + "operationId": "PrivateEndpointConnections_ListByAccount", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "query", + "name": "$skipToken", + "description": "The skip token.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateEndpointConnections_ListByAccount": { + "$ref": "./examples/PrivateEndpointConnections_ListByAccount.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Gets private endpoint connection information.", + "description": "Get a private endpoint connection", + "operationId": "PrivateEndpointConnections_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "in": "path", + "name": "privateEndpointConnectionName", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Get": { + "$ref": "./examples/PrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Approves/Rejects private endpoint connection request.", + "description": "Create or update a private endpoint connection", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "in": "path", + "name": "privateEndpointConnectionName", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "request", + "description": "The request.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } }, "default": { "description": "An error response received from the provider.", @@ -1102,12 +1284,12 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { "PrivateEndpointConnections_CreateOrUpdate": { "$ref": "./examples/PrivateEndpointConnections_CreateOrUpdate.json" } - } + }, + "x-ms-long-running-operation": true }, "delete": { "tags": [ @@ -1116,6 +1298,9 @@ "summary": "Deletes private endpoint connection.", "description": "Delete a private endpoint connection", "operationId": "PrivateEndpointConnections_Delete", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1127,8 +1312,8 @@ "$ref": "#/parameters/accountName" }, { - "name": "privateEndpointConnectionName", "in": "path", + "name": "privateEndpointConnectionName", "description": "Name of the private endpoint connection.", "required": true, "type": "string" @@ -1145,7 +1330,7 @@ "description": "Accepted" }, "204": { - "description": "Success" + "description": "No Content" }, "default": { "description": "An error response received from the provider.", @@ -1154,12 +1339,12 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { "PrivateEndpointConnections_Delete": { "$ref": "./examples/PrivateEndpointConnections_Delete.json" } - } + }, + "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources": { @@ -1170,6 +1355,9 @@ "summary": "Gets a list of privately linkable resources for an account.", "description": "Gets a list of privately linkable resources for an account", "operationId": "PrivateLinkResources_ListByAccount", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1216,6 +1404,9 @@ "summary": "Gets a privately linkable resources for an account with given group identifier.", "description": "Gets a privately linkable resources for an account with given group identifier", "operationId": "PrivateLinkResources_GetByGroupId", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1227,8 +1418,8 @@ "$ref": "#/parameters/accountName" }, { - "name": "groupId", "in": "path", + "name": "groupId", "description": "The group identifier.", "required": true, "type": "string" @@ -1266,21 +1457,27 @@ "summary": "Checks the account name availability.", "description": "Checks if account name is available.", "operationId": "Accounts_CheckNameAvailability", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { - "name": "checkNameAvailabilityRequest", + "$ref": "#/parameters/api-version" + }, + { "in": "body", + "name": "checkNameAvailabilityRequest", "description": "The check name availability request.", "required": true, "schema": { "$ref": "#/definitions/CheckNameAvailabilityRequest" } - }, - { - "$ref": "#/parameters/api-version" } ], "responses": { @@ -1312,13 +1509,16 @@ "summary": "Gets the Usage quota configuration.", "description": "Get the usage quota configuration", "operationId": "Usages_Get", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { - "name": "location", "in": "path", + "name": "location", "description": "The region.", "required": true, "type": "string" @@ -1327,9 +1527,9 @@ "$ref": "#/parameters/api-version" }, { - "name": "$filter", "in": "query", - "required": false, + "name": "$filter", + "description": "The filter, currently unused.", "type": "string" } ], @@ -1356,30 +1556,18 @@ } }, "definitions": { - "AccountList": { - "description": "Paged list of Account resources", - "required": [ - "value" - ], + "AccessKeys": { + "description": "The Purview Account access keys.", "type": "object", "properties": { - "count": { - "format": "int64", - "description": "Total item count.", - "type": "integer" - }, - "nextLink": { - "description": "The Url of next result page.", + "atlasKafkaPrimaryEndpoint": { + "description": "Gets or sets the primary connection string.", "type": "string" }, - "value": { - "description": "Collection of items of type results.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Account" - } - } + "atlasKafkaSecondaryEndpoint": { + "description": "Gets or sets the secondary connection string.", + "type": "string" + } } }, "Account": { @@ -1393,7 +1581,6 @@ "properties": { "properties": { "$ref": "#/definitions/AccountProperties", - "description": "Gets or sets the properties.", "x-ms-client-flatten": true }, "sku": { @@ -1407,25 +1594,40 @@ } } }, - "AccountSku": { - "description": "The Sku", + "AccountEndpoints": { + "description": "The account endpoints", "type": "object", "properties": { - "capacity": { - "format": "int32", - "description": "Gets or sets the sku capacity.", - "type": "integer" + "catalog": { + "description": "Gets the catalog endpoint.", + "type": "string", + "readOnly": true }, - "name": { - "description": "Gets or sets the sku name.", - "enum": [ - "Standard" - ], + "scan": { + "description": "Gets the scan endpoint.", "type": "string", - "x-ms-enum": { - "name": "name", - "modelAsString": true - } + "readOnly": true + } + } + }, + "AccountList": { + "description": "Paged list of Account resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "type": "array", + "items": { + "$ref": "#/definitions/Account" + }, + "x-ms-identifiers": [] } } }, @@ -1443,8 +1645,7 @@ "readOnly": true }, "cloudConnectors": { - "$ref": "#/definitions/CloudConnectors", - "description": "Cloud connectors.\r\nExternal cloud identifier used as part of scanning configuration." + "$ref": "#/definitions/CloudConnectors" }, "createdAt": { "format": "date-time", @@ -1476,8 +1677,11 @@ "type": "string", "readOnly": true }, + "ingestionStorage": { + "$ref": "#/definitions/IngestionStorage" + }, "managedEventHubState": { - "description": " Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed.", + "description": "Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed.", "default": "NotSpecified", "enum": [ "NotSpecified", @@ -1523,12 +1727,12 @@ }, "privateEndpointConnections": { "description": "Gets the private endpoint connections information.", - "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "provisioningState": { "description": "Gets or sets the state of the provisioning.", @@ -1566,132 +1770,29 @@ } } }, - "Identity": { - "description": "The Managed Identity of the resource", - "type": "object", - "properties": { - "principalId": { - "description": "Service principal object Id", - "type": "string", - "readOnly": true - }, - "tenantId": { - "description": "Tenant Id", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Identity Type", - "enum": [ - "None", - "SystemAssigned", - "UserAssigned" - ], - "type": "string", - "x-ms-enum": { - "name": "type", - "modelAsString": true - } - }, - "userAssignedIdentities": { - "description": "User Assigned Identities", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/UserAssignedIdentity" - } - } - } - }, - "SystemData": { - "description": "Metadata pertaining to creation and last modification of the resource.", + "AccountSku": { + "description": "The Sku", "type": "object", "properties": { - "createdAt": { - "format": "date-time", - "description": "The timestamp of resource creation (UTC).", - "type": "string", - "readOnly": true - }, - "createdBy": { - "description": "The identity that created the resource.", - "type": "string", - "readOnly": true - }, - "createdByType": { - "description": "The type of identity that created the resource.", - "enum": [ - "User", - "Application", - "ManagedIdentity", - "Key" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "createdByType", - "modelAsString": true - } - }, - "lastModifiedAt": { - "format": "date-time", - "description": "The timestamp of the last modification the resource (UTC).", - "type": "string", - "readOnly": true - }, - "lastModifiedBy": { - "description": "The identity that last modified the resource.", - "type": "string", - "readOnly": true + "capacity": { + "format": "int32", + "description": "Gets or sets the sku capacity.", + "type": "integer" }, - "lastModifiedByType": { - "description": "The type of identity that last modified the resource.", + "name": { + "description": "Gets or sets the sku name.", "enum": [ - "User", - "Application", - "ManagedIdentity", - "Key" + "Standard", + "Free" ], "type": "string", - "readOnly": true, "x-ms-enum": { - "name": "lastModifiedByType", + "name": "name", "modelAsString": true } } } }, - "CloudConnectors": { - "description": "External Cloud Service connectors", - "type": "object", - "properties": { - "awsExternalId": { - "description": "AWS external identifier.\r\nConfigured in AWS to allow use of the role arn used for scanning", - "type": "string", - "readOnly": true - } - } - }, - "AccountEndpoints": { - "description": "The account endpoints", - "type": "object", - "properties": { - "catalog": { - "description": "Gets the catalog endpoint.", - "type": "string", - "readOnly": true - }, - "guardian": { - "description": "Gets the guardian endpoint.", - "type": "string", - "readOnly": true - }, - "scan": { - "description": "Gets the scan endpoint.", - "type": "string", - "readOnly": true - } - } - }, "AccountStatus": { "description": "The account status.", "type": "object", @@ -1728,207 +1829,202 @@ } } }, - "PrivateEndpointConnection": { - "description": "A private endpoint connection class.", + "AccountUpdateParameters": { + "description": "The account update properties.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], "properties": { + "identity": { + "$ref": "#/definitions/Identity" + }, "properties": { - "$ref": "#/definitions/PrivateEndpointConnectionProperties", - "description": "The connection identifier.", - "x-ms-client-flatten": true + "$ref": "#/definitions/AccountProperties" + }, + "tags": { + "description": "Tags on the azure resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "ManagedResources": { - "description": "The managed resources in customer subscription.", + "BatchFeatureRequest": { + "description": "Feature request model", "type": "object", "properties": { - "eventHubNamespace": { - "description": "Gets the managed event hub namespace resource identifier.", - "type": "string", - "readOnly": true - }, - "resourceGroup": { - "description": "Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account.", - "type": "string", - "readOnly": true - }, - "storageAccount": { - "description": "Gets the managed storage account resource identifier.", - "type": "string", - "readOnly": true + "features": { + "description": "Set of features", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] } } }, - "UserAssignedIdentity": { - "description": "Uses client ID and Principal ID", + "BatchFeatureStatus": { + "description": "List of features with enabled status", "type": "object", "properties": { - "clientId": { - "description": "Gets or Sets Client ID", - "type": "string", - "readOnly": true - }, - "principalId": { - "description": "Gets or Sets Principal ID", - "type": "string", + "features": { + "description": "Features with enabled status", + "type": "object", + "additionalProperties": { + "type": "boolean" + }, "readOnly": true } } }, - "ErrorModel": { - "description": "Default error model", + "CheckNameAvailabilityRequest": { + "description": "The request payload for CheckNameAvailability API", "type": "object", "properties": { - "code": { - "description": "Gets or sets the code.", - "type": "string", - "readOnly": true - }, - "details": { - "description": "Gets or sets the details.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ErrorModel" - }, - "x-ms-identifiers": [ - "code" - ], - "readOnly": true + "name": { + "description": "Resource name to verify for availability", + "type": "string" }, + "type": { + "description": "Fully qualified resource type which includes provider namespace", + "type": "string" + } + } + }, + "CheckNameAvailabilityResult": { + "description": "The response payload for CheckNameAvailability API", + "type": "object", + "properties": { "message": { - "description": "Gets or sets the messages.", - "type": "string", - "readOnly": true + "description": "Error message", + "type": "string" }, - "target": { - "description": "Gets or sets the target.", + "nameAvailable": { + "description": "Indicates if name is valid and available.", + "type": "boolean" + }, + "reason": { + "description": "The reason the name is not available.", + "enum": [ + "Invalid", + "AlreadyExists" + ], "type": "string", - "readOnly": true + "x-ms-enum": { + "name": "reason", + "modelAsString": true + } } } }, - "PrivateEndpointConnectionProperties": { - "description": "A private endpoint connection properties class.", + "CloudConnectors": { + "description": "External Cloud Service connectors", "type": "object", "properties": { - "privateEndpoint": { - "$ref": "#/definitions/PrivateEndpoint", - "description": "The private endpoint information." - }, - "privateLinkServiceConnectionState": { - "$ref": "#/definitions/PrivateLinkServiceConnectionState", - "description": "The private link service connection state." - }, - "provisioningState": { - "description": "The provisioning state.", + "awsExternalId": { + "description": "AWS external identifier.\r\nConfigured in AWS to allow use of the role arn used for scanning", "type": "string", "readOnly": true } } }, - "PrivateEndpoint": { - "description": "A private endpoint class.", + "CollectionAdminUpdate": { + "description": "Collection administrator update.", "type": "object", "properties": { - "id": { - "description": "The private endpoint identifier.", + "objectId": { + "description": "Gets or sets the object identifier of the admin.", "type": "string" } } }, - "PrivateLinkServiceConnectionState": { - "description": "The private link service connection state.", + "Consent": { + "description": "Consent extension resource", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], "properties": { - "actionsRequired": { - "description": "The required actions.", - "type": "string" - }, - "description": { - "description": "The description.", - "type": "string" - }, - "status": { - "description": "The status.", + "kind": { + "description": "Gets or sets the consent kind.", "enum": [ - "Unknown", - "Pending", - "Approved", - "Rejected", - "Disconnected" + "Metadata", + "Governance" ], "type": "string", "x-ms-enum": { - "name": "status", + "name": "ConsentKind", "modelAsString": true } + }, + "properties": { + "$ref": "#/definitions/ConsentProperties", + "x-ms-client-flatten": true } } }, - "ErrorResponseModel": { - "description": "Default error response model", + "ConsentProperties": { + "description": "The consent properties", "type": "object", "properties": { - "error": { - "description": "Gets or sets the error.", - "allOf": [ - { - "$ref": "#/definitions/ErrorModel" - } - ], + "scope": { + "type": "string", "readOnly": true - } - } - }, - "AccountUpdateParameters": { - "description": "The account update properties.", - "type": "object", - "properties": { - "identity": { - "$ref": "#/definitions/Identity", - "description": "Identity related info to add/remove userAssignedIdentities." }, - "properties": { - "$ref": "#/definitions/AccountProperties", - "description": "The account properties." + "scopeType": { + "description": "Defines consent scope type.", + "enum": [ + "Azure", + "Fabric", + "Databricks", + "Snowflake", + "S3" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ConsentScopeType", + "modelAsString": true + } }, - "tags": { - "description": "Tags on the azure resource.", - "type": "object", - "additionalProperties": { - "type": "string" + "status": { + "description": "Defines consent status.", + "enum": [ + "NotSpecified", + "Enabled", + "Disabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ConsentStatus", + "modelAsString": true } } } }, - "AccessKeys": { - "description": "The Account access keys.", + "Credentials": { + "description": "Credentials to access the event streaming service attached to the purview account.", "type": "object", "properties": { - "atlasKafkaPrimaryEndpoint": { - "description": "Gets or sets the primary connection string.", + "identityId": { + "description": "Identity identifier for UserAssign type.", "type": "string" }, - "atlasKafkaSecondaryEndpoint": { - "description": "Gets or sets the secondary connection string.", - "type": "string" - } - } - }, - "CollectionAdminUpdate": { - "description": "Collection administrator update.", - "type": "object", - "properties": { - "objectId": { - "description": "Gets or sets the object identifier of the admin.", - "type": "string" + "type": { + "description": "Identity Type.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "CredentialsType", + "modelAsString": true + } } } }, @@ -1970,29 +2066,130 @@ } } }, - "BatchFeatureRequest": { - "description": "Feature request model", + "DimensionProperties": { + "description": "properties for dimension", "type": "object", "properties": { - "features": { - "description": "Set of features", - "uniqueItems": true, + "displayName": { + "description": "localized display name of the dimension to customer", + "type": "string" + }, + "name": { + "description": "dimension name", + "type": "string" + }, + "toBeExportedForCustomer": { + "description": "flag indicating whether this dimension should be included to the customer in Azure Monitor logs (aka Shoebox)", + "type": "boolean" + } + } + }, + "ErrorModel": { + "description": "Default error model", + "type": "object", + "properties": { + "code": { + "description": "Gets or sets the code.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Gets or sets the details.", "type": "array", "items": { - "type": "string" - } + "$ref": "#/definitions/ErrorModel" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "message": { + "description": "Gets or sets the messages.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Gets or sets the target.", + "type": "string", + "readOnly": true } } }, - "BatchFeatureStatus": { - "description": "List of features with enabled status", + "ErrorResponseModel": { + "description": "Default error response model", "type": "object", "properties": { - "features": { - "description": "Features with enabled status", + "error": { + "description": "Gets or sets the error.", + "allOf": [ + { + "$ref": "#/definitions/ErrorModel" + } + ], + "readOnly": true + } + } + }, + "Identity": { + "description": "The Managed Identity of the resource", + "type": "object", + "properties": { + "principalId": { + "description": "Service principal object Id", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Tenant Id", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Identity Type", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "type", + "modelAsString": true + } + }, + "userAssignedIdentities": { + "description": "User Assigned Identities", "type": "object", "additionalProperties": { - "type": "boolean" + "$ref": "#/definitions/UserAssignedIdentity" + } + } + } + }, + "IngestionStorage": { + "description": "Ingestion Storage Account Info", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets the Id.", + "type": "string", + "readOnly": true + }, + "primaryEndpoint": { + "description": "Gets or sets the primary endpoint.", + "type": "string", + "readOnly": true + }, + "publicNetworkAccess": { + "description": "Gets or sets the public network access setting", + "enum": [ + "NotSpecified", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true } } } @@ -2006,10 +2203,30 @@ } ], "properties": { - "properties": { - "$ref": "#/definitions/KafkaConfigurationProperties", - "description": "Gets or sets the kafka configuration properties.", - "x-ms-client-flatten": true + "properties": { + "$ref": "#/definitions/KafkaConfigurationProperties", + "x-ms-client-flatten": true + } + } + }, + "KafkaConfigurationList": { + "description": "Paged list of kafka configuration resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "type": "array", + "items": { + "$ref": "#/definitions/KafkaConfiguration" + }, + "x-ms-identifiers": [] } } }, @@ -2022,8 +2239,11 @@ "type": "string" }, "credentials": { - "$ref": "#/definitions/Credentials", - "description": "Credentials to access event hub." + "$ref": "#/definitions/Credentials" + }, + "eventHubPartitionId": { + "description": "Optional partition Id for notification event hub. If not set, all partitions will be leveraged.", + "type": "string" }, "eventHubResourceId": { "type": "string", @@ -2074,78 +2294,27 @@ "name": "eventStreamingType", "modelAsString": true } - }, - "eventHubPartitionId": { - "description": "Optional partition Id for notification event hub. If not set, all partitions will be leveraged.", - "type": "string" } } }, - "Credentials": { - "description": "Credentials to access the event streaming service attached to the purview account.", + "ManagedResources": { + "description": "The managed resources in customer subscription.", "type": "object", "properties": { - "identityId": { - "description": "Identity identifier for UserAssign type.", - "type": "string" - }, - "type": { - "description": "Identity Type.", - "enum": [ - "None", - "SystemAssigned", - "UserAssigned" - ], + "eventHubNamespace": { + "description": "Gets the managed event hub namespace resource identifier.", "type": "string", - "x-ms-enum": { - "name": "CredentialsType", - "modelAsString": true - } - } - } - }, - "KafkaConfigurationList": { - "description": "Paged list of kafka configuration resources", - "required": [ - "value" - ], - "type": "object", - "properties": { - "nextLink": { - "description": "The Url of next result page.", - "type": "string" + "readOnly": true }, - "value": { - "description": "Collection of items of type results.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/KafkaConfiguration" - } - } - } - }, - "OperationList": { - "description": "Paged list of operation resources", - "required": [ - "value" - ], - "type": "object", - "properties": { - "nextLink": { - "description": "The Url of next result page.", - "type": "string" + "resourceGroup": { + "description": "Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account.", + "type": "string", + "readOnly": true }, - "value": { - "description": "Collection of items of type results.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "x-ms-identifiers": [ - "name" - ] + "storageAccount": { + "description": "Gets the managed storage account resource identifier.", + "type": "string", + "readOnly": true } } }, @@ -2154,8 +2323,7 @@ "type": "object", "properties": { "display": { - "$ref": "#/definitions/OperationDisplay", - "description": "Properties on the operation" + "$ref": "#/definitions/OperationDisplay" }, "isDataAction": { "description": "Whether operation is a data action", @@ -2171,7 +2339,6 @@ }, "properties": { "$ref": "#/definitions/OperationProperties", - "description": "properties for the operation meta info", "x-ms-client-flatten": true } } @@ -2198,41 +2365,47 @@ } } }, - "OperationProperties": { - "description": "properties on meta info", + "OperationList": { + "description": "Paged list of operation resources", + "required": [ + "value" + ], "type": "object", "properties": { - "serviceSpecification": { - "$ref": "#/definitions/OperationMetaServiceSpecification", - "description": "meta service specification" + "count": { + "format": "int64", + "description": "Total item count.", + "type": "integer" + }, + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [] } } }, - "OperationMetaServiceSpecification": { - "description": "The operation meta service specification", + "OperationMetaLogSpecification": { + "description": "log specifications for operation api", "type": "object", "properties": { - "logSpecifications": { - "description": "log specifications for the operation", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/OperationMetaLogSpecification" - }, - "x-ms-identifiers": [ - "name" - ] + "blobDuration": { + "description": "blob duration of the log", + "type": "string" }, - "metricSpecifications": { - "description": "metric specifications for the operation", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/OperationMetaMetricSpecification" - }, - "x-ms-identifiers": [ - "name" - ] + "displayName": { + "description": "localized name of the log category", + "type": "string" + }, + "name": { + "description": "name of the log category", + "type": "string" } } }, @@ -2246,14 +2419,11 @@ }, "dimensions": { "description": "properties for dimension", - "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/DimensionProperties" }, - "x-ms-identifiers": [ - "name" - ] + "x-ms-identifiers": [] }, "displayDescription": { "description": "description of the metric", @@ -2285,19 +2455,19 @@ }, "supportedAggregationTypes": { "description": "supported aggregation types", - "uniqueItems": false, "type": "array", "items": { "type": "string" - } + }, + "x-ms-identifiers": [] }, "supportedTimeGrainTypes": { "description": "supported time grain types", - "uniqueItems": false, "type": "array", "items": { "type": "string" - } + }, + "x-ms-identifiers": [] }, "unit": { "description": "units for the metric", @@ -2305,39 +2475,60 @@ } } }, - "OperationMetaLogSpecification": { - "description": "log specifications for operation api", + "OperationMetaServiceSpecification": { + "description": "The operation meta service specification", "type": "object", "properties": { - "blobDuration": { - "description": "blob duration of the log", - "type": "string" - }, - "displayName": { - "description": "localized name of the log category", - "type": "string" + "logSpecifications": { + "description": "log specifications for the operation", + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetaLogSpecification" + }, + "x-ms-identifiers": [] }, - "name": { - "description": "name of the log category", - "type": "string" + "metricSpecifications": { + "description": "metric specifications for the operation", + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetaMetricSpecification" + }, + "x-ms-identifiers": [] } } }, - "DimensionProperties": { - "description": "properties for dimension", + "OperationProperties": { + "description": "properties on meta info", "type": "object", "properties": { - "displayName": { - "description": "localized display name of the dimension to customer", - "type": "string" - }, - "name": { - "description": "dimension name", + "serviceSpecification": { + "$ref": "#/definitions/OperationMetaServiceSpecification" + } + } + }, + "PrivateEndpoint": { + "description": "A private endpoint class.", + "type": "object", + "properties": { + "id": { + "description": "The private endpoint identifier.", "type": "string" - }, - "toBeExportedForCustomer": { - "description": "flag indicating whether this dimension should be included to the customer in Azure Monitor logs (aka Shoebox)", - "type": "boolean" + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The connection identifier.", + "x-ms-client-flatten": true } } }, @@ -2354,35 +2545,57 @@ }, "value": { "description": "Collection of items of type results.", - "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" - }, - "x-ms-identifiers": [ - "name" - ] + } + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "A private endpoint connection properties class.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The private endpoint information." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "The private link service connection state." + }, + "provisioningState": { + "description": "The provisioning state.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnectionStatusUpdateRequest": { + "description": "A private endpoint connection status update request class.", + "type": "object", + "properties": { + "privateEndpointId": { + "description": "The private endpoint resource identifier.", + "type": "string" + }, + "status": { + "description": "The private endpoint connection status.", + "type": "string" } } }, - "PrivateLinkResourceList": { - "description": "Paged list of private link resources", - "required": [ - "value" - ], + "PrivateEndpointConnectionStatusUpdateResponse": { + "description": "A private endpoint connection status update response class.", "type": "object", "properties": { - "nextLink": { - "description": "The Url of next result page.", + "privateEndpointId": { + "description": "The private endpoint resource identifier.", "type": "string" }, - "value": { - "description": "Collection of items of type results.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/PrivateLinkResource" - } + "status": { + "description": "The private endpoint connection status.", + "type": "string" } } }, @@ -2412,6 +2625,26 @@ } } }, + "PrivateLinkResourceList": { + "description": "Paged list of private link resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, "PrivateLinkResourceProperties": { "description": "A privately linkable resource properties.", "type": "object", @@ -2441,100 +2674,65 @@ } } }, - "CheckNameAvailabilityRequest": { - "description": "The request payload for CheckNameAvailability API", + "PrivateLinkServiceConnectionState": { + "description": "The private link service connection state.", "type": "object", "properties": { - "name": { - "description": "Resource name to verify for availability", + "actionsRequired": { + "description": "The required actions.", "type": "string" }, - "type": { - "description": "Fully qualified resource type which includes provider namespace", - "type": "string" - } - } - }, - "CheckNameAvailabilityResult": { - "description": "The response payload for CheckNameAvailability API", - "type": "object", - "properties": { - "message": { - "description": "Error message", + "description": { + "description": "The description.", "type": "string" }, - "nameAvailable": { - "description": "Indicates if name is valid and available.", - "type": "boolean" - }, - "reason": { - "description": "The reason the name is not available.", + "status": { + "description": "The status.", "enum": [ - "Invalid", - "AlreadyExists" + "Unknown", + "Pending", + "Approved", + "Rejected", + "Disconnected" ], "type": "string", "x-ms-enum": { - "name": "reason", + "name": "status", "modelAsString": true } } } }, - "UsageList": { - "description": "Response for usage get request", - "type": "object", - "properties": { - "value": { - "description": "Collection of usage values.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Usage" - } - }, - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - } - } - }, - "Usage": { - "description": "Response for usage information", + "ProxyResource": { + "description": "Proxy Azure Resource", "type": "object", "properties": { - "currentValue": { - "format": "int32", - "description": "Current usage quota value", - "type": "integer", - "readOnly": true - }, "id": { - "description": "Fully qualified ARM resource Id", + "description": "Gets or sets the identifier.", "type": "string", "readOnly": true }, - "limit": { - "format": "int32", - "description": "Usage quota limit", - "type": "integer", + "name": { + "description": "Gets or sets the name.", + "type": "string", "readOnly": true }, - "name": { - "description": "Quota name", + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", "allOf": [ { - "$ref": "#/definitions/QuotaName" + "$ref": "#/definitions/SystemData" } ], "readOnly": true }, - "unit": { - "description": "Quota usage unit.", + "type": { + "description": "Gets or sets the type.", "type": "string", "readOnly": true } - } + }, + "x-ms-azure-resource": true }, "QuotaName": { "description": "Quota name", @@ -2550,6 +2748,64 @@ } } }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "properties": { + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC).", + "type": "string", + "readOnly": true + }, + "createdBy": { + "description": "The identity that created the resource.", + "type": "string", + "readOnly": true + }, + "createdByType": { + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of the last modification the resource (UTC).", + "type": "string", + "readOnly": true + }, + "lastModifiedBy": { + "description": "The identity that last modified the resource.", + "type": "string", + "readOnly": true + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "lastModifiedByType", + "modelAsString": true + } + } + } + }, "TrackedResource": { "description": "Azure ARM Tracked Resource", "type": "object", @@ -2560,8 +2816,7 @@ "readOnly": true }, "identity": { - "$ref": "#/definitions/Identity", - "description": "Identity Info on the tracked resource" + "$ref": "#/definitions/Identity" }, "location": { "description": "Gets or sets the location.", @@ -2596,56 +2851,97 @@ }, "x-ms-azure-resource": true }, - "ProxyResource": { - "description": "Proxy Azure Resource", + "Usage": { + "description": "Response for usage information", "type": "object", "properties": { + "currentValue": { + "format": "int32", + "description": "Current usage quota value", + "type": "integer", + "readOnly": true + }, "id": { - "description": "Gets or sets the identifier.", + "description": "Fully qualified resource Id", "type": "string", "readOnly": true }, - "name": { - "description": "Gets or sets the name.", - "type": "string", + "limit": { + "format": "int32", + "description": "Usage quota limit", + "type": "integer", "readOnly": true }, - "systemData": { - "description": "Metadata pertaining to creation and last modification of the resource.", + "name": { + "description": "Quota name", "allOf": [ { - "$ref": "#/definitions/SystemData" + "$ref": "#/definitions/QuotaName" } ], "readOnly": true }, - "type": { - "description": "Gets or sets the type.", + "unit": { + "description": "Quota usage unit.", "type": "string", "readOnly": true } - }, - "x-ms-azure-resource": true + } + }, + "UsageList": { + "description": "List of usage information", + "type": "object", + "properties": { + "value": { + "description": "Collection of usage values.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "readOnly": true + }, + "nextLink": { + "description": "The Url of next link.", + "type": "string" + } + } + }, + "UserAssignedIdentity": { + "description": "Uses client ID and Principal ID", + "type": "object", + "properties": { + "clientId": { + "description": "Gets or Sets Client ID", + "type": "string", + "readOnly": true + }, + "principalId": { + "description": "Gets or Sets Principal ID", + "type": "string", + "readOnly": true + } + } } }, "parameters": { "subscriptionId": { - "name": "subscriptionId", "in": "path", + "name": "subscriptionId", "description": "The subscription identifier", "required": true, "type": "string" }, "api-version": { - "name": "api-version", "in": "query", + "name": "api-version", "description": "The api version to use.", "required": true, "type": "string" }, "accountName": { - "name": "accountName", "in": "path", + "name": "accountName", "description": "The name of the account.", "required": true, "type": "string", @@ -2655,8 +2951,8 @@ "x-ms-parameter-location": "method" }, "resourceGroupName": { - "name": "resourceGroupName", "in": "path", + "name": "resourceGroupName", "description": "The resource group name.", "required": true, "type": "string", @@ -2665,12 +2961,12 @@ }, "securityDefinitions": { "azure_auth": { + "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" }, - "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow." } }, @@ -2680,6 +2976,5 @@ "user_impersonation" ] } - ], - "tags": [] + ] } diff --git a/swagger-specs/purview/resource-manager/api-set.json b/swagger-specs/purview/resource-manager/api-set.json index be7a29c89..c905b44cd 100644 --- a/swagger-specs/purview/resource-manager/api-set.json +++ b/swagger-specs/purview/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Purview/stable/2021-12-01/purview.json"], "name": "package-2021-12-01"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.Purview/preview/2023-05-01-preview/purview.json"], "name": "package-2023-05-01-preview"} \ No newline at end of file diff --git a/swagger-specs/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/policy.json b/swagger-specs/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/policy.json index 26d62df58..cf20ff74e 100644 --- a/swagger-specs/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/policy.json +++ b/swagger-specs/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/policy.json @@ -1,128 +1,164 @@ { "swagger": "2.0", "info": { - "version": "2023-06-01-preview", "title": "PurviewPolicyClient", - "description": "Creates a Microsoft.Purview management client." + "version": "2023-06-01-preview", + "description": "Creates a Microsoft.Purview management client.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] }, - "host": "management.azure.com", "schemes": [ "https" ], - "consumes": [ + "host": "management.azure.com", + "produces": [ "application/json" ], - "produces": [ + "consumes": [ "application/json" ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "PurviewPolicies" + }, + { + "name": "PolicyListing" + } + ], "paths": { "/{scope}/providers/Microsoft.Purview/policies": { "get": { + "operationId": "PurviewPolicies_List", "tags": [ + "PurviewPolicies", "PolicyListing" ], "summary": "API to list the purview RBAC policies based on a scope", "description": "The API lists the Azure purview RBAC policies affecting the scope. The scope can be any valid ARM resource id", - "operationId": "PurviewPolicies_List", "parameters": [ { - "$ref": "#/parameters/scopeParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/skipToken" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/SkipTokenParameter" }, { "name": "$filter", "in": "query", "description": "Supported filters : $filter=policyType eq SelfService, $filter=policyType eq SqlDevops. Returns only the policies of the specified type. If not specified, all policies are returned.", + "required": false, "type": "string", + "x-ms-client-name": "filter", "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/PolicyList" + "$ref": "#/definitions/PolicyListResult" } }, "default": { - "description": "An error response received from the provider.", + "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "ListPolicies": { - "$ref": "./examples/PolicyList.json" + "API to list the purview RBAC policies based on a scope - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/PurviewPolicies_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Purview/operations": { "get": { + "operationId": "Operations_List", "tags": [ - "Operation" + "Operations" ], - "summary": "Lists the available operations", - "description": "List of available operations", - "operationId": "Operations_List", + "description": "List the operations for the provider", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" + "Operations_List - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List - generated by [MinimumSet] rule": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } } }, "definitions": { - "PolicyList": { - "required": [ - "value" - ], - "description": "A paginated list of purview RBAC policies", + "AadMember": { "type": "object", + "description": "Azure active directory member", "properties": { - "value": { - "type": "array", - "description": "A list of purview RBAC policies", - "items": { - "$ref": "#/definitions/Policy" - } + "tenantId": { + "type": "string", + "description": "The tenantId of the member" }, - "nextLink": { + "objectId": { "type": "string", - "description": "Pagination link" + "description": "The objectId of the member" + }, + "objectType": { + "$ref": "#/definitions/ObjectType", + "description": "The objectType of the member." } } }, @@ -143,51 +179,80 @@ } } }, - "PolicyDecisionRule": { - "type": "object", - "description": "Purview RBAC policy decision rule", - "required": [ - "effect" + "Decision": { + "type": "string", + "description": "The effect for rule", + "enum": [ + "Permit", + "Deny" ], + "x-ms-enum": { + "name": "Decision", + "modelAsString": true, + "values": [ + { + "name": "Permit", + "value": "Permit", + "description": "Access permitted" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Access denied" + } + ] + } + }, + "FabricItemMember": { + "type": "object", + "description": "Microsoft fabric item member", "properties": { - "effect": { - "description": "The effect for rule", - "enum": [ - "Permit", - "Deny" - ], + "sourcePath": { "type": "string", - "x-ms-enum": { - "name": "Decision", - "modelAsString": true - } + "description": "Source path of the member" }, - "permission": { + "itemAccess": { "type": "array", - "description": "Array of attribute predicates", + "description": "Array of access items for the member", "items": { - "$ref": "#/definitions/AttributePredicate" - }, - "x-ms-identifiers": [] + "type": "string" + } } } }, - "Policy": { - "required": [ - "id", - "source", - "decisionRules", - "members", - "etag", - "scopes" + "ObjectType": { + "type": "string", + "description": "The objectType of the member.", + "enum": [ + "User", + "Group", + "ServicePrincipal" ], + "x-ms-enum": { + "name": "ObjectType", + "modelAsString": true, + "values": [ + { + "name": "User", + "value": "User", + "description": "AAD User object type." + }, + { + "name": "Group", + "value": "Group", + "description": "AAD Group object type." + }, + { + "name": "ServicePrincipal", + "value": "ServicePrincipal", + "description": "Service Principal object type." + } + ] + } + }, + "Policy": { "type": "object", "description": "Purview RBAC policy", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ], "properties": { "kind": { "type": "string", @@ -206,13 +271,11 @@ "description": "Array of scopes where the policy is published", "items": { "type": "string" - }, - "x-ms-identifiers": [] + } }, "members": { - "type": "object", - "description": "Members of the policy", - "$ref": "#/definitions/PolicyMembers" + "$ref": "#/definitions/PolicyMembers", + "description": "Members of the policy" }, "decisionRules": { "type": "array", @@ -223,103 +286,95 @@ "x-ms-identifiers": [] }, "expiryTime": { + "type": "string", "format": "date-time", - "description": "The timestamp of the expiry time of the policy (UTC).", - "type": "string" + "description": "The timestamp of the expiry time of the policy (UTC)." }, "requestor": { "type": "string", "description": "The AAD member who requested the policy" } - } + }, + "required": [ + "source", + "etag", + "scopes", + "members", + "decisionRules" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] }, - "PolicyMembers": { + "PolicyDecisionRule": { "type": "object", - "description": "Policy member", + "description": "Purview RBAC policy decision rule", "properties": { - "fabricItemMembers": { - "type": "array", - "description": "Array of azure active directory members", - "items": { - "$ref": "#/definitions/FabricItemMember" - }, - "x-ms-identifiers": [] + "effect": { + "$ref": "#/definitions/Decision", + "description": "The effect for rule" }, - "aadMembers": { + "permission": { "type": "array", - "description": "Array of azure active directory members", + "description": "Array of attribute predicates", "items": { - "$ref": "#/definitions/AADMember" + "$ref": "#/definitions/AttributePredicate" }, "x-ms-identifiers": [] } - } + }, + "required": [ + "effect" + ] }, - "AADMember": { + "PolicyListResult": { "type": "object", - "description": "Azure active directory member", + "description": "The response of a Policy list operation.", "properties": { - "tenantId": { - "type": "string", - "description": "The tenantId of the member" - }, - "objectId": { - "type": "string", - "description": "The objectId of the member" + "value": { + "type": "array", + "description": "The Policy items on this page", + "items": { + "$ref": "#/definitions/Policy" + } }, - "objectType": { + "nextLink": { "type": "string", - "description": "The objectType of the member.", - "enum": [ - "User", - "Group", - "ServicePrincipal" - ], - "x-ms-enum": { - "name": "objectType", - "modelAsString": true - } + "format": "uri", + "description": "The link to the next page of items" } - } + }, + "required": [ + "value" + ] }, - "FabricItemMember": { + "PolicyMembers": { "type": "object", - "description": "Microsoft fabric item member", + "description": "Policy member", "properties": { - "sourcePath": { - "type": "string", - "description": "Source path of the member" + "fabricItemMembers": { + "type": "array", + "description": "Array of azure active directory members", + "items": { + "$ref": "#/definitions/FabricItemMember" + }, + "x-ms-identifiers": [] }, - "itemAccess": { + "aadMembers": { "type": "array", - "description": "Array of access items for the member", + "description": "Array of azure active directory members", "items": { - "type": "string", - "description": "access item" - } + "$ref": "#/definitions/AadMember" + }, + "x-ms-identifiers": [] } } } }, "parameters": { - "scopeParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the operation or resource. Valid scopes are: subscription (format: '/subscriptions/{subscriptionId}'), or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "method" - }, - "api-version": { - "name": "api-version", - "in": "query", - "description": "The api version to use.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "skipToken": { + "SkipTokenParameter": { "name": "skipToken", "in": "query", "description": "Paging key to paginate to next page.", @@ -327,24 +382,5 @@ "type": "string", "x-ms-parameter-location": "method" } - }, - "securityDefinitions": { - "azure_auth": { - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "tags": [] + } } diff --git a/swagger-specs/quantum/data-plane/Microsoft.Quantum/preview/2019-11-04-preview/quantum.json b/swagger-specs/quantum/data-plane/Microsoft.Quantum/preview/2019-11-04-preview/quantum.json deleted file mode 100644 index 2c0143b4a..000000000 --- a/swagger-specs/quantum/data-plane/Microsoft.Quantum/preview/2019-11-04-preview/quantum.json +++ /dev/null @@ -1,662 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Quantum Client", - "description": "Azure Quantum REST API client", - "version": "2019-11-04-preview" - }, - "host": "quantum.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs": { - "get": { - "operationId": "Jobs_List", - "description": "List jobs.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/JobDetailsList" - } - } - }, - "x-ms-examples": { - "Get list of jobs in a Quantum Workspace": { - "$ref": "./examples/jobList.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}": { - "get": { - "operationId": "Jobs_Get", - "description": "Get job by id", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "$ref": "#/parameters/jobIdParameter" - } - ], - "x-ms-examples": { - "Get a job's metadata": { - "$ref": "./examples/jobGet.json" - } - }, - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JobDetails" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/restError" - } - } - } - }, - "put": { - "operationId": "Jobs_Create", - "description": "Create a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "$ref": "#/parameters/jobIdParameter" - }, - { - "name": "job", - "description": "The complete metadata of the job to submit.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobDetails" - } - } - ], - "x-ms-examples": { - "Submit a new job for execution to a Quantum Workspace": { - "$ref": "./examples/jobPut.json" - } - }, - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JobDetails" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/JobDetails" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/restError" - } - } - } - }, - "delete": { - "operationId": "Jobs_Cancel", - "description": "Cancel a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "$ref": "#/parameters/jobIdParameter" - } - ], - "x-ms-examples": { - "Cancel the execution of an existing job": { - "$ref": "./examples/jobDelete.json" - } - }, - "responses": { - "204": { - "description": "NoContent - The job was successfully cancelled." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/restError" - } - } - } - } - }, - "/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/providerStatus": { - "get": { - "operationId": "Providers_GetStatus", - "description": "Get provider status.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - } - ], - "x-ms-examples": { - "Get list of of providers and their status for a Quantum Workspace": { - "$ref": "./examples/providerStatus.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ProviderStatusList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/restError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/storage/sasUri": { - "post": { - "operationId": "Storage_SasUri", - "description": "Gets a URL with SAS token for a container/blob in the storage account associated with the workspace. The SAS URL can be used to upload job input and/or download job output.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - }, - { - "name": "blobDetails", - "description": "The details (name and container) of the blob to store or download data.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BlobDetails" - } - } - ], - "x-ms-examples": { - "Get a SAS token to upload data for a Quantum Workspace": { - "$ref": "./examples/storageGet.json" - } - }, - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SasUriResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/restError" - } - } - } - } - }, - "/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/quotas": { - "get": { - "operationId": "Quotas_List", - "description": "List quotas for the given workspace.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/workspaceNameParameter" - } - ], - "x-ms-examples": { - "Get a list of quotas for a particular quantum workspace.": { - "$ref": "./examples/quotaList.json" - } - }, - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/QuotaList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/restError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "JobDetailsList": { - "description": "List of job details.", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/JobDetails" - } - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total records count number." - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "JobDetails": { - "description": "Job details.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The job id." - }, - "name": { - "type": "string", - "description": "The job name. Is not required for the name to be unique and it's only used for display purposes." - }, - "containerUri": { - "type": "string", - "description": "The blob container SAS uri, the container is used to host job data." - }, - "inputDataUri": { - "type": "string", - "description": "The input blob SAS uri, if specified, it will override the default input blob in the container." - }, - "inputDataFormat": { - "type": "string", - "description": "The format of the input data." - }, - "inputParams": { - "type": "object", - "description": "The input parameters for the job. JSON object used by the target solver. It is expected that the size of this object is small and only used to specify parameters for the execution target, not the input data." - }, - "providerId": { - "type": "string", - "description": "The unique identifier for the provider." - }, - "target": { - "type": "string", - "description": "The target identifier to run the job." - }, - "metadata": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The job metadata. Metadata provides client the ability to store client-specific information" - }, - "outputDataUri": { - "type": "string", - "description": "The output blob SAS uri. When a job finishes successfully, results will be uploaded to this blob." - }, - "outputDataFormat": { - "type": "string", - "description": "The format of the output data." - }, - "status": { - "type": "string", - "description": "The job status.", - "readOnly": true, - "enum": [ - "Waiting", - "Executing", - "Succeeded", - "Failed", - "Cancelled" - ], - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - } - }, - "creationTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "The creation time of the job." - }, - "beginExecutionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "The time when the job began execution." - }, - "endExecutionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "The time when the job finished execution." - }, - "cancellationTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "The time when a job was successfully cancelled." - }, - "errorData": { - "$ref": "#/definitions/ErrorData", - "readOnly": true, - "description": "The error data for the job. This is expected only when Status 'Failed'." - } - }, - "required": [ - "containerUri", - "inputDataFormat", - "providerId", - "target" - ] - }, - "BlobDetails": { - "description": "Blob details.", - "type": "object", - "properties": { - "containerName": { - "type": "string", - "description": "The container name." - }, - "blobName": { - "type": "string", - "description": "The blob name." - } - }, - "required": [ - "containerName" - ] - }, - "SasUriResponse": { - "description": "Get SAS URL operation response.", - "type": "object", - "properties": { - "sasUri": { - "type": "string", - "description": "A URL with a SAS token to upload a blob for execution in the given workspace." - } - } - }, - "ProviderStatusList": { - "description": "Providers status.", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/ProviderStatus" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "ProviderStatus": { - "description": "Providers status.", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Provider id." - }, - "currentAvailability": { - "type": "string", - "readOnly": true, - "description": "Provider availability.", - "enum": [ - "Available", - "Degraded", - "Unavailable" - ], - "x-ms-enum": { - "name": "ProviderAvailability", - "modelAsString": true - } - }, - "targets": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TargetStatus" - } - } - } - }, - "TargetStatus": { - "description": "Target status.", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Target id." - }, - "currentAvailability": { - "type": "string", - "readOnly": true, - "description": "Target availability.", - "enum": [ - "Available", - "Degraded", - "Unavailable" - ], - "x-ms-enum": { - "name": "TargetAvailability", - "modelAsString": true - } - }, - "averageQueueTime": { - "type": "integer", - "format": "int64", - "readOnly": true, - "description": "Average queue time in seconds." - }, - "statusPage": { - "type": "string", - "readOnly": true, - "description": "A page with detailed status of the provider." - } - } - }, - "QuotaList": { - "description": "List of quotas.", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/Quota" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "Quota": { - "description": "Quota information.", - "type": "object", - "properties": { - "dimension": { - "type": "string", - "description": "The name of the dimension associated with the quota." - }, - "scope": { - "type": "string", - "description": "The scope at which the quota is applied.", - "enum": [ - "Workspace", - "Subscription" - ], - "x-ms-enum": { - "name": "DimensionScope", - "modelAsString": true - } - }, - "providerId": { - "type": "string", - "description": "The unique identifier for the provider." - }, - "utilization": { - "type": "number", - "description": "The amount of the usage that has been applied for the current period." - }, - "holds": { - "type": "number", - "description": "The amount of the usage that has been reserved but not applied for the current period." - }, - "limit": { - "type": "number", - "description": "The maximum amount of usage allowed for the current period." - }, - "period": { - "type": "string", - "description": "The time period in which the quota's underlying meter is accumulated. Based on calendar year. 'None' is used for concurrent quotas.", - "enum": [ - "None", - "Monthly" - ], - "x-ms-enum": { - "name": "MeterPeriod", - "modelAsString": true - } - } - } - }, - "restError": { - "type": "object", - "description": "Error information returned by the API", - "properties": { - "error": { - "$ref": "#/definitions/ErrorData" - } - } - }, - "ErrorData": { - "properties": { - "code": { - "type": "string", - "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." - }, - "message": { - "type": "string", - "description": "A message describing the error, intended to be suitable for displaying in a user interface." - } - }, - "description": "An error response from Azure." - } - }, - "parameters": { - "subscriptionIdParameter": { - "name": "subscriptionId", - "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)", - "in": "path", - "required": true, - "x-ms-parameter-location": "client", - "type": "string" - }, - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "client", - "description": "Name of an Azure resource group." - }, - "workspaceNameParameter": { - "name": "workspaceName", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "client", - "description": "Name of the workspace." - }, - "jobIdParameter": { - "name": "jobId", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Id of the job." - } - } -} diff --git a/swagger-specs/quantum/data-plane/Microsoft.Quantum/preview/2024-03-01-preview/quantum.json b/swagger-specs/quantum/data-plane/Microsoft.Quantum/preview/2024-03-01-preview/quantum.json new file mode 100644 index 000000000..6005d94d8 --- /dev/null +++ b/swagger-specs/quantum/data-plane/Microsoft.Quantum/preview/2024-03-01-preview/quantum.json @@ -0,0 +1,2248 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Quantum Workspace Services", + "version": "2024-03-01-preview", + "description": "Azure Quantum Workspace Services", + "contact": { + "email": "azqengg@microsoft.com" + }, + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "https://{region}.{serviceBaseUrl}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "region", + "in": "path", + "description": "The Azure region where the Azure Quantum Workspace is located.", + "required": true, + "type": "string" + }, + { + "name": "serviceBaseUrl", + "in": "path", + "description": "The Azure Quantum service base url.", + "required": true, + "type": "string", + "default": "quantum.azure.com" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "AzureEntraAuth": [ + "https://quantum.microsoft.com/.default" + ] + }, + { + "AzureApiKeyAuth": [] + } + ], + "securityDefinitions": { + "AzureApiKeyAuth": { + "type": "apiKey", + "description": "Azure Api-Key Authentication", + "name": "x-ms-quantum-api-key", + "in": "header" + }, + "AzureEntraAuth": { + "type": "oauth2", + "description": "Azure Entra OAuth2 Authentication", + "flow": "application", + "scopes": { + "https://quantum.microsoft.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/token" + } + }, + "tags": [], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs": { + "get": { + "operationId": "Jobs_List", + "description": "List all jobs.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedJobDetails" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List jobs in a workspace.": { + "$ref": "./examples/Jobs_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}": { + "get": { + "operationId": "Jobs_Get", + "description": "Get job by its id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "jobId", + "in": "path", + "description": "Id of the job.", + "required": true, + "type": "string", + "maxLength": 36, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/JobDetails" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a job by its id.": { + "$ref": "./examples/Jobs_Get.json" + } + } + }, + "put": { + "operationId": "Jobs_Create", + "description": "Create a new job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "jobId", + "in": "path", + "description": "Id of the job.", + "required": true, + "type": "string", + "maxLength": 36, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + }, + { + "name": "resource", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/JobDetails" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/JobDetails" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/JobDetails" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates a job.": { + "$ref": "./examples/Jobs_Create.json" + } + } + }, + "patch": { + "operationId": "Jobs_Update", + "description": "Update job properties.", + "consumes": [ + "application/json-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "jobId", + "in": "path", + "description": "Id of the job.", + "required": true, + "type": "string", + "maxLength": 36, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + }, + { + "name": "resource", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/JsonPatchDocument" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/JobDetails" + } + }, + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Patches a job.": { + "$ref": "./examples/Jobs_Update.json" + } + } + }, + "delete": { + "operationId": "Jobs_Cancel", + "description": "Request the cancellation of an existing job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "jobId", + "in": "path", + "description": "Id of the job.", + "required": true, + "type": "string", + "maxLength": 36, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Cancels a job.": { + "$ref": "./examples/Jobs_Cancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/providerStatus": { + "get": { + "operationId": "Providers_List", + "description": "List all providers in the workspace with their respective status.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedProviderStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get provider and target statuses.": { + "$ref": "./examples/Providers_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/quotas": { + "get": { + "operationId": "Quotas_List", + "description": "List quotas for the given workspace.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedQuota" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get workspace quotas.": { + "$ref": "./examples/Quotas_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions": { + "get": { + "operationId": "Sessions_List", + "description": "List all Sessions.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedSessionDetails" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List sessions in a workspace.": { + "$ref": "./examples/Sessions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}": { + "get": { + "operationId": "Sessions_Get", + "description": "Get Session by its id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "sessionId", + "in": "path", + "description": "Id of the session.", + "required": true, + "type": "string", + "maxLength": 36, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionDetails" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a session by its id.": { + "$ref": "./examples/Sessions_Get.json" + } + } + }, + "put": { + "operationId": "Sessions_Open", + "description": "Open a new session.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "sessionId", + "in": "path", + "description": "Id of the session.", + "required": true, + "type": "string", + "maxLength": 36, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + }, + { + "name": "resource", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/SessionDetails" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionDetails" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/SessionDetails" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Open a session.": { + "$ref": "./examples/Sessions_Open.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}:close": { + "post": { + "operationId": "Sessions_Close", + "description": "Close an existing session.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "sessionId", + "in": "path", + "description": "Id of the session.", + "required": true, + "type": "string", + "maxLength": 36, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionDetails" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Closes a session by its id.": { + "$ref": "./examples/Sessions_Close.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}/jobs": { + "get": { + "operationId": "SessionsJobs_List", + "description": "List jobs in a session.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "sessionId", + "in": "path", + "description": "Id of the session to list jobs from.", + "required": true, + "type": "string", + "maxLength": 36, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedJobDetails" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List jobs in a workspace.": { + "$ref": "./examples/SessionsJobs_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/storage/sasUri": { + "post": { + "operationId": "Storage_GetSasUri", + "description": "Gets a URL with SAS token for a container/blob in the storage account associated with the workspace. The SAS URL can be used to upload job input and/or download job output.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/CommonParams.subscriptionId" + }, + { + "$ref": "#/parameters/CommonParams.resourceGroupName" + }, + { + "$ref": "#/parameters/CommonParams.workspaceName" + }, + { + "name": "blobDetails", + "in": "body", + "description": "The details (name and container) of the blob.", + "required": true, + "schema": { + "$ref": "#/definitions/BlobDetails" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SasUriResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a URL with SAS token for a container/blob.": { + "$ref": "./examples/Storage_GetSasUri.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/topLevelItems": { + "get": { + "operationId": "TopLevelItems_List", + "description": "List top-level items.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedItemDetails" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List top level items in a workspace.": { + "$ref": "./examples/TopLevelItems_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "BlobDetails": { + "type": "object", + "description": "The details (name and container) of the blob to store or download data.", + "properties": { + "containerName": { + "type": "string", + "description": "The container name.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "blobName": { + "type": "string", + "description": "The blob name.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "containerName" + ] + }, + "CostEstimate": { + "type": "object", + "description": "The job cost billed by the provider. The final cost on your bill might be slightly different due to added taxes and currency conversion rates.", + "properties": { + "currencyCode": { + "type": "string", + "description": "The currency code." + }, + "events": { + "type": "array", + "description": "List of usage events.", + "items": { + "$ref": "#/definitions/UsageEvent" + }, + "x-ms-identifiers": [] + }, + "estimatedTotal": { + "type": "number", + "format": "float", + "description": "The estimated total." + } + }, + "required": [ + "currencyCode", + "estimatedTotal" + ] + }, + "DimensionScope": { + "type": "string", + "description": "The scope at which the quota is applied to.", + "enum": [ + "Workspace", + "Subscription" + ], + "x-ms-enum": { + "name": "DimensionScope", + "modelAsString": true, + "values": [ + { + "name": "Workspace", + "value": "Workspace", + "description": "The quota is applied to the Quantum Workspace." + }, + { + "name": "Subscription", + "value": "Subscription", + "description": "The quota is applied to the Azure Subscription." + } + ] + } + }, + "Errors.WorkspaceItemError": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "ItemDetails": { + "type": "object", + "description": "A workspace item.", + "properties": { + "id": { + "$ref": "#/definitions/WorkspaceItemId", + "description": "Id of the item.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the item. It is not required for the name to be unique and it's only used for display purposes.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "providerId": { + "type": "string", + "description": "The unique identifier for the provider.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "target": { + "type": "string", + "description": "The target identifier to run the job.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "itemType": { + "$ref": "#/definitions/ItemType", + "description": "Type of the Quantum Workspace item", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "The creation time of the item.", + "readOnly": true + }, + "beginExecutionTime": { + "type": "string", + "format": "date-time", + "description": "The time when the item began execution.", + "readOnly": true + }, + "endExecutionTime": { + "type": "string", + "format": "date-time", + "description": "The time when the item finished execution.", + "readOnly": true + }, + "costEstimate": { + "$ref": "#/definitions/CostEstimate", + "description": "Cost estimate.", + "readOnly": true + }, + "errorData": { + "$ref": "#/definitions/Errors.WorkspaceItemError", + "description": "Error information.", + "readOnly": true + } + }, + "discriminator": "itemType", + "required": [ + "id", + "name", + "providerId", + "target", + "itemType" + ] + }, + "ItemType": { + "type": "string", + "description": "The type of the workspace item.", + "enum": [ + "Job", + "Session" + ], + "x-ms-enum": { + "name": "ItemType", + "modelAsString": true, + "values": [ + { + "name": "Job", + "value": "Job", + "description": "A program, problem, or application submitted for processing." + }, + { + "name": "Session", + "value": "Session", + "description": "A logical grouping of jobs." + } + ] + } + }, + "JobDetails": { + "type": "object", + "description": "A job to be run in the workspace.", + "properties": { + "id": { + "$ref": "#/definitions/WorkspaceItemId", + "description": "Id of the job.", + "readOnly": true + }, + "jobType": { + "$ref": "#/definitions/JobType", + "description": "The type of job.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sessionId": { + "type": "string", + "description": "The ID of the session that the job is part of.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "containerUri": { + "type": "string", + "description": "The blob container SAS uri, the container is used to host job data.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "inputDataUri": { + "type": "string", + "description": "The input blob URI, if specified, it will override the default input blob in the container.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "inputDataFormat": { + "type": "string", + "description": "The format of the input data.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the job.", + "readOnly": true + }, + "metadata": { + "type": "object", + "description": "The job metadata. Metadata provides client the ability to store client-specific information", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "cancellationTime": { + "type": "string", + "format": "date-time", + "description": "The time when a job was successfully cancelled.", + "readOnly": true + }, + "tags": { + "type": "array", + "description": "List of user-supplied tags associated with the job.", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "quantumComputingData": { + "$ref": "#/definitions/QuantumComputingData", + "description": "Quantum computing data.", + "readOnly": true + }, + "inputParams": { + "type": "object", + "description": "The input parameters for the job. JSON object used by the target solver. It is expected that the size of this object is small and only used to specify parameters for the execution target, not the input data.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "outputDataUri": { + "type": "string", + "description": "The output blob uri. When a job finishes successfully, results will be uploaded to this blob.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "outputDataFormat": { + "type": "string", + "description": "The format of the output data.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "id", + "containerUri" + ], + "allOf": [ + { + "$ref": "#/definitions/ItemDetails" + } + ], + "x-ms-discriminator-value": "Job" + }, + "JobStatus": { + "type": "string", + "description": "The status of the job.", + "enum": [ + "Waiting", + "Executing", + "Succeeded", + "Failed", + "Cancelled" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true, + "values": [ + { + "name": "Waiting", + "value": "Waiting", + "description": "The job is waiting in the queue to be executed." + }, + { + "name": "Executing", + "value": "Executing", + "description": "The job is being executed." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The job completed with success." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The job completed with failure." + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "The job was cancelled." + } + ] + } + }, + "JobType": { + "type": "string", + "description": "The type of the job.", + "enum": [ + "Unknown", + "QuantumComputing", + "Optimization" + ], + "x-ms-enum": { + "name": "JobType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown job type." + }, + { + "name": "QuantumComputing", + "value": "QuantumComputing", + "description": "Quantum Computing job type." + }, + { + "name": "Optimization", + "value": "Optimization", + "description": "Optimization job type." + } + ] + } + }, + "JsonPatchDocument": { + "type": "array", + "description": "A JSONPatch document as defined by RFC 6902.", + "items": { + "$ref": "#/definitions/JsonPatchObject" + }, + "x-ms-identifiers": [] + }, + "JsonPatchObject": { + "type": "object", + "description": "A JSONPatch object as defined by RFC 6902.", + "properties": { + "op": { + "$ref": "#/definitions/JsonPatchOperation", + "description": "The operation to be performed.", + "x-ms-client-name": "operation", + "x-ms-mutability": [ + "create" + ] + }, + "path": { + "type": "string", + "description": "A JSON-Pointer.", + "x-ms-mutability": [ + "create" + ] + }, + "value": { + "type": "object", + "description": "A value to be used in the operation on the path.", + "x-ms-mutability": [ + "create" + ] + }, + "from": { + "type": "string", + "description": "Optional field used in copy and move operations.", + "x-ms-mutability": [ + "create" + ] + } + }, + "required": [ + "op", + "path" + ] + }, + "JsonPatchOperation": { + "type": "string", + "description": "The operation to be performed.", + "enum": [ + "add", + "remove", + "replace", + "move", + "copy", + "test" + ], + "x-ms-enum": { + "name": "JsonPatchOperation", + "modelAsString": true, + "values": [ + { + "name": "add", + "value": "add", + "description": "Add value operation." + }, + { + "name": "remove", + "value": "remove", + "description": "Remove value operation." + }, + { + "name": "replace", + "value": "replace", + "description": "Replace value operation." + }, + { + "name": "move", + "value": "move", + "description": "Move value operation." + }, + { + "name": "copy", + "value": "copy", + "description": "Copy value operation." + }, + { + "name": "test", + "value": "test", + "description": "Test value operation." + } + ] + } + }, + "MeterPeriod": { + "type": "string", + "description": "The time period in which the quota's underlying meter is accumulated. Based on calendar year. 'None' is used for concurrent quotas.", + "enum": [ + "None", + "Monthly" + ], + "x-ms-enum": { + "name": "MeterPeriod", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "The meter period is instantaneous. Used for concurrent quotas." + }, + { + "name": "Monthly", + "value": "Monthly", + "description": "The meter period is per month." + } + ] + } + }, + "PagedItemDetails": { + "type": "object", + "description": "Paged collection of ItemDetails items", + "properties": { + "value": { + "type": "array", + "description": "The ItemDetails items on this page", + "items": { + "$ref": "#/definitions/ItemDetails" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedJobDetails": { + "type": "object", + "description": "Paged collection of JobDetails items", + "properties": { + "value": { + "type": "array", + "description": "The JobDetails items on this page", + "items": { + "$ref": "#/definitions/JobDetails" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedProviderStatus": { + "type": "object", + "description": "Paged collection of ProviderStatus items", + "properties": { + "value": { + "type": "array", + "description": "The ProviderStatus items on this page", + "items": { + "$ref": "#/definitions/ProviderStatus" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedQuota": { + "type": "object", + "description": "Paged collection of Quota items", + "properties": { + "value": { + "type": "array", + "description": "The Quota items on this page", + "items": { + "$ref": "#/definitions/Quota" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedSessionDetails": { + "type": "object", + "description": "Paged collection of SessionDetails items", + "properties": { + "value": { + "type": "array", + "description": "The SessionDetails items on this page", + "items": { + "$ref": "#/definitions/SessionDetails" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProviderAvailability": { + "type": "string", + "description": "Provider availability.", + "enum": [ + "Available", + "Degraded", + "Unavailable" + ], + "x-ms-enum": { + "name": "ProviderAvailability", + "modelAsString": true, + "values": [ + { + "name": "Available", + "value": "Available", + "description": "Provider is available." + }, + { + "name": "Degraded", + "value": "Degraded", + "description": "Provider is available with degraded experience." + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Provider is unavailable." + } + ] + } + }, + "ProviderStatus": { + "type": "object", + "description": "Provider status.", + "properties": { + "id": { + "type": "string", + "description": "Provider id.", + "readOnly": true + }, + "currentAvailability": { + "$ref": "#/definitions/ProviderAvailability", + "description": "Current provider availability.", + "readOnly": true + }, + "targets": { + "type": "array", + "description": "Current target statuses.", + "items": { + "$ref": "#/definitions/TargetStatus" + }, + "readOnly": true + } + }, + "required": [ + "id", + "currentAvailability", + "targets" + ] + }, + "QuantumComputingData": { + "type": "object", + "description": "Quantum computing data.", + "properties": { + "count": { + "type": "integer", + "format": "int64", + "description": "The number of quantum computing items in the job.", + "readOnly": true + } + }, + "required": [ + "count" + ] + }, + "Quota": { + "type": "object", + "description": "Quota information.", + "properties": { + "dimension": { + "type": "string", + "description": "The name of the dimension associated with the quota.", + "readOnly": true + }, + "scope": { + "$ref": "#/definitions/DimensionScope", + "description": "The scope at which the quota is applied.", + "readOnly": true + }, + "providerId": { + "type": "string", + "description": "The unique identifier for the provider.", + "readOnly": true + }, + "utilization": { + "type": "number", + "format": "float", + "description": "The amount of the usage that has been applied for the current period.", + "readOnly": true + }, + "holds": { + "type": "number", + "format": "float", + "description": "The amount of the usage that has been reserved but not applied for the current period.", + "readOnly": true + }, + "limit": { + "type": "number", + "format": "float", + "description": "The maximum amount of usage allowed for the current period.", + "readOnly": true + }, + "period": { + "$ref": "#/definitions/MeterPeriod", + "description": "The time period in which the quota's underlying meter is accumulated. Based on calendar year. 'None' is used for concurrent quotas.", + "readOnly": true + } + }, + "required": [ + "dimension", + "scope", + "providerId", + "utilization", + "holds", + "limit", + "period" + ] + }, + "SasUriResponse": { + "type": "object", + "description": "SAS URI operation response.", + "properties": { + "sasUri": { + "type": "string", + "description": "A URL with a SAS token to upload a blob for execution in the given workspace.", + "readOnly": true + } + }, + "required": [ + "sasUri" + ] + }, + "SessionDetails": { + "type": "object", + "description": "Session, a logical grouping of jobs.", + "properties": { + "id": { + "$ref": "#/definitions/WorkspaceItemId", + "description": "Id of the session.", + "readOnly": true + }, + "jobFailurePolicy": { + "$ref": "#/definitions/SessionJobFailurePolicy", + "description": "Policy controlling the behavior of the Session when a job in the session fails.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "status": { + "$ref": "#/definitions/SessionStatus", + "description": "The status of the session.", + "readOnly": true + } + }, + "required": [ + "id", + "jobFailurePolicy" + ], + "allOf": [ + { + "$ref": "#/definitions/ItemDetails" + } + ], + "x-ms-discriminator-value": "Session" + }, + "SessionJobFailurePolicy": { + "type": "string", + "description": "Policy controlling the behavior of the Session when a job in the session fails.", + "enum": [ + "Abort", + "Continue" + ], + "x-ms-enum": { + "name": "SessionJobFailurePolicy", + "modelAsString": true, + "values": [ + { + "name": "Abort", + "value": "Abort", + "description": "New jobs submitted after a job fails will be rejected." + }, + { + "name": "Continue", + "value": "Continue", + "description": "New jobs submitted after a job fails will be accepted." + } + ] + } + }, + "SessionStatus": { + "type": "string", + "description": "The status of the session.", + "enum": [ + "Waiting", + "Executing", + "Succeeded", + "Failed", + "Failure(s)", + "TimedOut" + ], + "x-ms-enum": { + "name": "SessionStatus", + "modelAsString": true, + "values": [ + { + "name": "Waiting", + "value": "Waiting", + "description": "The session is waiting in the queue to be executed." + }, + { + "name": "Executing", + "value": "Executing", + "description": "The session is being executed." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The session completed with success." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The session completed with failure." + }, + { + "name": "Failure(s)", + "value": "Failure(s)", + "description": "The session completed with some failures." + }, + { + "name": "TimedOut", + "value": "TimedOut", + "description": "The session timed out." + } + ] + } + }, + "TargetAvailability": { + "type": "string", + "description": "Target availability.", + "enum": [ + "Available", + "Degraded", + "Unavailable" + ], + "x-ms-enum": { + "name": "TargetAvailability", + "modelAsString": true, + "values": [ + { + "name": "Available", + "value": "Available", + "description": "Target is available." + }, + { + "name": "Degraded", + "value": "Degraded", + "description": "Target is available with degraded experience." + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Target is unavailable." + } + ] + } + }, + "TargetStatus": { + "type": "object", + "description": "Target status.", + "properties": { + "id": { + "type": "string", + "description": "Target id.", + "readOnly": true + }, + "currentAvailability": { + "$ref": "#/definitions/TargetAvailability", + "description": "Current target availability.", + "readOnly": true + }, + "averageQueueTime": { + "type": "integer", + "format": "int64", + "description": "Average queue time in seconds.", + "readOnly": true + }, + "statusPage": { + "type": "string", + "description": "A page with detailed status of the provider.", + "readOnly": true + } + }, + "required": [ + "id", + "currentAvailability", + "averageQueueTime" + ] + }, + "UsageEvent": { + "type": "object", + "description": "Usage event details.", + "properties": { + "dimensionId": { + "type": "string", + "description": "The dimension id." + }, + "dimensionName": { + "type": "string", + "description": "The dimension name." + }, + "measureUnit": { + "type": "string", + "description": "The unit of measure." + }, + "amountBilled": { + "type": "number", + "format": "float", + "description": "The amount billed." + }, + "amountConsumed": { + "type": "number", + "format": "float", + "description": "The amount consumed." + }, + "unitPrice": { + "type": "number", + "format": "float", + "description": "The unit price." + } + }, + "required": [ + "dimensionId", + "dimensionName", + "measureUnit", + "amountBilled", + "amountConsumed", + "unitPrice" + ] + }, + "WorkspaceItemId": { + "type": "string", + "description": "Id of the workspace item.", + "maxLength": 36, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "CommonParams.resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the Azure resource group.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_\\.]*$", + "x-ms-parameter-location": "client" + }, + "CommonParams.subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$", + "x-ms-parameter-location": "client" + }, + "CommonParams.workspaceName": { + "name": "workspaceName", + "in": "path", + "description": "Name of the Azure Quantum workspace.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]*$", + "x-ms-parameter-location": "client" + } + } +} diff --git a/swagger-specs/quantum/data-plane/api-set.json b/swagger-specs/quantum/data-plane/api-set.json index 30d9063c1..401ccbe65 100644 --- a/swagger-specs/quantum/data-plane/api-set.json +++ b/swagger-specs/quantum/data-plane/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Quantum/preview/2019-11-04-preview/quantum.json"], "name": "package-2019-11-04-preview"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.Quantum/preview/2024-03-01-preview/quantum.json"], "name": "package-2024-03-01-preview"} \ No newline at end of file diff --git a/swagger-specs/quota/resource-manager/Microsoft.Quota/preview/2023-06-01-preview/groupquota.json b/swagger-specs/quota/resource-manager/Microsoft.Quota/preview/2023-06-01-preview/groupquota.json new file mode 100644 index 000000000..e3abd7884 --- /dev/null +++ b/swagger-specs/quota/resource-manager/Microsoft.Quota/preview/2023-06-01-preview/groupquota.json @@ -0,0 +1,2617 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Quota Extension API", + "version": "2023-06-01-preview", + "description": "Microsoft Azure Quota Resource Provider. This Swagger is for Azure Group Quota using GroupQuota Entity." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth 2.0 authorization" + } + }, + "paths": { + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}": { + "put": { + "tags": [ + "GroupQuotas" + ], + "summary": "Creates a new GroupQuota for the name passed.", + "description": "Creates a new GroupQuota for the name passed. A RequestId will be returned by the Service. The status can be polled periodically. The status Async polling is using standards defined at - https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#asynchronous-operations. Use the OperationsStatus URI provided in Azure-AsyncOperation header, the duration will be specified in retry-after header. Once the operation gets to terminal state - Succeeded | Failed, then the URI will change to Get URI and full details can be checked.", + "operationId": "GroupQuotas_CreateOrUpdate", + "x-ms-examples": { + "GroupQuotas_Put_Request_ForCompute": { + "$ref": "./examples/GroupQuotas/PutGroupQuotas.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "GroupQuotaPutRequestBody", + "in": "body", + "description": "The GroupQuota body details for creation or update of a GroupQuota entity.", + "schema": { + "$ref": "#/definitions/GroupQuotasEntity" + } + } + ], + "responses": { + "200": { + "description": "OK, Create or Update", + "schema": { + "$ref": "#/definitions/GroupQuotasEntity" + } + }, + "201": { + "description": "Request Accepted, Create or Update", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int64" + }, + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers. New guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#131-resource-based-long-running-operations-relo", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/LROResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "GroupQuotas" + ], + "summary": "Updates a new GroupQuotas for the name passed.", + "description": "Updates the GroupQuotas for the name passed. A GroupQuotas RequestId will be returned by the Service. The status can be polled periodically. The status Async polling is using standards defined at - https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#asynchronous-operations. Use the OperationsStatus URI provided in Azure-AsyncOperation header, the duration will be specified in retry-after header. Once the operation gets to terminal state - Succeeded | Failed, then the URI will change to Get URI and full details can be checked. \n Any change in the filters will be applicable to the future quota assignments, existing quota allocated to subscriptions from the GroupQuotas remains unchanged.", + "operationId": "GroupQuotas_Update", + "x-ms-examples": { + "GroupQuotas_Patch_Request_ForCompute": { + "$ref": "./examples/GroupQuotas/PatchGroupQuotas.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": " GroupQuotasPatchRequestBody", + "in": "body", + "description": "The GroupQuotas Patch Request.", + "schema": { + "$ref": "#/definitions/GroupQuotasEntityPatch" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GroupQuotasEntity" + } + }, + "202": { + "description": "Request Accepted", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int64" + }, + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } + }, + "default": { + "description": "Bad Request", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "GroupQuotas" + ], + "summary": "Gets GroupQuotas for the name passed.", + "description": "Gets the GroupQuotas for the name passed. It will return the GroupQuotas properties only. The details on group quota can be access from the group quota APIs.", + "operationId": "GroupQuotas_Get", + "x-ms-examples": { + "GroupQuotas_Get_Request_ForCompute": { + "$ref": "./examples/GroupQuotas/GetGroupQuotas.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GroupQuotasEntity" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "GroupQuotas" + ], + "summary": "Deletes GroupQuotas for the name passed.", + "description": "Deletes the GroupQuotas for the name passed. All the remaining shareQuota in the GroupQuotas will be lost.", + "operationId": "GroupQuotas_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "GroupQuotas_Delete_Request_ForCompute": { + "$ref": "./examples/GroupQuotas/DeleteGroupQuotas.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Request Accepted", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int64" + }, + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas": { + "get": { + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "GroupQuotas" + ], + "summary": "Lists GroupQuotas for the scope passed.", + "description": "Lists GroupQuotas for the scope passed. It will return the GroupQuotas QuotaEntity properties only.The details on group quota can be access from the group quota APIs.", + "operationId": "GroupQuotas_List", + "x-ms-examples": { + "GroupQuotas_List_Request_ForCompute": { + "$ref": "./examples/GroupQuotas/GetGroupQuotasList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GroupQuotaList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptions/{subscriptionId}": { + "put": { + "tags": [ + "GroupQuotasSubscriptions" + ], + "summary": "Adds subscription to the GroupQuotas.", + "description": "Adds a subscription to GroupQuotas. The subscriptions will be validated based on the additionalAttributes defined in the GroupQuota. The additionalAttributes works as filter for the subscriptions, which can be included in the GroupQuotas. The request's TenantId is validated against the subscription's TenantId.", + "operationId": "GroupQuotaSubscriptions_CreateOrUpdate", + "x-ms-examples": { + "GroupQuotaSubscriptions_Put_Subscriptions": { + "$ref": "./examples/GroupQuotasSubscriptions/PutGroupQuotasSubscription.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK, Create or Update", + "schema": { + "$ref": "#/definitions/GroupQuotaSubscriptionId" + } + }, + "201": { + "description": "Request Accepted, Create or Update", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int64" + }, + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers. New guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#131-resource-based-long-running-operations-relo", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/LROResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "GroupQuotasSubscriptions" + ], + "summary": "Updates the GroupQuotas with the subscription to add to the subscriptions list.", + "description": "Updates the GroupQuotas with the subscription to add to the subscriptions list. The subscriptions will be validated if additionalAttributes are defined in the GroupQuota. The request's TenantId is validated against the subscription's TenantId.", + "operationId": "GroupQuotaSubscriptions_Update", + "x-ms-examples": { + "GroupQuotaSubscriptions_Patch_Subscriptions": { + "$ref": "./examples/GroupQuotasSubscriptions/PatchGroupQuotasSubscription.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GroupQuotaSubscriptionId" + } + }, + "202": { + "description": "Request Accepted", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int64" + }, + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "GroupQuotasSubscriptions" + ], + "summary": "Removes the subscription from GroupQuotas.", + "description": "Removes the subscription from GroupQuotas. The request's TenantId is validated against the subscription's TenantId.", + "operationId": "GroupQuotaSubscriptions_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "GroupQuotaSubscriptions_Delete_Subscriptions": { + "$ref": "./examples/GroupQuotasSubscriptions/DeleteGroupQuotaSubscriptions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Request Accepted", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int64" + }, + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "GroupQuotasSubscriptions" + ], + "summary": "Returns the subscriptionId along with its provisioning state for being associated with the GroupQuotas.", + "description": "Returns the subscriptionIds along with its provisioning state for being associated with the GroupQuota. If the subscription is not a member of GroupQuota, it will return 404, else 200.", + "operationId": "GroupQuotaSubscriptions_Get", + "x-ms-examples": { + "GroupQuotaSubscriptions_Get_Subscriptions": { + "$ref": "./examples/GroupQuotasSubscriptions/GetGroupQuotaSubscriptions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GroupQuotaSubscriptionId" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptions": { + "get": { + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "GroupQuotasSubscriptions" + ], + "summary": "Returns a list of the subscriptionIds for the GroupQuotas.", + "description": "Returns a list of the subscriptionIds associated with the GroupQuotas.", + "operationId": "GroupQuotaSubscriptions_List", + "x-ms-examples": { + "GroupQuotaSubscriptions_List_Subscriptions": { + "$ref": "./examples/GroupQuotasSubscriptions/ListGroupQuotaSubscriptions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GroupQuotaSubscriptionIdList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptionRequests": { + "get": { + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "GroupQuotaSubscriptionRequests" + ], + "summary": "List the status of all requests to add subscriptionIds to the GroupQuotasEntity.", + "description": "List API to check the status of a subscriptionId requests by requestId. Request history is maintained for 1 year.", + "operationId": "GroupQuotaSubscriptionRequests_List", + "x-ms-examples": { + "GroupQuotaSubscriptionRequests_List": { + "$ref": "./examples/SubscriptionRequests/SubscriptionRequests_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success, with the details of the subscriptionId request.", + "schema": { + "$ref": "#/definitions/GroupQuotaSubscriptionRequestStatusList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptionRequests/{requestId}": { + "get": { + "tags": [ + "GroupQuotaSubscriptionRequests" + ], + "summary": "Get the status of a single subscriptionId request by requestId. The Async pattern will be used, if we determine the request is taking longer, else it can return 200 response as response to the subscription add API call.", + "description": "Get API to check the status of a subscriptionIds request by requestId. Use the polling API - OperationsStatus URI specified in Azure-AsyncOperation header field, with retry-after duration in seconds to check the intermediate status. This API provides the finals status with the request details and status.", + "operationId": "GroupQuotaSubscriptionRequests_Get", + "x-ms-examples": { + "GroupQuotaSubscriptionRequests_Get": { + "$ref": "./examples/SubscriptionRequests/SubscriptionRequests_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/RequestId" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success, with the details of the subscriptionId request.", + "schema": { + "$ref": "#/definitions/GroupQuotaSubscriptionRequestStatus" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/groupQuotaLimits/{resourceName}": { + "get": { + "tags": [ + "GroupQuotaLimits" + ], + "summary": "Gets the GroupQuotaLimits for the specific resource.", + "description": "Gets the GroupQuotaLimits for the specific resource for a specific resource based on the resourceProviders, resourceName and $filter passed.\nThe $filter=location eq {location} is required to location specific resources groupQuota.", + "operationId": "GroupQuotaLimits_Get", + "x-ms-examples": { + "GroupQuotaLimits_Get_Request_ForCompute": { + "$ref": "./examples/GroupQuotaLimits/GetGroupQuotaLimits-Compute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceProviderName" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterLocationInQuery" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/GroupQuotaLimit" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/groupQuotaLimits": { + "get": { + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "GroupQuotaLimits" + ], + "summary": "Gets the GroupQuotaLimits for all the resources for the specified location in $filter=location eq {location}.", + "description": "Gets the GroupQuotaLimits for the all resource for a specific resourceProvider and $filter passed.\nThe $filter=location eq {location} is required to location specific resources groupQuota.", + "operationId": "GroupQuotaLimits_List", + "x-ms-examples": { + "GroupQuotaLimits_List_Request_ForCompute": { + "$ref": "./examples/GroupQuotaLimits/ListGroupQuotaLimits-Compute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceProviderName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterLocationInQuery" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/GroupQuotaLimitList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/groupQuotaRequests/{resourceName}": { + "put": { + "tags": [ + "GroupQuotaLimitRequest" + ], + "summary": "Put the GroupQuota requests for a specific ResourceProvider/Location/Resource.", + "description": "Put the GroupQuota requests for a specific ResourceProvider/Location/Resource. the location and resourceName (\"name\": {\"value\" : \"resourceName\") properties are specified in the request body. Only 1 resource quota can be requested.\nUse the polling API - OperationsStatus URI specified in Azure-AsyncOperation header field, with retry-after duration in seconds to check the intermediate status. This API provides the finals status with the request details and status.", + "operationId": "GroupQuotaLimitsRequest_CreateOrUpdate", + "x-ms-azure-resource": true, + "x-ms-examples": { + "GroupQuotaLimitsRequests_CreateOrUpdate": { + "$ref": "./examples/GroupQuotaLimitsRequests/PutGroupQuotaLimitsRequests-Compute.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceProviderName" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "groupQuotaRequest", + "in": "body", + "description": "The GroupQuotaRequest body details for specific resourceProvider/location/resources.", + "schema": { + "$ref": "#/definitions/SubmittedResourceRequestStatus" + } + } + ], + "responses": { + "200": { + "description": "Success, with the details of the group quota request.", + "schema": { + "$ref": "#/definitions/SubmittedResourceRequestStatus" + } + }, + "201": { + "description": "Request Accepted, Create or Update", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int64" + }, + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers. New guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#131-resource-based-long-running-operations-relo", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/LROResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "GroupQuotaLimitRequest" + ], + "summary": "Create the GroupQuota requests for a specific ResourceProvider/Location/Resource.", + "description": "Create the GroupQuota requests for a specific ResourceProvider/Location/Resource. the location and resourceName properties are specified in the request body. Only 1 resource quota can be requested. Please note that patch request creates a new groupQuota request.\nUse the polling API - OperationsStatus URI specified in Azure-AsyncOperation header field, with retry-after duration in seconds to check the intermediate status. This API provides the finals status with the request details and status.", + "operationId": "GroupQuotaLimitsRequest_Update", + "x-ms-examples": { + "GroupQuotaLimitsRequests_Update": { + "$ref": "./examples/GroupQuotaLimitsRequests/PatchGroupQuotaLimitsRequests-Compute.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceProviderName" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "groupQuotaRequest", + "in": "body", + "description": "The GroupQuotaRequest body details for specific resourceProvider/location/resources.", + "schema": { + "$ref": "#/definitions/SubmittedResourceRequestStatus" + } + } + ], + "responses": { + "200": { + "description": "Success, with the details of the group quota request.", + "schema": { + "$ref": "#/definitions/SubmittedResourceRequestStatus" + } + }, + "202": { + "description": "Request Accepted, Create or Update", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int64" + }, + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers. New guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#131-resource-based-long-running-operations-relo", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/groupQuotaRequests/{requestId}": { + "get": { + "tags": [ + "GroupQuotaLimitRequest" + ], + "summary": "Get the status of a single GroupQuota request by requestId.", + "description": "Get API to check the status of a GroupQuota request by requestId.", + "operationId": "GroupQuotaLimitsRequest_Get", + "x-ms-examples": { + "GroupQuotaLimitsRequests_Get": { + "$ref": "./examples/GroupQuotaLimitsRequests/GroupQuotaLimitsRequests_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/RequestId" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success, with the details of the group quota request.", + "schema": { + "$ref": "#/definitions/SubmittedResourceRequestStatus" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/groupQuotaRequests": { + "get": { + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "GroupQuotaLimitRequest" + ], + "summary": "Get the status of a single GroupQuota request by requestId.", + "description": "Get API to check the status of a GroupQuota request by requestId.", + "operationId": "GroupQuotaLimitsRequest_List", + "x-ms-examples": { + "GroupQuotaLimitsRequest_List": { + "$ref": "./examples/GroupQuotaLimitsRequests/GroupQuotaLimitsRequests_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceProviderName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterResourceAndLocationInQuery" + } + ], + "responses": { + "200": { + "description": "Success, with the details of the group quota request.", + "schema": { + "$ref": "#/definitions/SubmittedResourceRequestStatusList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/quotaAllocations": { + "get": { + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "SubscriptionQuotaAllocation" + ], + "summary": "Gets all the quota allocated to a subscription for the specific Resource Provider, Location.", + "description": "Gets all the quota allocated to a subscription for the specific Resource Provider, Location. This will include the GroupQuota and total quota allocated to the subscription. Only the Group quota allocated to the subscription can be allocated back to the MG Group Quota. Use the $filter parameter to filter out the specific resource based on the ResourceProvider/Location. $filter is a required parameter. ", + "operationId": "GroupQuotaSubscriptionAllocation_List", + "x-ms-examples": { + "SubscriptionQuotaAllocation_List_ForCompute": { + "$ref": "./examples/SubscriptionQuotaAllocation/SubscriptionQuotaAllocation_List-Compute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterLocationInQuery" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaAllocationsList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/quotaAllocations/{resourceName}": { + "get": { + "tags": [ + "SubscriptionQuotaAllocation" + ], + "summary": "Gets Quota allocated to a subscription for the specific Resource Provider, Location, ResourceName.", + "description": "Gets Quota allocated to a subscription for the specific Resource Provider, Location, ResourceName. This will include the GroupQuota and total quota allocated to the subscription. Only the Group quota allocated to the subscription can be allocated back to the MG Group Quota.", + "operationId": "GroupQuotaSubscriptionAllocation_Get", + "x-ms-examples": { + "SubscriptionQuotaAllocation_Get_Request_ForCompute": { + "$ref": "./examples/SubscriptionQuotaAllocation/SubscriptionQuotaAllocation_Get-Compute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterLocationInQuery" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaAllocations" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/quotaAllocationRequests/{allocationId}": { + "get": { + "tags": [ + "SubscriptionQuotaAllocationRequest" + ], + "operationId": "GroupQuotaSubscriptionAllocationRequest_Get", + "summary": "Get the status of the quota allocation request for the subscriptionId.", + "description": "Get the quota allocation request status for the subscriptionId by allocationId.", + "x-ms-examples": { + "SubscriptionQuotaAllocationRequests_Get_Request_ForCompute": { + "$ref": "./examples/SubscriptionQuotaAllocationRequests/SubscriptionQuotaAllocationRequests_Get-Compute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/AllocationId" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/QuotaAllocationRequestStatus" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocationRequests": { + "get": { + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "SubscriptionQuotaAllocationRequest" + ], + "summary": "Get all the quotaAllocationRequests for a resourceProvider/location.", + "description": "Get all the quotaAllocationRequests for a resourceProvider/location. The filter paramter for location is required.", + "operationId": "GroupQuotaSubscriptionAllocationRequest_List", + "x-ms-examples": { + "SubscriptionQuotaAllocation_List_Request_ForCompute": { + "$ref": "./examples/SubscriptionQuotaAllocationRequests/SubscriptionQuotaAllocationRequests_List-Compute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceProviderName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterLocationInQuery" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/QuotaAllocationRequestStatusList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocationRequests/{resourceName}": { + "put": { + "tags": [ + "SubscriptionQuotaAllocationRequest" + ], + "summary": "Request to assign quota from group quota to a specific Subscription. This request will use Asynchronous pattern to check the status using Async polling as standards defined at - https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#asynchronous-operations.", + "description": "Request to assign quota from group quota to a specific Subscription. The assign GroupQuota to subscriptions or reduce the quota allocated to subscription to give back the unused quota ( quota >= usages) to the groupQuota. So, this API can be used to assign Quota to subscriptions and assign back unused quota to group quota, which can be assigned to another subscriptions in the GroupQuota.", + "operationId": "GroupQuotaSubscriptionAllocationRequest_CreateOrUpdate", + "x-ms-examples": { + "SubscriptionQuotaAllocation_Put_Request_ForCompute": { + "$ref": "./examples/SubscriptionQuotaAllocationRequests/PutSubscriptionQuotaAllocationRequest-Compute.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceProviderName" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "allocateQuotaRequest", + "in": "body", + "description": "Quota requests payload.", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaAllocationRequestStatus" + } + } + ], + "responses": { + "200": { + "description": "OK. , Create or Update", + "schema": { + "$ref": "#/definitions/QuotaAllocationRequestStatus" + } + }, + "201": { + "description": "Request Created. Create or Update", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int64" + }, + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/LROResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "SubscriptionQuotaAllocationRequest" + ], + "summary": "Request to assign quota from group quota to a specific Subscription. This request will use Asynchronous pattern with 202 response and status polling API.", + "description": "Request to assign quota from group quota to a specific Subscription. The assign GroupQuota to subscriptions or reduce the quota allocated to subscription to give back the unused quota ( quota >= usages) to the groupQuota. So, this API can be used to assign Quota to subscriptions and assign back unused quota to group quota, which can be assigned to another subscriptions in the GroupQuota. User can collect unused quotas from multiple subscriptions within the groupQuota and assign the groupQuota to the subscription, where it's needed.", + "operationId": "GroupQuotaSubscriptionAllocationRequest_Update", + "x-ms-examples": { + "SubscriptionQuotaAllocation_Patch_Request_ForCompute": { + "$ref": "./examples/SubscriptionQuotaAllocationRequests/PatchSubscriptionQuotaAllocationRequest-Compute.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceProviderName" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "allocateQuotaRequest", + "in": "body", + "description": "Quota requests payload.", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaAllocationRequestStatus" + } + } + ], + "responses": { + "200": { + "description": "Request status details.", + "schema": { + "$ref": "#/definitions/QuotaAllocationRequestStatus" + } + }, + "202": { + "description": "Request Accepted", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int64" + }, + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationUsages/{location}": { + "get": { + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "GroupQuotaUsages" + ], + "summary": "Gets the GroupQuotas usages and limits(quota) for the resourceProvider/location.", + "description": "Gets the GroupQuotas usages and limits(quota). Location is required paramter.", + "operationId": "GroupQuotaUsages_List", + "x-ms-examples": { + "GroupQuotasUsages_List": { + "$ref": "./examples/GroupQuotaUsages/GetGroupQuotaUsages.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceProviderName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ResourceUsageList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}": { + "put": { + "tags": [ + "GroupQuotaLocationSettings" + ], + "summary": "Enables the GroupQuotas enforcement settings for the resource provider and the location specified.", + "description": "Enables the GroupQuotas enforcement for the resource provider and the location specified. The resource provider will start using the group quotas as the overall quota for the subscriptions included in the GroupQuota. The subscriptions cannot request quota at subscription level.\nThe subscriptions share the GroupQuotaLimits assigned to the GroupQuota. If the GroupQuotaLimits is used, then submit a groupQuotaLimit request for the specific resource - provider/location/resource.\nOnce the GroupQuota Enforcement is enabled then, it cannot be deleted or reverted back. To disable GroupQuota Enforcement -\n 1. Remove all the subscriptions from the groupQuota using the delete API for Subscriptions (Check the example - GroupQuotaSubscriptions_Delete).\n 2. Ten delete the GroupQuota (Check the example - GroupQuotas_Delete).", + "operationId": "GroupQuotaLocationSettings_CreateOrUpdate", + "x-ms-examples": { + "GroupQuotaLocationSettings_CreateOrUpdate": { + "$ref": "./examples/GroupQuotasEnforcement/PutGroupQuotaEnforcement.json" + }, + "GroupQuotaLocationSettings_CreateOrUpdate_Failed": { + "$ref": "./examples/GroupQuotasEnforcement/PutGroupQuotaEnforcementFailed.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceProviderName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "LocationSettings", + "in": "body", + "description": "The GroupQuota body details for creation or update of a GroupQuota entity.", + "schema": { + "$ref": "#/definitions/GroupQuotasEnforcementResponse" + } + } + ], + "responses": { + "200": { + "description": "OK, Create or Update", + "schema": { + "$ref": "#/definitions/GroupQuotasEnforcementResponse" + } + }, + "201": { + "description": "Request Accepted, Create or Update", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int64" + }, + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers. New guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#131-resource-based-long-running-operations-relo", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/LROResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "GroupQuotaLocationSettings" + ], + "summary": "Enables the GroupQuotas enforcement settings for the resource provider and the location specified.", + "description": "Enables the GroupQuotas enforcement for the resource provider and the location specified. The resource provider will start using the group quotas as the overall quota for the subscriptions included in the GroupQuota. The subscriptions cannot request quota at subscription level.\nThe subscriptions share the GroupQuotaLimits assigned to the GroupQuota. If the GroupQuotaLimits is used, then submit a groupQuotaLimit request for the specific resource - provider/location/resource.\nOnce the GroupQuota Enforcement is enabled then, it cannot be deleted or reverted back. To disable GroupQuota Enforcement -\n 1. Remove all the subscriptions from the groupQuota using the delete API for Subscriptions (Check the example - GroupQuotaSubscriptions_Delete).\n 2. Ten delete the GroupQuota (Check the example - GroupQuotas_Delete).", + "operationId": "GroupQuotaLocationSettings_Update", + "x-ms-examples": { + "GroupQuotaLocationSettings_Patch": { + "$ref": "./examples/GroupQuotasEnforcement/PatchGroupQuotaEnforcement.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceProviderName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "LocationSettings", + "in": "body", + "description": "The GroupQuota body details for creation or update of a GroupQuota entity.", + "schema": { + "$ref": "#/definitions/GroupQuotasEnforcementResponse" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GroupQuotasEnforcementResponse" + } + }, + "202": { + "description": "Request Accepted", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int64" + }, + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } + }, + "default": { + "description": "Bad Request", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "GroupQuotaLocationSettings" + ], + "summary": "Gets the GroupQuotas enforcement settings for the resource provider/location.", + "description": "Gets the GroupQuotas enforcement settings for the ResourceProvider/location. The locations, where GroupQuota enforcement is not enabled will return Not Found.", + "operationId": "GroupQuotaLocationSettings_Get", + "x-ms-examples": { + "GroupQuotasEnforcement_Get": { + "$ref": "./examples/GroupQuotasEnforcement/GetGroupQuotaEnforcement.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceProviderName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GroupQuotasEnforcementResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings": { + "get": { + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "GroupQuotaLocationSettings" + ], + "summary": "Returns a list of the Azure regions settings, where the GroupQuotas enforcement is enabled.", + "description": "Returns only the list of the Azure regions settings, where the GroupQuotas enforcement is enabled. The locations not included in GroupQuota Enforcement will not be listed, the regions in failed status with listed as status Failed.", + "operationId": "GroupQuotaLocationSettings_List", + "x-ms-examples": { + "GroupQuotaEnforcement_List": { + "$ref": "./examples/GroupQuotasEnforcement/ListGroupQuotaEnforcement.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupId" + }, + { + "$ref": "#/parameters/GroupQuotaName" + }, + { + "$ref": "#/parameters/ResourceProviderName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GroupQuotasEnforcementListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "RequestState": { + "description": "Request status.", + "enum": [ + "Accepted", + "Created", + "Invalid", + "Succeeded", + "Failed", + "InProgress", + "Canceled" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "RequestState", + "modelAsString": true + } + }, + "QuotaAllocationRequestStatus": { + "type": "object", + "description": "The subscription quota allocation status.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "requestedResource": { + "$ref": "#/definitions/QuotaAllocationRequestBase" + }, + "requestSubmitTime": { + "description": "The request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "provisioningState": { + "$ref": "#/definitions/RequestState", + "readOnly": true + }, + "faultCode": { + "type": "string", + "description": "Details of the failure.", + "readOnly": true + } + } + } + } + }, + "QuotaAllocationRequestStatusList": { + "type": "object", + "description": "List of QuotaAllocation Request Status", + "properties": { + "value": { + "type": "array", + "description": "List of QuotaAllocation Request Status", + "items": { + "$ref": "#/definitions/QuotaAllocationRequestStatus" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "LROResponse": { + "type": "object", + "description": "The provisioning state for the operation.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/RequestState", + "readOnly": true + } + } + } + } + }, + "GroupQuotaRequestBase": { + "type": "object", + "description": "The new GroupQuota limit requested.", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "limit": { + "type": "integer", + "format": "int64", + "description": "The new quota limit for the subscription. The incremental quota will be allocated from pre-approved group quota." + }, + "name": { + "type": "object", + "x-ms-client-flatten": true, + "readOnly": true, + "description": "Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response.", + "properties": { + "value": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "localizedValue": { + "description": "Resource display name.", + "type": "string", + "readOnly": true + } + } + }, + "region": { + "$ref": "#/definitions/RegionScope" + }, + "comments": { + "description": "GroupQuota Request comments and details for request. This is optional paramter to provide more details related to the requested resource.", + "type": "string" + } + } + } + } + }, + "QuotaAllocationRequestBase": { + "type": "object", + "description": "The new quota request allocated to subscription.", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "limit": { + "type": "integer", + "format": "int64", + "description": "The new quota limit for the subscription. The incremental quota will be allocated from pre-approved group quota." + }, + "name": { + "type": "object", + "x-ms-client-flatten": true, + "description": "Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response.", + "readOnly": true, + "properties": { + "value": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "localizedValue": { + "description": "Resource display name.", + "type": "string", + "readOnly": true + } + } + }, + "region": { + "type": "string", + "description": "The location for which the subscription is allocated" + } + } + } + } + }, + "AllocatedToSubscription": { + "type": "object", + "description": "SubscriptionIds and quota allocated to subscriptions from the GroupQuota.", + "properties": { + "subscriptionId": { + "type": "string", + "description": "An Azure subscriptionId." + }, + "quotaAllocated": { + "type": "integer", + "format": "int64", + "description": "The amount of quota allocated to this subscriptionId from the GroupQuotasEntity." + } + } + }, + "AllocatedQuotaToSubscriptionList": { + "type": "object", + "description": "Quota allocated to subscriptions", + "properties": { + "value": { + "type": "array", + "description": "List of Group Quota Limit allocated to subscriptions.", + "items": { + "$ref": "#/definitions/AllocatedToSubscription" + } + } + } + }, + "GroupQuotaLimit": { + "type": "object", + "description": "Group Quota limit.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Group Quota properties for the specified resource.", + "$ref": "#/definitions/GroupQuotaDetails" + } + } + }, + "RegionScope": { + "description": "Location/Azure region for the quota requested for resource.", + "type": "string" + }, + "GroupQuotaDetails": { + "type": "object", + "description": "Group Quota details.", + "properties": { + "region": { + "$ref": "#/definitions/RegionScope" + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The current Group Quota Limit at the parentId level." + }, + "comment": { + "description": "Any comment related to quota request.", + "type": "string" + }, + "name": { + "type": "object", + "x-ms-client-flatten": true, + "readOnly": true, + "description": "Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response.", + "properties": { + "value": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "localizedValue": { + "description": "Resource display name.", + "type": "string", + "readOnly": true + } + } + }, + "unit": { + "description": " The usages units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.", + "type": "string", + "readOnly": true + }, + "availableLimit": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The available Group Quota Limit at the MG level. This Group quota can be allocated to subscription(s)." + }, + "allocatedToSubscriptions": { + "$ref": "#/definitions/AllocatedQuotaToSubscriptionList", + "readOnly": true + } + } + }, + "GroupQuotaLimitList": { + "type": "object", + "description": "List of Group Quota Limit details.", + "properties": { + "value": { + "type": "array", + "description": "List of Group Quota Limit details.", + "items": { + "$ref": "#/definitions/GroupQuotaLimit" + } + }, + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "GroupQuotaSubscriptionRequestStatus": { + "type": "object", + "description": "The new quota limit request status.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "type": "object", + "properties": { + "subscriptionId": { + "type": "string", + "description": "The subscription Id" + }, + "requestSubmitTime": { + "description": "The request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ", + "type": "string", + "format": "date-time" + }, + "provisioningState": { + "$ref": "#/definitions/RequestState", + "description": "Status of this subscriptionId being associated with the GroupQuotasEntity." + } + } + } + } + }, + "GroupQuotaSubscriptionRequestStatusList": { + "type": "object", + "description": "List of GroupQuotaSubscriptionRequests Status", + "properties": { + "value": { + "type": "array", + "description": "List of GroupQuotaSubscriptionRequests Status", + "items": { + "$ref": "#/definitions/GroupQuotaSubscriptionRequestStatus" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "GroupQuotaSubscriptionId": { + "type": "object", + "description": "This represents a Azure subscriptionId that is associated with a GroupQuotasEntity.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "type": "object", + "properties": { + "subscriptionId": { + "description": "An Azure subscriptionId.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/RequestState", + "description": "Status of this subscriptionId being associated with the GroupQuotasEntity." + } + } + } + } + }, + "GroupQuotaSubscriptionIdList": { + "type": "object", + "description": "List of GroupQuotaSubscriptionIds", + "properties": { + "value": { + "type": "array", + "description": "List of GroupQuotaSubscriptionIds", + "items": { + "$ref": "#/definitions/GroupQuotaSubscriptionId" + } + }, + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "SubscriptionQuotaAllocationRequestList": { + "type": "object", + "description": "List of Allocated Group Quota to the subscriptions.", + "properties": { + "value": { + "type": "array", + "description": "Allocated Group Quota to subscriptions.", + "items": { + "$ref": "#/definitions/QuotaAllocationRequestStatus" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "SubscriptionGroupQuotaAssignment": { + "type": "object", + "description": "MGId the source of group quota.", + "properties": { + "groupQuotaId": { + "type": "string", + "description": "The group quota id of the quota source." + }, + "quotaAllocated": { + "type": "integer", + "format": "int64", + "description": "The amount of quota allocated to this subscriptionId from the quota source." + } + } + }, + "SubscriptionQuotaAllocations": { + "type": "object", + "description": "Quota allocated to a subscription for the specific Resource Provider, Location, ResourceName. This will include the GroupQuota and total quota allocated to the subscription. Only the Group quota allocated to the subscription can be allocated back to the MG Group Quota.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Quota properties for the specified resource.", + "$ref": "#/definitions/SubscriptionQuotaDetails" + } + } + }, + "SubscriptionQuotaDetails": { + "type": "object", + "description": "Subscription Quota details.", + "properties": { + "region": { + "$ref": "#/definitions/RegionScope" + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The total quota limit for the subscription.", + "readOnly": false + }, + "shareableQuota": { + "type": "integer", + "format": "int64", + "description": "The shareable quota for the subscription.", + "readOnly": true + }, + "name": { + "type": "object", + "x-ms-client-flatten": true, + "readOnly": true, + "description": "Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response.", + "properties": { + "value": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "localizedValue": { + "description": "Resource display name.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "SubmittedResourceRequestStatus": { + "type": "object", + "description": "Status of a single GroupQuota request.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "type": "object", + "properties": { + "requestedResource": { + "description": "Requested Resource.", + "$ref": "#/definitions/GroupQuotaRequestBase" + }, + "requestSubmitTime": { + "description": "The request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "provisioningState": { + "$ref": "#/definitions/RequestState", + "readOnly": true + }, + "faultCode": { + "type": "string", + "description": "Details of the failure.", + "readOnly": true + } + } + } + } + }, + "SubmittedResourceRequestStatusList": { + "type": "object", + "description": "Share Quota Entity list.", + "properties": { + "value": { + "type": "array", + "description": "Subscription groupQuotaRequests list.", + "items": { + "$ref": "#/definitions/SubmittedResourceRequestStatus" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "SubscriptionQuotaAllocationsStatusList": { + "type": "object", + "description": "Subscription quota allocation requests status list.", + "properties": { + "value": { + "type": "array", + "description": "Subscription quota allocation status list.", + "items": { + "$ref": "#/definitions/SubmittedResourceRequestStatus" + } + }, + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "SubscriptionQuotaAllocationsList": { + "type": "object", + "description": "Subscription quota list.", + "properties": { + "value": { + "type": "array", + "description": "Subscription quota list.", + "items": { + "$ref": "#/definitions/SubscriptionQuotaAllocations" + } + }, + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ResourceBaseRequest": { + "type": "object", + "description": "Resource definition with the requested quota.", + "properties": { + "resourceName": { + "type": "string", + "description": "The resource name, such as SKU name.", + "readOnly": true + }, + "limit": { + "type": "integer", + "description": "Quota requested for the resource.", + "format": "int64" + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond. Based on - https://armwiki.azurewebsites.net/api_contracts/UsagesAPIContract.html?q=usages . Different RPs may have different units, Count, type as int64 should work for most of the integer values." + } + } + }, + "ResourceUsageList": { + "type": "object", + "description": "List of resource usages and quotas for GroupQuota.", + "properties": { + "value": { + "type": "array", + "description": "List of resource usages at Group Quotas.", + "items": { + "$ref": "#/definitions/ResourceUsages" + } + }, + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ResourceUsages": { + "type": "object", + "description": "Resource details with usages and GroupQuota.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/GroupQuotaUsagesBase" + } + } + }, + "GroupQuotaUsagesBase": { + "type": "object", + "description": "Resource details with usages and GroupQuota.", + "properties": { + "name": { + "type": "object", + "x-ms-client-flatten": true, + "description": "Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response.", + "properties": { + "value": { + "description": "Resource name.", + "type": "string" + }, + "localizedValue": { + "description": "Resource display name.", + "type": "string", + "readOnly": true + } + } + }, + "limit": { + "type": "integer", + "description": "Quota/limits for the resource.", + "format": "int64" + }, + "usages": { + "type": "integer", + "description": "Usages for the resource.", + "format": "int64" + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond. Based on - https://armwiki.azurewebsites.net/api_contracts/UsagesAPIContract.html?q=usages . Different RPs may have different units, Count, type as int64 should work for most of the integer values." + } + } + }, + "GroupQuotasEntityBase": { + "type": "object", + "description": "Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified.", + "properties": { + "displayName": { + "description": "Display name of the GroupQuota entity.", + "type": "string" + }, + "additionalAttributes": { + "description": "Additional attributes to filter/restrict the subscriptions, which can be added to the subscriptionIds.", + "$ref": "#/definitions/AdditionalAttributes" + }, + "provisioningState": { + "description": "Provisioning state of the operation.", + "$ref": "#/definitions/RequestState", + "readOnly": true + } + } + }, + "GroupQuotasEntityBasePatch": { + "type": "object", + "description": "Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified.", + "properties": { + "displayName": { + "description": "Display name of the GroupQuota entity.", + "type": "string" + }, + "additionalAttributes": { + "description": "Additional attributes to filter/restrict the subscriptions, which can be added to the subscriptionIds.", + "$ref": "#/definitions/AdditionalAttributesPatch" + }, + "provisioningState": { + "description": "Provisioning state of the operation.", + "$ref": "#/definitions/RequestState", + "readOnly": true + } + } + }, + "GroupQuotasEntityPatch": { + "type": "object", + "description": "Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "title": "Properties", + "type": "object", + "$ref": "#/definitions/GroupQuotasEntityBasePatch" + } + } + }, + "GroupQuotasEntity": { + "type": "object", + "description": "Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "title": "Properties", + "type": "object", + "$ref": "#/definitions/GroupQuotasEntityBase" + } + } + }, + "BillingAccountId": { + "type": "object", + "description": "A Billing Account Id.", + "properties": { + "id": { + "type": "string" + } + } + }, + "EnvironmentType": { + "type": "string", + "description": "Environment name.", + "enum": [ + "NonProduction", + "Production" + ], + "x-ms-enum": { + "name": "EnvironmentType", + "modelAsString": true + } + }, + "Environment": { + "type": "object", + "$ref": "#/definitions/EnvironmentType" + }, + "GroupingIdType": { + "type": "string", + "description": "GroupingId type. It is a required property. More types of groupIds can be supported in future.", + "enum": [ + "ServiceTreeId", + "BillingId" + ], + "x-ms-enum": { + "name": "GroupingIdType", + "modelAsString": true + } + }, + "GroupingId": { + "description": "The grouping Id for the group quota. It can be Billing Id or ServiceTreeId if applicable. ", + "type": "object", + "properties": { + "groupingIdType": { + "$ref": "#/definitions/GroupingIdType" + }, + "value": { + "description": "GroupId value based on the groupingType selected - Billing Id or ServiceTreeId.", + "type": "string" + } + } + }, + "AdditionalAttributes": { + "description": "Additional attribute or filter to allow subscriptions meeting the requirements to be part of the GroupQuota.", + "type": "object", + "properties": { + "groupId": { + "$ref": "#/definitions/GroupingId" + }, + "environment": { + "$ref": "#/definitions/Environment" + } + }, + "required": [ + "groupId" + ] + }, + "AdditionalAttributesPatch": { + "description": "Additional attribute or filter to allow subscriptions meeting the requirements to be part of the GroupQuota.", + "type": "object", + "properties": { + "groupId": { + "$ref": "#/definitions/GroupingId" + }, + "environment": { + "$ref": "#/definitions/Environment" + } + } + }, + "GroupQuotaList": { + "type": "object", + "description": "List of Group Quotas at MG level.", + "properties": { + "value": { + "type": "array", + "description": "List of Group Quotas at MG level.", + "items": { + "$ref": "#/definitions/GroupQuotasEntity" + } + }, + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "GroupQuotasEnforcementListResponse": { + "type": "object", + "description": "List of Azure regions, where the group quotas is enabled for enforcement.", + "properties": { + "value": { + "type": "array", + "description": "List of Azure Regions.", + "items": { + "$ref": "#/definitions/GroupQuotasEnforcementResponse" + } + }, + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "EnforcementState": { + "description": "Enforcement status.", + "enum": [ + "Enabled", + "Disabled", + "NotAvailable" + ], + "type": "string", + "x-ms-enum": { + "name": "EnforcementState", + "modelAsString": true + } + }, + "GroupQuotasEnforcementResponse": { + "type": "object", + "description": "The GroupQuota Enforcement status for a Azure Location/Region.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "type": "object", + "properties": { + "enforcementEnabled": { + "$ref": "#/definitions/EnforcementState", + "description": "Is the GroupQuota Enforcement enabled for the Azure region." + }, + "provisioningState": { + "$ref": "#/definitions/RequestState", + "readOnly": true + }, + "faultCode": { + "type": "string", + "description": "Details of the failure.", + "readOnly": true + } + } + } + } + } + }, + "parameters": { + "RequestId": { + "name": "requestId", + "in": "path", + "required": true, + "type": "string", + "description": "Request Id.", + "x-ms-parameter-location": "method" + }, + "ResourceName": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63, + "description": "Resource name.", + "x-ms-parameter-location": "method" + }, + "AllocationId": { + "name": "allocationId", + "in": "path", + "required": true, + "type": "string", + "description": "Request Id.", + "x-ms-parameter-location": "method" + }, + "ManagementGroupId": { + "name": "managementGroupId", + "in": "path", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "description": "Management Group Id.", + "x-ms-parameter-location": "method" + }, + "GroupQuotaName": { + "name": "groupQuotaName", + "in": "path", + "required": true, + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63, + "type": "string", + "description": "The GroupQuota name. The name should be unique for the provided context tenantId/MgId.", + "x-ms-parameter-location": "method" + }, + "ResourceProviderName": { + "name": "resourceProviderName", + "in": "path", + "pattern": "^((?!-)[a-zA-Z0-9-]{1,63}(?` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7.", - "x-ms-parameter-grouping": { - "name": "SearchOptions" - } - }, { "name": "searchMode", "in": "query", @@ -526,6 +355,90 @@ "name": "SearchOptions" } }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "name": "semanticConfiguration", + "in": "query", + "type": "string", + "description": "The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticErrorHandling", + "in": "query", + "type": "string", + "enum": [ + "partial", + "fail" + ], + "x-ms-enum": { + "name": "SemanticErrorMode", + "modelAsString": true, + "values": [ + { + "value": "partial", + "name": "Partial", + "description": "If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure." + }, + { + "value": "fail", + "name": "Fail", + "description": "If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error." + } + ] + }, + "description": "Allows the user to choose whether a semantic call should fail completely, or to return partial results (default).", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticMaxWaitInMilliseconds", + "in": "query", + "type": "integer", + "format": "int32", + "minimum": 700, + "description": "Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "answers", + "in": "query", + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "QueryAnswerType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return answers for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language." + } + ] + }, + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character `|` followed by the `count-` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, { "name": "captions", "in": "query", @@ -556,22 +469,13 @@ } }, { - "name": "semanticFields", + "name": "semanticQuery", "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of field names used for semantic ranking.", + "type": "string", + "description": "Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase.", "x-ms-parameter-grouping": { "name": "SearchOptions" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestIdParameter" } ], "x-ms-request-id": "request-id", @@ -585,7 +489,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -598,11 +502,14 @@ ], "operationId": "Documents_SearchPost", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + "url": "https://learn.microsoft.com/rest/api/searchservice/Search-Documents" }, "x-ms-examples": { "SearchIndexSearchDocumentsPost": { "$ref": "./examples/SearchIndexSearchDocumentsPost.json" + }, + "SearchIndexSearchDocumentsSemanticPost": { + "$ref": "./examples/SearchIndexSearchDocumentsSemanticPost.json" } }, "description": "Searches for documents in the index.", @@ -635,7 +542,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -648,7 +555,7 @@ ], "operationId": "Documents_Get", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/lookup-document" + "url": "https://learn.microsoft.com/rest/api/searchservice/lookup-document" }, "x-ms-examples": { "SearchIndexGetDocument": { @@ -691,7 +598,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -704,7 +611,7 @@ ], "operationId": "Documents_SuggestGet", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions" + "url": "https://learn.microsoft.com/rest/api/searchservice/suggestions" }, "x-ms-examples": { "SearchIndexSuggestDocumentsGet": { @@ -841,7 +748,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -854,7 +761,7 @@ ], "operationId": "Documents_SuggestPost", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions" + "url": "https://learn.microsoft.com/rest/api/searchservice/suggestions" }, "x-ms-examples": { "SearchIndexSuggestDocumentsPost": { @@ -890,7 +797,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -903,7 +810,7 @@ ], "operationId": "Documents_Index", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents" + "url": "https://learn.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents" }, "x-ms-examples": { "SearchIndexIndexDocuments": { @@ -945,7 +852,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -958,7 +865,7 @@ ], "operationId": "Documents_AutocompleteGet", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + "url": "https://learn.microsoft.com/rest/api/searchservice/autocomplete" }, "x-ms-examples": { "SearchIndexAutocompleteDocumentsGet": { @@ -1105,7 +1012,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -1118,7 +1025,7 @@ ], "operationId": "Documents_AutocompletePost", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + "url": "https://learn.microsoft.com/rest/api/searchservice/autocomplete" }, "x-ms-examples": { "SearchIndexAutocompleteDocumentsPost": { @@ -1154,7 +1061,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -1213,217 +1120,7 @@ "additionalProperties": true, "description": "A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval." }, - "AnswerResult": { - "x-ms-client-name": "QueryAnswerResult", - "properties": { - "score": { - "type": "number", - "format": "double", - "readOnly": true, - "description": "The score value represents how relevant the answer is to the query relative to other answers returned for the query." - }, - "key": { - "type": "string", - "readOnly": true, - "description": "The key of the document the answer was extracted from." - }, - "text": { - "type": "string", - "readOnly": true, - "description": "The text passage extracted from the document contents as the answer." - }, - "highlights": { - "type": "string", - "readOnly": true, - "x-nullable": true, - "description": "Same text passage as in the Text property with highlighted text phrases most relevant to the query." - } - }, - "additionalProperties": true, - "description": "An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected." - }, - "CaptionResult": { - "x-ms-client-name": "QueryCaptionResult", - "properties": { - "text": { - "type": "string", - "readOnly": true, - "description": "A representative text passage extracted from the document most relevant to the search query." - }, - "highlights": { - "type": "string", - "readOnly": true, - "x-nullable": true, - "description": "Same text passage as in the Text property with highlighted phrases most relevant to the query." - } - }, - "additionalProperties": true, - "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'.." - }, - "SemanticPartialResponseReason": { - "type": "string", - "enum": [ - "maxWaitExceeded", - "capacityOverloaded", - "transient" - ], - "x-ms-enum": { - "name": "SemanticErrorReason", - "modelAsString": true, - "values": [ - { - "value": "maxWaitExceeded", - "name": "MaxWaitExceeded", - "description": "If 'semanticMaxWaitInMilliseconds' was set and the semantic processing duration exceeded that value. Only the base results were returned." - }, - { - "value": "capacityOverloaded", - "name": "CapacityOverloaded", - "description": "The request was throttled. Only the base results were returned." - }, - { - "value": "transient", - "name": "Transient", - "description": "At least one step of the semantic process failed." - } - ] - }, - "description": "Reason that a partial response was returned for a semantic ranking request." - }, - "SemanticPartialResponseType": { - "type": "string", - "enum": [ - "baseResults", - "rerankedResults" - ], - "x-ms-enum": { - "name": "SemanticSearchResultsType", - "modelAsString": true, - "values": [ - { - "value": "baseResults", - "name": "BaseResults", - "description": "Results without any semantic enrichment or reranking." - }, - { - "value": "rerankedResults", - "name": "RerankedResults", - "description": "Results have been reranked with the reranker model and will include semantic captions. They will not include any answers, answers highlights or caption highlights." - } - ] - }, - "description": "Type of partial response that was returned for a semantic ranking request." - }, - "DocumentDebugInfo": { - "type": "object", - "properties": { - "semantic": { - "$ref": "#/definitions/SemanticDebugInfo", - "readOnly": true, - "description": "Contains debugging information specific to semantic ranking requests." - } - }, - "description": "Contains debugging information that can be used to further explore your search results." - }, - "SemanticDebugInfo": { - "type": "object", - "properties": { - "titleField": { - "$ref": "#/definitions/QueryResultDocumentSemanticField", - "readOnly": true, - "description": "The title field that was sent to the semantic enrichment process, as well as how it was used" - }, - "contentFields": { - "type": "array", - "items": { - "$ref": "#/definitions/QueryResultDocumentSemanticField" - }, - "readOnly": true, - "description": "The content fields that were sent to the semantic enrichment process, as well as how they were used" - }, - "keywordFields": { - "type": "array", - "items": { - "$ref": "#/definitions/QueryResultDocumentSemanticField" - }, - "readOnly": true, - "description": "The keyword fields that were sent to the semantic enrichment process, as well as how they were used" - }, - "rerankerInput": { - "$ref": "#/definitions/QueryResultDocumentRerankerInput", - "readOnly": true, - "description": "The raw concatenated strings that were sent to the semantic enrichment process." - } - } - }, - "QueryResultDocumentSemanticField": { - "type": "object", - "properties": { - "name": { - "type": "string", - "readOnly": true, - "description": "The name of the field that was sent to the semantic enrichment process" - }, - "state": { - "$ref": "#/definitions/QueryResultDocumentSemanticFieldState", - "readOnly": true, - "description": "The way the field was used for the semantic enrichment process (fully used, partially used, or unused)" - } - }, - "description": "Description of fields that were sent to the semantic enrichment process, as well as how they were used" - }, - "QueryResultDocumentSemanticFieldState": { - "type": "string", - "enum": [ - "used", - "unused", - "partial" - ], - "x-ms-enum": { - "name": "SemanticFieldState", - "modelAsString": true, - "values": [ - { - "value": "used", - "name": "Used", - "description": "The field was fully used for semantic enrichment." - }, - { - "value": "unused", - "name": "Unused", - "description": "The field was not used for semantic enrichment." - }, - { - "value": "partial", - "name": "Partial", - "description": "The field was partially used for semantic enrichment." - } - ] - }, - "description": "The way the field was used for the semantic enrichment process." - }, - "QueryResultDocumentRerankerInput": { - "type": "object", - "properties": { - "title": { - "type": "string", - "readOnly": true, - "description": "The raw string for the title field that was used for semantic enrichment." - }, - "content": { - "type": "string", - "readOnly": true, - "description": "The raw concatenated strings for the content fields that were used for semantic enrichment." - }, - "keywords": { - "type": "string", - "readOnly": true, - "description": "The raw concatenated strings for the keyword fields that were used for semantic enrichment." - } - }, - "description": "The raw concatenated strings that were sent to the semantic enrichment process." - }, - "SearchDocumentsResult": { + "SearchDocumentsResult": { "properties": { "@odata.count": { "type": "integer", @@ -1467,18 +1164,6 @@ "x-ms-client-name": "NextPageParameters", "description": "Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response." }, - "@search.semanticPartialResponseReason": { - "$ref": "#/definitions/SemanticPartialResponseReason", - "readOnly": true, - "x-ms-client-name": "SemanticPartialResponseReason", - "description": "Reason that a partial response was returned for a semantic ranking request." - }, - "@search.semanticPartialResponseType": { - "$ref": "#/definitions/SemanticPartialResponseType", - "readOnly": true, - "x-ms-client-name": "SemanticPartialResponseType", - "description": "Type of partial response that was returned for a semantic ranking request." - }, "value": { "type": "array", "items": { @@ -1493,6 +1178,18 @@ "readOnly": true, "x-ms-client-name": "NextLink", "description": "Continuation URL returned when the query can't return all the requested results in a single response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response." + }, + "@search.semanticPartialResponseReason": { + "$ref": "#/definitions/SemanticPartialResponseReason", + "readOnly": true, + "x-ms-client-name": "SemanticPartialResponseReason", + "description": "Reason that a partial response was returned for a semantic ranking request." + }, + "@search.semanticPartialResponseType": { + "$ref": "#/definitions/SemanticPartialResponseType", + "readOnly": true, + "x-ms-client-name": "SemanticPartialResponseType", + "description": "Type of partial response that was returned for a semantic ranking request." } }, "required": [ @@ -1539,16 +1236,6 @@ "x-ms-client-name": "Captions", "x-nullable": true, "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'." - }, - "@search.documentDebugInfo": { - "type": "array", - "items": { - "$ref": "#/definitions/DocumentDebugInfo" - }, - "readOnly": true, - "x-ms-client-name": "DocumentDebugInfo", - "x-nullable": true, - "description": "Contains debugging information that can be used to further explore your search results." } }, "required": [ @@ -1673,54 +1360,6 @@ ], "description": "Response containing the status of operations for all documents in the indexing request." }, - "SemanticErrorHandling": { - "type": "string", - "enum": [ - "partial", - "fail" - ], - "x-ms-enum": { - "name": "SemanticErrorMode", - "modelAsString": true, - "values": [ - { - "value": "partial", - "name": "Partial", - "description": "If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure." - }, - { - "value": "fail", - "name": "Fail", - "description": "If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error." - } - ] - }, - "description": "Allows the user to choose whether a semantic call should fail completely, or to return partial results." - }, - "QueryDebugMode": { - "type": "string", - "enum": [ - "disabled", - "semantic" - ], - "x-ms-enum": { - "name": "QueryDebugMode", - "modelAsString": true, - "values": [ - { - "value": "disabled", - "name": "Disabled", - "description": "No query debugging information will be returned." - }, - { - "value": "semantic", - "name": "Semantic", - "description": "Allows the user to further explore their reranked results." - } - ] - }, - "description": "Enables a debugging tool that can be used to further explore your search results." - }, "SearchMode": { "type": "string", "enum": [ @@ -1773,79 +1412,7 @@ } ] }, - "description": "Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax and 'semantic' if query syntax is not needed." - }, - "Speller": { - "type": "string", - "enum": [ - "none", - "lexicon" - ], - "x-ms-enum": { - "name": "QuerySpellerType", - "modelAsString": true, - "values": [ - { - "value": "none", - "name": "None", - "description": "Speller not enabled." - }, - { - "value": "lexicon", - "name": "Lexicon", - "description": "Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter." - } - ] - }, - "description": "Improve search recall by spell-correcting individual search query terms." - }, - "Answers": { - "type": "string", - "enum": [ - "none", - "extractive" - ], - "x-ms-enum": { - "name": "QueryAnswerType", - "modelAsString": true, - "values": [ - { - "value": "none", - "name": "None", - "description": "Do not return answers for the query." - }, - { - "value": "extractive", - "name": "Extractive", - "description": "Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language." - } - ] - }, - "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character `|` followed by the `count-` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7." - }, - "Captions": { - "type": "string", - "enum": [ - "none", - "extractive" - ], - "x-ms-enum": { - "name": "QueryCaptionType", - "modelAsString": true, - "values": [ - { - "value": "none", - "name": "None", - "description": "Do not return captions for the query." - }, - { - "value": "extractive", - "name": "Extractive", - "description": "Extracts captions from the matching documents that contain passages relevant to the search query." - } - ] - }, - "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character `|` followed by the `highlight-` option, such as `extractive|highlight-true`. Defaults to `None`." + "description": "Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." }, "VectorQuery": { "type": "object", @@ -1868,6 +1435,16 @@ "exhaustive": { "type": "boolean", "description": "When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values." + }, + "oversampling": { + "type": "number", + "format": "double", + "description": "Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' is true. This parameter is only permitted when a compression method is used on the underlying vector field." + }, + "weight": { + "type": "number", + "format": "float", + "description": "Relative weight of the vector query when compared to other vector query and/or the text query within the same search request. This value is used when combining the results of multiple ranking lists produced by the different vector queries and/or the results retrieved through the text query. The higher the weight, the higher the documents that matched that query will be in the final ranking. Default is 1.0 and the value needs to be a positive number larger than zero. " } }, "required": [ @@ -1877,6 +1454,7 @@ }, "RawVectorQuery": { "type": "object", + "x-ms-client-name": "VectorizedQuery", "x-ms-discriminator-value": "vector", "allOf": [ { @@ -1912,502 +1490,58 @@ "description": "The text to be vectorized to perform a vector search query." } }, - "required": [ - "text" - ], - "description": "The query parameters to use for vector search when a text value that needs to be vectorized is provided." - }, - "VectorQueryKind": { - "type": "string", - "enum": [ - "vector", - "text" - ], - "x-ms-enum": { - "name": "VectorQueryKind", - "modelAsString": true, - "values": [ - { - "value": "vector", - "name": "Vector", - "description": "Vector query where a raw vector value is provided." - }, - { - "value": "text", - "name": "Text", - "description": "Vector query where a text value that needs to be vectorized is provided." - } - ] - }, - "description": "The kind of vector query being performed." - }, - "VectorFilterMode": { - "type": "string", - "enum": [ - "postFilter", - "preFilter" - ], - "x-ms-enum": { - "name": "VectorFilterMode", - "modelAsString": true, - "values": [ - { - "value": "postFilter", - "name": "PostFilter", - "description": "The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'." - }, - { - "value": "preFilter", - "name": "PreFilter", - "description": "The filter will be applied before the search query." - } - ] - }, - "description": "Determines whether or not filters are applied before or after the vector search is performed." - }, - "QueryLanguage": { - "type": "string", - "enum": [ - "none", - "en-us", - "en-gb", - "en-in", - "en-ca", - "en-au", - "fr-fr", - "fr-ca", - "de-de", - "es-es", - "es-mx", - "zh-cn", - "zh-tw", - "pt-br", - "pt-pt", - "it-it", - "ja-jp", - "ko-kr", - "ru-ru", - "cs-cz", - "nl-be", - "nl-nl", - "hu-hu", - "pl-pl", - "sv-se", - "tr-tr", - "hi-in", - "ar-sa", - "ar-eg", - "ar-ma", - "ar-kw", - "ar-jo", - "da-dk", - "no-no", - "bg-bg", - "hr-hr", - "hr-ba", - "ms-my", - "ms-bn", - "sl-sl", - "ta-in", - "vi-vn", - "el-gr", - "ro-ro", - "is-is", - "id-id", - "th-th", - "lt-lt", - "uk-ua", - "lv-lv", - "et-ee", - "ca-es", - "fi-fi", - "sr-ba", - "sr-me", - "sr-rs", - "sk-sk", - "nb-no", - "hy-am", - "bn-in", - "eu-es", - "gl-es", - "gu-in", - "he-il", - "ga-ie", - "kn-in", - "ml-in", - "mr-in", - "fa-ae", - "pa-in", - "te-in", - "ur-pk" - ], - "x-ms-enum": { - "name": "QueryLanguage", - "modelAsString": true, - "values": [ - { - "value": "none", - "name": "None", - "description": "Query language not specified." - }, - { - "value": "en-us", - "name": "EnUs", - "description": "Query language value for English (United States)." - }, - { - "value": "en-gb", - "name": "EnGb", - "description": "Query language value for English (Great Britain)." - }, - { - "value": "en-in", - "name": "EnIn", - "description": "Query language value for English (India)." - }, - { - "value": "en-ca", - "name": "EnCa", - "description": "Query language value for English (Canada)." - }, - { - "value": "en-au", - "name": "EnAu", - "description": "Query language value for English (Australia)." - }, - { - "value": "fr-fr", - "name": "FrFr", - "description": "Query language value for French (France)." - }, - { - "value": "fr-ca", - "name": "FrCa", - "description": "Query language value for French (Canada)." - }, - { - "value": "de-de", - "name": "DeDe", - "description": "Query language value for German (Germany)." - }, - { - "value": "es-es", - "name": "EsEs", - "description": "Query language value for Spanish (Spain)." - }, - { - "value": "es-mx", - "name": "EsMx", - "description": "Query language value for Spanish (Mexico)." - }, - { - "value": "zh-cn", - "name": "ZhCn", - "description": "Query language value for Chinese (China)." - }, - { - "value": "zh-tw", - "name": "ZhTw", - "description": "Query language value for Chinese (Taiwan)." - }, - { - "value": "pt-br", - "name": "PtBr", - "description": "Query language value for Portuguese (Brazil)." - }, - { - "value": "pt-pt", - "name": "PtPt", - "description": "Query language value for Portuguese (Portugal)." - }, - { - "value": "it-it", - "name": "ItIt", - "description": "Query language value for Italian (Italy)." - }, - { - "value": "ja-jp", - "name": "JaJp", - "description": "Query language value for Japanese (Japan)." - }, - { - "value": "ko-kr", - "name": "KoKr", - "description": "Query language value for Korean (Korea)." - }, - { - "value": "ru-ru", - "name": "RuRu", - "description": "Query language value for Russian (Russia)." - }, - { - "value": "cs-cz", - "name": "CsCz", - "description": "Query language value for Czech (Czech Republic)." - }, - { - "value": "nl-be", - "name": "NlBe", - "description": "Query language value for Dutch (Belgium)." - }, - { - "value": "nl-nl", - "name": "NlNl", - "description": "Query language value for Dutch (Netherlands)." - }, - { - "value": "hu-hu", - "name": "HuHu", - "description": "Query language value for Hungarian (Hungary)." - }, - { - "value": "pl-pl", - "name": "PlPl", - "description": "Query language value for Polish (Poland)." - }, - { - "value": "sv-se", - "name": "SvSe", - "description": "Query language value for Swedish (Sweden)." - }, - { - "value": "tr-tr", - "name": "TrTr", - "description": "Query language value for Turkish (Turkey)." - }, - { - "value": "hi-in", - "name": "HiIn", - "description": "Query language value for Hindi (India)." - }, - { - "value": "ar-sa", - "name": "ArSa", - "description": "Query language value for Arabic (Saudi Arabia)." - }, - { - "value": "ar-eg", - "name": "ArEg", - "description": "Query language value for Arabic (Egypt)." - }, - { - "value": "ar-ma", - "name": "ArMa", - "description": "Query language value for Arabic (Morocco)." - }, - { - "value": "ar-kw", - "name": "ArKw", - "description": "Query language value for Arabic (Kuwait)." - }, - { - "value": "ar-jo", - "name": "ArJo", - "description": "Query language value for Arabic (Jordan)." - }, - { - "value": "da-dk", - "name": "DaDk", - "description": "Query language value for Danish (Denmark)." - }, - { - "value": "no-no", - "name": "NoNo", - "description": "Query language value for Norwegian (Norway)." - }, - { - "value": "bg-bg", - "name": "BgBg", - "description": "Query language value for Bulgarian (Bulgaria)." - }, - { - "value": "hr-hr", - "name": "HrHr", - "description": "Query language value for Croatian (Croatia)." - }, - { - "value": "hr-ba", - "name": "HrBa", - "description": "Query language value for Croatian (Bosnia and Herzegovina)." - }, - { - "value": "ms-my", - "name": "MsMy", - "description": "Query language value for Malay (Malaysia)." - }, - { - "value": "ms-bn", - "name": "MsBn", - "description": "Query language value for Malay (Brunei Darussalam)." - }, - { - "value": "sl-sl", - "name": "SlSl", - "description": "Query language value for Slovenian (Slovenia)." - }, - { - "value": "ta-in", - "name": "TaIn", - "description": "Query language value for Tamil (India)." - }, - { - "value": "vi-vn", - "name": "ViVn", - "description": "Query language value for Vietnamese (Viet Nam)." - }, - { - "value": "el-gr", - "name": "ElGr", - "description": "Query language value for Greek (Greece)." - }, - { - "value": "ro-ro", - "name": "RoRo", - "description": "Query language value for Romanian (Romania)." - }, - { - "value": "is-is", - "name": "IsIs", - "description": "Query language value for Icelandic (Iceland)." - }, - { - "value": "id-id", - "name": "IdId", - "description": "Query language value for Indonesian (Indonesia)." - }, - { - "value": "th-th", - "name": "ThTh", - "description": "Query language value for Thai (Thailand)." - }, - { - "value": "lt-lt", - "name": "LtLt", - "description": "Query language value for Lithuanian (Lithuania)." - }, - { - "value": "uk-ua", - "name": "UkUa", - "description": "Query language value for Ukrainian (Ukraine)." - }, - { - "value": "lv-lv", - "name": "LvLv", - "description": "Query language value for Latvian (Latvia)." - }, - { - "value": "et-ee", - "name": "EtEe", - "description": "Query language value for Estonian (Estonia)." - }, - { - "value": "ca-es", - "name": "CaEs", - "description": "Query language value for Catalan." - }, - { - "value": "fi-fi", - "name": "FiFi", - "description": "Query language value for Finnish (Finland)." - }, - { - "value": "sr-ba", - "name": "SrBa", - "description": "Query language value for Serbian (Bosnia and Herzegovina)." - }, - { - "value": "sr-me", - "name": "SrMe", - "description": "Query language value for Serbian (Montenegro)." - }, - { - "value": "sr-rs", - "name": "SrRs", - "description": "Query language value for Serbian (Serbia)." - }, - { - "value": "sk-sk", - "name": "SkSk", - "description": "Query language value for Slovak (Slovakia)." - }, - { - "value": "nb-no", - "name": "NbNo", - "description": "Query language value for Norwegian (Norway)." - }, - { - "value": "hy-am", - "name": "HyAm", - "description": "Query language value for Armenian (Armenia)." - }, - { - "value": "bn-in", - "name": "BnIn", - "description": "Query language value for Bengali (India)." - }, - { - "value": "eu-es", - "name": "EuEs", - "description": "Query language value for Basque." - }, - { - "value": "gl-es", - "name": "GlEs", - "description": "Query language value for Galician." - }, - { - "value": "gu-in", - "name": "GuIn", - "description": "Query language value for Gujarati (India)." - }, - { - "value": "he-il", - "name": "HeIl", - "description": "Query language value for Hebrew (Israel)." - }, - { - "value": "ga-ie", - "name": "GaIe", - "description": "Query language value for Irish (Ireland)." - }, - { - "value": "kn-in", - "name": "KnIn", - "description": "Query language value for Kannada (India)." - }, - { - "value": "ml-in", - "name": "MlIn", - "description": "Query language value for Malayalam (India)." - }, - { - "value": "mr-in", - "name": "MrIn", - "description": "Query language value for Marathi (India)." - }, + "required": [ + "text" + ], + "description": "The query parameters to use for vector search when a text value that needs to be vectorized is provided." + }, + "VectorQueryKind": { + "type": "string", + "enum": [ + "vector", + "text" + ], + "x-ms-enum": { + "name": "VectorQueryKind", + "modelAsString": true, + "values": [ { - "value": "fa-ae", - "name": "FaAe", - "description": "Query language value for Persian (U.A.E.)." + "value": "vector", + "name": "Vector", + "description": "Vector query where a raw vector value is provided." }, { - "value": "pa-in", - "name": "PaIn", - "description": "Query language value for Punjabi (India)." - }, + "value": "text", + "name": "Text", + "description": "Vector query where a text value that needs to be vectorized is provided." + } + ] + }, + "description": "The kind of vector query being performed." + }, + "VectorFilterMode": { + "type": "string", + "enum": [ + "postFilter", + "preFilter" + ], + "x-ms-enum": { + "name": "VectorFilterMode", + "modelAsString": true, + "values": [ { - "value": "te-in", - "name": "TeIn", - "description": "Query language value for Telugu (India)." + "value": "postFilter", + "name": "PostFilter", + "description": "The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'." }, { - "value": "ur-pk", - "name": "UrPk", - "description": "Query language value for Urdu (Pakistan)." + "value": "preFilter", + "name": "PreFilter", + "description": "The filter will be applied before the search query." } ] }, - "description": "The language of the query." + "description": "Determines whether or not filters are applied before or after the vector search is performed." }, "ScoringStatistics": { "type": "string", @@ -2472,7 +1606,7 @@ }, "facets": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + "url": "https://learn.microsoft.com/rest/api/searchservice/Search-Documents" }, "type": "array", "items": { @@ -2482,7 +1616,7 @@ }, "filter": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + "url": "https://learn.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" }, "type": "string", "description": "The OData $filter expression to apply to the search query." @@ -2533,29 +1667,6 @@ "type": "string", "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results." }, - "semanticQuery": { - "type": "string", - "description": "Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase." - }, - "semanticConfiguration": { - "type": "string", - "description": "The name of a semantic configuration that will be used when processing documents for queries of type semantic." - }, - "semanticErrorHandling": { - "$ref": "#/definitions/SemanticErrorHandling", - "description": "Allows the user to choose whether a semantic call should fail completely, or to return partial results (default)." - }, - "semanticMaxWaitInMilliseconds": { - "type": "integer", - "format": "int32", - "x-nullable": true, - "minimum": 700, - "description": "Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails." - }, - "debug": { - "$ref": "#/definitions/QueryDebugMode", - "description": "Enables a debugging tool that can be used to further explore your reranked results." - }, "search": { "type": "string", "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", @@ -2569,18 +1680,6 @@ "$ref": "#/definitions/SearchMode", "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match." }, - "queryLanguage": { - "$ref": "#/definitions/QueryLanguage", - "description": "A value that specifies the language of the search query." - }, - "speller": { - "$ref": "#/definitions/Speller", - "description": "A value that specified the type of the speller to use to spell-correct individual search query terms." - }, - "answers": { - "$ref": "#/definitions/Answers", - "description": "A value that specifies whether answers should be returned as part of the search response." - }, "select": { "type": "string", "description": "The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included." @@ -2595,14 +1694,33 @@ "format": "int32", "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results." }, + "semanticConfiguration": { + "type": "string", + "description": "The name of a semantic configuration that will be used when processing documents for queries of type semantic." + }, + "semanticErrorHandling": { + "$ref": "#/definitions/SemanticErrorHandling", + "description": "Allows the user to choose whether a semantic call should fail completely (default / current behavior), or to return partial results." + }, + "semanticMaxWaitInMilliseconds": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 700, + "description": "Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails." + }, + "semanticQuery": { + "type": "string", + "description": "Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase." + }, + "answers": { + "$ref": "#/definitions/Answers", + "description": "A value that specifies whether answers should be returned as part of the search response." + }, "captions": { "$ref": "#/definitions/Captions", "description": "A value that specifies whether captions should be returned as part of the search response." }, - "semanticFields": { - "type": "string", - "description": "The comma-separated list of field names used for semantic ranking." - }, "vectorQueries": { "type": "array", "items": { @@ -2612,7 +1730,7 @@ }, "vectorFilterMode": { "$ref": "#/definitions/VectorFilterMode", - "description": "Determines whether or not filters are applied before or after the vector search is performed. Default is 'preFilter'." + "description": "Determines whether or not filters are applied before or after the vector search is performed. Default is 'preFilter' for new indexes." } }, "description": "Parameters for filtering, sorting, faceting, paging, and other search query behaviors." @@ -2621,7 +1739,7 @@ "properties": { "filter": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + "url": "https://learn.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" }, "type": "string", "description": "An OData expression that filters the documents considered for suggestions." @@ -2691,7 +1809,7 @@ }, "filter": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + "url": "https://learn.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" }, "type": "string", "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result." @@ -2777,31 +1895,178 @@ ], "description": "The result of Autocomplete requests." }, - "SearchError": { + "AnswerResult": { + "x-ms-client-name": "QueryAnswerResult", "properties": { - "code": { + "score": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The score value represents how relevant the answer is to the query relative to other answers returned for the query." + }, + "key": { "type": "string", "readOnly": true, - "description": "One of a server-defined set of error codes." + "description": "The key of the document the answer was extracted from." }, - "message": { + "text": { "type": "string", "readOnly": true, - "description": "A human-readable representation of the error." + "description": "The text passage extracted from the document contents as the answer." }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchError" - }, + "highlights": { + "type": "string", "readOnly": true, - "description": "An array of details about specific errors that led to this reported error." + "x-nullable": true, + "description": "Same text passage as in the Text property with highlighted text phrases most relevant to the query." } }, - "required": [ - "message" + "additionalProperties": true, + "description": "An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected." + }, + "CaptionResult": { + "x-ms-client-name": "QueryCaptionResult", + "properties": { + "text": { + "type": "string", + "readOnly": true, + "description": "A representative text passage extracted from the document most relevant to the search query." + }, + "highlights": { + "type": "string", + "readOnly": true, + "x-nullable": true, + "description": "Same text passage as in the Text property with highlighted phrases most relevant to the query." + } + }, + "additionalProperties": true, + "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type `semantic`." + }, + "SemanticPartialResponseReason": { + "type": "string", + "enum": [ + "maxWaitExceeded", + "capacityOverloaded", + "transient" + ], + "x-ms-enum": { + "name": "SemanticErrorReason", + "modelAsString": true, + "values": [ + { + "value": "maxWaitExceeded", + "name": "MaxWaitExceeded", + "description": "If `semanticMaxWaitInMilliseconds` was set and the semantic processing duration exceeded that value. Only the base results were returned." + }, + { + "value": "capacityOverloaded", + "name": "CapacityOverloaded", + "description": "The request was throttled. Only the base results were returned." + }, + { + "value": "transient", + "name": "Transient", + "description": "At least one step of the semantic process failed." + } + ] + }, + "description": "Reason that a partial response was returned for a semantic ranking request." + }, + "SemanticPartialResponseType": { + "type": "string", + "enum": [ + "baseResults", + "rerankedResults" + ], + "x-ms-enum": { + "name": "SemanticSearchResultsType", + "modelAsString": true, + "values": [ + { + "value": "baseResults", + "name": "BaseResults", + "description": "Results without any semantic enrichment or reranking." + }, + { + "value": "rerankedResults", + "name": "RerankedResults", + "description": "Results have been reranked with the reranker model and will include semantic captions. They will not include any answers, answers highlights or caption highlights." + } + ] + }, + "description": "Type of partial response that was returned for a semantic ranking request." + }, + "SemanticErrorHandling": { + "type": "string", + "enum": [ + "partial", + "fail" + ], + "x-ms-enum": { + "name": "SemanticErrorMode", + "modelAsString": true, + "values": [ + { + "value": "partial", + "name": "Partial", + "description": "If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure." + }, + { + "value": "fail", + "name": "Fail", + "description": "If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error." + } + ] + }, + "description": "Allows the user to choose whether a semantic call should fail completely, or to return partial results." + }, + "Answers": { + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "QueryAnswerType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return answers for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language." + } + ] + }, + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character `|` followed by the `count-` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7." + }, + "Captions": { + "type": "string", + "enum": [ + "none", + "extractive" ], - "description": "Describes an error condition for the API." + "x-ms-enum": { + "name": "QueryCaptionType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return captions for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts captions from the matching documents that contain passages relevant to the search query." + } + ] + }, + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character `|` followed by the `highlight-` option, such as `extractive|highlight-true`. Defaults to `None`." } }, "parameters": { diff --git a/swagger-specs/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json b/swagger-specs/search/data-plane/Azure.Search/stable/2024-07-01/searchservice.json similarity index 89% rename from swagger-specs/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json rename to swagger-specs/search/data-plane/Azure.Search/stable/2024-07-01/searchservice.json index 63b62a564..1963fef0f 100644 --- a/swagger-specs/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json +++ b/swagger-specs/search/data-plane/Azure.Search/stable/2024-07-01/searchservice.json @@ -3,7 +3,7 @@ "info": { "title": "SearchServiceClient", "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service.", - "version": "2023-10-01-Preview", + "version": "2024-07-01", "x-ms-code-generation-settings": { "useDateTimeOffset": true } @@ -37,7 +37,7 @@ }, "description": "Creates a new datasource or updates a datasource if it already exists.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Data-Source" + "url": "https://learn.microsoft.com/rest/api/searchservice/Update-Data-Source" }, "parameters": [ { @@ -70,9 +70,6 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/IgnoreResetRequirementsParameter" } ], "x-ms-request-id": "request-id", @@ -92,7 +89,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -109,7 +106,7 @@ }, "description": "Deletes a datasource.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Data-Source" + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Data-Source" }, "parameters": [ { @@ -143,7 +140,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -160,7 +157,7 @@ }, "description": "Retrieves a datasource definition.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Data-Source" + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Data-Source" }, "parameters": [ { @@ -188,7 +185,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -207,7 +204,7 @@ }, "description": "Lists all datasources available for a search service.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/List-Data-Sources" + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Data-Sources" }, "parameters": [ { @@ -235,7 +232,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -252,7 +249,7 @@ }, "description": "Creates a new datasource.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Data-Source" }, "parameters": [ { @@ -282,7 +279,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -301,7 +298,7 @@ }, "description": "Resets the change tracking state associated with an indexer.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Reset-Indexer" + "url": "https://learn.microsoft.com/rest/api/searchservice/Reset-Indexer" }, "parameters": [ { @@ -326,84 +323,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" - } - } - } - } - }, - "/indexers('{indexerName}')/search.resetdocs": { - "post": { - "tags": [ - "Indexers" - ], - "operationId": "Indexers_ResetDocs", - "x-ms-examples": { - "SearchServiceResetDocs": { - "$ref": "./examples/SearchServiceResetDocs.json" - } - }, - "description": "Resets specific documents in the datasource to be selectively re-ingested by the indexer.", - "externalDocs": { - "url": "https://aka.ms/reset-documents" - }, - "parameters": [ - { - "name": "indexerName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the indexer to reset documents for." - }, - { - "name": "keysOrIds", - "in": "body", - "required": false, - "schema": { - "type": "object", - "x-ms-client-name": "DocumentKeysOrIds", - "properties": { - "documentKeys": { - "type": "array", - "items": { - "type": "string" - }, - "description": "document keys to be reset" - }, - "datasourceDocumentIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "datasource document identifiers to be reset" - } - } - } - }, - { - "name": "overwrite", - "in": "query", - "required": false, - "default": false, - "type": "boolean", - "description": "If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this payload will be queued to be re-ingested." - }, - { - "$ref": "#/parameters/ClientRequestIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "x-ms-request-id": "request-id", - "responses": { - "204": { - "description": "" - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -422,7 +342,7 @@ }, "description": "Runs an indexer on-demand.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Run-Indexer" + "url": "https://learn.microsoft.com/rest/api/searchservice/Run-Indexer" }, "parameters": [ { @@ -447,7 +367,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -466,7 +386,7 @@ }, "description": "Creates a new indexer or updates an indexer if it already exists.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Indexer" }, "parameters": [ { @@ -499,12 +419,6 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/IgnoreResetRequirementsParameter" - }, - { - "$ref": "#/parameters/DisableCacheReprocessingChangeDetectionParameter" } ], "x-ms-request-id": "request-id", @@ -524,7 +438,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -541,7 +455,7 @@ }, "description": "Deletes an indexer.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Indexer" + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Indexer" }, "parameters": [ { @@ -575,7 +489,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -592,7 +506,7 @@ }, "description": "Retrieves an indexer definition.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer" + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Indexer" }, "parameters": [ { @@ -620,7 +534,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -639,7 +553,7 @@ }, "description": "Lists all indexers available for a search service.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexers" + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Indexers" }, "parameters": [ { @@ -667,7 +581,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -684,7 +598,7 @@ }, "description": "Creates a new indexer.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Indexer" }, "parameters": [ { @@ -714,7 +628,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -733,7 +647,7 @@ }, "description": "Returns the current status and execution history of an indexer.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer-Status" + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Indexer-Status" }, "parameters": [ { @@ -761,7 +675,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -780,7 +694,7 @@ }, "description": "Creates a new skillset in a search service or updates the skillset if it already exists.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/update-skillset" + "url": "https://learn.microsoft.com/rest/api/searchservice/update-skillset" }, "parameters": [ { @@ -813,12 +727,6 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/IgnoreResetRequirementsParameter" - }, - { - "$ref": "#/parameters/DisableCacheReprocessingChangeDetectionParameter" } ], "x-ms-request-id": "request-id", @@ -838,7 +746,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -855,7 +763,7 @@ }, "description": "Deletes a skillset in a search service.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/delete-skillset" + "url": "https://learn.microsoft.com/rest/api/searchservice/delete-skillset" }, "parameters": [ { @@ -889,7 +797,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -906,7 +814,7 @@ }, "description": "Retrieves a skillset in a search service.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/get-skillset" + "url": "https://learn.microsoft.com/rest/api/searchservice/get-skillset" }, "parameters": [ { @@ -934,7 +842,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -953,7 +861,7 @@ }, "description": "List all skillsets in a search service.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/list-skillset" + "url": "https://learn.microsoft.com/rest/api/searchservice/list-skillset" }, "parameters": [ { @@ -981,7 +889,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -998,7 +906,7 @@ }, "description": "Creates a new skillset in a search service.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/create-skillset" + "url": "https://learn.microsoft.com/rest/api/searchservice/create-skillset" }, "parameters": [ { @@ -1028,70 +936,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" - } - } - } - } - }, - "/skillsets('{skillsetName}')/search.resetskills": { - "post": { - "tags": [ - "Skillsets" - ], - "operationId": "Skillsets_ResetSkills", - "x-ms-examples": { - "SearchServiceResetSkills": { - "$ref": "./examples/SearchServiceResetSkills.json" - } - }, - "description": "Reset an existing skillset in a search service.", - "externalDocs": { - "url": "https://aka.ms/reset-skills" - }, - "parameters": [ - { - "name": "skillsetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the skillset to reset." - }, - { - "name": "skillNames", - "in": "body", - "required": true, - "schema": { - "type": "object", - "x-ms-client-name": "SkillNames", - "properties": { - "skillNames": { - "type": "array", - "items": { - "type": "string" - }, - "description": "the names of skills to be reset." - } - } - }, - "description": "The names of skills to reset." - }, - { - "$ref": "#/parameters/ClientRequestIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "x-ms-request-id": "request-id", - "responses": { - "204": { - "description": "The skills in the skillset are successfully reset." - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -1110,7 +955,7 @@ }, "description": "Creates a new synonym map or updates a synonym map if it already exists.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Synonym-Map" + "url": "https://learn.microsoft.com/rest/api/searchservice/Update-Synonym-Map" }, "parameters": [ { @@ -1162,7 +1007,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -1179,7 +1024,7 @@ }, "description": "Deletes a synonym map.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Synonym-Map" + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Synonym-Map" }, "parameters": [ { @@ -1213,7 +1058,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -1230,7 +1075,7 @@ }, "description": "Retrieves a synonym map definition.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Synonym-Map" + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Synonym-Map" }, "parameters": [ { @@ -1258,7 +1103,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -1277,7 +1122,7 @@ }, "description": "Lists all synonym maps available for a search service.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/List-Synonym-Maps" + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Synonym-Maps" }, "parameters": [ { @@ -1305,7 +1150,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -1322,7 +1167,7 @@ }, "description": "Creates a new synonym map.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map" + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Synonym-Map" }, "parameters": [ { @@ -1352,7 +1197,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -1371,7 +1216,7 @@ }, "description": "Creates a new search index.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Index" }, "parameters": [ { @@ -1401,7 +1246,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -1418,7 +1263,7 @@ }, "description": "Lists all indexes available for a search service.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexes" + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Indexes" }, "parameters": [ { @@ -1446,7 +1291,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } }, @@ -1468,7 +1313,7 @@ }, "description": "Creates a new search index or updates an index if it already exists.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Index" + "url": "https://learn.microsoft.com/rest/api/searchservice/Update-Index" }, "parameters": [ { @@ -1527,7 +1372,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -1544,7 +1389,7 @@ }, "description": "Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Index" + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Index" }, "parameters": [ { @@ -1578,7 +1423,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -1595,7 +1440,7 @@ }, "description": "Retrieves an index definition.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index" + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Index" }, "parameters": [ { @@ -1623,7 +1468,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -1642,7 +1487,7 @@ }, "description": "Returns statistics for the given index, including a document count and storage usage.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics" + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Index-Statistics" }, "parameters": [ { @@ -1670,7 +1515,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } @@ -1689,7 +1534,7 @@ }, "description": "Shows how an analyzer breaks text into tokens.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/test-analyzer" + "url": "https://learn.microsoft.com/rest/api/searchservice/test-analyzer" }, "parameters": [ { @@ -1726,74 +1571,24 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } } } }, - "/aliases": { - "post": { - "tags": [ - "Aliases" - ], - "operationId": "Aliases_Create", - "x-ms-examples": { - "SearchServiceCreateAlias": { - "$ref": "./examples/SearchServiceCreateAlias.json" - } - }, - "description": "Creates a new search alias.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Alias" - }, - "parameters": [ - { - "name": "alias", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SearchAlias" - }, - "description": "The definition of the alias to create." - }, - { - "$ref": "#/parameters/ClientRequestIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "x-ms-request-id": "request-id", - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/SearchAlias" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "#/definitions/SearchError" - } - } - } - }, + "/servicestats": { "get": { "tags": [ - "Aliases" + "Service" ], - "operationId": "Aliases_List", + "operationId": "GetServiceStatistics", "x-ms-examples": { - "SearchServiceListAliases": { - "$ref": "./examples/SearchServiceListAliases.json" + "SearchServiceGetServiceStatistics": { + "$ref": "./examples/SearchServiceGetServiceStatistics.json" } }, - "description": "Lists all aliases available for a search service.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/List-Aliases" - }, + "description": "Gets service level statistics for a search service.", "parameters": [ { "$ref": "#/parameters/ClientRequestIdParameter" @@ -1807,288 +1602,77 @@ "200": { "description": "", "schema": { - "$ref": "#/definitions/ListAliasesResult" + "$ref": "#/definitions/ServiceStatistics" } }, "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/SearchError" + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": null } } - }, - "/aliases('{aliasName}')": { - "put": { - "tags": [ - "Aliases" - ], - "operationId": "Aliases_CreateOrUpdate", - "x-ms-examples": { - "SearchServiceCreateOrUpdateAlias": { - "$ref": "./examples/SearchServiceCreateOrUpdateAlias.json" - } + } + }, + "definitions": { + "AnalyzeRequest": { + "properties": { + "text": { + "type": "string", + "description": "The text to break into tokens." }, - "description": "Creates a new search alias or updates an alias if it already exists.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Alias" + "analyzer": { + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive." }, - "parameters": [ - { - "name": "aliasName", - "in": "path", - "required": true, - "type": "string", - "description": "The definition of the alias to create or update." - }, - { - "name": "alias", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SearchAlias" - }, - "description": "The definition of the alias to create or update." - }, - { - "$ref": "#/parameters/ClientRequestIdParameter" - }, - { - "$ref": "#/parameters/IfMatchParameter" - }, - { - "$ref": "#/parameters/IfNoneMatchParameter" - }, - { - "$ref": "#/parameters/PreferHeaderParameter" + "tokenizer": { + "$ref": "#/definitions/LexicalTokenizerName", + "description": "The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "x-ms-request-id": "request-id", - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SearchAlias" - } + "description": "An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/SearchAlias" - } + "description": "An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + } + }, + "required": [ + "text" + ], + "description": "Specifies some text and analysis components used to break that text into tokens." + }, + "AnalyzeResult": { + "properties": { + "tokens": { + "type": "array", + "items": { + "$ref": "#/definitions/AnalyzedTokenInfo" }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "#/definitions/SearchError" - } - } + "description": "The list of tokens returned by the analyzer specified in the request." } }, - "delete": { - "tags": [ - "Aliases" - ], - "operationId": "Aliases_Delete", - "x-ms-examples": { - "SearchServiceDeleteAlias": { - "$ref": "./examples/SearchServiceDeleteAlias.json" - } - }, - "description": "Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Alias" - }, - "parameters": [ - { - "name": "aliasName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the alias to delete." - }, - { - "$ref": "#/parameters/ClientRequestIdParameter" - }, - { - "$ref": "#/parameters/IfMatchParameter" - }, - { - "$ref": "#/parameters/IfNoneMatchParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "x-ms-request-id": "request-id", - "responses": { - "204": { - "description": "" - }, - "404": { - "description": "" - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "#/definitions/SearchError" - } - } - } - }, - "get": { - "tags": [ - "Aliases" - ], - "operationId": "Aliases_Get", - "x-ms-examples": { - "SearchServiceGetAlias": { - "$ref": "./examples/SearchServiceGetAlias.json" - } - }, - "description": "Retrieves an alias definition.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Alias" - }, - "parameters": [ - { - "name": "aliasName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the alias to retrieve." - }, - { - "$ref": "#/parameters/ClientRequestIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "x-ms-request-id": "request-id", - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SearchAlias" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "#/definitions/SearchError" - } - } - } - } - }, - "/servicestats": { - "get": { - "tags": [ - "Service" - ], - "operationId": "GetServiceStatistics", - "x-ms-examples": { - "SearchServiceGetServiceStatistics": { - "$ref": "./examples/SearchServiceGetServiceStatistics.json" - } - }, - "description": "Gets service level statistics for a search service.", - "parameters": [ - { - "$ref": "#/parameters/ClientRequestIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "x-ms-request-id": "request-id", - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ServiceStatistics" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "#/definitions/SearchError" - } - } - } - } - } - }, - "definitions": { - "AnalyzeRequest": { - "properties": { - "text": { - "type": "string", - "description": "The text to break into tokens." - }, - "analyzer": { - "$ref": "#/definitions/LexicalAnalyzerName", - "description": "The name of the analyzer to use to break the given text." - }, - "tokenizer": { - "$ref": "#/definitions/LexicalTokenizerName", - "description": "The name of the tokenizer to use to break the given text." - }, - "normalizer": { - "$ref": "#/definitions/LexicalNormalizerName", - "description": "The name of the normalizer to use to normalize the given text." - }, - "tokenFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/TokenFilterName", - "x-nullable": false - }, - "description": "An optional list of token filters to use when breaking the given text." - }, - "charFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/CharFilterName", - "x-nullable": false - }, - "description": "An optional list of character filters to use when breaking the given text." - } - }, - "required": [ - "text" - ], - "description": "Specifies some text and analysis components used to break that text into tokens." - }, - "AnalyzeResult": { - "properties": { - "tokens": { - "type": "array", - "items": { - "$ref": "#/definitions/AnalyzedTokenInfo" - }, - "description": "The list of tokens returned by the analyzer specified in the request." - } - }, - "required": [ - "tokens" - ], - "description": "The result of testing an analyzer on text." - }, - "AnalyzedTokenInfo": { - "properties": { - "token": { - "type": "string", - "readOnly": true, - "description": "The token returned by the analyzer." + "required": [ + "tokens" + ], + "description": "The result of testing an analyzer on text." + }, + "AnalyzedTokenInfo": { + "properties": { + "token": { + "type": "string", + "readOnly": true, + "description": "The token returned by the analyzer." }, "startOffset": { "type": "integer", @@ -2659,7 +2243,7 @@ { "value": "standardasciifolding.lucene", "name": "StandardAsciiFoldingLucene", - "description": "Standard ASCII Folding Lucene analyzer. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers" + "description": "Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers" }, { "value": "keyword", @@ -2690,7 +2274,7 @@ }, "description": "Defines the names of all text analyzers supported by the search engine.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + "url": "https://learn.microsoft.com/rest/api/searchservice/Language-support" } }, "LexicalTokenizerName": { @@ -2783,7 +2367,7 @@ }, "description": "Defines the names of all tokenizers supported by the search engine.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" } }, "TokenFilterName": { @@ -2966,7 +2550,7 @@ { "value": "stemmer", "name": "Stemmer", - "description": "Language specific stemming filter. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + "description": "Language specific stemming filter. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" }, { "value": "stopwords", @@ -3002,52 +2586,7 @@ }, "description": "Defines the names of all token filters supported by the search engine.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" - } - }, - "LexicalNormalizerName": { - "type": "string", - "enum": [ - "asciifolding", - "elision", - "lowercase", - "standard", - "uppercase" - ], - "x-ms-enum": { - "name": "LexicalNormalizerName", - "modelAsString": true, - "values": [ - { - "value": "asciifolding", - "name": "AsciiFolding", - "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" - }, - { - "value": "elision", - "name": "Elision", - "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" - }, - { - "value": "lowercase", - "name": "Lowercase", - "description": "Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html" - }, - { - "value": "standard", - "name": "Standard", - "description": "Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html" - }, - { - "value": "uppercase", - "name": "Uppercase", - "description": "Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html" - } - ] - }, - "description": "Defines the names of all text normalizers supported by the search engine.", - "externalDocs": { - "url": "https://aka.ms/azs-normalizers" + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" } }, "CharFilterName": { @@ -3068,7 +2607,7 @@ }, "description": "Defines the names of all character filters supported by the search engine.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" } }, "RegexFlags": { @@ -3134,6 +2673,24 @@ "url": "http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#field_summary" } }, + "VectorEncodingFormat": { + "type": "string", + "enum": [ + "packedBit" + ], + "x-ms-enum": { + "name": "VectorEncodingFormat", + "modelAsString": true, + "values": [ + { + "value": "packedBit", + "name": "PackedBit", + "description": "Encoding format representing bits packed into a wider data type." + } + ] + }, + "description": "The encoding format for interpreting vector field contents." + }, "SearchFieldDataType": { "type": "string", "enum": [ @@ -3145,7 +2702,11 @@ "Edm.DateTimeOffset", "Edm.GeographyPoint", "Edm.ComplexType", - "Edm.Single" + "Edm.Single", + "Edm.Half", + "Edm.Int16", + "Edm.SByte", + "Edm.Byte" ], "x-ms-enum": { "name": "SearchFieldDataType", @@ -3195,6 +2756,26 @@ "value": "Edm.Single", "name": "Single", "description": "Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single)." + }, + { + "value": "Edm.Half", + "name": "Half", + "description": "Indicates that a field contains a half-precision floating point number. This is only valid when used with Collection(Edm.Half)." + }, + { + "value": "Edm.Int16", + "name": "Int16", + "description": "Indicates that a field contains a 16-bit signed integer. This is only valid when used with Collection(Edm.Int16)." + }, + { + "value": "Edm.SByte", + "name": "SByte", + "description": "Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte)." + }, + { + "value": "Edm.Byte", + "name": "Byte", + "description": "Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte)." } ] }, @@ -3205,12 +2786,12 @@ "properties": { "@odata.type": { "type": "string", - "description": "A URI fragment specifying the type of analyzer. " + "description": "A URI fragment specifying the type of analyzer." }, "name": { "type": "string", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + "url": "https://learn.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" }, "description": "The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." } @@ -3340,57 +2921,6 @@ "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" } }, - "LexicalNormalizer": { - "discriminator": "@odata.type", - "properties": { - "@odata.type": { - "type": "string", - "description": "A URI fragment specifying the type of normalizer." - }, - "name": { - "type": "string", - "externalDocs": { - "url": "https://aka.ms/azs-normalizers" - }, - "description": "The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'." - } - }, - "required": [ - "@odata.type", - "name" - ], - "description": "Base type for normalizers." - }, - "CustomNormalizer": { - "x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomNormalizer", - "allOf": [ - { - "$ref": "#/definitions/LexicalNormalizer" - } - ], - "properties": { - "tokenFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/TokenFilterName", - "x-nullable": false - }, - "description": "A list of token filters used to filter out or modify the input token. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed." - }, - "charFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/CharFilterName", - "x-nullable": false - }, - "description": "A list of character filters used to prepare input text before it is processed. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed." - } - }, - "description": "Allows you to configure normalization for filterable, sortable, and facetable fields, which by default operate with strict matching. This is a user-defined configuration consisting of at least one or more filters, which modify the token that is stored.", - "externalDocs": { - "url": "https://aka.ms/azs-custom-normalizers" - } - }, "LexicalTokenizer": { "discriminator": "@odata.type", "properties": { @@ -3401,7 +2931,7 @@ "name": { "type": "string", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + "url": "https://learn.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" }, "description": "The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." } @@ -3412,7 +2942,7 @@ ], "description": "Base type for tokenizers.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" } }, "ClassicTokenizer": { @@ -4340,7 +3870,7 @@ "name": { "type": "string", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + "url": "https://learn.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" }, "description": "The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." } @@ -4351,7 +3881,7 @@ ], "description": "Base type for token filters.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" } }, "AsciiFoldingTokenFilter": { @@ -5525,7 +5055,7 @@ ], "description": "Language specific stemming filter. This token filter is implemented using Apache Lucene.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" } }, "StemmerOverrideTokenFilter": { @@ -5937,7 +5467,7 @@ "name": { "type": "string", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + "url": "https://learn.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" }, "description": "The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." } @@ -5948,7 +5478,7 @@ ], "description": "Base type for character filters.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" } }, "MappingCharFilter": { @@ -6013,7 +5543,7 @@ ], "description": "Base type for similarity algorithms. Similarity algorithms are used to calculate scores that tie queries to documents. The higher the score, the more relevant the document is to that specific query. Those scores are used to rank the search results.", "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/index-ranking-similarity" + "url": "https://learn.microsoft.com/azure/search/index-ranking-similarity" } }, "ClassicSimilarity": { @@ -6048,94 +5578,6 @@ }, "description": "Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter)." }, - "SemanticSettings": { - "x-ms-client-name": "SemanticSearch", - "properties": { - "defaultConfiguration": { - "x-ms-client-name": "defaultConfigurationName", - "type": "string", - "description": "Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time." - }, - "configurations": { - "type": "array", - "items": { - "$ref": "#/definitions/SemanticConfiguration" - }, - "description": "The semantic configurations for the index." - } - }, - "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/semantic-search-overview" - }, - "description": "Defines parameters for a search index that influence semantic capabilities." - }, - "SemanticConfiguration": { - "properties": { - "name": { - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" - }, - "type": "string", - "description": "The name of the semantic configuration.", - "x-nullable": false - }, - "prioritizedFields": { - "$ref": "#/definitions/PrioritizedFields", - "x-nullable": false, - "description": "Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set." - } - }, - "required": [ - "name", - "prioritizedFields" - ], - "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/semantic-search-overview" - }, - "description": "Defines a specific configuration to be used in the context of semantic capabilities." - }, - "PrioritizedFields": { - "x-ms-client-name": "SemanticPrioritizedFields", - "properties": { - "titleField": { - "$ref": "#/definitions/SemanticField", - "description": "Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank." - }, - "prioritizedContentFields": { - "x-ms-client-name": "contentFields", - "type": "array", - "items": { - "$ref": "#/definitions/SemanticField" - }, - "description": "Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long." - }, - "prioritizedKeywordsFields": { - "x-ms-client-name": "keywordsFields", - "type": "array", - "items": { - "$ref": "#/definitions/SemanticField" - }, - "description": "Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long." - } - }, - "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/semantic-search-overview" - }, - "description": "Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers." - }, - "SemanticField": { - "properties": { - "fieldName": { - "type": "string", - "description": "", - "x-nullable": false - } - }, - "required": [ - "fieldName" - ], - "description": "A field that is used as part of the semantic configuration." - }, "VectorSearch": { "type": "object", "properties": { @@ -6159,6 +5601,13 @@ "$ref": "#/definitions/VectorSearchVectorizer" }, "description": "Contains configuration options on how to vectorize text vector queries." + }, + "compressions": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchCompressionConfiguration" + }, + "description": "Contains configuration options specific to the compression method used during indexing or querying." } }, "description": "Contains configuration options related to vector search." @@ -6168,7 +5617,7 @@ "properties": { "name": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" }, "type": "string", "description": "The name to associate with this particular vector search profile.", @@ -6181,8 +5630,15 @@ "x-nullable": false }, "vectorizer": { + "x-ms-client-name": "vectorizerName", "type": "string", - "description": "The name of the kind of vectorization method being configured for use with vector search.", + "description": "The name of the vectorization being configured for use with vector search.", + "x-nullable": false + }, + "compression": { + "x-ms-client-name": "compressionConfigurationName", + "type": "string", + "description": "The name of the compression method configuration that specifies the compression method and optional parameters.", "x-nullable": false } }, @@ -6198,7 +5654,7 @@ "properties": { "name": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" }, "type": "string", "description": "The name to associate with this particular configuration.", @@ -6306,7 +5762,8 @@ "enum": [ "cosine", "euclidean", - "dotProduct" + "dotProduct", + "hamming" ], "x-ms-enum": { "name": "VectorSearchAlgorithmMetric", @@ -6314,19 +5771,27 @@ "values": [ { "value": "cosine", - "name": "Cosine" + "name": "Cosine", + "description": "Measures the angle between vectors to quantify their similarity, disregarding magnitude. The smaller the angle, the closer the similarity." }, { "value": "euclidean", - "name": "Euclidean" + "name": "Euclidean", + "description": "Computes the straight-line distance between vectors in a multi-dimensional space. The smaller the distance, the closer the similarity." }, { "value": "dotProduct", - "name": "DotProduct" + "name": "DotProduct", + "description": "Calculates the sum of element-wise products to gauge alignment and magnitude similarity. The larger and more positive, the closer the similarity." + }, + { + "value": "hamming", + "name": "Hamming", + "description": "Only applicable to bit-packed binary data types. Determines dissimilarity by counting differing positions in binary vectors. The fewer differences, the closer the similarity." } ] }, - "description": "The similarity metric to use for vector comparisons." + "description": "The similarity metric to use for vector comparisons. It is recommended to choose the same similarity metric as the embedding model was trained on." }, "VectorSearchAlgorithmKind": { "type": "string", @@ -6352,6 +5817,122 @@ }, "description": "The algorithm used for indexing and querying." }, + "VectorSearchCompressionConfiguration": { + "type": "object", + "discriminator": "kind", + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name to associate with this particular configuration.", + "x-nullable": false + }, + "kind": { + "$ref": "#/definitions/VectorSearchCompressionKind", + "description": "The name of the kind of compression method being configured for use with vector search.", + "x-nullable": false + }, + "rerankWithOriginalVectors": { + "type": "boolean", + "default": true, + "description": "If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency." + }, + "defaultOversampling": { + "type": "number", + "format": "double", + "description": "Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency.", + "x-nullable": true + } + }, + "required": [ + "name", + "kind" + ], + "description": "Contains configuration options specific to the compression method used during indexing or querying." + }, + "ScalarQuantizationVectorSearchCompressionConfiguration": { + "x-ms-client-name": "ScalarQuantizationCompressionConfiguration", + "type": "object", + "x-ms-discriminator-value": "scalarQuantization", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchCompressionConfiguration" + } + ], + "properties": { + "scalarQuantizationParameters": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/ScalarQuantizationParameters", + "description": "Contains the parameters specific to Scalar Quantization." + } + }, + "description": "Contains configuration options specific to the scalar quantization compression method used during indexing and querying." + }, + "ScalarQuantizationParameters": { + "type": "object", + "properties": { + "quantizedDataType": { + "$ref": "#/definitions/VectorSearchCompressionTargetDataType", + "x-nullable": true, + "description": "The quantized data type of compressed vector values." + } + }, + "description": "Contains the parameters specific to Scalar Quantization." + }, + "BinaryQuantizationVectorSearchCompressionConfiguration": { + "x-ms-client-name": "BinaryQuantizationCompressionConfiguration", + "type": "object", + "x-ms-discriminator-value": "binaryQuantization", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchCompressionConfiguration" + } + ], + "description": "Contains configuration options specific to the binary quantization compression method used during indexing and querying." + }, + "VectorSearchCompressionTargetDataType": { + "type": "string", + "enum": [ + "int8" + ], + "x-ms-enum": { + "name": "VectorSearchCompressionTargetDataType", + "modelAsString": true, + "values": [ + { + "value": "int8", + "name": "Int8" + } + ] + }, + "description": "The quantized data type of compressed vector values." + }, + "VectorSearchCompressionKind": { + "type": "string", + "enum": [ + "scalarQuantization", + "binaryQuantization" + ], + "x-ms-enum": { + "name": "VectorSearchCompressionKind", + "modelAsString": true, + "values": [ + { + "value": "scalarQuantization", + "name": "ScalarQuantization", + "description": "Scalar Quantization, a type of compression method. In scalar quantization, the original vectors values are compressed to a narrower type by discretizing and representing each component of a vector using a reduced set of quantized values, thereby reducing the overall data size." + }, + { + "value": "binaryQuantization", + "name": "BinaryQuantization", + "description": "Binary Quantization, a type of compression method. In binary quantization, the original vectors values are compressed to the narrower binary type by discretizing and representing each component of a vector using binary values, thereby reducing the overall data size." + } + ] + }, + "description": "The compression method used for indexing and querying." + }, "VectorSearchVectorizer": { "type": "object", "discriminator": "kind", @@ -6402,6 +5983,7 @@ "description": "The resource URI of the Azure OpenAI resource." }, "deploymentId": { + "x-ms-client-name": "deploymentName", "type": "string", "description": "ID of the Azure OpenAI model deployment on the designated resource." }, @@ -6413,11 +5995,42 @@ "$ref": "#/definitions/SearchIndexerDataIdentity", "x-nullable": true, "description": "The user-assigned managed identity used for outbound connections." + }, + "modelName": { + "$ref": "#/definitions/AzureOpenAIModelName", + "description": "The name of the embedding model that is deployed at the provided deploymentId path." } }, "description": "Specifies the parameters for connecting to the Azure OpenAI resource." }, - "CustomVectorizer": { + "AzureOpenAIModelName": { + "type": "string", + "enum": [ + "text-embedding-ada-002", + "text-embedding-3-large", + "text-embedding-3-small" + ], + "x-ms-enum": { + "name": "AzureOpenAIModelName", + "modelAsString": true, + "values": [ + { + "value": "text-embedding-ada-002", + "name": "TextEmbeddingAda002" + }, + { + "value": "text-embedding-3-large", + "name": "TextEmbedding3Large" + }, + { + "value": "text-embedding-3-small", + "name": "TextEmbedding3Small" + } + ] + }, + "description": "The Azure Open AI model name that will be called." + }, + "WebApiVectorizer": { "type": "object", "x-ms-discriminator-value": "customWebApi", "allOf": [ @@ -6427,14 +6040,14 @@ ], "properties": { "customWebApiParameters": { - "x-ms-client-name": "CustomWebApiParameters", - "$ref": "#/definitions/CustomWebApiParameters", + "x-ms-client-name": "WebApiParameters", + "$ref": "#/definitions/WebApiParameters", "description": "Specifies the properties of the user-defined vectorizer." } }, "description": "Specifies a user-defined vectorizer for generating the vector embedding of a query string. Integration of an external vectorizer is achieved using the custom Web API interface of a skillset." }, - "CustomWebApiParameters": { + "WebApiParameters": { "type": "object", "properties": { "uri": { @@ -6458,6 +6071,7 @@ "authResourceId": { "type": "string", "x-nullable": true, + "x-ms-format": "arm-id", "description": "Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the vectorization connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token." }, "authIdentity": { @@ -6496,7 +6110,7 @@ "properties": { "connectionString": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Data-Source" }, "type": "string", "description": "The connection string for the datasource. Set to `` (with brackets) if you don't want the connection string updated. Set to `` if you want to remove the connection string value from the datasource." @@ -6632,15 +6246,6 @@ } } }, - "NativeBlobSoftDeleteDeletionDetectionPolicy": { - "description": "Defines a data deletion detection policy utilizing Azure Blob Storage's native soft delete feature for deletion detection.", - "x-ms-discriminator-value": "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy", - "allOf": [ - { - "$ref": "#/definitions/DataDeletionDetectionPolicy" - } - ] - }, "SearchIndexerDataSourceType": { "type": "string", "enum": [ @@ -6693,7 +6298,7 @@ "properties": { "name": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" }, "type": "string", "description": "The name of the datasource." @@ -6714,11 +6319,6 @@ "$ref": "#/definitions/SearchIndexerDataContainer", "description": "The data container for the datasource." }, - "identity": { - "$ref": "#/definitions/SearchIndexerDataIdentity", - "x-nullable": true, - "description": "An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If \"none\" is specified, the value of this property is cleared." - }, "dataChangeDetectionPolicy": { "$ref": "#/definitions/DataChangeDetectionPolicy", "x-nullable": true, @@ -6814,7 +6414,7 @@ }, "description": "Represents parameters for indexer execution.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/create-indexer#parameters" + "url": "https://learn.microsoft.com/rest/api/searchservice/create-indexer#parameters" } }, "IndexingParametersConfiguration": { @@ -6846,7 +6446,7 @@ "indexStorageMetadataOnlyForOversizedDocuments": { "type": "boolean", "default": false, - "description": "For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://docs.microsoft.com/azure/search/search-limits-quotas-capacity." + "description": "For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://learn.microsoft.com/azure/search/search-limits-quotas-capacity." }, "delimitedTextHeaders": { "type": "string", @@ -6891,7 +6491,7 @@ "additionalProperties": true, "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/create-indexer#parameters" + "url": "https://learn.microsoft.com/rest/api/searchservice/create-indexer#parameters" } }, "ParsingMode": { @@ -7073,7 +6673,7 @@ ], "description": "Represents a function that transforms a value from a data source before indexing.", "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + "url": "https://learn.microsoft.com/azure/search/search-indexer-field-mappings" } }, "FieldMapping": { @@ -7097,14 +6697,14 @@ ], "description": "Defines a mapping between a field in a data source and a target field in an index.", "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + "url": "https://learn.microsoft.com/azure/search/search-indexer-field-mappings" } }, "SearchIndexer": { "properties": { "name": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" }, "type": "string", "description": "The name of the indexer." @@ -7142,7 +6742,7 @@ }, "description": "Defines mappings between fields in the data source and corresponding target fields in the index.", "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + "url": "https://learn.microsoft.com/azure/search/search-indexer-field-mappings" } }, "outputFieldMappings": { @@ -7152,7 +6752,7 @@ }, "description": "Output field mappings are applied after enrichment and immediately before indexing.", "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + "url": "https://learn.microsoft.com/azure/search/search-indexer-field-mappings" } }, "disabled": { @@ -7174,14 +6774,6 @@ "url": "https://aka.ms/azure-search-encryption-with-cmk" }, "x-nullable": true - }, - "cache": { - "$ref": "#/definitions/SearchIndexerCache", - "x-nullable": true, - "description": "Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time.", - "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/search-howto-incremental-index" - } } }, "required": [ @@ -7190,7 +6782,7 @@ "targetIndexName" ], "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Indexer-operations" + "url": "https://learn.microsoft.com/rest/api/searchservice/Indexer-operations" }, "description": "Represents an indexer." }, @@ -7292,16 +6884,6 @@ "readOnly": true, "description": "The outcome of this indexer execution." }, - "statusDetail": { - "$ref": "#/definitions/IndexerExecutionStatusDetail", - "readOnly": true, - "description": "The outcome of this indexer execution." - }, - "currentState": { - "$ref": "#/definitions/IndexerCurrentState", - "readOnly": true, - "description": "All of the state that defines and dictates the indexer's current execution." - }, "errorMessage": { "type": "string", "readOnly": true, @@ -7451,116 +7033,27 @@ ], "x-ms-enum": { "name": "IndexerStatus", - "modelAsString": false, - "values": [ - { - "value": "unknown", - "name": "Unknown", - "description": "Indicates that the indexer is in an unknown state." - }, - { - "value": "error", - "name": "Error", - "description": "Indicates that the indexer experienced an error that cannot be corrected without human intervention." - }, - { - "value": "running", - "name": "Running", - "description": "Indicates that the indexer is running normally." - } - ] - }, - "x-nullable": false, - "description": "Represents the overall indexer status." - }, - "IndexerExecutionStatusDetail": { - "type": "string", - "enum": [ - "resetDocs" - ], - "x-ms-enum": { - "name": "IndexerExecutionStatusDetail", - "modelAsString": true, - "values": [ - { - "value": "resetDocs", - "name": "ResetDocs", - "description": "Indicates that the reset that occurred was for a call to ResetDocs." - } - ] - }, - "description": "Details the status of an individual indexer execution." - }, - "IndexerCurrentState": { - "properties": { - "mode": { - "$ref": "#/definitions/IndexingMode", - "readOnly": true, - "description": "The mode the indexer is running in." - }, - "allDocsInitialChangeTrackingState": { - "type": "string", - "readOnly": true, - "description": "Change tracking state used when indexing starts on all documents in the datasource." - }, - "allDocsFinalChangeTrackingState": { - "type": "string", - "readOnly": true, - "description": "Change tracking state value when indexing finishes on all documents in the datasource." - }, - "resetDocsInitialChangeTrackingState": { - "type": "string", - "readOnly": true, - "description": "Change tracking state used when indexing starts on select, reset documents in the datasource." - }, - "resetDocsFinalChangeTrackingState": { - "type": "string", - "readOnly": true, - "description": "Change tracking state value when indexing finishes on select, reset documents in the datasource." - }, - "resetDocumentKeys": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys." - }, - "resetDatasourceDocumentIds": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids." - } - }, - "description": "Represents all of the state that defines and dictates the indexer's current execution." - }, - "IndexingMode": { - "type": "string", - "enum": [ - "indexingAllDocs", - "indexingResetDocs" - ], - "x-ms-enum": { - "name": "IndexingMode", - "modelAsString": true, + "modelAsString": false, "values": [ { - "value": "indexingAllDocs", - "name": "IndexingAllDocs", - "description": "The indexer is indexing all documents in the datasource." + "value": "unknown", + "name": "Unknown", + "description": "Indicates that the indexer is in an unknown state." + }, + { + "value": "error", + "name": "Error", + "description": "Indicates that the indexer experienced an error that cannot be corrected without human intervention." }, { - "value": "indexingResetDocs", - "name": "indexingResetDocs", - "description": "The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status." + "value": "running", + "name": "Running", + "description": "Indicates that the indexer is running normally." } ] }, "x-nullable": false, - "description": "Represents the mode the indexer is executing in." + "description": "Represents the overall indexer status." }, "SearchIndexerLimits": { "properties": { @@ -7590,14 +7083,14 @@ "type": "string", "description": "The name of the field, which must be unique within the fields collection of the index or parent field.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" } }, "type": { "$ref": "#/definitions/SearchFieldDataType", "description": "The data type of the field.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/supported-data-types" + "url": "https://learn.microsoft.com/rest/api/searchservice/supported-data-types" } }, "key": { @@ -7606,7 +7099,11 @@ }, "retrievable": { "type": "boolean", - "description": "A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields and null for complex fields." + "description": "A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields, false for vector fields, and null for complex fields." + }, + "stored": { + "type": "boolean", + "description": "An immutable value indicating whether the field will be persisted separately on disk to be returned in a search result. You can disable this option if you don't plan to return the field contents in a search response to save on storage overhead. This can only be set during index creation and only for vector fields. This property cannot be changed for existing fields or set as false for new fields. If this property is set as false, the property 'retrievable' must also be set to false. This property must be true or unset for key fields, for new fields, and for non-vector fields, and it must be null for complex fields. Disabling this property will reduce index storage requirements. The default is true for vector fields." }, "searchable": { "type": "boolean", @@ -7626,7 +7123,7 @@ }, "analyzer": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + "url": "https://learn.microsoft.com/rest/api/searchservice/Language-support" }, "$ref": "#/definitions/LexicalAnalyzerName", "description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", @@ -7634,7 +7131,7 @@ }, "searchAnalyzer": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + "url": "https://learn.microsoft.com/rest/api/searchservice/Language-support" }, "$ref": "#/definitions/LexicalAnalyzerName", "description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields.", @@ -7642,20 +7139,12 @@ }, "indexAnalyzer": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + "url": "https://learn.microsoft.com/rest/api/searchservice/Language-support" }, "$ref": "#/definitions/LexicalAnalyzerName", "description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", "x-nullable": true }, - "normalizer": { - "externalDocs": { - "url": "https://aka.ms/azs-normalizers" - }, - "$ref": "#/definitions/LexicalNormalizerName", - "description": "The name of the normalizer to use for the field. This option can be used only with fields with filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed for the field. Must be null for complex fields.", - "x-nullable": true - }, "dimensions": { "x-ms-client-name": "vectorSearchDimensions", "type": "integer", @@ -7671,9 +7160,15 @@ "x-nullable": true, "description": "The name of the vector search profile that specifies the algorithm and vectorizer to use when searching the vector field." }, + "vectorEncoding": { + "x-ms-client-name": "VectorEncodingFormat", + "$ref": "#/definitions/VectorEncodingFormat", + "description": "The encoding format to interpret the field contents.", + "x-nullable": true + }, "synonymMaps": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Synonym-Map-operations" + "url": "https://learn.microsoft.com/rest/api/searchservice/Synonym-Map-operations" }, "type": "array", "items": { @@ -7694,7 +7189,7 @@ "type" ], "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Index" }, "description": "Represents a field in an index definition, which describes the name, data type, and search behavior of a field." }, @@ -7742,7 +7237,7 @@ "boost" ], "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" }, "description": "Base type for functions that can modify document scores during ranking." }, @@ -7764,7 +7259,7 @@ "distance" ], "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" }, "description": "Defines a function that boosts scores based on distance from a geographic location." }, @@ -7804,7 +7299,7 @@ "freshness" ], "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" }, "description": "Defines a function that boosts scores based on the value of a date-time field." }, @@ -7839,7 +7334,7 @@ "magnitude" ], "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" }, "description": "Defines a function that boosts scores based on the magnitude of a numeric field." }, @@ -7885,7 +7380,7 @@ "tag" ], "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" }, "description": "Defines a function that boosts scores of documents with string values matching a given list of tags." }, @@ -7941,7 +7436,7 @@ "properties": { "name": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" }, "type": "string", "description": "The name of the scoring profile." @@ -7968,7 +7463,7 @@ "name" ], "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" }, "description": "Defines parameters for a search index that influence scoring in search queries." }, @@ -8034,7 +7529,7 @@ "allowedOrigins" ], "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Index" }, "description": "Defines options to control Cross-Origin Resource Sharing (CORS) for an index." }, @@ -8081,7 +7576,7 @@ "properties": { "name": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" }, "type": "string", "description": "The name of the index." @@ -8123,7 +7618,7 @@ }, "description": "The analyzers for the index.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" } }, "tokenizers": { @@ -8133,7 +7628,7 @@ }, "description": "The tokenizers for the index.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" } }, "tokenFilters": { @@ -8143,7 +7638,7 @@ }, "description": "The token filters for the index.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" } }, "charFilters": { @@ -8153,17 +7648,7 @@ }, "description": "The character filters for the index.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" - } - }, - "normalizers": { - "type": "array", - "items": { - "$ref": "#/definitions/LexicalNormalizer" - }, - "description": "The normalizers for the index.", - "externalDocs": { - "url": "https://aka.ms/azs-custom-normalizers" + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" } }, "encryptionKey": { @@ -8178,14 +7663,14 @@ "$ref": "#/definitions/Similarity", "description": "The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.", "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/index-ranking-similarity" + "url": "https://learn.microsoft.com/azure/search/index-ranking-similarity" } }, "semantic": { "$ref": "#/definitions/SemanticSettings", "description": "Defines parameters for a search index that influence semantic capabilities.", "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/semantic-search-overview" + "url": "https://learn.microsoft.com/azure/search/semantic-search-overview" }, "x-ms-client-name": "SemanticSearch", "x-nullable": true @@ -8208,34 +7693,6 @@ ], "description": "Represents a search index definition, which describes the fields and search behavior of an index." }, - "SearchAlias": { - "properties": { - "name": { - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" - }, - "type": "string", - "description": "The name of the alias." - }, - "indexes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The name of the index this alias maps to. Only one index name may be specified." - }, - "@odata.etag": { - "x-ms-client-name": "ETag", - "type": "string", - "description": "The ETag of the alias." - } - }, - "required": [ - "name", - "indexes" - ], - "description": "Represents an index alias, which describes a mapping from the alias name to an index. The alias name can be used in place of the index name for supported operations." - }, "GetIndexStatisticsResult": { "properties": { "documentCount": { @@ -8283,23 +7740,6 @@ ], "description": "Response from a List Indexes request. If successful, it includes the full definitions of all indexes." }, - "ListAliasesResult": { - "properties": { - "value": { - "x-ms-client-name": "Aliases", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/SearchAlias" - }, - "description": "The aliases in the Search service." - } - }, - "required": [ - "value" - ], - "description": "Response from a List Aliases request. If successful, it includes the associated index mappings for all aliases." - }, "SearchIndexerSkillset": { "properties": { "name": { @@ -8349,7 +7789,7 @@ "skills" ], "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-tutorial-blob" }, "description": "A list of skills." }, @@ -8383,14 +7823,6 @@ "x-nullable": false }, "description": "A list of additional projections to perform during indexing." - }, - "identity": { - "$ref": "#/definitions/SearchIndexerDataIdentity", - "x-nullable": true, - "description": "The user-assigned managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." - }, - "parameters": { - "$ref": "#/definitions/SearchIndexerKnowledgeStoreParameters" } }, "required": [ @@ -8398,7 +7830,7 @@ "projections" ], "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/knowledge-store-projection-overview" + "url": "https://learn.microsoft.com/azure/search/knowledge-store-projection-overview" }, "description": "Definition of additional projections to azure blob, table, or files, of enriched data." }, @@ -8674,7 +8106,7 @@ "outputs" ], "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-predefined-skills" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-predefined-skills" }, "description": "Base type for skills." }, @@ -8820,7 +8252,7 @@ "name" ], "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/naming-rules" + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" }, "description": "Output field mapping for a skill." }, @@ -8832,7 +8264,7 @@ } ], "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-conditional" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-conditional" }, "description": "A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output." }, @@ -8861,7 +8293,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-keyphrases" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-keyphrases" }, "description": "A skill that uses text analytics for key phrase extraction." }, @@ -8889,7 +8321,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-ocr" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-ocr" }, "description": "A skill that extracts text from image files." }, @@ -8923,7 +8355,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-image-analysis" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-image-analysis" }, "description": "A skill that analyzes image files. It extracts a rich set of visual features based on the image content." }, @@ -8947,7 +8379,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-language-detection" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-language-detection" }, "description": "A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis." }, @@ -8959,7 +8391,7 @@ } ], "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-shaper" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-shaper" }, "description": "A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields)." }, @@ -8983,7 +8415,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textmerger" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-textmerger" }, "description": "A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part." }, @@ -9020,7 +8452,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-recognition" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-entity-recognition" }, "description": "This skill is deprecated. Use the V3.EntityRecognitionSkill instead.", "x-az-search-deprecated": true @@ -9039,7 +8471,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-sentiment" }, "description": "This skill is deprecated. Use the V3.SentimentSkill instead.", "x-az-search-deprecated": true @@ -9069,7 +8501,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment-v3" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-sentiment-v3" }, "description": "Using the Text Analytics API, evaluates unstructured text and for each record, provides sentiment labels (such as \"negative\", \"neutral\" and \"positive\") based on the highest confidence score found by the service at a sentence and document-level." }, @@ -9101,7 +8533,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-linking-v3" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-entity-linking-v3" }, "description": "Using the Text Analytics API, extracts linked entities from text." }, @@ -9141,7 +8573,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-recognition-v3" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-entity-recognition-v3" }, "description": "Using the Text Analytics API, extracts entities of different types from text." }, @@ -9197,7 +8629,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-pii-detection" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-pii-detection" }, "description": "Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it." }, @@ -9238,7 +8670,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textsplit" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-textsplit" }, "description": "A skill to split a string into chunks of text." }, @@ -9286,7 +8718,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/search/cognitive-search-skill-custom-entity-lookup" + "url": "https://learn.microsoft.com/en-us/azure/search/cognitive-search-skill-custom-entity-lookup" }, "description": "A skill looks for text from a custom, user-defined list of words and phrases." }, @@ -9316,7 +8748,7 @@ "defaultToLanguageCode" ], "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-text-translation" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-text-translation" }, "description": "A skill to translate text from one language to another." }, @@ -9346,7 +8778,7 @@ } }, "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-document-extraction" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-document-extraction" }, "description": "A skill that extracts content from a file within the enrichment pipeline." }, @@ -9355,26 +8787,12 @@ "allOf": [ { "$ref": "#/definitions/SearchIndexerSkill" + }, + { + "$ref": "#/definitions/WebApiParameters" } ], "properties": { - "uri": { - "type": "string", - "description": "The url for the Web API." - }, - "httpHeaders": { - "$ref": "#/definitions/WebApiHttpHeaders", - "description": "The headers required to make the http request." - }, - "httpMethod": { - "type": "string", - "description": "The method for the http request." - }, - "timeout": { - "type": "string", - "format": "duration", - "description": "The desired timeout for the request. Default is 30 seconds." - }, "batchSize": { "type": "integer", "format": "int32", @@ -9386,24 +8804,13 @@ "format": "int32", "x-nullable": true, "description": "If set, the number of parallel calls that can be made to the Web API." - }, - "authResourceId": { - "type": "string", - "x-nullable": true, - "x-ms-format": "arm-id", - "description": "Applies to custom skills that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the custom skill connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token." - }, - "authIdentity": { - "$ref": "#/definitions/SearchIndexerDataIdentity", - "x-nullable": true, - "description": "The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." } }, "required": [ "uri" ], "externalDocs": { - "url": "https://docs.microsoft.com/azure/search/cognitive-search-custom-skill-web-api" + "url": "https://learn.microsoft.com/azure/search/cognitive-search-custom-skill-web-api" }, "description": "A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code." }, @@ -9414,85 +8821,26 @@ }, "description": "A dictionary of http request headers." }, - "AmlSkill": { - "x-ms-client-name": "AzureMachineLearningSkill", - "x-ms-discriminator-value": "#Microsoft.Skills.Custom.AmlSkill", - "allOf": [ - { - "$ref": "#/definitions/SearchIndexerSkill" - } - ], - "properties": { - "uri": { - "x-ms-client-name": "ScoringUri", - "type": "string", - "format": "uri", - "x-nullable": true, - "description": "(Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed." - }, - "key": { - "x-ms-client-name": "AuthenticationKey", - "type": "string", - "x-nullable": true, - "description": "(Required for key authentication) The key for the AML service." - }, - "resourceId": { - "type": "string", - "x-nullable": true, - "description": "(Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}." - }, - "timeout": { - "type": "string", - "format": "duration", - "x-nullable": true, - "description": "(Optional) When specified, indicates the timeout for the http client making the API call." - }, - "region": { - "type": "string", - "x-nullable": true, - "description": "(Optional for token authentication). The region the AML service is deployed in." - }, - "degreeOfParallelism": { - "type": "integer", - "format": "int32", - "x-nullable": true, - "description": "(Optional) When specified, indicates the number of calls the indexer will make in parallel to the endpoint you have provided. You can decrease this value if your endpoint is failing under too high of a request load, or raise it if your endpoint is able to accept more requests and you would like an increase in the performance of the indexer. If not set, a default value of 5 is used. The degreeOfParallelism can be set to a maximum of 10 and a minimum of 1." - } - }, - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/search/cognitive-search-aml-skill" - }, - "description": "The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment." - }, "AzureOpenAIEmbeddingSkill": { "x-ms-client-name": "AzureOpenAIEmbeddingSkill", "x-ms-discriminator-value": "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill", "allOf": [ { "$ref": "#/definitions/SearchIndexerSkill" + }, + { + "$ref": "#/definitions/AzureOpenAIParameters" } ], - "type": "object", "properties": { - "resourceUri": { - "type": "string", - "format": "uri", - "description": "The resource URI for your Azure OpenAI resource." - }, - "deploymentId": { - "type": "string", - "description": "ID of your Azure OpenAI model deployment on the designated resource." - }, - "apiKey": { - "type": "string", - "description": "API key for the designated Azure OpenAI resource." - }, - "authIdentity": { - "$ref": "#/definitions/SearchIndexerDataIdentity", + "dimensions": { + "type": "integer", + "format": "int32", "x-nullable": true, - "description": "The user-assigned managed identity used for outbound connections." + "description": "The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models." } }, + "type": "object", "description": "Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource." }, "ListSkillsetsResult": { @@ -11780,7 +11128,7 @@ "properties": { "name": { "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" }, "type": "string", "description": "The name of the synonym map." @@ -11807,7 +11155,7 @@ "type": "string", "description": "A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.", "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map#SynonymMapFormat" + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Synonym-Map#SynonymMapFormat" } }, "encryptionKey": { @@ -11871,11 +11219,6 @@ "externalDocs": { "url": "https://aka.ms/azure-search-msi" } - }, - "identity": { - "$ref": "#/definitions/SearchIndexerDataIdentity", - "x-nullable": true, - "description": "An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If \"none\" is specified, the value of this property is cleared." } }, "required": [ @@ -11885,24 +11228,6 @@ ], "description": "A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest, such as indexes and synonym maps." }, - "SearchIndexerCache": { - "properties": { - "storageConnectionString": { - "type": "string", - "description": "The connection string to the storage account where the cache data will be persisted." - }, - "enableReprocessing": { - "type": "boolean", - "x-nullable": true, - "description": "Specifies whether incremental reprocessing is enabled." - }, - "identity": { - "$ref": "#/definitions/SearchIndexerDataIdentity", - "x-nullable": true, - "description": "The user-assigned managed identity used for connections to the enrichment cache. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." - } - } - }, "AzureActiveDirectoryApplicationCredentials": { "properties": { "applicationId": { @@ -11938,11 +11263,6 @@ }, "ServiceCounters": { "properties": { - "aliasesCount": { - "x-ms-client-name": "aliasCounter", - "$ref": "#/definitions/ResourceCounter", - "description": "Total number of aliases." - }, "documentCount": { "x-ms-client-name": "documentCounter", "$ref": "#/definitions/ResourceCounter", @@ -11985,7 +11305,6 @@ } }, "required": [ - "aliasesCount", "documentCount", "indexesCount", "indexersCount", @@ -12022,6 +11341,13 @@ "format": "int32", "x-nullable": true, "description": "The maximum number of objects in complex collections allowed per document." + }, + "maxStoragePerIndex": { + "x-ms-client-name": "maxStoragePerIndexInBytes", + "type": "integer", + "format": "int64", + "x-nullable": true, + "description": "The maximum amount of storage in bytes allowed per index." } }, "description": "Represents various service level limits." @@ -12046,31 +11372,93 @@ ], "description": "Represents a resource's usage and quota." }, - "SearchError": { + "SemanticSettings": { + "x-ms-client-name": "SemanticSearch", "properties": { - "code": { + "defaultConfiguration": { + "x-ms-client-name": "defaultConfigurationName", "type": "string", - "readOnly": true, - "description": "One of a server-defined set of error codes." + "description": "Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time." }, - "message": { + "configurations": { + "type": "array", + "items": { + "$ref": "#/definitions/SemanticConfiguration" + }, + "description": "The semantic configurations for the index." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/semantic-search-overview" + }, + "description": "Defines parameters for a search index that influence semantic capabilities." + }, + "SemanticConfiguration": { + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, "type": "string", - "readOnly": true, - "description": "A human-readable representation of the error." + "description": "The name of the semantic configuration.", + "x-nullable": false }, - "details": { + "prioritizedFields": { + "$ref": "#/definitions/PrioritizedFields", + "x-nullable": false, + "description": "Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set." + } + }, + "required": [ + "name", + "prioritizedFields" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/semantic-search-overview" + }, + "description": "Defines a specific configuration to be used in the context of semantic capabilities." + }, + "PrioritizedFields": { + "x-ms-client-name": "SemanticPrioritizedFields", + "properties": { + "titleField": { + "$ref": "#/definitions/SemanticField", + "description": "Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank." + }, + "prioritizedContentFields": { + "x-ms-client-name": "contentFields", "type": "array", "items": { - "$ref": "#/definitions/SearchError" + "$ref": "#/definitions/SemanticField" }, - "readOnly": true, - "description": "An array of details about specific errors that led to this reported error." + "description": "Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long." + }, + "prioritizedKeywordsFields": { + "x-ms-client-name": "keywordsFields", + "type": "array", + "items": { + "$ref": "#/definitions/SemanticField" + }, + "description": "Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/semantic-search-overview" + }, + "description": "Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers." + }, + "SemanticField": { + "properties": { + "fieldName": { + "type": "string", + "description": "", + "x-nullable": false } }, "required": [ - "message" + "fieldName" ], - "description": "Describes an error condition for the API." + "description": "A field that is used as part of the semantic configuration." } }, "parameters": { @@ -12129,23 +11517,6 @@ "x-ms-skip-url-encoding": true, "description": "The endpoint URL of the search service.", "x-ms-parameter-location": "client" - }, - "DisableCacheReprocessingChangeDetectionParameter": { - "name": "disableCacheReprocessingChangeDetection", - "in": "query", - "required": false, - "type": "boolean", - "description": "Disables cache reprocessing change detection.", - "x-ms-parameter-location": "method" - }, - "IgnoreResetRequirementsParameter": { - "name": "ignoreResetRequirements", - "x-ms-client-name": "skipIndexerResetRequirementForCache", - "in": "query", - "required": false, - "type": "boolean", - "description": "Ignores cache reset requirements.", - "x-ms-parameter-location": "method" } } } diff --git a/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json b/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json index 57c2e42ca..ef8c6ffee 100644 --- a/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json +++ b/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json @@ -39,8 +39,8 @@ "tags": [ "sensitivitySettings" ], - "description": "Updates data sensitivity settings for sensitive data discovery", - "operationId": "UpdateSensitivitySettings", + "description": "Create or update data sensitivity settings for sensitive data discovery", + "operationId": "SensitivitySettings_CreateOrUpdate", "parameters": [ { "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" @@ -80,7 +80,7 @@ "sensitivitySettings" ], "description": "Gets data sensitivity settings for sensitive data discovery", - "operationId": "GetSensitivitySettings", + "operationId": "SensitivitySettings_Get", "parameters": [ { "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" diff --git a/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/automations.json b/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/automations.json new file mode 100644 index 000000000..24ed13d90 --- /dev/null +++ b/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/automations.json @@ -0,0 +1,786 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Defender for Cloud", + "description": "API spec for Microsoft.Security (Microsoft Defender for Cloud) resource provider", + "version": "2023-12-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/automations": { + "get": { + "x-ms-examples": { + "List all security automations of a specified subscription": { + "$ref": "./examples/Automations/GetAutomationsSubscription_example.json" + } + }, + "tags": [ + "Automations" + ], + "description": "Lists all the security automations in the specified subscription. Use the 'nextLink' property in the response to get the next page of security automations for the specified subscription.", + "operationId": "Automations_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AutomationList" + } + }, + "default": { + "description": "Error response that describes why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations": { + "get": { + "x-ms-examples": { + "List all security automations of a specified resource group": { + "$ref": "./examples/Automations/GetAutomationsResourceGroup_example.json" + } + }, + "tags": [ + "Automations" + ], + "description": "Lists all the security automations in the specified resource group. Use the 'nextLink' property in the response to get the next page of security automations for the specified resource group.", + "operationId": "Automations_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/AutomationList" + } + }, + "default": { + "description": "Error response that describes why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName}": { + "get": { + "x-ms-examples": { + "Retrieve a security automation": { + "$ref": "./examples/Automations/GetAutomationResourceGroup_example.json" + } + }, + "tags": [ + "Automations" + ], + "description": "Retrieves information about the model of a security automation.", + "operationId": "Automations_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/AutomationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Automation" + } + }, + "default": { + "description": "Error response that describes why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update a security automation for all assessments (including all severities)": { + "$ref": "./examples/Automations/PutAutomationAllAssessments_example.json" + }, + "Create or update a security automation for all high severity assessments": { + "$ref": "./examples/Automations/PutAutomationHighSeverityAssessments_example.json" + }, + "Disable or enable a security automation": { + "$ref": "./examples/Automations/PutDisableAutomation_example.json" + } + }, + "tags": [ + "Automations" + ], + "description": "Creates or updates a security automation. If a security automation is already created and a subsequent request is issued for the same automation id, then it will be updated.", + "operationId": "Automations_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AutomationName" + }, + { + "$ref": "#/parameters/AutomationInBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Automation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Automation" + } + }, + "default": { + "description": "Error response that describes why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "x-ms-examples": { + "Update a security automation": { + "$ref": "./examples/Automations/PatchAutomation_example.json" + } + }, + "tags": [ + "Automations" + ], + "description": "Updates a security automation", + "operationId": "Automations_Update", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AutomationName" + }, + { + "$ref": "#/parameters/AutomationUpdateInBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Automation" + } + }, + "default": { + "description": "Error response that describes why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a security automation": { + "$ref": "./examples/Automations/DeleteAutomation_example.json" + } + }, + "tags": [ + "Automations" + ], + "operationId": "Automations_Delete", + "description": "Deletes a security automation.", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AutomationName" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "200": { + "description": "Automation deleted" + }, + "default": { + "description": "Error response that describes why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName}/validate": { + "post": { + "x-ms-examples": { + "Validate the security automation model before create or update": { + "$ref": "./examples/Automations/ValidateAutomation_example.json" + } + }, + "tags": [ + "Automations" + ], + "description": "Validates the security automation model before create or update. Any validation errors are returned to the client.", + "operationId": "Automations_Validate", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AutomationName" + }, + { + "$ref": "#/parameters/AutomationInBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AutomationValidationStatus" + } + }, + "default": { + "description": "Error response that describes why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "AutomationList": { + "type": "object", + "description": "List of security automations response.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "The list of security automations under the given scope.", + "items": { + "$ref": "#/definitions/Automation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "Automation": { + "type": "object", + "description": "The security automation resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Security automation data", + "$ref": "#/definitions/AutomationProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/TrackedResource" + } + ] + }, + "AutomationUpdateModel": { + "type": "object", + "description": "The update model of security automation resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Security automation data", + "$ref": "#/definitions/AutomationProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Tags" + } + ] + }, + "AutomationProperties": { + "type": "object", + "description": "A set of properties that defines the behavior of the automation configuration. To learn more about the supported security events data models schemas - please visit https://aka.ms/ASCAutomationSchemas.", + "properties": { + "description": { + "type": "string", + "description": "The security automation description." + }, + "isEnabled": { + "type": "boolean", + "description": "Indicates whether the security automation is enabled." + }, + "scopes": { + "type": "array", + "description": "A collection of scopes on which the security automations logic is applied. Supported scopes are the subscription itself or a resource group under that subscription. The automation will only apply on defined scopes.", + "items": { + "$ref": "#/definitions/AutomationScope" + }, + "x-ms-identifiers": [] + }, + "sources": { + "type": "array", + "description": "A collection of the source event types which evaluate the security automation set of rules.", + "items": { + "$ref": "#/definitions/AutomationSource" + }, + "x-ms-identifiers": [] + }, + "actions": { + "type": "array", + "description": "A collection of the actions which are triggered if all the configured rules evaluations, within at least one rule set, are true.", + "items": { + "$ref": "#/definitions/AutomationAction" + }, + "x-ms-identifiers": [] + } + } + }, + "AutomationSource": { + "type": "object", + "description": "The source event types which evaluate the security automation set of rules. For example - security alerts and security assessments. To learn more about the supported security events data models schemas - please visit https://aka.ms/ASCAutomationSchemas.", + "properties": { + "eventSource": { + "type": "string", + "description": "A valid event source type.", + "enum": [ + "Assessments", + "AssessmentsSnapshot", + "SubAssessments", + "SubAssessmentsSnapshot", + "Alerts", + "SecureScores", + "SecureScoresSnapshot", + "SecureScoreControls", + "SecureScoreControlsSnapshot", + "RegulatoryComplianceAssessment", + "RegulatoryComplianceAssessmentSnapshot", + "AttackPaths", + "AttackPathsSnapshot" + ], + "x-ms-enum": { + "name": "EventSource", + "modelAsString": true, + "values": [ + { + "value": "Assessments" + }, + { + "value": "AssessmentsSnapshot" + }, + { + "value": "SubAssessments" + }, + { + "value": "SubAssessmentsSnapshot" + }, + { + "value": "Alerts" + }, + { + "value": "SecureScores" + }, + { + "value": "SecureScoresSnapshot" + }, + { + "value": "SecureScoreControls" + }, + { + "value": "SecureScoreControlsSnapshot" + }, + { + "value": "RegulatoryComplianceAssessment" + }, + { + "value": "RegulatoryComplianceAssessmentSnapshot" + }, + { + "value": "AttackPaths" + }, + { + "value": "AttackPathsSnapshot" + } + ] + } + }, + "ruleSets": { + "type": "array", + "description": "A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or').", + "items": { + "$ref": "#/definitions/AutomationRuleSet" + }, + "x-ms-identifiers": [] + } + } + }, + "AutomationScope": { + "type": "object", + "description": "A single automation scope.", + "properties": { + "description": { + "type": "string", + "description": "The resources scope description." + }, + "scopePath": { + "type": "string", + "description": "The resources scope path. Can be the subscription on which the automation is defined on or a resource group under that subscription (fully qualified Azure resource IDs)." + } + } + }, + "AutomationAction": { + "type": "object", + "description": "The action that should be triggered.", + "discriminator": "actionType", + "required": [ + "actionType" + ], + "properties": { + "actionType": { + "type": "string", + "description": "The type of the action that will be triggered by the Automation", + "enum": [ + "LogicApp", + "EventHub", + "Workspace" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true, + "values": [ + { + "value": "LogicApp" + }, + { + "value": "EventHub" + }, + { + "value": "Workspace" + } + ] + } + } + } + }, + "AutomationActionLogicApp": { + "type": "object", + "description": "The logic app action that should be triggered. To learn more about Microsoft Defender for Cloud's Workflow Automation capabilities, visit https://aka.ms/ASCWorkflowAutomationLearnMore", + "x-ms-discriminator-value": "LogicApp", + "allOf": [ + { + "readOnly": true, + "$ref": "#/definitions/AutomationAction" + } + ], + "properties": { + "logicAppResourceId": { + "type": "string", + "description": "The triggered Logic App Azure Resource ID. This can also reside on other subscriptions, given that you have permissions to trigger the Logic App" + }, + "uri": { + "type": "string", + "description": "The Logic App trigger URI endpoint (it will not be included in any response).", + "format": "uri" + } + } + }, + "AutomationActionEventHub": { + "type": "object", + "description": "The target Event Hub to which event data will be exported. To learn more about Microsoft Defender for Cloud continuous export capabilities, visit https://aka.ms/ASCExportLearnMore", + "x-ms-discriminator-value": "EventHub", + "allOf": [ + { + "$ref": "#/definitions/AutomationAction" + } + ], + "properties": { + "eventHubResourceId": { + "type": "string", + "description": "The target Event Hub Azure Resource ID." + }, + "sasPolicyName": { + "readOnly": true, + "type": "string", + "description": "The target Event Hub SAS policy name." + }, + "connectionString": { + "type": "string", + "description": "The target Event Hub connection string (it will not be included in any response)." + }, + "isTrustedServiceEnabled": { + "type": "boolean", + "description": "Indicates whether the trusted service is enabled or not." + } + } + }, + "AutomationActionWorkspace": { + "type": "object", + "description": "The Log Analytics Workspace to which event data will be exported. Security alerts data will reside in the 'SecurityAlert' table and the assessments data will reside in the 'SecurityRecommendation' table (under the 'Security'/'SecurityCenterFree' solutions). Note that in order to view the data in the workspace, the Security Center Log Analytics free/standard solution needs to be enabled on that workspace. To learn more about Microsoft Defender for Cloud continuous export capabilities, visit https://aka.ms/ASCExportLearnMore", + "x-ms-discriminator-value": "Workspace", + "allOf": [ + { + "$ref": "#/definitions/AutomationAction" + } + ], + "properties": { + "workspaceResourceId": { + "type": "string", + "description": "The fully qualified Log Analytics Workspace Azure Resource ID." + } + } + }, + "AutomationRuleSet": { + "type": "object", + "description": "A rule set which evaluates all its rules upon an event interception. Only when all the included rules in the rule set will be evaluated as 'true', will the event trigger the defined actions. ", + "properties": { + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/AutomationTriggeringRule" + }, + "x-ms-identifiers": [] + } + } + }, + "AutomationTriggeringRule": { + "type": "object", + "description": "A rule which is evaluated upon event interception. The rule is configured by comparing a specific value from the event model to an expected value. This comparison is done by using one of the supported operators set.", + "properties": { + "propertyJPath": { + "type": "string", + "description": "The JPath of the entity model property that should be checked." + }, + "propertyType": { + "type": "string", + "description": "The data type of the compared operands (string, integer, floating point number or a boolean [true/false]]", + "enum": [ + "String", + "Integer", + "Number", + "Boolean" + ], + "x-ms-enum": { + "name": "PropertyType", + "modelAsString": true, + "values": [ + { + "value": "String" + }, + { + "value": "Integer" + }, + { + "value": "Number" + }, + { + "value": "Boolean" + } + ] + } + }, + "expectedValue": { + "type": "string", + "description": "The expected value." + }, + "operator": { + "type": "string", + "description": "A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType.", + "enum": [ + "Equals", + "GreaterThan", + "GreaterThanOrEqualTo", + "LesserThan", + "LesserThanOrEqualTo", + "NotEquals", + "Contains", + "StartsWith", + "EndsWith" + ], + "x-ms-enum": { + "name": "Operator", + "modelAsString": true, + "values": [ + { + "value": "Equals", + "description": "Applies for decimal and non-decimal operands" + }, + { + "value": "GreaterThan", + "description": "Applies only for decimal operands" + }, + { + "value": "GreaterThanOrEqualTo", + "description": "Applies only for decimal operands" + }, + { + "value": "LesserThan", + "description": "Applies only for decimal operands" + }, + { + "value": "LesserThanOrEqualTo", + "description": "Applies only for decimal operands" + }, + { + "value": "NotEquals", + "description": "Applies for decimal and non-decimal operands" + }, + { + "value": "Contains", + "description": "Applies only for non-decimal operands" + }, + { + "value": "StartsWith", + "description": "Applies only for non-decimal operands" + }, + { + "value": "EndsWith", + "description": "Applies only for non-decimal operands" + } + ] + } + } + } + }, + "AutomationValidationStatus": { + "type": "object", + "description": "The security automation model state property bag.", + "properties": { + "isValid": { + "type": "boolean", + "description": "Indicates whether the model is valid or not." + }, + "message": { + "type": "string", + "description": "The validation message." + } + } + } + }, + "parameters": { + "AutomationName": { + "name": "automationName", + "in": "path", + "required": true, + "type": "string", + "description": "The security automation name.", + "x-ms-parameter-location": "method" + }, + "AutomationInBody": { + "name": "Automation", + "in": "body", + "required": true, + "description": "The security automation resource", + "schema": { + "$ref": "#/definitions/Automation" + }, + "x-ms-parameter-location": "method" + }, + "AutomationUpdateInBody": { + "name": "Automation", + "in": "body", + "required": true, + "description": "The update model of security automation resource", + "schema": { + "$ref": "#/definitions/AutomationUpdateModel" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/securityContacts.json b/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/securityContacts.json new file mode 100644 index 000000000..4e06c8f23 --- /dev/null +++ b/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/securityContacts.json @@ -0,0 +1,504 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Defender for Cloud", + "description": "API spec for Microsoft.Security (Microsoft Defender for Cloud) resource provider", + "version": "2023-12-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": { + "List security contact data": { + "$ref": "./examples/SecurityContacts/GetSecurityContactsSubscription_example.json" + } + }, + "tags": [ + "Security Contacts" + ], + "description": "List all 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 a security contact": { + "$ref": "./examples/SecurityContacts/GetSecurityContact_example.json" + } + }, + "tags": [ + "Security Contacts" + ], + "description": "Get Default 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": { + "$ref": "./examples/SecurityContacts/CreateSecurityContact_example.json" + } + }, + "tags": [ + "Security Contacts" + ], + "description": "Create 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": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SecurityContact" + } + }, + "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": { + "Deletes a security contact data": { + "$ref": "./examples/SecurityContacts/DeleteSecurityContact_example.json" + } + }, + "tags": [ + "Security Contacts" + ], + "description": "Delete 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": { + "200": { + "description": "Security contact deleted" + }, + "204": { + "description": "Security contact was not found" + }, + "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", + "required": [ + "value" + ], + "properties": { + "value": { + "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 and configurations for notifications coming from Microsoft Defender for Cloud.", + "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": { + "emails": { + "type": "string", + "description": "List of email addresses which will get notifications from Microsoft Defender for Cloud by the configurations defined in this security contact." + }, + "phone": { + "type": "string", + "description": "The security contact's phone number" + }, + "isEnabled": { + "type": "boolean", + "description": "Indicates whether the security contact is enabled." + }, + "notificationsSources": { + "type": "array", + "description": "A collection of sources types which evaluate the email notification.", + "items": { + "$ref": "#/definitions/NotificationsSource" + }, + "x-ms-identifiers": [] + }, + "notificationsByRole": { + "type": "object", + "description": "Defines whether to send email notifications from Microsoft Defender for Cloud to persons with specific RBAC roles on the subscription.", + "properties": { + "state": { + "type": "string", + "description": "Defines whether to send email notifications from AMicrosoft Defender for Cloud to persons with specific RBAC roles on the subscription.", + "enum": [ + "On", + "Off" + ], + "x-ms-enum": { + "name": "state", + "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" + } + ] + } + }, + "roles": { + "type": "array", + "description": "Defines which RBAC roles will get email notifications from Microsoft Defender for Cloud. List of allowed RBAC roles: ", + "items": { + "$ref": "#/definitions/SecurityContactRole" + } + } + } + } + } + }, + "NotificationsSource": { + "type": "object", + "description": "A valid notification source type", + "discriminator": "sourceType", + "required": [ + "sourceType" + ], + "properties": { + "sourceType": { + "type": "string", + "description": "The source type that will trigger the notification", + "enum": [ + "Alert", + "AttackPath" + ], + "x-ms-enum": { + "name": "sourceType", + "modelAsString": true + } + } + } + }, + "NotificationsSourceAlert": { + "type": "object", + "description": "Alert notification source", + "x-ms-discriminator-value": "Alert", + "allOf": [ + { + "$ref": "#/definitions/NotificationsSource" + } + ], + "properties": { + "minimalSeverity": { + "type": "object", + "$ref": "#/definitions/MinimalSeverity", + "description": "" + } + } + }, + "MinimalSeverity": { + "type": "string", + "description": "Defines the minimal alert severity which will be sent as email notifications", + "enum": [ + "High", + "Medium", + "Low" + ], + "x-ms-enum": { + "name": "minimalSeverity", + "modelAsString": true, + "values": [ + { + "value": "High", + "description": "Get notifications on new alerts with High severity" + }, + { + "value": "Medium", + "description": "Get notifications on new alerts with Medium or High severity" + }, + { + "value": "Low", + "description": "Get notifications on new alerts with Low, Medium or High severity" + } + ] + } + }, + "NotificationsSourceAttackPath": { + "type": "object", + "description": "Attack path notification source", + "x-ms-discriminator-value": "AttackPath", + "allOf": [ + { + "$ref": "#/definitions/NotificationsSource" + } + ], + "properties": { + "minimalRiskLevel": { + "type": "object", + "$ref": "#/definitions/MinimalRiskLevel", + "description": "Defines the minimal attach path risk level which will be sent as email notifications" + } + } + }, + "MinimalRiskLevel": { + "type": "string", + "description": "Defines the minimal attack path risk level which will be sent as email notifications", + "enum": [ + "Critical", + "High", + "Medium", + "Low" + ], + "x-ms-enum": { + "name": "minimalRiskLevel", + "modelAsString": true, + "values": [ + { + "value": "Critical", + "description": "Get notifications on new attack paths with Critical risk level" + }, + { + "value": "High", + "description": "Get notifications on new attack paths with High or Critical risk level" + }, + { + "value": "Medium", + "description": "Get notifications on new attach paths with Medium, High or Critical risk level" + }, + { + "value": "Low", + "description": "Get notifications on new attach paths with Low, Medium, High or Critical risk level" + } + ] + } + }, + "State": { + "type": "string", + "description": "Defines if email notifications will be sent about new security events", + "enum": [ + "On", + "Off" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true, + "values": [ + { + "value": "On", + "description": "Get notifications on new events" + }, + { + "value": "Off", + "description": "Don't get notifications on new events" + } + ] + } + }, + "SecurityContactRole": { + "type": "string", + "description": "A possible role to configure sending security notification alerts to", + "enum": [ + "AccountAdmin", + "ServiceAdmin", + "Owner", + "Contributor" + ], + "x-ms-enum": { + "name": "securityContactRole", + "modelAsString": true, + "values": [ + { + "value": "AccountAdmin", + "description": "If enabled, send notification on new alerts to the account admins" + }, + { + "value": "ServiceAdmin", + "description": "If enabled, send notification on new alerts to the service admins" + }, + { + "value": "Owner", + "description": "If enabled, send notification on new alerts to the subscription owners" + }, + { + "value": "Contributor", + "description": "If enabled, send notification on new alerts to the subscription contributors" + } + ] + } + } + }, + "parameters": { + "SecurityContactName": { + "name": "securityContactName", + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "securityContactName", + "modelAsString": true, + "values": [ + { + "value": "default", + "description": "The single applicable name of the security contact object" + } + ] + }, + "in": "path", + "required": true, + "pattern": "^(default)$", + "minLength": 7, + "maxLength": 7, + "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" + } + } +} diff --git a/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-10-01-preview/securityConnectors.json b/swagger-specs/security/resource-manager/Microsoft.Security/preview/2024-03-01-preview/securityConnectors.json similarity index 81% rename from swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-10-01-preview/securityConnectors.json rename to swagger-specs/security/resource-manager/Microsoft.Security/preview/2024-03-01-preview/securityConnectors.json index 5b9380bd3..680adddde 100644 --- a/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-10-01-preview/securityConnectors.json +++ b/swagger-specs/security/resource-manager/Microsoft.Security/preview/2024-03-01-preview/securityConnectors.json @@ -3,7 +3,7 @@ "info": { "title": "Security Center", "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2023-10-01-preview" + "version": "2024-03-01-preview" }, "host": "management.azure.com", "schemes": [ @@ -676,7 +676,6 @@ "DefenderForContainersAws", "DefenderForServersAws", "DefenderForDatabasesAws", - "InformationProtectionAws", "CspmMonitorGcp", "CspmMonitorGithub", "CspmMonitorAzureDevOps", @@ -685,10 +684,7 @@ "DefenderForDatabasesGcp", "DefenderCspmAws", "DefenderCspmGcp", - "DefenderForDevOpsGithub", - "DefenderForDevOpsAzureDevOps", - "CspmMonitorGitLab", - "DefenderForDevOpsGitLab" + "CspmMonitorGitLab" ], "x-ms-enum": { "name": "offeringType", @@ -744,9 +740,9 @@ } } }, - "kubernetesScubaReader": { + "kubernetesDataCollection": { "type": "object", - "description": "The kubernetes to scuba connection configuration", + "description": "The kubernetes data collection connection configuration", "properties": { "cloudRoleArn": { "type": "string", @@ -774,40 +770,24 @@ } } }, - "containerVulnerabilityAssessment": { - "type": "object", - "description": "The container vulnerability assessment configuration", - "properties": { - "cloudRoleArn": { - "type": "string", - "description": "The cloud role ARN in AWS for this feature" - } - } - }, - "containerVulnerabilityAssessmentTask": { - "type": "object", - "description": "The container vulnerability assessment task configuration", - "properties": { - "cloudRoleArn": { - "type": "string", - "description": "The cloud role ARN in AWS for this feature" - } - } + "enableAuditLogsAutoProvisioning": { + "type": "boolean", + "description": "Is audit logs data collection enabled" }, - "enableContainerVulnerabilityAssessment": { + "enableDefenderAgentAutoProvisioning": { "type": "boolean", - "description": "Enable container vulnerability assessment feature" + "description": "Is Microsoft Defender for Cloud Kubernetes agent auto provisioning enabled" }, - "autoProvisioning": { + "enablePolicyAgentAutoProvisioning": { "type": "boolean", - "description": "Is audit logs pipeline auto provisioning enabled" + "description": "Is Policy Kubernetes agent auto provisioning enabled" }, "kubeAuditRetentionTime": { "type": "integer", "format": "int64", "description": "The retention time in days of kube audit logs set on the CloudWatch log group" }, - "scubaExternalId": { + "dataCollectionExternalId": { "type": "string", "description": "The externalId used by the data reader to prevent the confused deputy attack" }, @@ -838,6 +818,16 @@ "description": "The cloud role ARN in AWS for this feature" } } + }, + "vmScanners": { + "type": "object", + "description": "The Microsoft Defender for Container K8s VM host scanning configuration", + "allOf": [ + { + "$ref": "#/definitions/vmScannersAws" + } + ], + "properties": {} } } }, @@ -864,30 +854,12 @@ "arcAutoProvisioning": { "type": "object", "description": "The ARC autoprovisioning configuration", - "properties": { - "enabled": { - "type": "boolean", - "description": "Is arc auto provisioning enabled" - }, - "cloudRoleArn": { - "type": "string", - "description": "The cloud role ARN in AWS for this feature" - }, - "configuration": { - "type": "object", - "description": "Configuration for servers Arc auto provisioning", - "properties": { - "proxy": { - "type": "string", - "description": "Optional HTTP proxy endpoint to use for the Arc agent" - }, - "privateLinkScope": { - "type": "string", - "description": "Optional Arc private link scope resource id to link the Arc agent" - } - } + "allOf": [ + { + "$ref": "#/definitions/arcAutoProvisioningAws" } - } + ], + "properties": {} }, "vaAutoProvisioning": { "type": "object", @@ -953,40 +925,12 @@ "vmScanners": { "type": "object", "description": "The Microsoft Defender for Server VM scanning configuration", - "properties": { - "enabled": { - "type": "boolean", - "description": "Is Microsoft Defender for Server VM scanning enabled" - }, - "configuration": { - "type": "object", - "description": "configuration for Microsoft Defender for Server VM scanning", - "properties": { - "cloudRoleArn": { - "type": "string", - "description": "The cloud role ARN in AWS for this feature" - }, - "scanningMode": { - "type": "string", - "description": "The scanning mode for the VM scan.", - "enum": [ - "Default" - ], - "x-ms-enum": { - "name": "scanningMode", - "modelAsString": true - } - }, - "exclusionTags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "VM tags that indicates that VM should not be scanned" - } - } + "allOf": [ + { + "$ref": "#/definitions/vmScannersAws" } - } + ], + "properties": {} } } }, @@ -1003,30 +947,12 @@ "arcAutoProvisioning": { "type": "object", "description": "The ARC autoprovisioning configuration", - "properties": { - "enabled": { - "type": "boolean", - "description": "Is arc auto provisioning enabled" - }, - "cloudRoleArn": { - "type": "string", - "description": "The cloud role ARN in AWS for this feature" - }, - "configuration": { - "type": "object", - "description": "Configuration for servers Arc auto provisioning", - "properties": { - "proxy": { - "type": "string", - "description": "Optional http proxy endpoint to use for the Arc agent" - }, - "privateLinkScope": { - "type": "string", - "description": "Optional Arc private link scope resource id to link the Arc agent" - } - } + "allOf": [ + { + "$ref": "#/definitions/arcAutoProvisioningAws" } - } + ], + "properties": {} }, "rds": { "type": "object", @@ -1058,28 +984,6 @@ } } }, - "informationProtectionAwsOffering": { - "type": "object", - "description": "The information protection for AWS offering", - "x-ms-discriminator-value": "InformationProtectionAws", - "allOf": [ - { - "$ref": "#/definitions/cloudOffering" - } - ], - "properties": { - "informationProtection": { - "type": "object", - "description": "The native cloud connection configuration", - "properties": { - "cloudRoleArn": { - "type": "string", - "description": "The cloud role ARN in AWS for this feature" - } - } - } - } - }, "cspmMonitorGcpOffering": { "type": "object", "description": "The CSPM monitoring for GCP offering", @@ -1133,26 +1037,12 @@ "arcAutoProvisioning": { "type": "object", "description": "The ARC autoprovisioning configuration", - "properties": { - "enabled": { - "type": "boolean", - "description": "Is arc auto provisioning enabled" - }, - "configuration": { - "type": "object", - "description": "Configuration for servers Arc auto provisioning", - "properties": { - "proxy": { - "type": "string", - "description": "Optional HTTP proxy endpoint to use for the Arc agent" - }, - "privateLinkScope": { - "type": "string", - "description": "Optional Arc private link scope resource id to link the Arc agent" - } - } + "allOf": [ + { + "$ref": "#/definitions/arcAutoProvisioningGcp" } - } + ], + "properties": {} }, "vaAutoProvisioning": { "type": "object", @@ -1218,36 +1108,12 @@ "vmScanners": { "type": "object", "description": "The Microsoft Defender for Server VM scanning configuration", - "properties": { - "enabled": { - "type": "boolean", - "description": "Is Microsoft Defender for Server VM scanning enabled" - }, - "configuration": { - "type": "object", - "description": "configuration for Microsoft Defender for Server VM scanning", - "properties": { - "scanningMode": { - "type": "string", - "description": "The scanning mode for the VM scan.", - "enum": [ - "Default" - ], - "x-ms-enum": { - "name": "scanningMode", - "modelAsString": true - } - }, - "exclusionTags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "VM tags that indicate that VM should not be scanned" - } - } + "allOf": [ + { + "$ref": "#/definitions/vmScannersGcp" } - } + ], + "properties": {} } } }, @@ -1264,26 +1130,12 @@ "arcAutoProvisioning": { "type": "object", "description": "The ARC autoprovisioning configuration", - "properties": { - "enabled": { - "type": "boolean", - "description": "Is arc auto provisioning enabled" - }, - "configuration": { - "type": "object", - "description": "Configuration for servers Arc auto provisioning", - "properties": { - "proxy": { - "type": "string", - "description": "Optional http proxy endpoint to use for the Arc agent" - }, - "privateLinkScope": { - "type": "string", - "description": "Optional Arc private link scope resource id to link the Arc agent" - } - } + "allOf": [ + { + "$ref": "#/definitions/arcAutoProvisioningGcp" } - } + ], + "properties": {} }, "defenderForDatabasesArcAutoProvisioning": { "type": "object", @@ -1339,15 +1191,15 @@ } } }, - "auditLogsAutoProvisioningFlag": { + "enableAuditLogsAutoProvisioning": { "type": "boolean", "description": "Is audit logs data collection enabled" }, - "defenderAgentAutoProvisioningFlag": { + "enableDefenderAgentAutoProvisioning": { "type": "boolean", "description": "Is Microsoft Defender for Cloud Kubernetes agent auto provisioning enabled" }, - "policyAgentAutoProvisioningFlag": { + "enablePolicyAgentAutoProvisioning": { "type": "boolean", "description": "Is Policy Kubernetes agent auto provisioning enabled" }, @@ -1386,6 +1238,16 @@ "description": "The service account email address in GCP for this feature" } } + }, + "vmScanners": { + "type": "object", + "description": "The Microsoft Defender for Container K8s VM host scanning configuration", + "allOf": [ + { + "$ref": "#/definitions/vmScannersGcp" + } + ], + "properties": {} } } }, @@ -1423,41 +1285,13 @@ "properties": { "vmScanners": { "type": "object", - "description": "The Microsoft Defender for Server VM scanning configuration", - "properties": { - "enabled": { - "type": "boolean", - "description": "Is Microsoft Defender for Server VM scanning enabled" - }, - "configuration": { - "type": "object", - "description": "configuration for Microsoft Defender for Server VM scanning", - "properties": { - "cloudRoleArn": { - "type": "string", - "description": "The cloud role ARN in AWS for this feature" - }, - "scanningMode": { - "type": "string", - "description": "The scanning mode for the VM scan.", - "enum": [ - "Default" - ], - "x-ms-enum": { - "name": "scanningMode", - "modelAsString": true - } - }, - "exclusionTags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "VM tags that indicates that VM should not be scanned" - } - } + "description": "The Microsoft Defender for CSPM offering VM scanning configuration", + "allOf": [ + { + "$ref": "#/definitions/vmScannersAws" } - } + ], + "properties": {} }, "dataSensitivityDiscovery": { "type": "object", @@ -1489,25 +1323,25 @@ }, "ciem": { "type": "object", - "description": "Defenders CSPM Cloud infrastructure entitlement management (CIEM) offering configurations", + "description": "Defenders CSPM Permissions Management offering configurations", "properties": { "ciemDiscovery": { "type": "object", - "description": "Defender CSPM CIEM discovery configuration", + "description": "Defender CSPM Permissions Management discovery configuration", "properties": { "cloudRoleArn": { "type": "string", - "description": "The cloud role ARN in AWS for CIEM discovery" + "description": "The cloud role ARN in AWS for Permissions Management discovery" } } }, "ciemOidc": { "type": "object", - "description": "Defender CSPM CIEM AWS OIDC (open id connect) configuration", + "description": "AWS Defender CSPM Permissions Management OIDC (open id connect) connection configurations", "properties": { "cloudRoleArn": { "type": "string", - "description": "The cloud role ARN in AWS for CIEM oidc connection" + "description": "The cloud role ARN in AWS for Permissions Management used for oidc connection" }, "azureActiveDirectoryAppName": { "type": "string", @@ -1559,15 +1393,15 @@ "properties": { "ciemDiscovery": { "type": "object", - "description": "GCP Defenders CSPM Cloud infrastructure entitlement management (CIEM) discovery offering configurations", + "description": "GCP Defenders CSPM Permissions Management OIDC (Open ID connect) connection configurations", "properties": { "workloadIdentityProviderId": { "type": "string", - "description": "The GCP workload identity provider id for CIEM discovery offering" + "description": "The GCP workload identity provider id for Permissions Management offering" }, "serviceAccountEmailAddress": { "type": "string", - "description": "The service account email address in GCP for CIEM discovery offering" + "description": "The service account email address in GCP for Permissions Management offering" }, "azureActiveDirectoryAppName": { "type": "string", @@ -1577,37 +1411,13 @@ }, "vmScanners": { "type": "object", - "description": "The Microsoft Defender for Server VM scanning configuration", - "properties": { - "enabled": { - "type": "boolean", - "description": "Is Microsoft Defender for Server VM scanning enabled" - }, - "configuration": { - "type": "object", - "description": "configuration for Microsoft Defender for Server VM scanning", - "properties": { - "scanningMode": { - "type": "string", - "description": "The scanning mode for the VM scan.", - "enum": [ - "Default" - ], - "x-ms-enum": { - "name": "scanningMode", - "modelAsString": true - } - }, - "exclusionTags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "VM tags that indicates that VM should not be scanned" - } - } + "description": "The Microsoft Defender for CSPM VM scanning configuration", + "allOf": [ + { + "$ref": "#/definitions/vmScannersGcp" } - } + ], + "properties": {} }, "dataSensitivityDiscovery": { "type": "object", @@ -1665,10 +1475,10 @@ } } }, - "defenderForDevOpsGithubOffering": { + "cspmMonitorGitLabOffering": { "type": "object", - "description": "The Defender for DevOps for Github offering", - "x-ms-discriminator-value": "DefenderForDevOpsGithub", + "description": "The CSPM (Cloud security posture management) monitoring for gitlab offering", + "x-ms-discriminator-value": "CspmMonitorGitLab", "allOf": [ { "$ref": "#/definitions/cloudOffering" @@ -1676,38 +1486,113 @@ ], "properties": {} }, - "defenderForDevOpsAzureDevOpsOffering": { + "vmScannersBase": { + "type": "object", + "description": "A VM scanning configuration for a security offering of a given environment", + "properties": { + "enabled": { + "type": "boolean", + "description": "Is VM scanning enabled" + }, + "configuration": { + "type": "object", + "description": "Configuration for VM scanning", + "properties": { + "scanningMode": { + "type": "string", + "description": "The scanning mode for the VM scan.", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "scanningMode", + "modelAsString": true + } + }, + "exclusionTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags that indicates that a resource should not be scanned" + } + } + } + } + }, + "vmScannersGcp": { "type": "object", - "description": "The Defender for DevOps for Azure DevOps offering", - "x-ms-discriminator-value": "DefenderForDevOpsAzureDevOps", + "description": "A VM scanning configuration for a security offering of a GCP environment", + "properties": {}, "allOf": [ { - "$ref": "#/definitions/cloudOffering" + "$ref": "#/definitions/vmScannersBase" } - ], - "properties": {} + ] }, - "cspmMonitorGitLabOffering": { + "vmScannersAws": { "type": "object", - "description": "The CSPM (Cloud security posture management) monitoring for gitlab offering", - "x-ms-discriminator-value": "CspmMonitorGitLab", + "description": "A VM scanning configuration for a security offering of a Aws environment", + "properties": { + "cloudRoleArn": { + "type": "string", + "description": "The cloud role ARN in AWS for this feature" + } + }, "allOf": [ { - "$ref": "#/definitions/cloudOffering" + "$ref": "#/definitions/vmScannersBase" } - ], - "properties": {} + ] + }, + "arcAutoProvisioning": { + "type": "object", + "description": "The ARC autoprovisioning configuration", + "properties": { + "enabled": { + "type": "boolean", + "description": "Is arc auto provisioning enabled" + }, + "configuration": { + "type": "object", + "description": "Configuration for servers Arc auto provisioning for a given environment", + "properties": { + "proxy": { + "type": "string", + "description": "Optional HTTP proxy endpoint to use for the Arc agent" + }, + "privateLinkScope": { + "type": "string", + "description": "Optional Arc private link scope resource id to link the Arc agent" + } + } + } + } }, - "defenderForDevOpsGitLabOffering": { + "arcAutoProvisioningGcp": { "type": "object", - "description": "The Defender for DevOps for Gitlab offering", - "x-ms-discriminator-value": "DefenderForDevOpsGitLab", + "description": "The ARC autoprovisioning configuration for an GCP environment", + "properties": {}, "allOf": [ { - "$ref": "#/definitions/cloudOffering" + "$ref": "#/definitions/arcAutoProvisioning" } - ], - "properties": {} + ] + }, + "arcAutoProvisioningAws": { + "type": "object", + "description": "The ARC autoprovisioning configuration for an AWS environment", + "properties": { + "cloudRoleArn": { + "type": "string", + "description": "The cloud role ARN in AWS for this feature" + } + }, + "allOf": [ + { + "$ref": "#/definitions/arcAutoProvisioning" + } + ] } }, "parameters": { diff --git a/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-09-01-preview/securityConnectorsDevOps.json b/swagger-specs/security/resource-manager/Microsoft.Security/preview/2024-05-15-preview/securityConnectorsDevOps.json similarity index 79% rename from swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-09-01-preview/securityConnectorsDevOps.json rename to swagger-specs/security/resource-manager/Microsoft.Security/preview/2024-05-15-preview/securityConnectorsDevOps.json index a700d20a2..e2e0e66b1 100644 --- a/swagger-specs/security/resource-manager/Microsoft.Security/preview/2023-09-01-preview/securityConnectorsDevOps.json +++ b/swagger-specs/security/resource-manager/Microsoft.Security/preview/2024-05-15-preview/securityConnectorsDevOps.json @@ -3,7 +3,7 @@ "info": { "title": "Microsoft.Security", "description": "REST APIs for Defender for DevOps", - "version": "2023-09-01-preview" + "version": "2024-05-15-preview" }, "host": "management.azure.com", "schemes": [ @@ -876,6 +876,9 @@ "x-ms-examples": { "Get_DevOpsConfigurations": { "$ref": "./examples/SecurityConnectorsDevOps/GetDevOpsConfigurations_example.json" + }, + "Get_DevOpsConfigurations_WithCapabilities": { + "$ref": "./examples/SecurityConnectorsDevOps/GetDevOpsConfigurationsWithCapabilities_example.json" } } }, @@ -1069,6 +1072,390 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/policies": { + "get": { + "tags": [ + "DevOps" + ], + "summary": "Returns a list of DevOps Policies.", + "operationId": "DevOpsPolicies_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SecurityConnectorName" + }, + { + "$ref": "#/parameters/DevOpsPolicyType" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Provides a list of DevOps Policies.", + "schema": { + "$ref": "#/definitions/DevOpsPolicyListResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List_DevOpsPolicies": { + "$ref": "./examples/SecurityConnectorsDevOps/ListDevOpsPolicies_example.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/policies/{policyName}": { + "get": { + "tags": [ + "DevOps" + ], + "summary": "Returns a DevOps Policy.", + "operationId": "DevOpsPolicies_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SecurityConnectorName" + }, + { + "$ref": "#/parameters/PolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Provides DevOps Policy details.", + "schema": { + "$ref": "#/definitions/DevOpsPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get_DevOpsPolicies": { + "$ref": "./examples/SecurityConnectorsDevOps/GetDevOpsPolicies_example.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/policyAssignments": { + "get": { + "tags": [ + "DevOps" + ], + "summary": "Returns a list of DevOps Policy Assignments.", + "operationId": "DevOpsPolicyAssignments_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SecurityConnectorName" + }, + { + "$ref": "#/parameters/DevOpsPolicyType" + }, + { + "$ref": "#/parameters/ResourceId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Provides a list of DevOps Policy Assignments.", + "schema": { + "$ref": "#/definitions/DevOpsPolicyAssignmentListResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List_DevOpsPolicyAssignments": { + "$ref": "./examples/SecurityConnectorsDevOps/ListDevOpsPolicyAssignments_example.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/policyAssignments/{policyAssignmentId}": { + "get": { + "tags": [ + "DevOps" + ], + "summary": "Returns a DevOps Policy Assignment Resource.", + "operationId": "DevOpsPolicyAssignments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SecurityConnectorName" + }, + { + "$ref": "#/parameters/PolicyAssignmentId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Provides DevOps Policy Assignment details.", + "schema": { + "$ref": "#/definitions/DevOpsPolicyAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get_DevOpsPolicyAssignments": { + "$ref": "./examples/SecurityConnectorsDevOps/GetDevOpsPolicyAssignments_example.json" + } + } + }, + "put": { + "tags": [ + "DevOps" + ], + "summary": "Creates or updates a DevOps Policy Assignment Resource.", + "operationId": "DevOpsPolicyAssignments_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SecurityConnectorName" + }, + { + "$ref": "#/parameters/PolicyAssignmentId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "devOpsPolicyAssignment", + "description": "The DevOps Policy Assignment.", + "required": true, + "schema": { + "$ref": "#/definitions/DevOpsPolicyAssignment" + } + } + ], + "responses": { + "200": { + "description": "Creates or updates a DevOps Policy Assignment.", + "schema": { + "$ref": "#/definitions/DevOpsPolicyAssignment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DevOpsPolicyAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "CreateOrUpdate_DevOpsPolicyAssignments": { + "$ref": "./examples/SecurityConnectorsDevOps/CreateOrUpdateDevOpsPolicyAssignments_example.json" + } + } + }, + "patch": { + "tags": [ + "DevOps" + ], + "summary": "Updates a DevOps Policy Assignment Resource.", + "operationId": "DevOpsPolicyAssignments_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SecurityConnectorName" + }, + { + "$ref": "#/parameters/PolicyAssignmentId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "devOpsPolicyAssignment", + "description": "The DevOps Policy Assignment.", + "required": true, + "schema": { + "$ref": "#/definitions/DevOpsPolicyAssignment" + } + } + ], + "responses": { + "200": { + "description": "Updates a DevOps Policy Assignment.", + "schema": { + "$ref": "#/definitions/DevOpsPolicyAssignment" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DevOpsPolicyAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Update_DevOpsPolicyAssignments": { + "$ref": "./examples/SecurityConnectorsDevOps/UpdateDevOpsPolicyAssignments_example.json" + } + } + }, + "delete": { + "tags": [ + "DevOps" + ], + "summary": "Deletes a DevOps Policy Assignment Resource.", + "operationId": "DevOpsPolicyAssignments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SecurityConnectorName" + }, + { + "$ref": "#/parameters/PolicyAssignmentId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete_DevOpsPolicyAssignments": { + "$ref": "./examples/SecurityConnectorsDevOps/DeleteDevOpsPolicyAssignments_example.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/listAvailableGitHubOwners": { "post": { "tags": [ @@ -1772,14 +2159,14 @@ "type": "object", "properties": { "provisioningStatusMessage": { - "description": "Gets or sets resource status message.", + "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", - "description": "Gets or sets time when resource was last checked.", + "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, @@ -1868,14 +2255,14 @@ "type": "object", "properties": { "provisioningStatusMessage": { - "description": "Gets or sets resource status message.", + "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", - "description": "Gets or sets time when resource was last checked.", + "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, @@ -1939,14 +2326,14 @@ "type": "object", "properties": { "provisioningStatusMessage": { - "description": "Gets or sets resource status message.", + "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", - "description": "Gets or sets time when resource was last checked.", + "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, @@ -2006,6 +2393,20 @@ } } }, + "DescendantBehavior": { + "description": "The behavior of a policy on descendant resources.", + "enum": [ + "Unknown", + "Override", + "FallBack" + ], + "type": "string", + "x-ms-enum": { + "name": "DescendantBehavior", + "modelAsString": true, + "modelAsExtensible": true + } + }, "DesiredOnboardingState": { "description": "Onboarding states.", "enum": [ @@ -2019,6 +2420,22 @@ "modelAsExtensible": true } }, + "DevOpsCapability": { + "description": "Details about DevOps capability.", + "type": "object", + "properties": { + "name": { + "description": "Gets the name of the DevOps capability.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Gets the value of the DevOps capability.", + "type": "string", + "readOnly": true + } + } + }, "DevOpsConfiguration": { "description": "DevOps Configuration resource.", "type": "object", @@ -2059,14 +2476,14 @@ "type": "object", "properties": { "provisioningStatusMessage": { - "description": "Gets or sets resource status message.", + "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", - "description": "Gets or sets time when resource was last checked.", + "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, @@ -2085,9 +2502,220 @@ "items": { "type": "string" } + }, + "capabilities": { + "description": "List of capabilities assigned to the DevOps configuration during the discovery process.", + "type": "array", + "items": { + "$ref": "#/definitions/DevOpsCapability" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "DevOpsPolicy": { + "description": "DevOps Policy Resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "properties": { + "$ref": "#/definitions/DevOpsPolicyProperties" + } + } + }, + "DevOpsPolicyAssignment": { + "description": "DevOps Policy assignment resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "properties": { + "$ref": "#/definitions/DevOpsPolicyAssignmentProperties" + } + } + }, + "DevOpsPolicyAssignmentListResponse": { + "description": "List of RP resources which supports pagination.", + "type": "object", + "properties": { + "value": { + "description": "Gets or sets list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DevOpsPolicyAssignment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Gets or sets next link to scroll over the results.", + "type": "string" + } + } + }, + "DevOpsPolicyAssignmentProperties": { + "description": "Properties of the DevOps policy assignment resource.", + "type": "object", + "properties": { + "provisioningStatusMessage": { + "description": "Gets the resource status message.", + "type": "string", + "example": "Resource onboarded successful.", + "readOnly": true + }, + "provisioningStatusUpdateTimeUtc": { + "format": "date-time", + "description": "Gets the time when resource was last checked.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/DevOpsProvisioningState" + }, + "resourceId": { + "description": "Gets or sets the Azure resource id.", + "type": "string", + "format": "arm-id" + }, + "descendantBehavior": { + "$ref": "#/definitions/DescendantBehavior" + }, + "policy": { + "$ref": "#/definitions/DevOpsPolicyDescriptor" + }, + "assignedAt": { + "format": "date-time", + "description": "Gets or sets time when the assignment was created in UTC.", + "type": "string" + } + } + }, + "DevOpsPolicyDescriptor": { + "description": "Condensed information to identify a DevOps Policy resource.", + "type": "object", + "properties": { + "policyName": { + "description": "Gets or sets the policy name.", + "type": "string" + }, + "policyId": { + "description": "Gets or sets the policy GUID.", + "type": "string" + }, + "policyVersion": { + "description": "Gets or sets the version.", + "type": "string" + }, + "policyType": { + "$ref": "#/definitions/DevOpsPolicyType" + } + } + }, + "DevOpsPolicyListResponse": { + "description": "List of RP resources which supports pagination.", + "type": "object", + "properties": { + "value": { + "description": "Gets or sets list of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DevOpsPolicy" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Gets or sets next link to scroll over the results.", + "type": "string" + } + } + }, + "DevOpsPolicyProperties": { + "description": "Policy DevOps Resource properties that contain the full definition of a DevOps policy resource.", + "type": "object", + "properties": { + "provisioningStatusMessage": { + "description": "Gets the resource status message.", + "type": "string", + "example": "Resource onboarded successful.", + "readOnly": true + }, + "provisioningStatusUpdateTimeUtc": { + "format": "date-time", + "description": "Gets the time when resource was last checked.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/DevOpsProvisioningState" + }, + "source": { + "$ref": "#/definitions/DevOpsPolicySource" + }, + "policyId": { + "description": "Gets the policy resource GUID.", + "type": "string", + "readOnly": true, + "format": "uuid" + }, + "webUrl": { + "description": "Gets the web URL.", + "type": "string", + "readOnly": true, + "format": "url" + }, + "version": { + "description": "Gets or sets the semantic version.", + "type": "string" + }, + "type": { + "$ref": "#/definitions/DevOpsPolicyType" + }, + "content": { + "description": "Gets or sets the policy definition content JSON string.", + "type": "string" } } }, + "DevOpsPolicySource": { + "description": "DevOps Policy creation sources.", + "enum": [ + "Unknown", + "BuiltIn", + "UserDefined" + ], + "type": "string", + "x-ms-enum": { + "name": "DevOpsPolicySource", + "modelAsString": true, + "modelAsExtensible": true + } + }, + "DevOpsPolicyType": { + "description": "DevOps Policy resource types.", + "enum": [ + "Unknown", + "Pipeline" + ], + "type": "string", + "x-ms-enum": { + "name": "DevOpsPolicyType", + "modelAsString": true, + "modelAsExtensible": true + } + }, "DevOpsProvisioningState": { "description": "The provisioning state of the resource.\r\n\r\nPending - Provisioning pending.\r\nFailed - Provisioning failed.\r\nSucceeded - Successful provisioning.\r\nCanceled - Provisioning canceled.\r\nPendingDeletion - Deletion pending.\r\nDeletionSuccess - Deletion successful.\r\nDeletionFailure - Deletion failure.", "enum": [ @@ -2104,7 +2732,8 @@ "name": "DevOpsProvisioningState", "modelAsString": true, "modelAsExtensible": true - } + }, + "readOnly": true }, "GitHubOwner": { "description": "GitHub Owner resource.", @@ -2163,14 +2792,14 @@ "type": "object", "properties": { "provisioningStatusMessage": { - "description": "Gets or sets resource status message.", + "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", - "description": "Gets or sets time when resource was last checked.", + "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, @@ -2232,14 +2861,14 @@ "type": "object", "properties": { "provisioningStatusMessage": { - "description": "Gets or sets resource status message.", + "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", - "description": "Gets or sets time when resource was last checked.", + "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, @@ -2332,14 +2961,14 @@ "type": "object", "properties": { "provisioningStatusMessage": { - "description": "Gets or sets resource status message.", + "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", - "description": "Gets or sets time when resource was last checked.", + "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, @@ -2406,14 +3035,14 @@ "type": "object", "properties": { "provisioningStatusMessage": { - "description": "Gets or sets resource status message.", + "description": "Gets the resource status message.", "type": "string", "example": "Resource onboarded successful.", "readOnly": true }, "provisioningStatusUpdateTimeUtc": { "format": "date-time", - "description": "Gets or sets time when resource was last checked.", + "description": "Gets the time when resource was last checked.", "type": "string", "readOnly": true }, @@ -2541,6 +3170,36 @@ "type": "string", "x-ms-parameter-location": "method" }, + "DevOpsPolicyType": { + "in": "query", + "name": "devOpsPolicyType", + "description": "Optional filter for listing the policies.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "PolicyName": { + "in": "path", + "name": "policyName", + "description": "The policy name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceId": { + "in": "query", + "name": "resourceId", + "description": "Optional filter for listing the assignments of a specific resource.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "PolicyAssignmentId": { + "in": "path", + "name": "policyAssignmentId", + "description": "The policy assignment Id.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, "OwnerName": { "in": "path", "name": "ownerName", diff --git a/swagger-specs/security/resource-manager/Microsoft.Security/stable/2023-01-01/pricings.json b/swagger-specs/security/resource-manager/Microsoft.Security/stable/2024-01-01/pricings.json similarity index 59% rename from swagger-specs/security/resource-manager/Microsoft.Security/stable/2023-01-01/pricings.json rename to swagger-specs/security/resource-manager/Microsoft.Security/stable/2024-01-01/pricings.json index fe87c5024..a21cc97ab 100644 --- a/swagger-specs/security/resource-manager/Microsoft.Security/stable/2023-01-01/pricings.json +++ b/swagger-specs/security/resource-manager/Microsoft.Security/stable/2024-01-01/pricings.json @@ -3,7 +3,7 @@ "info": { "title": "Microsoft Defender for Cloud", "description": "API spec for Microsoft.Security (Microsoft Defender for Cloud) resource provider", - "version": "2023-01-01" + "version": "2024-01-01" }, "host": "management.azure.com", "schemes": [ @@ -34,31 +34,49 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings": { + "/{scopeId}/providers/Microsoft.Security/pricings/{pricingName}": { "get": { "x-ms-examples": { - "Get pricings on subscription": { - "$ref": "./examples/Pricings/ListPricings_example.json" + "Get pricings on subscription - VirtualMachines plan": { + "$ref": "./examples/Pricings/GetPricingByNameVirtualMachines_example.json" + }, + "Get pricings on resource - VirtualMachines plan": { + "$ref": "./examples/Pricings/GetResourcePricingByNameVirtualMachines_example.json" + }, + "Get pricings on subscription - Dns plan": { + "$ref": "./examples/Pricings/GetPricingByNameDns_example.json" + }, + "Get pricings on subscription - StorageAccounts plan": { + "$ref": "./examples/Pricings/GetPricingByNameStorageAccounts_example.json" + }, + "Get pricings on subscription - Containers plan": { + "$ref": "./examples/Pricings/GetPricingByNameContainers_example.json" + }, + "Get pricings on subscription - CloudPosture plan": { + "$ref": "./examples/Pricings/GetPricingByNameCloudPosture_example.json" } }, "tags": [ "Pricings" ], - "description": "Lists Microsoft Defender for Cloud pricing configurations in the subscription.", - "operationId": "Pricings_List", + "description": "Get the Defender plans pricing configurations of the selected scope (valid scopes are resource id or a subscription id). At the resource level, supported resource types are 'VirtualMachines, VMSS and ARC Machines'.", + "operationId": "Pricings_Get", "parameters": [ { "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" }, { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + "$ref": "../../../common/v1/types.json#/parameters/ScopeId" + }, + { + "$ref": "#/parameters/PricingName" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PricingList" + "$ref": "#/definitions/Pricing" } }, "default": { @@ -68,46 +86,50 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}": { - "get": { + }, + "put": { "x-ms-examples": { - "Get pricings on subscription - VirtualMachines plan": { - "$ref": "./examples/Pricings/GetPricingByNameVirtualMachines_example.json" - }, - "Get pricings on subscription - Dns plan": { - "$ref": "./examples/Pricings/GetPricingByNameDns_example.json" + "Update pricing on subscription (example for CloudPosture plan)": { + "$ref": "./examples/Pricings/PutPricingByName_example.json" }, - "Get pricings on subscription - StorageAccounts plan": { - "$ref": "./examples/Pricings/GetPricingByNameStorageAccounts_example.json" + "Update pricing on subscription (example for VirtualMachines plan)": { + "$ref": "./examples/Pricings/PutPricingVMsByName_example.json" }, - "Get pricings on subscription - Containers plan": { - "$ref": "./examples/Pricings/GetPricingByNameContainers_example.json" + "Update pricing on resource (example for VirtualMachines plan)": { + "$ref": "./examples/Pricings/PutResourcePricingByNameVirtualMachines_example.json" }, - "Get pricings on subscription - CloudPosture plan": { - "$ref": "./examples/Pricings/GetPricingByNameCloudPosture_example.json" + "Update pricing on subscription (example for CloudPosture plan) - partial success": { + "$ref": "./examples/Pricings/PutPricingByNamePartialSuccess_example.json" } }, "tags": [ "Pricings" ], - "description": "Gets a provided Microsoft Defender for Cloud pricing configuration in the subscription.", - "operationId": "Pricings_Get", + "description": "Updates a provided Microsoft Defender for Cloud pricing configuration in the scope. Valid scopes are: subscription id or a specific resource id (Supported resources are: 'VirtualMachines, VMSS and ARC Machines' and only for plan='VirtualMachines' and subPlan='P1').", + "operationId": "Pricings_Update", "parameters": [ { "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" }, { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + "$ref": "../../../common/v1/types.json#/parameters/ScopeId" }, { "$ref": "#/parameters/PricingName" + }, + { + "$ref": "#/parameters/Pricing" } ], "responses": { "200": { - "description": "OK", + "description": "Successfully updated", + "schema": { + "$ref": "#/definitions/Pricing" + } + }, + "201": { + "description": "Successfully created.", "schema": { "$ref": "#/definitions/Pricing" } @@ -120,39 +142,78 @@ } } }, - "put": { + "delete": { "x-ms-examples": { - "Update pricing on subscription": { - "$ref": "./examples/Pricings/PutPricingByName_example.json" - }, - "Update pricing on subscription - partial success": { - "$ref": "./examples/Pricings/PutPricingByNamePartialSuccess_example.json" + "Delete a pricing on resource": { + "$ref": "./examples/Pricings/DeleteResourcePricing_example.json" } }, "tags": [ "Pricings" ], - "description": "Updates a provided Microsoft Defender for Cloud pricing configuration in the subscription.", - "operationId": "Pricings_Update", + "description": "Deletes a provided Microsoft Defender for Cloud pricing configuration in a specific resource. Valid only for resource scope (Supported resources are: 'VirtualMachines, VMSS and ARC MachinesS').", + "operationId": "Pricings_Delete", "parameters": [ { "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" }, { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + "$ref": "../../../common/v1/types.json#/parameters/ScopeResourceId" }, { "$ref": "#/parameters/PricingName" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the pricing configuration of the resource." }, + "204": { + "description": "No Content - Pricing does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + }, + "/{scopeId}/providers/Microsoft.Security/pricings": { + "get": { + "x-ms-examples": { + "Get pricings on subscription": { + "$ref": "./examples/Pricings/ListPricings_example.json" + }, + "Get pricings on subscription with plans filter": { + "$ref": "./examples/Pricings/ListPricingsWithPlanFilter_example.json" + }, + "Get pricings on resource": { + "$ref": "./examples/Pricings/ListResourcePricings_example.json" + } + }, + "tags": [ + "Pricings" + ], + "description": "Lists Microsoft Defender for Cloud pricing configurations of the scopeId, that match the optional given $filter. Valid scopes are: subscription id or a specific resource id (Supported resources are: 'VirtualMachines, VMSS and ARC Machines'). Valid $filter is: 'name in ({planName1},{planName2},...)'. If $filter is not provided, the unfiltered list will be returned. If '$filter=name in (planName1,planName2)' is provided, the returned list includes the pricings set for 'planName1' and 'planName2' only.", + "operationId": "Pricings_List", + "parameters": [ { - "$ref": "#/parameters/Pricing" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ScopeId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Pricing" + "$ref": "#/definitions/PricingList" } }, "default": { @@ -167,6 +228,7 @@ }, "definitions": { "PricingList": { + "type": "object", "description": "List of pricing configurations response.", "required": [ "value" @@ -203,7 +265,7 @@ "properties": { "pricingTier": { "type": "string", - "description": "The pricing tier value. Microsoft Defender for Cloud is provided in two pricing tiers: free and standard. The standard tier offers advanced security capabilities, while the free tier offers basic security features.", + "description": "Indicates whether the Defender plan is enabled on the selected scope. Microsoft Defender for Cloud is provided in two pricing tiers: free and standard. The standard tier offers advanced security capabilities, while the free tier offers basic security features.", "enum": [ "Free", "Standard" @@ -225,7 +287,7 @@ }, "subPlan": { "type": "string", - "description": "The sub-plan selected for a Standard pricing configuration, when more than one sub-plan is available. Each sub-plan enables a set of security features. When not specified, full plan is applied." + "description": "The sub-plan selected for a Standard pricing configuration, when more than one sub-plan is available. Each sub-plan enables a set of security features. When not specified, full plan is applied. For VirtualMachines plan, available sub plans are 'P1' & 'P2', where for resource level only 'P1' sub plan is supported." }, "freeTrialRemainingTime": { "type": "string", @@ -239,6 +301,92 @@ "readOnly": true, "description": "Optional. If `pricingTier` is `Standard` then this property holds the date of the last time the `pricingTier` was set to `Standard`, when available (e.g 2023-03-01T12:42:42.1921106Z)." }, + "enforce": { + "type": "string", + "description": "If set to \"False\", it allows the descendants of this scope to override the pricing configuration set on this scope (allows setting inherited=\"False\"). If set to \"True\", it prevents overrides and forces this pricing configuration on all the descendants of this scope. This field is only available for subscription-level pricing.", + "enum": [ + "False", + "True" + ], + "x-ms-enum": { + "name": "enforce", + "modelAsString": true, + "values": [ + { + "value": "False", + "description": "Allows the descendants of this scope to override the pricing configuration set on this scope (allows setting inherited=\"False\")" + }, + { + "value": "True", + "description": "Prevents overrides and forces the current scope's pricing configuration to all descendants" + } + ] + } + }, + "inherited": { + "type": "string", + "readOnly": true, + "description": "\"inherited\" = \"True\" indicates that the current scope inherits its pricing configuration from its parent. The ID of the parent scope that provides the inherited configuration is displayed in the \"inheritedFrom\" field. On the other hand, \"inherited\" = \"False\" indicates that the current scope has its own pricing configuration explicitly set, and does not inherit from its parent. This field is read only and available only for resource-level pricing.", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "inherited", + "modelAsString": true, + "values": [ + { + "value": "True", + "description": "Indicates that the current scope is inheriting its pricing configuration from its parent" + }, + { + "value": "False", + "description": "Indicates that the current scope sets its own pricing configuration and does not inherit it from its parent" + } + ] + } + }, + "inheritedFrom": { + "type": "string", + "readOnly": true, + "description": "The id of the scope inherited from. \"Null\" if not inherited. This field is only available for resource-level pricing." + }, + "resourcesCoverageStatus": { + "type": "string", + "readOnly": true, + "description": "This field is available for subscription-level only, and reflects the coverage status of the resources under the subscription. Please note: The \"pricingTier\" field reflects the plan status of the subscription. However, since the plan status can also be defined at the resource level, there might be misalignment between the subscription's plan status and the resource status. This field helps indicate the coverage status of the resources.", + "enum": [ + "FullyCovered", + "PartiallyCovered", + "NotCovered" + ], + "x-ms-enum": { + "name": "resourcesCoverageStatus", + "modelAsString": true, + "values": [ + { + "value": "FullyCovered", + "description": "This value indicates that all resources associated with the subscription have the Defender plan enabled." + }, + { + "value": "PartiallyCovered", + "description": "This value indicates that some resources under the subscription have the Defender plan enabled, while others have it disabled. There is a mixed coverage status among resources." + }, + { + "value": "NotCovered", + "description": "This value indicates that the Defender plan is disabled for all resources under the subscription. None of the resources are protected by the Defender plan." + } + ] + } + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/Extension" + }, + "description": "Optional. List of extensions offered under a plan.", + "x-ms-identifiers": [] + }, "deprecated": { "type": "boolean", "readOnly": true, @@ -251,14 +399,6 @@ }, "readOnly": true, "description": "Optional. List of plans that replace this plan. This property exists only if this plan is deprecated." - }, - "extensions": { - "type": "array", - "items": { - "$ref": "#/definitions/Extension" - }, - "description": "Optional. List of extensions offered under a plan.", - "x-ms-identifiers": [] } }, "required": [ diff --git a/swagger-specs/security/resource-manager/api-set.json b/swagger-specs/security/resource-manager/api-set.json index 99dbe1047..2a5cb3a95 100644 --- a/swagger-specs/security/resource-manager/api-set.json +++ b/swagger-specs/security/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Security/preview/2021-10-01-preview/mdeOnboardings.json", "Microsoft.Security/preview/2021-07-01-preview/customAssessmentAutomation.json", "Microsoft.Security/preview/2021-07-01-preview/customEntityStoreAssignment.json", "Microsoft.Security/stable/2017-08-01/complianceResults.json", "Microsoft.Security/stable/2023-01-01/pricings.json", "Microsoft.Security/stable/2019-01-01/advancedThreatProtectionSettings.json", "Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json", "Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json", "Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.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/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/2020-01-01-preview/securityContacts.json", "Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json", "Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json", "Microsoft.Security/preview/2019-01-01-preview/subAssessments.json", "Microsoft.Security/preview/2019-01-01-preview/automations.json", "Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json", "Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json", "Microsoft.Security/stable/2021-06-01/assessmentMetadata.json", "Microsoft.Security/stable/2021-06-01/assessments.json", "Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json", "Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json", "Microsoft.Security/stable/2020-01-01/allowedConnections.json", "Microsoft.Security/stable/2020-01-01/topologies.json", "Microsoft.Security/stable/2020-01-01/jitNetworkAccessPolicies.json", "Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json", "Microsoft.Security/stable/2020-01-01/securitySolutionsReferenceData.json", "Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json", "Microsoft.Security/stable/2020-01-01/secureScore.json", "Microsoft.Security/stable/2020-01-01/SecuritySolutions.json", "Microsoft.Security/preview/2020-01-01-preview/connectors.json", "Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json", "Microsoft.Security/stable/2022-01-01/alerts.json", "Microsoft.Security/stable/2022-05-01/settings.json", "Microsoft.Security/preview/2021-05-01-preview/softwareInventories.json", "Microsoft.Security/preview/2022-01-01-preview/governanceRules.json", "Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json", "Microsoft.Security/preview/2022-07-01-preview/applications.json", "Microsoft.Security/stable/2023-11-15/apiCollections.json", "Microsoft.Security/preview/2023-02-01-preview/sqlVulnerabilityAssessmentsScanOperations.json", "Microsoft.Security/preview/2023-02-01-preview/sqlVulnerabilityAssessmentsScanResultsOperations.json", "Microsoft.Security/preview/2023-02-01-preview/sqlVulnerabilityAssessmentsBaselineRuleOperations.json", "Microsoft.Security/preview/2023-01-01-preview/securityOperators.json", "Microsoft.Security/stable/2023-05-01/ServerVulnerabilityAssessmentsSettings.json", "Microsoft.Security/preview/2023-05-01-preview/healthReports.json", "Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json", "Microsoft.Security/preview/2023-09-01-preview/securityConnectorsDevOps.json", "Microsoft.Security/preview/2023-10-01-preview/securityConnectors.json"], "name": "package-composite-v3"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["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/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/workspaceSettings.json", "Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json", "Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json", "Microsoft.Security/preview/2019-01-01-preview/subAssessments.json", "Microsoft.Security/preview/2020-01-01-preview/connectors.json", "Microsoft.Security/preview/2021-05-01-preview/softwareInventories.json", "Microsoft.Security/preview/2021-07-01-preview/customAssessmentAutomation.json", "Microsoft.Security/preview/2021-07-01-preview/customEntityStoreAssignment.json", "Microsoft.Security/preview/2021-10-01-preview/mdeOnboardings.json", "Microsoft.Security/preview/2022-01-01-preview/governanceAssignments.json", "Microsoft.Security/preview/2022-01-01-preview/governanceRules.json", "Microsoft.Security/preview/2022-07-01-preview/applications.json", "Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json", "Microsoft.Security/preview/2023-01-01-preview/securityOperators.json", "Microsoft.Security/preview/2023-02-01-preview/sqlVulnerabilityAssessmentsBaselineRuleOperations.json", "Microsoft.Security/preview/2023-02-01-preview/sqlVulnerabilityAssessmentsScanOperations.json", "Microsoft.Security/preview/2023-02-01-preview/sqlVulnerabilityAssessmentsScanResultsOperations.json", "Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json", "Microsoft.Security/preview/2023-05-01-preview/healthReports.json", "Microsoft.Security/preview/2023-12-01-preview/automations.json", "Microsoft.Security/preview/2023-12-01-preview/securityContacts.json", "Microsoft.Security/preview/2024-03-01-preview/securityConnectors.json", "Microsoft.Security/preview/2024-05-15-preview/securityConnectorsDevOps.json", "Microsoft.Security/stable/2017-08-01/complianceResults.json", "Microsoft.Security/stable/2019-01-01/advancedThreatProtectionSettings.json", "Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json", "Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json", "Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json", "Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json", "Microsoft.Security/stable/2020-01-01/allowedConnections.json", "Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json", "Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json", "Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json", "Microsoft.Security/stable/2020-01-01/jitNetworkAccessPolicies.json", "Microsoft.Security/stable/2020-01-01/secureScore.json", "Microsoft.Security/stable/2020-01-01/SecuritySolutions.json", "Microsoft.Security/stable/2020-01-01/securitySolutionsReferenceData.json", "Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json", "Microsoft.Security/stable/2020-01-01/topologies.json", "Microsoft.Security/stable/2021-06-01/assessmentMetadata.json", "Microsoft.Security/stable/2021-06-01/assessments.json", "Microsoft.Security/stable/2022-01-01/alerts.json", "Microsoft.Security/stable/2022-05-01/settings.json", "Microsoft.Security/stable/2023-05-01/ServerVulnerabilityAssessmentsSettings.json", "Microsoft.Security/stable/2023-11-15/apiCollections.json", "Microsoft.Security/stable/2024-01-01/pricings.json"], "name": "package-composite-v3"} \ No newline at end of file diff --git a/swagger-specs/security/resource-manager/common/v1/types.json b/swagger-specs/security/resource-manager/common/v1/types.json index 716360987..2c9aeab8f 100644 --- a/swagger-specs/security/resource-manager/common/v1/types.json +++ b/swagger-specs/security/resource-manager/common/v1/types.json @@ -427,6 +427,24 @@ "x-ms-parameter-location": "method", "x-ms-skip-url-encoding": true }, + "ScopeResourceId": { + "name": "scopeId", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier of the resource, (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName})", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "ScopeId": { + "name": "scopeId", + "in": "path", + "required": true, + "type": "string", + "description": "The scope id of the pricing. Valid scopes are: subscription (format: 'subscriptions/{subscriptionId}'), or a specific resource (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}) - Supported resources are (VirtualMachines)", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, "ODataFilter": { "name": "$filter", "in": "query", diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/AlertRules.json similarity index 99% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/AlertRules.json index 3ca6f0963..af694a81a 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/AlertRules.json @@ -3,7 +3,7 @@ "info": { "title": "Security Insights", "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", - "version": "2023-02-01" + "version": "2024-03-01" }, "host": "management.azure.com", "schemes": [ @@ -1137,9 +1137,6 @@ "x-ms-identifiers": [] } }, - "required": [ - "productFilter" - ], "type": "object" }, "MicrosoftSecurityProductName": { diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/AutomationRules.json similarity index 70% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/AutomationRules.json index ac65c7aab..af741a4bb 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/AutomationRules.json @@ -3,7 +3,7 @@ "info": { "title": "Security Insights", "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", - "version": "2023-02-01", + "version": "2024-03-01", "x-ms-code-generation-settings": { "name": "SecurityInsights" } @@ -21,13 +21,13 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -70,13 +70,13 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -130,13 +130,13 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -184,13 +184,13 @@ ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -219,6 +219,126 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityIdentifier}/runPlaybook": { + "post": { + "tags": [ + "manualTrigger" + ], + "description": "Triggers playbook on a specific entity.", + "operationId": "Entities_RunPlaybook", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "entityIdentifier", + "required": true, + "type": "string", + "description": "Entity ID" + }, + { + "in": "body", + "name": "requestBody", + "description": "Describes the request body for triggering a playbook on an entity.", + "schema": { + "$ref": "#/definitions/EntityManualTriggerRequestBody" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Entities_RunPlaybook": { + "$ref": "./examples/manualTrigger/Entities_RunPlaybook.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentIdentifier}/runPlaybook": { + "post": { + "tags": [ + "manualTrigger" + ], + "description": "Triggers playbook on a specific incident", + "operationId": "Incidents_RunPlaybook", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "incidentIdentifier", + "required": true, + "type": "string", + "description": "Incident ID" + }, + { + "in": "body", + "name": "requestBody", + "description": "Describes the request body for triggering a playbook on an incident.", + "schema": { + "$ref": "#/definitions/ManualTriggerRequestBody" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_RunPlaybook": { + "$ref": "./examples/manualTrigger/Incidents_RunPlaybook.json" + } + } + } } }, "definitions": { @@ -226,7 +346,8 @@ "description": "The type of the automation rule action.", "enum": [ "ModifyProperties", - "RunPlaybook" + "RunPlaybook", + "AddIncidentTask" ], "type": "string", "example": "ModifyProperties", @@ -241,10 +362,31 @@ { "value": "RunPlaybook", "description": "Run a playbook on an object" + }, + { + "value": "AddIncidentTask", + "description": "Add a task to an incident object" } ] } }, + "AddIncidentTaskActionProperties": { + "description": "Describes an automation rule action to add a task to an incident.", + "required": [ + "title" + ], + "type": "object", + "properties": { + "title": { + "description": "The title of the task.", + "type": "string" + }, + "description": { + "description": "The description of the task.", + "type": "string" + } + } + }, "AutomationRule": { "required": [ "properties" @@ -281,6 +423,64 @@ }, "discriminator": "actionType" }, + "AutomationRuleAddIncidentTaskAction": { + "description": "Describes an automation rule action to add a task to an incident", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleAction" + } + ], + "properties": { + "actionConfiguration": { + "type": "object", + "$ref": "#/definitions/AddIncidentTaskActionProperties" + } + }, + "x-ms-discriminator-value": "AddIncidentTask", + "x-ms-client-flatten": true + }, + "AutomationRuleBooleanCondition": { + "description": "Describes an automation rule condition with boolean operators.", + "type": "object", + "properties": { + "operator": { + "$ref": "#/definitions/AutomationRuleBooleanConditionSupportedOperator" + }, + "innerConditions": { + "maxItems": 10, + "minItems": 2, + "type": "array", + "items": { + "$ref": "#/definitions/AutomationRuleCondition" + }, + "x-ms-identifiers": [] + } + } + }, + "AutomationRuleBooleanConditionSupportedOperator": { + "description": "Describes a boolean condition operator.", + "enum": [ + "And", + "Or" + ], + "type": "string", + "example": "And", + "x-ms-enum": { + "name": "AutomationRuleBooleanConditionSupportedOperator", + "modelAsString": true, + "values": [ + { + "value": "And", + "description": "Evaluates as true if all the item conditions are evaluated as true" + }, + { + "value": "Or", + "description": "Evaluates as true if at least one of the item conditions are evaluated as true" + } + ] + } + }, "AutomationRuleCondition": { "description": "Describes an automation rule condition.", "required": [ @@ -308,8 +508,8 @@ "$ref": "#/definitions/IncidentPropertiesAction" } }, - "x-ms-client-flatten": true, - "x-ms-discriminator-value": "ModifyProperties" + "x-ms-discriminator-value": "ModifyProperties", + "x-ms-client-flatten": true }, "AutomationRuleProperties": { "description": "Automation rule properties", @@ -323,27 +523,27 @@ "properties": { "displayName": { "description": "The display name of the automation rule.", - "type": "string", - "maxLength": 500 + "maxLength": 500, + "type": "string" }, "order": { "format": "int32", "description": "The order of execution of the automation rule.", - "type": "integer", + "maximum": 1000, "minimum": 1, - "maximum": 1000 + "type": "integer" }, "triggeringLogic": { "$ref": "#/definitions/AutomationRuleTriggeringLogic" }, "actions": { "description": "The actions to execute when the automation rule is triggered.", + "maxItems": 20, "type": "array", "items": { "$ref": "#/definitions/AutomationRuleAction" }, - "x-ms-identifiers": [], - "maxItems": 20 + "x-ms-identifiers": [] }, "lastModifiedTimeUtc": { "format": "date-time", @@ -427,6 +627,67 @@ } } }, + "AutomationRulePropertyArrayConditionSupportedArrayConditionType": { + "description": "Describes an array condition evaluation type.", + "enum": [ + "AnyItem" + ], + "type": "string", + "example": "AnyItem", + "x-ms-enum": { + "name": "AutomationRulePropertyArrayConditionSupportedArrayConditionType", + "modelAsString": true, + "values": [ + { + "value": "AnyItem", + "description": "Evaluate the condition as true if any item fulfills it" + } + ] + } + }, + "AutomationRulePropertyArrayConditionSupportedArrayType": { + "description": "Describes an array condition evaluated array type.", + "enum": [ + "CustomDetails", + "CustomDetailValues" + ], + "type": "string", + "example": "CustomDetails", + "x-ms-enum": { + "name": "AutomationRulePropertyArrayConditionSupportedArrayType", + "modelAsString": true, + "values": [ + { + "value": "CustomDetails", + "description": "Evaluate the condition on the custom detail keys" + }, + { + "value": "CustomDetailValues", + "description": "Evaluate the condition on a custom detail's values" + } + ] + } + }, + "AutomationRulePropertyArrayValuesCondition": { + "description": "Describes an automation rule condition on array properties.", + "type": "object", + "properties": { + "arrayType": { + "$ref": "#/definitions/AutomationRulePropertyArrayConditionSupportedArrayType" + }, + "arrayConditionType": { + "$ref": "#/definitions/AutomationRulePropertyArrayConditionSupportedArrayConditionType" + }, + "itemConditions": { + "maxItems": 10, + "type": "array", + "items": { + "$ref": "#/definitions/AutomationRuleCondition" + }, + "x-ms-identifiers": [] + } + } + }, "AutomationRulePropertyChangedConditionSupportedChangedType": { "enum": [ "ChangedFrom", @@ -540,6 +801,8 @@ "IncidentLabel", "IncidentProviderName", "IncidentUpdatedBySource", + "IncidentCustomDetailsKey", + "IncidentCustomDetailsValue", "AccountAadTenantId", "AccountAadUserId", "AccountName", @@ -630,6 +893,14 @@ "value": "IncidentUpdatedBySource", "description": "The update source of the incident" }, + { + "value": "IncidentCustomDetailsKey", + "description": "The incident custom detail key" + }, + { + "value": "IncidentCustomDetailsValue", + "description": "The incident custom detail value" + }, { "value": "AccountAadTenantId", "description": "The account Azure Active Directory tenant id" @@ -872,22 +1143,8 @@ "$ref": "#/definitions/PlaybookActionProperties" } }, - "x-ms-client-flatten": true, - "x-ms-discriminator-value": "RunPlaybook" - }, - "AutomationRulesList": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AutomationRule" - } - }, - "nextLink": { - "type": "string" - } - } + "x-ms-discriminator-value": "RunPlaybook", + "x-ms-client-flatten": true }, "AutomationRuleTriggeringLogic": { "description": "Describes automation rule triggering logic.", @@ -915,8 +1172,8 @@ }, "conditions": { "description": "The conditions to evaluate to determine if the automation rule should be triggered on a given object.", - "type": "array", "maxItems": 50, + "type": "array", "items": { "$ref": "#/definitions/AutomationRuleCondition" }, @@ -926,11 +1183,44 @@ } } }, + "AutomationRulesList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AutomationRule" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "BooleanConditionProperties": { + "description": "Describes an automation rule condition that applies a boolean operator (e.g AND, OR) to conditions", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleCondition" + } + ], + "properties": { + "conditionProperties": { + "type": "object", + "$ref": "#/definitions/AutomationRuleBooleanCondition" + } + }, + "x-ms-discriminator-value": "Boolean", + "x-ms-client-flatten": true + }, "ConditionType": { "enum": [ "Property", + "PropertyArray", "PropertyChanged", - "PropertyArrayChanged" + "PropertyArrayChanged", + "Boolean" ], "type": "string", "example": "Property", @@ -942,6 +1232,10 @@ "value": "Property", "description": "Evaluate an object property value" }, + { + "value": "PropertyArray", + "description": "Evaluate an object array property value" + }, { "value": "PropertyChanged", "description": "Evaluate an object property changed value" @@ -949,10 +1243,58 @@ { "value": "PropertyArrayChanged", "description": "Evaluate an object array property changed value" + }, + { + "value": "Boolean", + "description": "Apply a boolean operator (e.g AND, OR) to conditions" } ] } }, + "EntityManualTriggerRequestBody": { + "description": "Describes the request body for triggering a playbook on an entity.", + "required": [ + "logicAppsResourceId" + ], + "type": "object", + "properties": { + "incidentArmId": { + "description": "The incident id to associate the entity with.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "scopes": [ + "Extension" + ], + "type": "Microsoft.SecurityInsights/incidents" + } + ] + } + }, + "tenantId": { + "format": "uuid", + "description": "The tenant id of the playbook resource.", + "type": "string" + }, + "logicAppsResourceId": { + "description": "The resource id of the playbook resource.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Logic/workflows" + }, + { + "type": "Microsoft.Web/sites" + } + ] + } + } + } + }, "IncidentPropertiesAction": { "type": "object", "properties": { @@ -987,15 +1329,55 @@ } } }, - "PlaybookActionProperties": { + "ManualTriggerRequestBody": { + "description": "Describes the request body for triggering a playbook on an incident.", + "required": [ + "logicAppsResourceId" + ], "type": "object", + "properties": { + "tenantId": { + "format": "uuid", + "description": "The tenant id of the playbook resource.", + "type": "string" + }, + "logicAppsResourceId": { + "description": "The resource id of the playbook resource.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Logic/workflows" + }, + { + "type": "Microsoft.Web/sites" + } + ] + } + } + } + }, + "PlaybookActionProperties": { "required": [ "logicAppResourceId" ], + "type": "object", "properties": { "logicAppResourceId": { "description": "The resource id of the playbook resource.", - "type": "string" + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Logic/workflows" + }, + { + "type": "Microsoft.Web/sites" + } + ] + } }, "tenantId": { "format": "uuid", @@ -1021,6 +1403,23 @@ "x-ms-discriminator-value": "PropertyArrayChanged", "x-ms-client-flatten": true }, + "PropertyArrayConditionProperties": { + "description": "Describes an automation rule condition that evaluates an array property's value", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleCondition" + } + ], + "properties": { + "conditionProperties": { + "type": "object", + "$ref": "#/definitions/AutomationRulePropertyArrayValuesCondition" + } + }, + "x-ms-discriminator-value": "PropertyArray", + "x-ms-client-flatten": true + }, "PropertyChangedConditionProperties": { "description": "Describes an automation rule condition that evaluates a property's value change", "type": "object", @@ -1052,8 +1451,8 @@ "$ref": "#/definitions/AutomationRulePropertyValuesCondition" } }, - "x-ms-client-flatten": true, - "x-ms-discriminator-value": "Property" + "x-ms-discriminator-value": "Property", + "x-ms-client-flatten": true }, "triggersOn": { "enum": [ diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Bookmarks.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/Bookmarks.json similarity index 99% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Bookmarks.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/Bookmarks.json index 1d3013440..5a3285a7e 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Bookmarks.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/Bookmarks.json @@ -3,7 +3,7 @@ "info": { "title": "Security Insights", "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", - "version": "2023-02-01" + "version": "2024-03-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ContentPackages.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ContentPackages.json new file mode 100644 index 000000000..e863c2df2 --- /dev/null +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ContentPackages.json @@ -0,0 +1,319 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentPackages": { + "get": { + "x-ms-examples": { + "Get all available packages.": { + "$ref": "./examples/contentPackages/GetPackages.json" + } + }, + "tags": [ + "ContentPackages" + ], + "description": "Gets all installed packages.", + "operationId": "ContentPackages_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSearch" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataCount" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkip" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/packageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentPackages/{packageId}": { + "get": { + "x-ms-examples": { + "Get installed packages by id.": { + "$ref": "./examples/contentPackages/GetPackageById.json" + } + }, + "tags": [ + "ContentPackages" + ], + "description": "Gets an installed packages by its id.", + "operationId": "ContentPackages_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/PackageIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/packageModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Install a package to the workspace.": { + "$ref": "./examples/contentPackages/InstallPackage.json" + } + }, + "tags": [ + "ContentPackages" + ], + "description": "Install a package to the workspace.", + "operationId": "ContentPackage_Install", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/PackageIdParameter" + }, + { + "$ref": "#/parameters/PackageInstallationProperties" + } + ], + "responses": { + "200": { + "description": "OK, a package is updated.", + "schema": { + "$ref": "#/definitions/packageModel" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/packageModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Uninstall a package from the workspace.": { + "$ref": "./examples/contentPackages/UninstallPackage.json" + } + }, + "tags": [ + "ContentPackages" + ], + "description": "Uninstall a package from the workspace.", + "operationId": "ContentPackage_Uninstall", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/PackageIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "packageList": { + "description": "List available packages.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of packages.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of packages.", + "items": { + "$ref": "#/definitions/packageModel" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "packageModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Package in Azure Security Insights.", + "properties": { + "properties": { + "description": "package properties", + "$ref": "#/definitions/packageProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "packageProperties": { + "description": "Describes package properties", + "allOf": [ + { + "$ref": "./common/ContentCommonTypes.json#/definitions/packageBaseProperties" + } + ], + "required": [ + "contentId", + "contentProductId", + "contentKind", + "version", + "displayName" + ], + "type": "object" + } + }, + "parameters": { + "PackageIdParameter": { + "description": "package Id", + "in": "path", + "name": "packageId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PackageInstallationProperties": { + "description": "Package installation properties", + "in": "body", + "name": "packageInstallationProperties", + "required": true, + "schema": { + "$ref": "#/definitions/packageModel" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ContentProductPackages.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ContentProductPackages.json new file mode 100644 index 000000000..6188b974a --- /dev/null +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ContentProductPackages.json @@ -0,0 +1,232 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductPackages": { + "get": { + "x-ms-examples": { + "Get all available packages.": { + "$ref": "./examples/contentPackages/GetProductPackages.json" + } + }, + "tags": [ + "ContentProductPackages" + ], + "description": "Gets all packages from the catalog.\nExpandable properties:\n- properties/installed\n- properties/packagedContent", + "operationId": "ProductPackages_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/productPackageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductPackages/{packageId}": { + "get": { + "x-ms-examples": { + "Get a package.": { + "$ref": "./examples/contentPackages/GetProductPackageById.json" + } + }, + "tags": [ + "ContentProductPackages" + ], + "description": "Gets a package by its identifier from the catalog.", + "operationId": "ProductPackage_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/PackageIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/productPackageModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "productPackageList": { + "description": "List available packages.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of packages.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of packages.", + "items": { + "$ref": "#/definitions/productPackageModel" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "productPackageModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Package in Azure Security Insights.", + "properties": { + "properties": { + "description": "package properties", + "$ref": "#/definitions/productPackageProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "productPackageProperties": { + "description": "Describes package properties", + "allOf": [ + { + "$ref": "./common/ContentCommonTypes.json#/definitions/packageBaseProperties", + "description": "The content id of the package" + }, + { + "$ref": "#/definitions/productPackageAdditionalProperties", + "description": "The package kind" + } + ], + "required": [ + "contentId", + "contentKind", + "version", + "displayName" + ], + "type": "object" + }, + "productPackageAdditionalProperties": { + "description": "product package additional properties", + "properties": { + "installedVersion": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion", + "description": "The version of the installed package, null or absent means not installed." + }, + "metadataResourceId": { + "description": "The metadata resource id.", + "type": "string", + "format": "arm-id" + }, + "packagedContent": { + "$ref": "#/definitions/packagedContent", + "description": "The json of the ARM template to deploy. Expandable." + } + }, + "type": "object" + }, + "packagedContent": { + "type": "object", + "description": "The json of the ARM template to deploy" + } + }, + "parameters": { + "PackageIdParameter": { + "description": "package Id", + "in": "path", + "name": "packageId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ContentProductTemplates.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ContentProductTemplates.json new file mode 100644 index 000000000..bac332f99 --- /dev/null +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ContentProductTemplates.json @@ -0,0 +1,226 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductTemplates": { + "get": { + "x-ms-examples": { + "Get all installed templates.": { + "$ref": "./examples/contentTemplates/GetProductTemplates.json" + } + }, + "tags": [ + "ContentProductTemplates" + ], + "description": "Gets all templates in the catalog.", + "operationId": "ProductTemplates_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSearch" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataCount" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkip" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/productTemplateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentproducttemplates/{templateId}": { + "get": { + "x-ms-examples": { + "Get a template.": { + "$ref": "./examples/contentTemplates/GetProductTemplateById.json" + } + }, + "tags": [ + "ContentProductTemplates" + ], + "description": "Gets a template by its identifier.", + "operationId": "ProductTemplate_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/templateIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/productTemplateModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "productTemplateList": { + "description": "List of all the template.", + "type": "object", + "properties": { + "value": { + "description": "Array of templates.", + "items": { + "$ref": "#/definitions/productTemplateModel" + }, + "type": "array" + }, + "nextLink": { + "description": "URL to fetch the next page of template.", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "productTemplateModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Template resource definition.", + "properties": { + "properties": { + "description": "template properties", + "$ref": "#/definitions/productTemplateProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "productTemplateProperties": { + "allOf": [ + { + "$ref": "./common/ContentCommonTypes.json#/definitions/templateBaseProperties" + }, + { + "$ref": "#/definitions/productTemplateAdditionalProperties" + } + ], + "description": "Template property bag.", + "required": [ + "contentId", + "version", + "displayName", + "contentKind", + "source" + ] + }, + "productTemplateAdditionalProperties": { + "description": "additional properties of product template.", + "type": "object", + "properties": { + "packagedContent": { + "type": "object", + "description": "The json of the ARM template to deploy" + } + } + } + }, + "parameters": { + "templateIdParameter": { + "description": "template Id", + "in": "path", + "name": "templateId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ContentTemplates.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ContentTemplates.json new file mode 100644 index 000000000..c1ccafda0 --- /dev/null +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ContentTemplates.json @@ -0,0 +1,353 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentTemplates": { + "get": { + "x-ms-examples": { + "Get all installed templates.": { + "$ref": "./examples/contentTemplates/GetTemplates.json" + } + }, + "tags": [ + "ContentTemplates" + ], + "description": "Gets all installed templates.\nExpandable properties:\n- properties/mainTemplate\n- properties/dependantTemplates", + "operationId": "ContentTemplates_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataExpand" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSearch" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataCount" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkip" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/templateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentTemplates/{templateId}": { + "put": { + "x-ms-examples": { + "Get a template.": { + "$ref": "./examples/contentTemplates/InstallTemplate.json" + } + }, + "tags": [ + "ContentTemplates" + ], + "description": "Install a template.", + "operationId": "ContentTemplate_Install", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/templateIdParameter" + }, + { + "$ref": "#/parameters/templateInstallationProperties" + } + ], + "responses": { + "200": { + "description": "OK, a template is updated.", + "schema": { + "$ref": "#/definitions/templateModel" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/templateModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "get": { + "x-ms-examples": { + "Get a template.": { + "$ref": "./examples/contentTemplates/GetTemplateById.json" + } + }, + "tags": [ + "ContentTemplates" + ], + "description": "Gets a template byt its identifier.\nExpandable properties:\n- properties/mainTemplate\n- properties/dependantTemplates", + "operationId": "ContentTemplate_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/templateIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/templateModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete metadata.": { + "$ref": "./examples/contentTemplates/DeleteTemplate.json" + } + }, + "tags": [ + "ContentTemplates" + ], + "description": "Delete an installed template.", + "operationId": "ContentTemplate_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/templateIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "templateList": { + "description": "List of all the template.", + "type": "object", + "properties": { + "value": { + "description": "Array of templates.", + "items": { + "$ref": "#/definitions/templateModel" + }, + "type": "array" + }, + "nextLink": { + "description": "URL to fetch the next page of template.", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "templateModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Template resource definition.", + "properties": { + "properties": { + "description": "template properties", + "$ref": "#/definitions/templateProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "templateProperties": { + "allOf": [ + { + "$ref": "./common/ContentCommonTypes.json#/definitions/templateBaseProperties" + }, + { + "$ref": "#/definitions/templateAdditionalProperties" + } + ], + "description": "Template property bag.", + "required": [ + "contentId", + "version", + "displayName", + "contentKind", + "source", + "packageId", + "packageVersion", + "contentProductId" + ], + "type": "object" + }, + "templateAdditionalProperties": { + "description": "additional properties of product template.", + "type": "object", + "properties": { + "mainTemplate": { + "$ref": "#/definitions/mainTemplate", + "description": "The JSON of the ARM template to deploy active content. Expandable." + }, + "dependantTemplates": { + "type": "array", + "items": { + "$ref": "#/definitions/templateProperties" + }, + "description": "Dependant templates. Expandable.", + "readOnly": true, + "x-ms-identifiers": [ + "contentId" + ] + } + } + }, + "mainTemplate": { + "description": "The JSON of the ARM template to deploy active content", + "type": "object" + } + }, + "parameters": { + "templateIdParameter": { + "description": "template Id", + "in": "path", + "name": "templateId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "templateInstallationProperties": { + "description": "Template installation properties", + "in": "body", + "name": "templateInstallationProperties", + "required": true, + "schema": { + "$ref": "#/definitions/templateModel" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/DataConnectors.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/DataConnectors.json similarity index 99% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/DataConnectors.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/DataConnectors.json index d4843a87d..62ae5904f 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/DataConnectors.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/DataConnectors.json @@ -3,7 +3,7 @@ "info": { "title": "Security Insights", "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", - "version": "2023-02-01" + "version": "2024-03-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/Incidents.json similarity index 76% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/Incidents.json index 520ff49da..d2651edd8 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/Incidents.json @@ -3,7 +3,7 @@ "info": { "title": "Security Insights", "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", - "version": "2023-02-01" + "version": "2024-03-01" }, "host": "management.azure.com", "schemes": [ @@ -48,13 +48,13 @@ "operationId": "Incidents_List", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -111,13 +111,13 @@ "operationId": "Incidents_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -154,13 +154,13 @@ "operationId": "Incidents_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -206,13 +206,13 @@ "operationId": "Incidents_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -251,13 +251,13 @@ "operationId": "Incidents_ListAlerts", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -296,13 +296,13 @@ "operationId": "Incidents_ListBookmarks", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -341,13 +341,13 @@ "operationId": "IncidentComments_List", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -402,13 +402,13 @@ "operationId": "IncidentComments_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -448,13 +448,13 @@ "operationId": "IncidentComments_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -503,13 +503,13 @@ "operationId": "IncidentComments_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -551,13 +551,13 @@ "operationId": "Incidents_ListEntities", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -596,13 +596,13 @@ "operationId": "IncidentRelations_List", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -657,13 +657,13 @@ "operationId": "IncidentRelations_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -703,13 +703,13 @@ "operationId": "IncidentRelations_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -758,13 +758,13 @@ "operationId": "IncidentRelations_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" @@ -791,6 +791,215 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks": { + "get": { + "tags": [ + "IncidentTasks" + ], + "description": "Gets all incident tasks.", + "operationId": "IncidentTasks_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentTaskList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "IncidentTasks_List": { + "$ref": "./examples/incidents/tasks/IncidentTasks_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks/{incidentTaskId}": { + "get": { + "tags": [ + "IncidentTasks" + ], + "description": "Gets an incident task.", + "operationId": "IncidentTasks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentTaskId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentTasks_Get": { + "$ref": "./examples/incidents/tasks/IncidentTasks_Get.json" + } + } + }, + "put": { + "tags": [ + "IncidentTasks" + ], + "description": "Creates or updates the incident task.", + "operationId": "IncidentTasks_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentTaskId" + }, + { + "$ref": "#/parameters/IncidentTask" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentTask" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IncidentTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentTasks_CreateOrUpdate": { + "$ref": "./examples/incidents/tasks/IncidentTasks_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "IncidentTasks" + ], + "description": "Delete the incident task.", + "operationId": "IncidentTasks_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentTaskId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentTasks_Delete": { + "$ref": "./examples/incidents/tasks/IncidentTasks_Delete.json" + } + } + } } }, "definitions": { @@ -1231,7 +1440,18 @@ "description": "List of resource ids of Analytic rules related to the incident", "items": { "description": "Related Analytic rule resource id", - "type": "string" + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "scopes": [ + "Extension" + ], + "type": "Microsoft.SecurityInsights/alertRules" + } + ] + } }, "readOnly": true, "type": "array", @@ -1280,6 +1500,101 @@ "status" ], "type": "object" + }, + "IncidentTask": { + "description": "Describes incident task properties", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/IncidentTaskProperties", + "x-ms-client-flatten": true + } + } + }, + "IncidentTaskList": { + "description": "List of incident tasks", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IncidentTask" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "IncidentTaskProperties": { + "description": "Describes the properties of an incident task", + "required": [ + "status", + "title" + ], + "type": "object", + "properties": { + "title": { + "description": "The title of the task", + "type": "string" + }, + "description": { + "description": "The description of the task", + "type": "string" + }, + "status": { + "$ref": "#/definitions/IncidentTaskStatus" + }, + "createdTimeUtc": { + "format": "date-time", + "description": "The time the task was created", + "type": "string", + "readOnly": true + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "description": "The last time the task was updated", + "type": "string", + "readOnly": true + }, + "createdBy": { + "$ref": "../../../common/2.0/types.json#/definitions/ClientInfo" + }, + "lastModifiedBy": { + "$ref": "../../../common/2.0/types.json#/definitions/ClientInfo" + } + } + }, + "IncidentTaskStatus": { + "description": "The status of the task", + "enum": [ + "New", + "Completed" + ], + "type": "string", + "x-ms-enum": { + "name": "IncidentTaskStatus", + "modelAsString": true, + "values": [ + { + "value": "New", + "description": "A new task" + }, + { + "value": "Completed", + "description": "A completed task" + } + ] + } } }, "parameters": { @@ -1336,6 +1651,24 @@ "type": "string", "description": "Relation Name", "x-ms-parameter-location": "method" + }, + "IncidentTask": { + "name": "incidentTask", + "description": "The incident task", + "required": true, + "in": "body", + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/IncidentTask" + } + }, + "IncidentTaskId": { + "in": "path", + "name": "incidentTaskId", + "description": "Incident task ID", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" } } } diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Metadata.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/Metadata.json similarity index 91% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Metadata.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/Metadata.json index 9251dca31..8fb436ab1 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Metadata.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/Metadata.json @@ -3,7 +3,7 @@ "info": { "title": "Security Insights", "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", - "version": "2023-02-01" + "version": "2024-03-01" }, "host": "management.azure.com", "schemes": [ @@ -457,59 +457,6 @@ } } }, - "metadataDependencies": { - "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies.", - "type": "object", - "properties": { - "contentId": { - "description": "Id of the content item we depend on", - "$ref": "#/definitions/metadataContentId" - }, - "kind": { - "description": "Type of the content item we depend on", - "$ref": "#/definitions/metadataKind" - }, - "version": { - "description": "Version of the the content item we depend on. Can be blank, * or missing to indicate any version fulfills the dependency. If version does not match our defined numeric format then an exact match is required.", - "$ref": "#/definitions/metadataVersion" - }, - "name": { - "description": "Name of the content item", - "type": "string" - }, - "operator": { - "description": "Operator used for list of dependencies in criteria array.", - "type": "string", - "enum": [ - "AND", - "OR" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "operator", - "values": [ - { - "value": "AND" - }, - { - "value": "OR" - } - ] - } - }, - "criteria": { - "description": "This is the list of dependencies we must fulfill, according to the AND/OR operator", - "type": "array", - "items": { - "$ref": "#/definitions/metadataDependencies", - "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." - }, - "x-ms-identifiers": [ - "contentId" - ] - } - } - }, "metadataCategories": { "type": "object", "description": "ies for the solution content item", @@ -656,7 +603,7 @@ "description": "Support information for the metadata - type, name, contact information" }, "dependencies": { - "$ref": "#/definitions/metadataDependencies", + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDependencies", "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." }, "categories": { @@ -738,7 +685,7 @@ "description": "Support information for the metadata - type, name, contact information" }, "dependencies": { - "$ref": "#/definitions/metadataDependencies", + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDependencies", "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." }, "categories": { diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/OnboardingStates.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/OnboardingStates.json similarity index 99% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/OnboardingStates.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/OnboardingStates.json index 9045d1bc3..ee516f7b5 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/OnboardingStates.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/OnboardingStates.json @@ -3,7 +3,7 @@ "info": { "title": "Security Insights", "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", - "version": "2023-02-01" + "version": "2024-03-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/SecurityMLAnalyticsSettings.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/SecurityMLAnalyticsSettings.json similarity index 99% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/SecurityMLAnalyticsSettings.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/SecurityMLAnalyticsSettings.json index c051914f8..7bde331de 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/SecurityMLAnalyticsSettings.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/SecurityMLAnalyticsSettings.json @@ -3,7 +3,7 @@ "info": { "title": "Security Insights", "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", - "version": "2023-02-01" + "version": "2024-03-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/SourceControls.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/SourceControls.json new file mode 100644 index 000000000..cb4037372 --- /dev/null +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/SourceControls.json @@ -0,0 +1,1005 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/listRepositories": { + "post": { + "x-ms-examples": { + "Get repository list.": { + "$ref": "./examples/repositories/GetRepositories.json" + } + }, + "tags": [ + "Repositories" + ], + "description": "Gets a list of repositories metadata.", + "operationId": "SourceControl_listRepositories", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RepositoryAccess" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RepoList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols": { + "get": { + "x-ms-examples": { + "Get all source controls.": { + "$ref": "./examples/sourcecontrols/GetSourceControls.json" + } + }, + "tags": [ + "SourceControls" + ], + "description": "Gets all source controls, without source control items.", + "operationId": "SourceControls_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControlList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols/{sourceControlId}": { + "get": { + "x-ms-examples": { + "Get a source control.": { + "$ref": "./examples/sourcecontrols/GetSourceControlById.json" + } + }, + "tags": [ + "SourceControls" + ], + "description": "Gets a source control byt its identifier.", + "operationId": "SourceControls_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SourceControlIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a source control.": { + "$ref": "./examples/sourcecontrols/CreateSourceControl.json" + } + }, + "tags": [ + "SourceControls" + ], + "description": "Creates a source control.", + "operationId": "SourceControls_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SourceControlIdParameter" + }, + { + "$ref": "#/parameters/SourceControl" + } + ], + "responses": { + "200": { + "description": "Updated", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols/{sourceControlId}/delete": { + "post": { + "x-ms-examples": { + "Delete a source control.": { + "$ref": "./examples/sourcecontrols/DeleteSourceControl.json" + } + }, + "tags": [ + "SourceControls" + ], + "description": "Delete a source control.", + "operationId": "SourceControls_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SourceControlIdParameter" + }, + { + "$ref": "#/parameters/RepositoryAccess" + } + ], + "responses": { + "200": { + "description": "Source control deleted.", + "schema": { + "$ref": "#/definitions/Warning" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "RepoList": { + "description": "List all the source controls.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of repositories.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of repositories.", + "items": { + "$ref": "#/definitions/Repo" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "Repo": { + "description": "Represents a repository.", + "properties": { + "url": { + "description": "The url to access the repository.", + "type": "string" + }, + "fullName": { + "description": "The name of the repository.", + "type": "string" + }, + "installationId": { + "description": "The installation id of the repository.", + "type": "integer", + "format": "int64" + }, + "branches": { + "description": "Array of branches.", + "items": { + "description": "name of branch.", + "type": "string" + }, + "type": "array" + } + }, + "x-ms-azure-resource": false, + "type": "object" + }, + "SourceControlList": { + "description": "List all the source controls.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of source controls.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of source controls.", + "items": { + "$ref": "#/definitions/SourceControl" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "SourceControl": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a SourceControl in Azure Security Insights.", + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "source control properties", + "$ref": "#/definitions/SourceControlProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "SourceControlProperties": { + "description": "Describes source control properties", + "properties": { + "id": { + "description": "The id (a Guid) of the source control", + "type": "string", + "readOnly": true + }, + "version": { + "$ref": "#/definitions/Version", + "description": "The version number associated with the source control", + "type": "string" + }, + "displayName": { + "description": "The display name of the source control", + "type": "string" + }, + "description": { + "description": "A description of the source control", + "type": "string" + }, + "repoType": { + "$ref": "#/definitions/RepoType", + "description": "The repository type of the source control", + "type": "string" + }, + "contentTypes": { + "description": "Array of source control content types.", + "items": { + "$ref": "#/definitions/ContentType" + }, + "type": "array" + }, + "repository": { + "description": "Repository metadata.", + "$ref": "#/definitions/Repository" + }, + "servicePrincipal": { + "description": "Service principal metadata.", + "$ref": "#/definitions/ServicePrincipal" + }, + "repositoryAccess": { + "description": "Repository access credentials. This is write-only object and it never returns back to a user.", + "x-ms-mutability": [ + "create", + "update" + ], + "$ref": "#/definitions/RepositoryAccess" + }, + "repositoryResourceInfo": { + "description": "Information regarding the resources created in user's repository.", + "$ref": "#/definitions/RepositoryResourceInfo" + }, + "lastDeploymentInfo": { + "description": "Information regarding the latest deployment for the source control.", + "$ref": "#/definitions/DeploymentInfo" + }, + "pullRequest": { + "description": "Information regarding the pull request of the source control.", + "$ref": "#/definitions/PullRequest" + } + }, + "required": [ + "displayName", + "repoType", + "contentTypes", + "repository" + ], + "type": "object" + }, + "RepositoryAccess": { + "type": "object", + "description": "Credentials to access repository.", + "required": [ + "kind" + ], + "properties": { + "kind": { + "description": "The kind of repository access credentials", + "$ref": "#/definitions/RepositoryAccessKind" + }, + "code": { + "x-ms-secret": true, + "type": "string", + "description": "OAuth Code. Required when `kind` is `OAuth`" + }, + "state": { + "x-ms-secret": true, + "type": "string", + "description": "OAuth State. Required when `kind` is `OAuth`" + }, + "clientId": { + "type": "string", + "description": "OAuth ClientId. Required when `kind` is `OAuth`" + }, + "token": { + "x-ms-secret": true, + "type": "string", + "description": "Personal Access Token. Required when `kind` is `PAT`" + }, + "installationId": { + "type": "string", + "description": "Application installation ID. Required when `kind` is `App`. Supported by `GitHub` only." + } + } + }, + "RepositoryAccessObject": { + "description": "Credentials to access repository.", + "type": "object", + "required": [ + "repositoryAccess" + ], + "properties": { + "repositoryAccess": { + "description": "RepositoryAccess properties", + "$ref": "#/definitions/RepositoryAccess", + "x-ms-client-flatten": true + } + } + }, + "RepositoryAccessProperties": { + "description": "Credentials to access repository.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "RepositoryAccess properties", + "$ref": "#/definitions/RepositoryAccessObject", + "x-ms-client-flatten": true + } + } + }, + "Repository": { + "type": "object", + "required": [ + "url", + "branch" + ], + "description": "metadata of a repository.", + "properties": { + "url": { + "description": "Url of repository.", + "type": "string" + }, + "branch": { + "description": "Branch name of repository.", + "type": "string" + }, + "displayUrl": { + "description": "Display url of repository.", + "type": "string" + }, + "deploymentLogsUrl": { + "description": "Url to access repository action logs.", + "type": "string", + "readOnly": true + } + } + }, + "ServicePrincipal": { + "type": "object", + "description": "Service principal metadata.", + "properties": { + "id": { + "description": "Id of service principal.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Tenant id of service principal.", + "type": "string", + "readOnly": true + }, + "appId": { + "description": "App id of service principal.", + "type": "string", + "readOnly": true + }, + "credentialsExpireOn": { + "format": "date-time", + "description": "Expiration time of service principal credentials.", + "type": "string" + } + } + }, + "RepositoryResourceInfo": { + "type": "object", + "description": "Resources created in user's repository for the source-control.", + "properties": { + "webhook": { + "type": "object", + "description": "The webhook object created for the source-control.", + "$ref": "#/definitions/Webhook" + }, + "gitHubResourceInfo": { + "type": "object", + "description": "Resources created in GitHub for this source-control.", + "$ref": "#/definitions/GitHubResourceInfo" + }, + "azureDevOpsResourceInfo": { + "type": "object", + "description": "Resources created in Azure DevOps for this source-control.", + "$ref": "#/definitions/AzureDevOpsResourceInfo" + } + } + }, + "Webhook": { + "description": "Detail about the webhook object.", + "type": "object", + "properties": { + "webhookId": { + "description": "Unique identifier for the webhook.", + "type": "string", + "readOnly": true + }, + "webhookUrl": { + "description": "URL that gets invoked by the webhook.", + "type": "string", + "readOnly": true + }, + "webhookSecretUpdateTime": { + "format": "date-time", + "description": "Time when the webhook secret was updated.", + "type": "string", + "readOnly": true + }, + "rotateWebhookSecret": { + "description": "A flag to instruct the backend service to rotate webhook secret.", + "type": "boolean" + } + } + }, + "GitHubResourceInfo": { + "readOnly": true, + "description": "Resources created in GitHub repository.", + "type": "object", + "properties": { + "appInstallationId": { + "description": "GitHub application installation id.", + "type": "string" + } + } + }, + "AzureDevOpsResourceInfo": { + "readOnly": true, + "description": "Resources created in Azure DevOps repository.", + "type": "object", + "properties": { + "pipelineId": { + "description": "Id of the pipeline created for the source-control.", + "type": "string" + }, + "serviceConnectionId": { + "description": "Id of the service-connection created for the source-control.", + "type": "string" + } + } + }, + "DeploymentInfo": { + "readOnly": true, + "description": "Information regarding a deployment.", + "type": "object", + "properties": { + "deploymentFetchStatus": { + "$ref": "#/definitions/DeploymentFetchStatus", + "description": "Status while fetching the last deployment.", + "type": "string" + }, + "deployment": { + "$ref": "#/definitions/Deployment", + "description": "Deployment information.", + "type": "object" + }, + "message": { + "description": "Additional details about the deployment that can be shown to the user.", + "type": "string" + } + } + }, + "Deployment": { + "description": "Description about a deployment.", + "type": "object", + "properties": { + "deploymentId": { + "description": "Deployment identifier.", + "type": "string" + }, + "deploymentState": { + "$ref": "#/definitions/DeploymentState", + "description": "Current status of the deployment.", + "type": "string" + }, + "deploymentResult": { + "$ref": "#/definitions/DeploymentResult", + "description": "The outcome of the deployment.", + "type": "string" + }, + "deploymentTime": { + "format": "date-time", + "description": "The time when the deployment finished.", + "type": "string" + }, + "deploymentLogsUrl": { + "description": "Url to access repository action logs.", + "type": "string" + } + } + }, + "ContentType": { + "description": "The content type of a source control path.", + "enum": [ + "AnalyticRule", + "AutomationRule", + "HuntingQuery", + "Parser", + "Playbook", + "Workbook" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ContentType", + "values": [ + { + "value": "AnalyticRule" + }, + { + "value": "AutomationRule" + }, + { + "value": "HuntingQuery" + }, + { + "value": "Parser" + }, + { + "value": "Playbook" + }, + { + "value": "Workbook" + } + ] + } + }, + "RepoType": { + "description": "The type of repository.", + "enum": [ + "Github", + "AzureDevOps" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RepoType", + "values": [ + { + "value": "Github" + }, + { + "value": "AzureDevOps" + } + ] + } + }, + "RepositoryAccessKind": { + "description": "The kind of repository access credentials", + "enum": [ + "OAuth", + "PAT", + "App" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RepositoryAccessKind", + "values": [ + { + "value": "OAuth" + }, + { + "value": "PAT" + }, + { + "value": "App" + } + ] + } + }, + "Version": { + "readOnly": true, + "description": "The version of the source control.", + "enum": [ + "V1", + "V2" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Version", + "values": [ + { + "value": "V1" + }, + { + "value": "V2" + } + ] + } + }, + "DeploymentFetchStatus": { + "description": "Status while trying to fetch the deployment information.", + "enum": [ + "Success", + "Unauthorized", + "NotFound" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeploymentFetchStatus", + "values": [ + { + "value": "Success" + }, + { + "value": "Unauthorized" + }, + { + "value": "NotFound" + } + ] + } + }, + "DeploymentState": { + "description": "The current state of the deployment.", + "enum": [ + "In_Progress", + "Completed", + "Queued", + "Canceling" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeploymentState", + "values": [ + { + "value": "In_Progress" + }, + { + "value": "Completed" + }, + { + "value": "Queued" + }, + { + "value": "Canceling" + } + ] + } + }, + "DeploymentResult": { + "description": "Status while trying to fetch the deployment information.", + "enum": [ + "Success", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeploymentResult", + "values": [ + { + "value": "Success" + }, + { + "value": "Canceled" + }, + { + "value": "Failed" + } + ] + } + }, + "PullRequest": { + "readOnly": true, + "description": "Information regarding pull request for protected branches.", + "type": "object", + "properties": { + "url": { + "description": "URL of pull request", + "type": "string", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/PullRequestState", + "description": "State of the pull request", + "type": "object", + "readOnly": true + } + } + }, + "PullRequestState": { + "description": "Status of the pull request.", + "enum": [ + "Open", + "Closed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "state", + "values": [ + { + "value": "Open" + }, + { + "value": "Closed" + } + ] + } + }, + "Warning": { + "description": "Warning response structure.", + "properties": { + "warning": { + "$ref": "#/definitions/WarningBody", + "description": "Warning data." + } + }, + "type": "object" + }, + "WarningBody": { + "readOnly": true, + "description": "Warning details.", + "properties": { + "code": { + "description": "An identifier for the warning. Codes are invariant and are intended to be consumed programmatically.", + "readOnly": true, + "type": "object", + "$ref": "#/definitions/WarningCode" + }, + "message": { + "description": "A message describing the warning, intended to be suitable for display in a user interface.", + "readOnly": true, + "type": "string" + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/WarningBody" + }, + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "WarningCode": { + "readOnly": true, + "description": "The type of repository.", + "enum": [ + "SourceControlWarning_DeleteServicePrincipal", + "SourceControlWarning_DeletePipelineFromAzureDevOps", + "SourceControlWarning_DeleteWorkflowAndSecretFromGitHub", + "SourceControlWarning_DeleteRoleAssignment", + "SourceControl_DeletedWithWarnings" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "WarningCode", + "values": [ + { + "value": "SourceControlWarning_DeleteServicePrincipal" + }, + { + "value": "SourceControlWarning_DeletePipelineFromAzureDevOps" + }, + { + "value": "SourceControlWarning_DeleteWorkflowAndSecretFromGitHub" + }, + { + "value": "SourceControlWarning_DeleteRoleAssignment" + }, + { + "value": "SourceControl_DeletedWithWarnings" + } + ] + } + } + }, + "parameters": { + "RepoTypeParameter": { + "description": "The repo type.", + "in": "body", + "name": "repoType", + "required": true, + "schema": { + "$ref": "#/definitions/RepoType" + }, + "x-ms-parameter-location": "method" + }, + "SourceControlIdParameter": { + "description": "Source control Id", + "in": "path", + "name": "sourceControlId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SourceControl": { + "description": "The SourceControl", + "in": "body", + "name": "sourceControl", + "required": true, + "schema": { + "$ref": "#/definitions/SourceControl" + }, + "x-ms-parameter-location": "method" + }, + "RepositoryAccess": { + "description": "The repository access credentials.", + "in": "body", + "name": "repositoryAccess", + "required": true, + "schema": { + "required": [ + "repositoryAccess" + ], + "$ref": "#/definitions/RepositoryAccessProperties" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/ThreatIntelligence.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ThreatIntelligence.json similarity index 99% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/ThreatIntelligence.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ThreatIntelligence.json index 0f74ab40b..e8d8690b5 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/ThreatIntelligence.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/ThreatIntelligence.json @@ -3,7 +3,7 @@ "info": { "title": "Security Insights", "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", - "version": "2023-02-01" + "version": "2024-03-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Watchlists.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/Watchlists.json similarity index 98% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Watchlists.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/Watchlists.json index 3e2a890c3..563e491d4 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Watchlists.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/Watchlists.json @@ -3,7 +3,7 @@ "info": { "title": "Security Insights", "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", - "version": "2023-02-01" + "version": "2024-03-01" }, "host": "management.azure.com", "schemes": [ @@ -480,16 +480,8 @@ "type": "string" }, "source": { - "description": "The source of the watchlist", - "enum": [ - "Local file", - "Remote storage" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "source" - } + "description": "The source of the watchlist. Only accepts \"Local file\" and \"Remote storage\". And it must included in the request.", + "type": "string" }, "created": { "description": "The time the watchlist was created", @@ -567,7 +559,6 @@ }, "required": [ "displayName", - "source", "provider", "itemsSearchKey" ], diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/common/AlertTypes.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/common/AlertTypes.json similarity index 98% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/common/AlertTypes.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/common/AlertTypes.json index e788531b7..917f277e4 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/common/AlertTypes.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/common/AlertTypes.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-02-01", + "version": "2024-03-01", "title": "Common Alert types" }, "paths": {}, diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/common/ContentCommonTypes.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/common/ContentCommonTypes.json new file mode 100644 index 000000000..5ed005af9 --- /dev/null +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/common/ContentCommonTypes.json @@ -0,0 +1,646 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-03-01", + "title": "Common content metadata types" + }, + "paths": {}, + "definitions": { + "metadataContentId": { + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a metadata, both will have the same contentId.", + "type": "string" + }, + "metadataParentId": { + "description": "Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)", + "type": "string" + }, + "metadataDisplayName": { + "description": "DisplayName of the content.", + "type": "string" + }, + "metadataVersion": { + "description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks", + "type": "string" + }, + "metadataPackageKind": { + "description": "The package kind", + "enum": [ + "Solution", + "Standalone" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "packageKind", + "values": [ + { + "value": "Solution" + }, + { + "value": "Standalone" + } + ] + } + }, + "metadataKind": { + "type": "string", + "description": "The kind of content the metadata is for.", + "enum": [ + "DataConnector", + "DataType", + "Workbook", + "WorkbookTemplate", + "Playbook", + "PlaybookTemplate", + "AnalyticsRuleTemplate", + "AnalyticsRule", + "HuntingQuery", + "InvestigationQuery", + "Parser", + "Watchlist", + "WatchlistTemplate", + "Solution", + "AzureFunction", + "LogicAppsCustomConnector", + "AutomationRule" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "kind", + "values": [ + { + "value": "DataConnector" + }, + { + "value": "DataType" + }, + { + "value": "Workbook" + }, + { + "value": "WorkbookTemplate" + }, + { + "value": "Playbook" + }, + { + "value": "PlaybookTemplate" + }, + { + "value": "AnalyticsRuleTemplate" + }, + { + "value": "AnalyticsRule" + }, + { + "value": "HuntingQuery" + }, + { + "value": "InvestigationQuery" + }, + { + "value": "Parser" + }, + { + "value": "Watchlist" + }, + { + "value": "WatchlistTemplate" + }, + { + "value": "Solution" + }, + { + "value": "AzureFunction" + }, + { + "value": "LogicAppsCustomConnector" + }, + { + "value": "AutomationRule" + } + ] + } + }, + "metadataTrueFalseFlag": { + "type": "string", + "description": "The boolean value the metadata is for.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "flag", + "values": [ + { + "value": "true" + }, + { + "value": "false" + } + ] + } + }, + "metadataSource": { + "description": "The original source of the content item, where it comes from.", + "type": "object", + "required": [ + "kind" + ], + "properties": { + "kind": { + "description": "Source type of the content", + "type": "string", + "enum": [ + "LocalWorkspace", + "Community", + "Solution", + "SourceRepository" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "sourceKind", + "values": [ + { + "value": "LocalWorkspace" + }, + { + "value": "Community" + }, + { + "value": "Solution" + }, + { + "value": "SourceRepository" + } + ] + } + }, + "name": { + "description": "Name of the content source. The repo name, solution name, LA workspace name etc.", + "type": "string" + }, + "sourceId": { + "description": "ID of the content source. The solution ID, workspace ID, etc", + "type": "string" + } + } + }, + "metadataAuthor": { + "type": "object", + "description": "Publisher or creator of the content item.", + "properties": { + "name": { + "description": "Name of the author. Company or person.", + "type": "string" + }, + "email": { + "description": "Email of author contact", + "type": "string" + }, + "link": { + "description": "Link for author/vendor page", + "type": "string" + } + } + }, + "metadataSupport": { + "type": "object", + "description": "Support information for the content item.", + "required": [ + "tier" + ], + "properties": { + "tier": { + "description": "Type of support for content item", + "type": "string", + "enum": [ + "Microsoft", + "Partner", + "Community" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "supportTier", + "values": [ + { + "value": "Microsoft" + }, + { + "value": "Partner" + }, + { + "value": "Community" + } + ] + } + }, + "name": { + "description": "Name of the support contact. Company or person.", + "type": "string" + }, + "email": { + "description": "Email of support contact", + "type": "string" + }, + "link": { + "description": "Link for support help, like to support page to open a ticket etc.", + "type": "string" + } + } + }, + "metadataDependencies": { + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies.", + "type": "object", + "properties": { + "contentId": { + "description": "Id of the content item we depend on", + "$ref": "#/definitions/metadataContentId" + }, + "kind": { + "description": "Type of the content item we depend on", + "$ref": "#/definitions/metadataKind" + }, + "version": { + "description": "Version of the the content item we depend on. Can be blank, * or missing to indicate any version fulfills the dependency. If version does not match our defined numeric format then an exact match is required.", + "$ref": "#/definitions/metadataVersion" + }, + "name": { + "description": "Name of the content item", + "type": "string" + }, + "operator": { + "description": "Operator used for list of dependencies in criteria array.", + "type": "string", + "enum": [ + "AND", + "OR" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "operator", + "values": [ + { + "value": "AND" + }, + { + "value": "OR" + } + ] + } + }, + "criteria": { + "description": "This is the list of dependencies we must fulfill, according to the AND/OR operator", + "type": "array", + "items": { + "$ref": "#/definitions/metadataDependencies", + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." + }, + "x-ms-identifiers": [ + "contentId" + ], + "example": [ + { + "kind": "DataConnector", + "contentId": "68b1de8a-b635-430d-b208-01ba3dda5877", + "version": "1.0.0" + }, + { + "kind": "Workbook", + "contentId": "ad903b46-9905-4504-9825-3bcce796da8e", + "version": "1.0.0" + } + ] + } + } + }, + "metadataCategories": { + "type": "object", + "description": "ies for the solution content item", + "properties": { + "domains": { + "description": "domain for the solution content item", + "type": "array", + "example": [ + "str1", + "str2", + "str3" + ], + "items": { + "type": "string" + } + }, + "verticals": { + "description": "Industry verticals for the solution content item", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "str1", + "str2", + "str3" + ] + } + } + }, + "metadataProviders": { + "description": "Providers for the solution content item", + "type": "array", + "example": [ + "str1", + "str2", + "str3" + ], + "items": { + "type": "string" + } + }, + "metadataFirstPublishDate": { + "description": "first publish date of solution content item", + "type": "string", + "format": "date" + }, + "metadataLastPublishDate": { + "description": "last publish date of solution content item", + "type": "string", + "format": "date" + }, + "metadataCustomVersion": { + "description": "The custom version of the content. A optional free text", + "type": "string" + }, + "metadataContentSchemaVersion": { + "description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version", + "type": "string" + }, + "metadataIcon": { + "description": "the icon identifier. this id can later be fetched from the metadata", + "type": "string" + }, + "metadataThreatAnalysisTactics": { + "description": "the tactics the resource covers", + "type": "array", + "example": [ + "reconnaissance", + "exfiltration" + ], + "items": { + "type": "string" + } + }, + "metadataThreatAnalysisTechniques": { + "description": "the techniques the resource covers, these have to be aligned with the tactics being used", + "type": "array", + "example": [ + "T1548", + "T1548.001", + "T1134.003" + ], + "items": { + "type": "string" + } + }, + "metadataPreviewImages": { + "description": "preview image file names. These will be taken from the solution artifacts", + "type": "array", + "example": [ + "example.png", + "example2.jpeg" + ], + "items": { + "type": "string" + } + }, + "metadataPreviewImagesDark": { + "description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support", + "type": "array", + "example": [ + "example.png", + "example2.jpeg" + ], + "items": { + "type": "string" + } + }, + "metadataTags": { + "description": "the tags assigned to the resource", + "type": "array", + "example": [ + "str1", + "str2", + "str3" + ], + "items": { + "type": "string" + } + }, + "templateBaseProperties": { + "description": "Template property bag.", + "type": "object", + "properties": { + "contentId": { + "$ref": "#/definitions/metadataContentId", + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Dynamic for user-created. This is the resource name" + }, + "contentProductId": { + "type": "string", + "description": "Unique ID for the content. It should be generated based on the contentId of the package, contentId of the template, contentKind of the template and the contentVersion of the template" + }, + "packageVersion": { + "$ref": "#/definitions/metadataVersion", + "description": "Version of the package. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM metadata best practices. Can also be any string, but then we cannot guarantee any version checks" + }, + "version": { + "$ref": "#/definitions/metadataVersion", + "description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM metadata best practices. Can also be any string, but then we cannot guarantee any version checks" + }, + "displayName": { + "$ref": "#/definitions/metadataDisplayName", + "description": "The display name of the template" + }, + "contentKind": { + "$ref": "#/definitions/metadataKind", + "description": "The kind of content the template is for." + }, + "source": { + "$ref": "#/definitions/metadataSource", + "description": "Source of the content. This is where/how it was created." + }, + "author": { + "$ref": "#/definitions/metadataAuthor", + "description": "The creator of the content item." + }, + "support": { + "$ref": "#/definitions/metadataSupport", + "description": "Support information for the template - type, name, contact information" + }, + "dependencies": { + "$ref": "#/definitions/metadataDependencies", + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." + }, + "categories": { + "$ref": "#/definitions/metadataCategories", + "description": "Categories for the item" + }, + "providers": { + "$ref": "#/definitions/metadataProviders", + "description": "Providers for the content item" + }, + "firstPublishDate": { + "$ref": "#/definitions/metadataFirstPublishDate", + "description": "first publish date content item" + }, + "lastPublishDate": { + "$ref": "#/definitions/metadataLastPublishDate", + "description": "last publish date for the content item" + }, + "customVersion": { + "$ref": "#/definitions/metadataCustomVersion", + "description": "The custom version of the content. A optional free text" + }, + "contentSchemaVersion": { + "$ref": "#/definitions/metadataContentSchemaVersion", + "description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version" + }, + "icon": { + "$ref": "#/definitions/metadataIcon", + "description": "the icon identifier. this id can later be fetched from the content metadata" + }, + "threatAnalysisTactics": { + "$ref": "#/definitions/metadataThreatAnalysisTactics", + "description": "the tactics the resource covers" + }, + "threatAnalysisTechniques": { + "$ref": "#/definitions/metadataThreatAnalysisTechniques", + "description": "the techniques the resource covers, these have to be aligned with the tactics being used" + }, + "previewImages": { + "$ref": "#/definitions/metadataPreviewImages", + "description": "preview image file names. These will be taken from the solution artifacts" + }, + "previewImagesDark": { + "$ref": "#/definitions/metadataPreviewImagesDark", + "description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support" + }, + "packageId": { + "$ref": "#/definitions/metadataContentId", + "description": "the package Id contains this template" + }, + "packageKind": { + "$ref": "#/definitions/metadataPackageKind", + "description": "the packageKind of the package contains this template" + }, + "packageName": { + "$ref": "#/definitions/metadataDisplayName", + "description": "the name of the package contains this template" + }, + "isDeprecated": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this template is deprecated", + "readOnly": true + } + } + }, + "packageBaseProperties": { + "description": "Describes package properties", + "properties": { + "contentId": { + "$ref": "#/definitions/metadataContentId", + "description": "The content id of the package" + }, + "contentProductId": { + "type": "string", + "description": "Unique ID for the content. It should be generated based on the contentId, contentKind and the contentVersion of the package" + }, + "contentKind": { + "$ref": "#/definitions/metadataPackageKind", + "description": "The package kind" + }, + "contentSchemaVersion": { + "$ref": "#/definitions/metadataVersion", + "description": "The version of the content schema." + }, + "isNew": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this is a newly published package." + }, + "isPreview": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this package is in preview." + }, + "isFeatured": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this package is among the featured list." + }, + "isDeprecated": { + "$ref": "#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this template is deprecated" + }, + "version": { + "$ref": "#/definitions/metadataVersion", + "description": "the latest version number of the package" + }, + "displayName": { + "$ref": "#/definitions/metadataDisplayName", + "description": "The display name of the package" + }, + "description": { + "description": "The description of the package", + "type": "string" + }, + "publisherDisplayName": { + "$ref": "#/definitions/metadataDisplayName", + "description": "The publisher display name of the package" + }, + "source": { + "$ref": "#/definitions/metadataSource", + "description": "The source of the package" + }, + "author": { + "$ref": "#/definitions/metadataAuthor", + "description": "The author of the package" + }, + "support": { + "$ref": "#/definitions/metadataSupport", + "description": "The support tier of the package" + }, + "dependencies": { + "$ref": "#/definitions/metadataDependencies", + "description": "The support tier of the package" + }, + "providers": { + "$ref": "#/definitions/metadataProviders", + "description": "Providers for the package item" + }, + "firstPublishDate": { + "$ref": "#/definitions/metadataFirstPublishDate", + "description": "first publish date package item" + }, + "lastPublishDate": { + "$ref": "#/definitions/metadataLastPublishDate", + "description": "last publish date for the package item" + }, + "categories": { + "$ref": "#/definitions/metadataCategories", + "description": "The categories of the package" + }, + "threatAnalysisTactics": { + "$ref": "#/definitions/metadataThreatAnalysisTactics", + "description": "the tactics the resource covers" + }, + "threatAnalysisTechniques": { + "$ref": "#/definitions/metadataThreatAnalysisTechniques", + "description": "the techniques the resource covers, these have to be aligned with the tactics being used" + }, + "icon": { + "$ref": "#/definitions/metadataIcon", + "description": "the icon identifier. this id can later be fetched from the content metadata" + } + }, + "type": "object" + } + }, + "parameters": {} +} diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/common/EntityTypes.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/common/EntityTypes.json similarity index 99% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/common/EntityTypes.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/common/EntityTypes.json index e078a663f..f9e8cc91f 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/common/EntityTypes.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/common/EntityTypes.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-02-01", + "version": "2024-03-01", "title": "Common Entity types" }, "paths": {}, diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/common/IncidentTypes.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/common/IncidentTypes.json similarity index 99% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/common/IncidentTypes.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/common/IncidentTypes.json index 767404692..dc944ba3d 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/common/IncidentTypes.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/common/IncidentTypes.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-02-01", + "version": "2024-03-01", "title": "Common Incident types" }, "paths": {}, diff --git a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/operations.json b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/operations.json similarity index 99% rename from swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/operations.json rename to swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/operations.json index baf8d972e..e2c81fb13 100644 --- a/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/operations.json +++ b/swagger-specs/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-03-01/operations.json @@ -3,7 +3,7 @@ "info": { "title": "Security Insights", "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", - "version": "2023-02-01" + "version": "2024-03-01" }, "host": "management.azure.com", "schemes": [ diff --git a/swagger-specs/securityinsights/resource-manager/api-set.json b/swagger-specs/securityinsights/resource-manager/api-set.json index 7f225f1d9..f17bfb547 100644 --- a/swagger-specs/securityinsights/resource-manager/api-set.json +++ b/swagger-specs/securityinsights/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json", "Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json", "Microsoft.SecurityInsights/stable/2023-02-01/Bookmarks.json", "Microsoft.SecurityInsights/stable/2023-02-01/DataConnectors.json", "Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json", "Microsoft.SecurityInsights/stable/2023-02-01/Metadata.json", "Microsoft.SecurityInsights/stable/2023-02-01/OnboardingStates.json", "Microsoft.SecurityInsights/stable/2023-02-01/SecurityMLAnalyticsSettings.json", "Microsoft.SecurityInsights/stable/2023-02-01/ThreatIntelligence.json", "Microsoft.SecurityInsights/stable/2023-02-01/Watchlists.json", "Microsoft.SecurityInsights/stable/2023-02-01/operations.json"], "name": "package-2023-02"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.SecurityInsights/stable/2024-03-01/AlertRules.json", "Microsoft.SecurityInsights/stable/2024-03-01/AutomationRules.json", "Microsoft.SecurityInsights/stable/2024-03-01/Bookmarks.json", "Microsoft.SecurityInsights/stable/2024-03-01/ContentPackages.json", "Microsoft.SecurityInsights/stable/2024-03-01/ContentProductPackages.json", "Microsoft.SecurityInsights/stable/2024-03-01/ContentProductTemplates.json", "Microsoft.SecurityInsights/stable/2024-03-01/ContentTemplates.json", "Microsoft.SecurityInsights/stable/2024-03-01/DataConnectors.json", "Microsoft.SecurityInsights/stable/2024-03-01/Incidents.json", "Microsoft.SecurityInsights/stable/2024-03-01/Metadata.json", "Microsoft.SecurityInsights/stable/2024-03-01/OnboardingStates.json", "Microsoft.SecurityInsights/stable/2024-03-01/SecurityMLAnalyticsSettings.json", "Microsoft.SecurityInsights/stable/2024-03-01/SourceControls.json", "Microsoft.SecurityInsights/stable/2024-03-01/ThreatIntelligence.json", "Microsoft.SecurityInsights/stable/2024-03-01/Watchlists.json", "Microsoft.SecurityInsights/stable/2024-03-01/operations.json"], "name": "package-2024-03"} \ No newline at end of file diff --git a/swagger-specs/servicebus/data-plane/Microsoft.ServiceBus/stable/2021-05/servicebus.json b/swagger-specs/servicebus/data-plane/Microsoft.ServiceBus/stable/2021-05/servicebus.json index 971b4852e..4e2e0a466 100644 --- a/swagger-specs/servicebus/data-plane/Microsoft.ServiceBus/stable/2021-05/servicebus.json +++ b/swagger-specs/servicebus/data-plane/Microsoft.ServiceBus/stable/2021-05/servicebus.json @@ -1607,6 +1607,30 @@ } } }, + "KeyObjectValue": { + "description": "Key Values of custom properties", + "type": "object", + "xml": { + "name": "KeyValueOfObjectType", + "namespace": "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" + }, + "properties": { + "key": { + "type": "string", + "xml": { + "name": "Key", + "namespace": "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" + } + }, + "value": { + "type": "object", + "xml": { + "name": "Value", + "namespace": "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" + } + } + } + }, "RuleFilter": { "type": "object", "discriminator": "type", @@ -1700,7 +1724,7 @@ "namespace": "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" }, "items": { - "$ref": "#/definitions/KeyValue" + "$ref": "#/definitions/KeyObjectValue" } } } diff --git a/swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/managedapplication.json b/swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/stable/2024-04-01/managedapplication.json similarity index 99% rename from swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/managedapplication.json rename to swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/stable/2024-04-01/managedapplication.json index 458ac3d71..a2ca26816 100644 --- a/swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/managedapplication.json +++ b/swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/stable/2024-04-01/managedapplication.json @@ -3,7 +3,7 @@ "info": { "title": "ServiceFabricManagementClient", "description": "Azure Service Fabric Resource Provider API Client", - "version": "2023-11-01-preview" + "version": "2024-04-01" }, "host": "management.azure.com", "schemes": [ @@ -1827,10 +1827,12 @@ }, "HealthCheckStableDuration": { "type": "string", + "x-ms-format": "duration-constant", "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." }, "HealthCheckWaitDuration": { "type": "string", + "x-ms-format": "duration-constant", "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." }, "ManagedIdentity": { @@ -2973,7 +2975,7 @@ "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 \"2023-11-01-preview\" for this specification.", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2024-04-01\" for this specification.", "required": true, "type": "string", "x-ms-parameter-location": "client" diff --git a/swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/managedcluster.json b/swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/stable/2024-04-01/managedcluster.json similarity index 98% rename from swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/managedcluster.json rename to swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/stable/2024-04-01/managedcluster.json index 55c938f2e..019c4b155 100644 --- a/swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/managedcluster.json +++ b/swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/stable/2024-04-01/managedcluster.json @@ -3,7 +3,7 @@ "info": { "title": "ServiceFabricManagementClient", "description": "Azure Service Fabric Resource Provider API Client", - "version": "2023-11-01-preview" + "version": "2024-04-01" }, "host": "management.azure.com", "schemes": [ @@ -992,10 +992,12 @@ "properties": { "healthCheckWaitDuration": { "type": "string", + "x-ms-format": "duration-constant", "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", + "x-ms-format": "duration-constant", "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": { @@ -1160,24 +1162,6 @@ }, "description": "Describes the policy used when upgrading the cluster." }, - "IPTag": { - "type": "object", - "required": [ - "ipTagType", - "tag" - ], - "properties": { - "ipTagType": { - "type": "string", - "description": "The IP tag type." - }, - "tag": { - "type": "string", - "description": "The value of the IP tag." - } - }, - "description": "IPTag associated with the object." - }, "LoadBalancingRule": { "type": "object", "required": [ @@ -1496,7 +1480,7 @@ "ipTags": { "type": "array", "items": { - "$ref": "#/definitions/IPTag" + "$ref": "#/definitions/IpTag" }, "x-ms-identifiers": [], "description": "The list of IP tags associated with the default public IP address of the cluster." @@ -1573,6 +1557,15 @@ "upgradeDescription": { "$ref": "#/definitions/ClusterUpgradePolicy", "description": "The policy to use when upgrading the cluster." + }, + "httpGatewayTokenAuthConnectionPort": { + "type": "integer", + "format": "int32", + "description": "The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint." + }, + "enableHttpGatewayExclusiveAuthMode": { + "type": "boolean", + "description": "If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined." } }, "description": "Describes the managed cluster resource properties." @@ -1731,6 +1724,11 @@ "type": "boolean", "description": "VM Size name.", "readOnly": true + }, + "details": { + "type": "string", + "description": "Zone resiliency status details for the resource.", + "readOnly": true } }, "description": "Describes Az Resiliency status of Base resources" @@ -1931,6 +1929,24 @@ }, "description": "The error details." }, + "IpTag": { + "type": "object", + "required": [ + "ipTagType", + "tag" + ], + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "The IP tag associated with the public IP address." + }, "ManagedResourceProvisioningState": { "type": "string", "description": "The provisioning state of the managed resource.", @@ -2237,7 +2253,7 @@ "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 \"2023-11-01-preview\" for this specification.", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2024-04-01\" for this specification.", "required": true, "type": "string", "x-ms-parameter-location": "client" diff --git a/swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/nodetype.json b/swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/stable/2024-04-01/nodetype.json similarity index 97% rename from swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/nodetype.json rename to swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/stable/2024-04-01/nodetype.json index c0d1ee459..9d806ed89 100644 --- a/swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/nodetype.json +++ b/swagger-specs/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/stable/2024-04-01/nodetype.json @@ -3,7 +3,7 @@ "info": { "title": "ServiceFabricManagementClient", "description": "Azure Service Fabric Resource Provider API Client", - "version": "2023-11-01-preview" + "version": "2024-04-01" }, "host": "management.azure.com", "schemes": [ @@ -841,24 +841,6 @@ } } }, - "IpTag": { - "type": "object", - "required": [ - "ipTagType", - "tag" - ], - "properties": { - "ipTagType": { - "type": "string", - "description": "IP tag type. Example: FirstPartyUsage." - }, - "tag": { - "type": "string", - "description": "IP tag associated with the public IP. Example: SQL, Storage etc." - } - }, - "description": "The IP tag associated with the public IP address." - }, "ManagedProxyResource": { "type": "object", "properties": { @@ -1184,9 +1166,10 @@ }, "securityType": { "type": "string", - "description": "Specifies the security type of the nodeType. Only TrustedLaunch is currently supported", + "description": "Specifies the security type of the nodeType. Only Standard and TrustedLaunch are currently supported", "enum": [ - "TrustedLaunch" + "TrustedLaunch", + "Standard" ], "x-ms-enum": { "name": "securityType", @@ -1195,6 +1178,10 @@ { "value": "TrustedLaunch", "description": "Trusted Launch is a security type that secures generation 2 virtual machines." + }, + { + "value": "Standard", + "description": "Standard is the default security type for all machines." } ] } @@ -1238,6 +1225,14 @@ }, "description": "Specifies the resource id of a NAT Gateway to attach to the subnet of this node type. Node type must use custom load balancer." }, + "natConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeTypeNatConfig" + }, + "x-ms-identifiers": [], + "description": "Specifies the NAT configuration on default public Load Balancer for the node type. This is only supported for node types use the default public Load Balancer." + }, "vmImagePlan": { "$ref": "#/definitions/VmImagePlan", "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save." @@ -1275,6 +1270,10 @@ "name" ], "description": "Specifies the settings for any additional secondary network interfaces to attach to the node type." + }, + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix. Limited to 9 characters. If specified, allows for a longer name to be specified for the node type name." } }, "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." @@ -1297,6 +1296,33 @@ }, "description": "Node type list results" }, + "NodeTypeNatConfig": { + "type": "object", + "properties": { + "backendPort": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The internal port for the NAT configuration." + }, + "frontendPortRangeStart": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65534, + "description": "The port range start for the external endpoint." + }, + "frontendPortRangeEnd": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65534, + "description": "The port range end for the external endpoint." + } + }, + "description": "Provides information about NAT configuration on the default public Load Balancer for the node type." + }, "NodeTypeUpdateParameters": { "type": "object", "properties": { @@ -1756,6 +1782,24 @@ }, "description": "The error details." }, + "IpTag": { + "type": "object", + "required": [ + "ipTagType", + "tag" + ], + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "The IP tag associated with the public IP address." + }, "ManagedResourceProvisioningState": { "type": "string", "description": "The provisioning state of the managed resource.", @@ -1953,7 +1997,7 @@ "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 \"2023-11-01-preview\" for this specification.", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2024-04-01\" for this specification.", "required": true, "type": "string", "x-ms-parameter-location": "client" diff --git a/swagger-specs/servicefabricmanagedclusters/resource-manager/api-set.json b/swagger-specs/servicefabricmanagedclusters/resource-manager/api-set.json index 0f4086188..872f91e4c 100644 --- a/swagger-specs/servicefabricmanagedclusters/resource-manager/api-set.json +++ b/swagger-specs/servicefabricmanagedclusters/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.ServiceFabric/preview/2023-11-01-preview/managedapplication.json", "Microsoft.ServiceFabric/preview/2023-11-01-preview/managedcluster.json", "Microsoft.ServiceFabric/preview/2023-11-01-preview/nodetype.json"], "name": "package-2023-11-preview"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.ServiceFabric/stable/2024-04-01/managedapplication.json", "Microsoft.ServiceFabric/stable/2024-04-01/managedcluster.json", "Microsoft.ServiceFabric/stable/2024-04-01/nodetype.json"], "name": "package-2024-04"} \ No newline at end of file diff --git a/swagger-specs/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json b/swagger-specs/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json deleted file mode 100644 index 7d609af89..000000000 --- a/swagger-specs/servicenetworking/resource-manager/Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json +++ /dev/null @@ -1,1361 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "TrafficController", - "version": "2023-11-01", - "description": "Traffic Controller Provider management API.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "host": "management.azure.com", - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow.", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "tags": [ - { - "name": "AssociationsInterface" - }, - { - "name": "FrontendsInterface" - }, - { - "name": "TrafficControllerInterface" - }, - { - "name": "Operations" - } - ], - "paths": { - "/providers/Microsoft.ServiceNetworking/operations": { - "get": { - "operationId": "Operations_List", - "tags": [ - "Operations" - ], - "description": "List the operations for the provider", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Operations List": { - "$ref": "./examples/OperationsList.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceNetworking/trafficControllers": { - "get": { - "operationId": "TrafficControllerInterface_ListBySubscription", - "tags": [ - "TrafficControllerInterface" - ], - "description": "List TrafficController resources by subscription ID", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/TrafficControllerListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Traffic Controllers List": { - "$ref": "./examples/TrafficControllersGetList.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers": { - "get": { - "operationId": "TrafficControllerInterface_ListByResourceGroup", - "tags": [ - "TrafficControllerInterface" - ], - "description": "List TrafficController resources by resource group", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/TrafficControllerListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Traffic Controllers": { - "$ref": "./examples/TrafficControllersGet.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}": { - "get": { - "operationId": "TrafficControllerInterface_Get", - "tags": [ - "TrafficControllerInterface" - ], - "description": "Get a TrafficController", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/TrafficController" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Traffic Controller": { - "$ref": "./examples/TrafficControllerGet.json" - } - } - }, - "put": { - "operationId": "TrafficControllerInterface_CreateOrUpdate", - "tags": [ - "TrafficControllerInterface" - ], - "description": "Create a TrafficController", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/TrafficController" - } - } - ], - "responses": { - "200": { - "description": "Resource 'TrafficController' update operation succeeded", - "schema": { - "$ref": "#/definitions/TrafficController" - } - }, - "201": { - "description": "Resource 'TrafficController' create operation succeeded", - "schema": { - "$ref": "#/definitions/TrafficController" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Put Traffic Controller": { - "$ref": "./examples/TrafficControllerPut.json" - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true - }, - "patch": { - "operationId": "TrafficControllerInterface_Update", - "tags": [ - "TrafficControllerInterface" - ], - "description": "Update a TrafficController", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "properties", - "in": "body", - "description": "The resource properties to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/TrafficControllerUpdate" - } - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/TrafficController" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Patch Traffic Controller": { - "$ref": "./examples/TrafficControllerPatch.json" - } - } - }, - "delete": { - "operationId": "TrafficControllerInterface_Delete", - "tags": [ - "TrafficControllerInterface" - ], - "description": "Delete a TrafficController", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "202": { - "description": "Resource deletion accepted.", - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." - } - } - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete Traffic Controller": { - "$ref": "./examples/TrafficControllerDelete.json" - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations": { - "get": { - "operationId": "AssociationsInterface_ListByTrafficController", - "tags": [ - "AssociationsInterface" - ], - "description": "List Association resources by TrafficController", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/AssociationListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Associations": { - "$ref": "./examples/AssociationsGet.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations/{associationName}": { - "get": { - "operationId": "AssociationsInterface_Get", - "tags": [ - "AssociationsInterface" - ], - "description": "Get a Association", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "associationName", - "in": "path", - "description": "Name of Association", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/Association" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Association": { - "$ref": "./examples/AssociationGet.json" - } - } - }, - "put": { - "operationId": "AssociationsInterface_CreateOrUpdate", - "tags": [ - "AssociationsInterface" - ], - "description": "Create a Association", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "associationName", - "in": "path", - "description": "Name of Association", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/Association" - } - } - ], - "responses": { - "200": { - "description": "Resource 'Association' update operation succeeded", - "schema": { - "$ref": "#/definitions/Association" - } - }, - "201": { - "description": "Resource 'Association' create operation succeeded", - "schema": { - "$ref": "#/definitions/Association" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Put Association": { - "$ref": "./examples/AssociationPut.json" - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true - }, - "patch": { - "operationId": "AssociationsInterface_Update", - "tags": [ - "AssociationsInterface" - ], - "description": "Update a Association", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "associationName", - "in": "path", - "description": "Name of Association", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "properties", - "in": "body", - "description": "The resource properties to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AssociationUpdate" - } - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/Association" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Update Association": { - "$ref": "./examples/AssociationPatch.json" - } - } - }, - "delete": { - "operationId": "AssociationsInterface_Delete", - "tags": [ - "AssociationsInterface" - ], - "description": "Delete a Association", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "associationName", - "in": "path", - "description": "Name of Association", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "202": { - "description": "Resource deletion accepted.", - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." - } - } - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete Association": { - "$ref": "./examples/AssociationDelete.json" - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends": { - "get": { - "operationId": "FrontendsInterface_ListByTrafficController", - "tags": [ - "FrontendsInterface" - ], - "description": "List Frontend resources by TrafficController", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/FrontendListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Frontends": { - "$ref": "./examples/FrontendsGet.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends/{frontendName}": { - "get": { - "operationId": "FrontendsInterface_Get", - "tags": [ - "FrontendsInterface" - ], - "description": "Get a Frontend", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "frontendName", - "in": "path", - "description": "Frontends", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/Frontend" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Frontend": { - "$ref": "./examples/FrontendGet.json" - } - } - }, - "put": { - "operationId": "FrontendsInterface_CreateOrUpdate", - "tags": [ - "FrontendsInterface" - ], - "description": "Create a Frontend", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "frontendName", - "in": "path", - "description": "Frontends", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "resource", - "in": "body", - "description": "Resource create parameters.", - "required": true, - "schema": { - "$ref": "#/definitions/Frontend" - } - } - ], - "responses": { - "200": { - "description": "Resource 'Frontend' update operation succeeded", - "schema": { - "$ref": "#/definitions/Frontend" - } - }, - "201": { - "description": "Resource 'Frontend' create operation succeeded", - "schema": { - "$ref": "#/definitions/Frontend" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Put Frontend": { - "$ref": "./examples/FrontendPut.json" - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true - }, - "patch": { - "operationId": "FrontendsInterface_Update", - "tags": [ - "FrontendsInterface" - ], - "description": "Update a Frontend", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "frontendName", - "in": "path", - "description": "Frontends", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "properties", - "in": "body", - "description": "The resource properties to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/FrontendUpdate" - } - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/Frontend" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Update Frontend": { - "$ref": "./examples/FrontendPatch.json" - } - } - }, - "delete": { - "operationId": "FrontendsInterface_Delete", - "tags": [ - "FrontendsInterface" - ], - "description": "Delete a Frontend", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "trafficControllerName", - "in": "path", - "description": "traffic controller name for path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - }, - { - "name": "frontendName", - "in": "path", - "description": "Frontends", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "202": { - "description": "Resource deletion accepted.", - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - }, - "Location": { - "type": "string", - "description": "The Location header contains the URL where the status of the long running operation can be checked." - } - } - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete Frontend": { - "$ref": "./examples/FrontendDelete.json" - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "Association": { - "type": "object", - "description": "Association Subresource of Traffic Controller", - "properties": { - "properties": { - "$ref": "#/definitions/AssociationProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ] - }, - "AssociationListResult": { - "type": "object", - "description": "The response of a Association list operation.", - "properties": { - "value": { - "type": "array", - "description": "The Association items on this page", - "items": { - "$ref": "#/definitions/Association" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "AssociationProperties": { - "type": "object", - "description": "Association Properties.", - "properties": { - "associationType": { - "$ref": "#/definitions/AssociationType", - "description": "Association Type" - }, - "subnet": { - "$ref": "#/definitions/AssociationSubnet", - "description": "Association Subnet" - }, - "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "Provisioning State of Traffic Controller Association Resource", - "readOnly": true - } - }, - "required": [ - "associationType" - ] - }, - "AssociationSubnet": { - "type": "object", - "description": "Association Subnet.", - "properties": { - "id": { - "type": "string", - "description": "Association ID." - } - }, - "required": [ - "id" - ] - }, - "AssociationSubnetUpdate": { - "type": "object", - "description": "Association Subnet.", - "properties": { - "id": { - "type": "string", - "description": "Association ID." - } - } - }, - "AssociationType": { - "type": "string", - "enum": [ - "subnets" - ], - "x-ms-enum": { - "name": "AssociationType", - "modelAsString": true - } - }, - "AssociationUpdate": { - "type": "object", - "description": "The type used for update operations of the Association.", - "properties": { - "tags": { - "type": "object", - "description": "Resource tags.", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/AssociationUpdateProperties", - "x-ms-client-flatten": true - } - } - }, - "AssociationUpdateProperties": { - "type": "object", - "description": "The updatable properties of the Association.", - "properties": { - "associationType": { - "$ref": "#/definitions/AssociationType", - "description": "Association Type" - }, - "subnet": { - "$ref": "#/definitions/AssociationSubnetUpdate", - "description": "Association Subnet" - } - } - }, - "Frontend": { - "type": "object", - "description": "Frontend Subresource of Traffic Controller.", - "properties": { - "properties": { - "$ref": "#/definitions/FrontendProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ] - }, - "FrontendListResult": { - "type": "object", - "description": "The response of a Frontend list operation.", - "properties": { - "value": { - "type": "array", - "description": "The Frontend items on this page", - "items": { - "$ref": "#/definitions/Frontend" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "FrontendProperties": { - "type": "object", - "description": "Frontend Properties.", - "properties": { - "fqdn": { - "type": "string", - "description": "The Fully Qualified Domain Name of the DNS record associated to a Traffic Controller frontend.", - "readOnly": true - }, - "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "Provisioning State of Traffic Controller Frontend Resource", - "readOnly": true - } - } - }, - "FrontendUpdate": { - "type": "object", - "description": "The type used for update operations of the Frontend.", - "properties": { - "tags": { - "type": "object", - "description": "Resource tags.", - "additionalProperties": { - "type": "string" - } - } - } - }, - "ProvisioningState": { - "type": "string", - "enum": [ - "Provisioning", - "Updating", - "Deleting", - "Accepted", - "Succeeded", - "Failed", - "Canceled" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "ResourceId": { - "type": "object", - "description": "Resource ID definition used by parent to reference child resources.", - "properties": { - "id": { - "type": "string", - "description": "Resource ID of child resource." - } - }, - "required": [ - "id" - ] - }, - "TrafficController": { - "type": "object", - "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", - "properties": { - "properties": { - "$ref": "#/definitions/TrafficControllerProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ] - }, - "TrafficControllerListResult": { - "type": "object", - "description": "The response of a TrafficController list operation.", - "properties": { - "value": { - "type": "array", - "description": "The TrafficController items on this page", - "items": { - "$ref": "#/definitions/TrafficController" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "TrafficControllerProperties": { - "type": "object", - "description": "Traffic Controller Properties.", - "properties": { - "configurationEndpoints": { - "type": "array", - "description": "Configuration Endpoints.", - "items": { - "type": "string" - }, - "readOnly": true - }, - "frontends": { - "type": "array", - "description": "Frontends References List", - "items": { - "$ref": "#/definitions/ResourceId" - }, - "readOnly": true - }, - "associations": { - "type": "array", - "description": "Associations References List", - "items": { - "$ref": "#/definitions/ResourceId" - }, - "readOnly": true - }, - "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "The status of the last operation.", - "readOnly": true - } - } - }, - "TrafficControllerUpdate": { - "type": "object", - "description": "The type used for update operations of the TrafficController.", - "properties": { - "tags": { - "type": "object", - "description": "Resource tags.", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "parameters": {} -} diff --git a/swagger-specs/servicenetworking/resource-manager/api-set.json b/swagger-specs/servicenetworking/resource-manager/api-set.json deleted file mode 100644 index dbad0f48e..000000000 --- a/swagger-specs/servicenetworking/resource-manager/api-set.json +++ /dev/null @@ -1 +0,0 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.ServiceNetworking/stable/2023-11-01/TrafficController.json"], "name": "package-2023-11-01"} \ No newline at end of file diff --git a/swagger-specs/signalr/resource-manager/Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json b/swagger-specs/signalr/resource-manager/Microsoft.SignalRService/stable/2024-03-01/signalr.json similarity index 94% rename from swagger-specs/signalr/resource-manager/Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json rename to swagger-specs/signalr/resource-manager/Microsoft.SignalRService/stable/2024-03-01/signalr.json index 32788c4c4..021ab14f2 100644 --- a/swagger-specs/signalr/resource-manager/Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json +++ b/swagger-specs/signalr/resource-manager/Microsoft.SignalRService/stable/2024-03-01/signalr.json @@ -3,7 +3,7 @@ "info": { "title": "SignalRManagementClient", "description": "REST API for Azure SignalR Service", - "version": "2023-08-01-preview" + "version": "2024-03-01" }, "paths": { "/providers/Microsoft.SignalRService/operations": { @@ -1597,6 +1597,180 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List shared private link resources", + "operationId": "SignalRReplicaSharedPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of shared private link resources.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRReplicaSharedPrivateLinkResources_List": { + "$ref": "./examples/SignalRReplicaSharedPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the specified shared private link resource", + "operationId": "SignalRReplicaSharedPrivateLinkResources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a shared private link resource.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRReplicaSharedPrivateLinkResources_Get": { + "$ref": "./examples/SignalRReplicaSharedPrivateLinkResources_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a shared private link resource", + "operationId": "SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The shared private link resource", + "required": true, + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the shared private link resource is updated.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "201": { + "description": "Created. The response indicates the shared private link resource is created.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate": { + "$ref": "./examples/SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/skus": { "get": { "tags": [ @@ -1756,11 +1930,7 @@ ], "parameters": [ { - "in": "path", - "name": "sharedPrivateLinkResourceName", - "description": "The name of the shared private link resource", - "required": true, - "type": "string" + "$ref": "#/parameters/SharedPrivateLinkResourceName" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" @@ -1806,11 +1976,7 @@ ], "parameters": [ { - "in": "path", - "name": "sharedPrivateLinkResourceName", - "description": "The name of the shared private link resource", - "required": true, - "type": "string" + "$ref": "#/parameters/SharedPrivateLinkResourceName" }, { "in": "body", @@ -1872,11 +2038,7 @@ "operationId": "SignalRSharedPrivateLinkResources_Delete", "parameters": [ { - "in": "path", - "name": "sharedPrivateLinkResourceName", - "description": "The name of the shared private link resource", - "required": true, - "type": "string" + "$ref": "#/parameters/SharedPrivateLinkResourceName" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" @@ -2645,6 +2807,7 @@ "Moving" ], "type": "string", + "readOnly": true, "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true @@ -2760,7 +2923,7 @@ "type": "object", "properties": { "name": { - "description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1", + "description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2", "type": "string" }, "tier": { @@ -2778,7 +2941,7 @@ }, "capacity": { "format": "int32", - "description": "Optional, integer. The unit count of the resource. 1 by default.\r\n\r\nIf present, following values are allowed:\r\n Free: 1;\r\n Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;", + "description": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n Free_F1: 1;\r\n Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium_P2: 100,200,300,400,500,600,700,800,900,1000;", "type": "integer" } } @@ -3499,6 +3662,17 @@ "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", "type": "string", "x-ms-parameter-location": "method" + }, + "SharedPrivateLinkResourceName": { + "in": "path", + "name": "sharedPrivateLinkResourceName", + "description": "The name of the shared private link resource.", + "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" } }, "securityDefinitions": { diff --git a/swagger-specs/signalr/resource-manager/api-set.json b/swagger-specs/signalr/resource-manager/api-set.json index 1a7c59ed7..fe265df5e 100644 --- a/swagger-specs/signalr/resource-manager/api-set.json +++ b/swagger-specs/signalr/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json"], "name": "package-2023-08-01-preview"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.SignalRService/stable/2024-03-01/signalr.json"], "name": "package-2024-03-01"} \ No newline at end of file diff --git a/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json b/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json index aa0abaf3e..bf279a240 100644 --- a/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json +++ b/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json @@ -1072,12 +1072,12 @@ }, "storageIOps": { "format": "int32", - "description": "Storage IOps. Minimum value: 120. Maximum value: 120000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.", + "description": "Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.", "type": "integer" }, "storageThroughputMBps": { "format": "int32", - "description": "Storage throughput in MBps. Minimum value: 25. Maximum value: 4000. Increments of 1 MBps allowed only. Maximum value depends on the selected hardware family and number of vCores.", + "description": "Storage throughput MBps parameter is not supported in the instance create/update operation.", "type": "integer" }, "collation": { diff --git a/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionBackups.json b/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionBackups.json index c519e9b5b..d4f49813f 100644 --- a/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionBackups.json +++ b/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionBackups.json @@ -69,7 +69,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-pageable": { @@ -142,7 +145,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-pageable": { @@ -222,7 +228,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-pageable": { @@ -286,7 +295,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage - Archiving long-term retention backups on zone redundant backup storage is not supported. Use locally redundant or geo-redundant storage types instead.\n\n * 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing - The subscription ID is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrServerMissing - The server name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrDatabaseMissing - The database name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-examples": { @@ -342,7 +354,10 @@ "description": "Successfully deleted the backup." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage - Archiving long-term retention backups on zone redundant backup storage is not supported. Use locally redundant or geo-redundant storage types instead.\n\n * 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing - The subscription ID is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrServerMissing - The server name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrDatabaseMissing - The database name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted" @@ -411,7 +426,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage - Archiving long-term retention backups on zone redundant backup storage is not supported. Use locally redundant or geo-redundant storage types instead.\n\n * 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing - The subscription ID is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrServerMissing - The server name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrDatabaseMissing - The database name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - \n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -488,7 +503,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage - Archiving long-term retention backups on zone redundant backup storage is not supported. Use locally redundant or geo-redundant storage types instead.\n\n * 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing - The subscription ID is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrServerMissing - The server name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrDatabaseMissing - The database name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - \n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Copying the backup is in progress." @@ -562,7 +580,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage - Archiving long-term retention backups on zone redundant backup storage is not supported. Use locally redundant or geo-redundant storage types instead.\n\n * 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing - The subscription ID is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrServerMissing - The server name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrDatabaseMissing - The database name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - \n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Updating the backup is in progress." @@ -632,7 +653,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-pageable": { @@ -708,7 +732,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-pageable": { @@ -791,7 +818,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-pageable": { @@ -858,7 +888,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage - Archiving long-term retention backups on zone redundant backup storage is not supported. Use locally redundant or geo-redundant storage types instead.\n\n * 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing - The subscription ID is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrServerMissing - The server name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrDatabaseMissing - The database name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-examples": { @@ -917,7 +950,10 @@ "description": "Successfully deleted the backup." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage - Archiving long-term retention backups on zone redundant backup storage is not supported. Use locally redundant or geo-redundant storage types instead.\n\n * 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing - The subscription ID is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrServerMissing - The server name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrDatabaseMissing - The database name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted" @@ -989,7 +1025,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "description": "*** Error Responses: ***\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage - Archiving long-term retention backups on zone redundant backup storage is not supported. Use locally redundant or geo-redundant storage types instead.\n\n * 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing - The subscription ID is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrServerMissing - The server name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrDatabaseMissing - The database name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - \n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } @@ -1069,7 +1105,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage - Archiving long-term retention backups on zone redundant backup storage is not supported. Use locally redundant or geo-redundant storage types instead.\n\n * 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing - The subscription ID is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrServerMissing - The server name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrDatabaseMissing - The database name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - \n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Copying the backup is in progress." @@ -1146,7 +1185,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidLongTermRetentionBackupId - Invalid long term retention backup identifier for SQL DBs.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMismatchingSubscriptionId - The provided subscription id did not match the id in the other input\n\n * 400 LongTermRetentionMismatchingResourceGroupName - The provided resource group name did not match the name in the other input\n\n * 400 LongTermRetentionMismatchingServerName - The provided server name did not match the name in the other input\n\n * 400 DeleteLtrSubscriptionMissing - The subscription ID is required to delete a long-term retention backup.\n\n * 400 DeleteLtrServerMissing - The server name is required to delete a long-term retention backup.\n\n * 400 DeleteLtrDatabaseMissing - The database name is required to delete a long-term retention backup.\n\n * 400 LtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 UpdateBackupStorageAccessTierLTRFailedOnZoneRedundantBackupStorage - Archiving long-term retention backups on zone redundant backup storage is not supported. Use locally redundant or geo-redundant storage types instead.\n\n * 400 UpdateBackupStorageAccessTierLtrSubscriptionMissing - The subscription ID is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrServerMissing - The server name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrDatabaseMissing - The database name is required to update the long-term retention backup.\n\n * 400 UpdateBackupStorageAccessTierLtrBackupResourceIdIncorrect - The provided long-term retention backup resource ID or backup name is incorrect.\n\n * 400 LongTermRetentionMigrationRequestNotSupported - Subscription is not allowed LTR backup Migration feature.\n\n * 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - Source and target subscriptions are not allowed to communicate for LTR backup copy feature.\n\n * 400 LongTermRetentionMigrationParameterMissing - Required parameter missing for the operation.\n\n * 400 LongTermRetentionMigrationSameServerNotSupported - LTR Copy feature is not supported to copy LTR backups within same server.\n\n * 400 LongTermRetentionMigrationTargetServerNotFound - Target server does not exists or is not ready for LTR backup copy operation.\n\n * 400 LongTermRetentionMigrationTargetDatabaseNotFound - Target Database does not exists on the server.\n\n * 400 LongTermRetentionMigrationStorageTypeNotSupported - Specified Backup Storage Redundancy is not supported in target region.\n\n * 400 LongTermRetentionMigrationStorageMismatch - Active backup redundancy of database does not match backup redundancy requested by customer.\n\n * 400 LtrOperationFailedBackupImmutable - Deleting Long Term Retention backup failed because the backup is immutable.\n\n * 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR migration is only supported for managed instance and Azure SQL DB LTR backups.\n\n * 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - Changing backup storage redundancy is not allowed for LTR Copy operations.\n\n * 400 LtrRestoreFailedArchiveStorageTier - Restoring archived long-term retention backup is not supported. Restore can be performed only on rehydrated or regular long-term retention backups.\n\n * 400 LtrArchiveStorageTierNotEnabled - \n\n * 400 LtrArchiveWrongParameters - ChangeLongTermRetentionBackupAccessTier is not supported for the desired (backupStorageAccessTier, operationMode) combination. Only (Archive, Move) and (Hot, Copy) are allowed.\n\n * 400 LTRArchiveRedundancyChangeFailed - Updating the backup storage redundancy type to zone-redundant storage is not supported when a long-term retention policy with the 'archive' backup storage access tier is set\n\n * 400 LongTermRetentionMigrationSubscriptionNotFound - The subscription could not be found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 LongTermRetentionMigrationBackupNotFound - LTR backup specified does not exists.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 LongTermRetentionMigrationRequestConflict - A conflict operation on this LTR backup is still in progress.\n\n * 409 LongTermRetentionMigrationBackupConflict - Another LTR backup with same backup time for target database exists.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - Failed to start LTR backup copy request in target region.\n\n * 500 LongTermRetentionMigrationRequestCopyFailed - Copy operation failed for LTR backup blobs.\n\n * 500 LongTermRetentionMigrationRestoreVerExceeded - Restore verification failed after max attempts were reached.\n\n * 500 LongTermRetentionMigrationRestoreVerFailed - Restore verification failed.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Updating the backup is in progress." diff --git a/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionPolicies.json b/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionPolicies.json index d50c559fe..423b271e3 100644 --- a/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionPolicies.json +++ b/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionPolicies.json @@ -48,7 +48,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled - Enabling long-term backup retention for a serverless database is not supported if auto-pause is enabled.\n\n * 400 LtrConfigPolicyDuringVldbMigration - Enabling long-term backup retention for a database during migration to the Hyperscale service tier is not supported.\n\n * 400 LtrConfigPolicyDuringVldbReverseMigration - Enabling long-term backup retention for a database during a reverse migration from Hyperscale is not supported.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 LTRHyperscaleSetPolicyError - An error has occurred while enabling Long-term backup retention for this database. Please reach out to Microsoft support to enable long-term backup retention.\n\n * 400 LTRNotSupportedForPerDBCMK - Long-term Backup Retention is not supported when Database-level CMK is configured in preview.\n\n * 400 LongTermRetentionPolicyNotSupported - Long Term Retention is not supported on this database.\n\n * 400 LongTermRetentionPolicyInvalid - Long Term Retention policy is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 ConflictingServerOperation - Server '{0}' is busy with another operation. Please try your operation later.\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." + "description": "*** Error Responses: ***\n\n * 400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled - Enabling long-term backup retention for a serverless database is not supported if auto-pause is enabled.\n\n * 400 LtrConfigPolicyDuringVldbMigration - Enabling long-term backup retention for a database during migration to the Hyperscale service tier is not supported.\n\n * 400 LtrConfigPolicyDuringVldbReverseMigration - Enabling long-term backup retention for a database during a reverse migration from Hyperscale is not supported.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 LTRHyperscaleSetPolicyError - An error has occurred while enabling Long-term backup retention for this database. Please reach out to Microsoft support to enable long-term backup retention.\n\n * 400 LTRNotSupportedForPerDBCMK - Long-term Backup Retention is not supported when Database-level CMK is configured in preview.\n\n * 400 LTRArchiveStorageDisabledOnHyperscaleEdition - Archiving long-term retention backups on Hyperscale databases is not enabled.\n\n * 400 LongTermRetentionPolicyNotSupported - Long Term Retention is not supported on this database.\n\n * 400 LTRArchiveStorageFailedOnZoneRedundantBackupStorage - Setting a long-term retention policy with the backup storage access tier set to 'archive' is not supported on zone-redundant backup storage. Use either locally redundant or geo-redundant storage types.\n\n * 400 LongTermRetentionPolicyInvalid - Long Term Retention policy is invalid.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 ConflictingServerOperation - Server '{0}' is busy with another operation. Please try your operation later.\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.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-pageable": { @@ -107,7 +110,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled - Enabling long-term backup retention for a serverless database is not supported if auto-pause is enabled.\n\n * 400 LtrConfigPolicyDuringVldbMigration - Enabling long-term backup retention for a database during migration to the Hyperscale service tier is not supported.\n\n * 400 LtrConfigPolicyDuringVldbReverseMigration - Enabling long-term backup retention for a database during a reverse migration from Hyperscale is not supported.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 LTRHyperscaleSetPolicyError - An error has occurred while enabling Long-term backup retention for this database. Please reach out to Microsoft support to enable long-term backup retention.\n\n * 400 LTRNotSupportedForPerDBCMK - Long-term Backup Retention is not supported when Database-level CMK is configured in preview.\n\n * 400 LongTermRetentionPolicyNotSupported - Long Term Retention is not supported on this database.\n\n * 400 LongTermRetentionPolicyInvalid - Long Term Retention policy is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 ConflictingServerOperation - Server '{0}' is busy with another operation. Please try your operation later.\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." + "description": "*** Error Responses: ***\n\n * 400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled - Enabling long-term backup retention for a serverless database is not supported if auto-pause is enabled.\n\n * 400 LtrConfigPolicyDuringVldbMigration - Enabling long-term backup retention for a database during migration to the Hyperscale service tier is not supported.\n\n * 400 LtrConfigPolicyDuringVldbReverseMigration - Enabling long-term backup retention for a database during a reverse migration from Hyperscale is not supported.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 LTRHyperscaleSetPolicyError - An error has occurred while enabling Long-term backup retention for this database. Please reach out to Microsoft support to enable long-term backup retention.\n\n * 400 LTRNotSupportedForPerDBCMK - Long-term Backup Retention is not supported when Database-level CMK is configured in preview.\n\n * 400 LTRArchiveStorageDisabledOnHyperscaleEdition - Archiving long-term retention backups on Hyperscale databases is not enabled.\n\n * 400 LongTermRetentionPolicyNotSupported - Long Term Retention is not supported on this database.\n\n * 400 LTRArchiveStorageFailedOnZoneRedundantBackupStorage - Setting a long-term retention policy with the backup storage access tier set to 'archive' is not supported on zone-redundant backup storage. Use either locally redundant or geo-redundant storage types.\n\n * 400 LongTermRetentionPolicyInvalid - Long Term Retention policy is invalid.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 ConflictingServerOperation - Server '{0}' is busy with another operation. Please try your operation later.\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.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-examples": { @@ -120,7 +126,7 @@ "tags": [ "LongTermRetentionPolicies" ], - "description": "Sets a database's long term retention policy.", + "description": "Set or update a database's long term retention policy.", "operationId": "LongTermRetentionPolicies_CreateOrUpdate", "parameters": [ { @@ -164,13 +170,16 @@ ], "responses": { "200": { - "description": "Successfully set the policy.", + "description": "Successfully updated the policy.", "schema": { "$ref": "#/definitions/LongTermRetentionPolicy" } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMissingWeekOfYear - WeekOfYear is required to be set between 1 and 52 in order to set yearly retention.\n\n * 400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled - Enabling long-term backup retention for a serverless database is not supported if auto-pause is enabled.\n\n * 400 LtrConfigPolicyDuringVldbMigration - Enabling long-term backup retention for a database during migration to the Hyperscale service tier is not supported.\n\n * 400 LtrConfigPolicyDuringVldbReverseMigration - Enabling long-term backup retention for a database during a reverse migration from Hyperscale is not supported.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 LTRHyperscaleSetPolicyError - An error has occurred while enabling Long-term backup retention for this database. Please reach out to Microsoft support to enable long-term backup retention.\n\n * 400 LTRNotSupportedForPerDBCMK - Long-term Backup Retention is not supported when Database-level CMK is configured in preview.\n\n * 400 LongTermRetentionPolicyNotSupported - Long Term Retention is not supported on this database.\n\n * 400 LongTermRetentionPolicyInvalid - Long Term Retention policy is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 ConflictingServerOperation - Server '{0}' is busy with another operation. Please try your operation later.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionMissingWeekOfYear - WeekOfYear is required to be set between 1 and 52 in order to set yearly retention.\n\n * 400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled - Enabling long-term backup retention for a serverless database is not supported if auto-pause is enabled.\n\n * 400 LtrConfigPolicyDuringVldbMigration - Enabling long-term backup retention for a database during migration to the Hyperscale service tier is not supported.\n\n * 400 LtrConfigPolicyDuringVldbReverseMigration - Enabling long-term backup retention for a database during a reverse migration from Hyperscale is not supported.\n\n * 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - User attempted configuring backup retention policy on a Named Replica.\n\n * 400 LTRHyperscaleSetPolicyError - An error has occurred while enabling Long-term backup retention for this database. Please reach out to Microsoft support to enable long-term backup retention.\n\n * 400 LTRNotSupportedForPerDBCMK - Long-term Backup Retention is not supported when Database-level CMK is configured in preview.\n\n * 400 LTRArchiveStorageDisabledOnHyperscaleEdition - Archiving long-term retention backups on Hyperscale databases is not enabled.\n\n * 400 LongTermRetentionPolicyNotSupported - Long Term Retention is not supported on this database.\n\n * 400 LTRArchiveStorageFailedOnZoneRedundantBackupStorage - Setting a long-term retention policy with the backup storage access tier set to 'archive' is not supported on zone-redundant backup storage. Use either locally redundant or geo-redundant storage types.\n\n * 400 LongTermRetentionPolicyInvalid - Long Term Retention policy is invalid.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 ConflictingServerOperation - Server '{0}' is busy with another operation. Please try your operation later.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted" @@ -186,29 +195,6 @@ } }, "definitions": { - "BaseLongTermRetentionPolicyProperties": { - "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" - } - } - }, "LongTermRetentionPolicy": { "description": "A long term retention policy.", "type": "object", @@ -219,7 +205,7 @@ ], "properties": { "properties": { - "$ref": "#/definitions/BaseLongTermRetentionPolicyProperties", + "$ref": "#/definitions/LongTermRetentionPolicyProperties", "description": "Resource properties.", "x-ms-client-flatten": true } @@ -243,6 +229,45 @@ "readOnly": true } } + }, + "LongTermRetentionPolicyProperties": { + "description": "Properties of a long term retention policy", + "type": "object", + "properties": { + "makeBackupsImmutable": { + "description": "The setting whether to make LTR backups immutable", + "type": "boolean" + }, + "backupStorageAccessTier": { + "description": "The BackupStorageAccessTier for the LTR backups", + "enum": [ + "Hot", + "Archive" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupStorageAccessTier", + "modelAsString": true + } + }, + "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" + } + } } }, "parameters": { diff --git a/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/ManagedInstances.json b/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/ManagedInstances.json index 11df27391..ae4035048 100644 --- a/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/ManagedInstances.json +++ b/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/ManagedInstances.json @@ -1070,12 +1070,12 @@ }, "storageIOps": { "format": "int32", - "description": "Storage IOps. Minimum value: 120. Maximum value: 120000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.", + "description": "Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.", "type": "integer" }, "storageThroughputMBps": { "format": "int32", - "description": "Storage throughput in MBps. Minimum value: 25. Maximum value: 4000. Increments of 1 MBps allowed only. Maximum value depends on the selected hardware family and number of vCores.", + "description": "Storage throughput MBps parameter is not supported in the instance create/update operation.", "type": "integer" }, "collation": { diff --git a/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/Servers.json b/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/Servers.json index db62fa1e3..44392df24 100644 --- a/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/Servers.json +++ b/swagger-specs/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/Servers.json @@ -48,7 +48,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidNameAvailabilityRequest - The check name availability request is invalid.\n\n * 400 UnknownNameType - Unknown resource type specified for a subscription level name availability check." + "description": "*** Error Responses: ***\n\n * 400 InvalidNameAvailabilityRequest - The check name availability request is invalid.\n\n * 400 UnknownNameType - Unknown resource type specified for a subscription level name availability check.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-examples": { @@ -94,7 +97,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionNotFound - The requested subscription was not found." + "description": "*** Error Responses: ***\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\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.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-pageable": { @@ -143,7 +149,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionNotFound - The requested subscription was not found." + "description": "*** Error Responses: ***\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\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.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-pageable": { @@ -195,7 +204,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ResourceNotFound - The requested resource was not found." + "description": "*** Error Responses: ***\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\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.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } } }, "x-ms-examples": { @@ -244,7 +256,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 PECsNotExistingToDenyPublicNetworkAccess - Unable to set Deny Public Network Access to Yes since there is no private endpoint enabled to access the server. Please set up private endpoints and retry the operation (https://docs.microsoft.com/azure/sql-database/sql-database-private-endpoint-overview#how-to-set-up-private-link-for-azure-sql-database).\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 Ipv6FeatureNotEnabled - User tried to turn on Ipv6 support on the server without enabling feature flag on subscription, or the feature support is currently disabled in the region.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\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 * 409 UpsertLogicalServerRequestAlreadyInProgress - An ongoing logical server request is already in progress, please try your request again later.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 ServerAlreadyExists - Duplicate server name.\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 * 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 * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - 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." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 PECsNotExistingToDenyPublicNetworkAccess - Unable to set Deny Public Network Access to Yes since there is no private endpoint enabled to access the server. Please set up private endpoints and retry the operation (https://docs.microsoft.com/azure/sql-database/sql-database-private-endpoint-overview#how-to-set-up-private-link-for-azure-sql-database).\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 Ipv6FeatureNotEnabled - User tried to turn on Ipv6 support on the server without enabling feature flag on subscription, or the feature support is currently disabled in the region.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 409 UpsertLogicalServerRequestAlreadyInProgress - An ongoing logical server request is already in progress, please try your request again later.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 ServerAlreadyExists - Duplicate server name.\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 * 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 * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - 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.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted" @@ -288,7 +303,10 @@ "description": "Successfully deleted the server." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\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 * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 DropLogicalServerAlreadyInProgress - Server is already being dropped.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - 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." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 CannotDropDatabaseAKVError - The database {0} on server {1} cannot be safely dropped because it is encrypted with a customer managed key that is no longer accessible to take the last backup before drop. Please restore Azure Key Vault Access on the server and revalidate the keys to make this database accessible and then proceed with the drop. For details see https://aka.ms/tdecmkrestorability\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 409 DropLogicalServerAlreadyInProgress - Server is already being dropped.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - 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.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted" @@ -341,7 +359,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 PECsNotExistingToDenyPublicNetworkAccess - Unable to set Deny Public Network Access to Yes since there is no private endpoint enabled to access the server. Please set up private endpoints and retry the operation (https://docs.microsoft.com/azure/sql-database/sql-database-private-endpoint-overview#how-to-set-up-private-link-for-azure-sql-database).\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 Ipv6FeatureNotEnabled - User tried to turn on Ipv6 support on the server without enabling feature flag on subscription, or the feature support is currently disabled in the region.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\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 * 409 UpsertLogicalServerRequestAlreadyInProgress - An ongoing logical server request is already in progress, please try your request again later.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 ServerAlreadyExists - Duplicate server name.\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 * 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 * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - 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." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned\n\n * 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter\n\n * 400 PECsNotExistingToDenyPublicNetworkAccess - Unable to set Deny Public Network Access to Yes since there is no private endpoint enabled to access the server. Please set up private endpoints and retry the operation (https://docs.microsoft.com/azure/sql-database/sql-database-private-endpoint-overview#how-to-set-up-private-link-for-azure-sql-database).\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call\n\n * 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 400 Ipv6FeatureNotEnabled - User tried to turn on Ipv6 support on the server without enabling feature flag on subscription, or the feature support is currently disabled in the region.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CMKOperationNotAllowed - User tried to perform an operation on the server when the server did not have Azure Key Vault Access.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 InvalidMinimalTlsVersion - Invalid minimal TLS version.\n\n * 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.\n\n * 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.\n\n * 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.\n\n * 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.\n\n * 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.\n\n * 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 409 UpsertLogicalServerRequestAlreadyInProgress - An ongoing logical server request is already in progress, please try your request again later.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 ServerAlreadyExists - Duplicate server name.\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 * 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 * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - 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.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Accepted" @@ -393,7 +414,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 MissingImportExportInputParameters - Missing ImportExport input parameters.\n\n * 400 InvalidImportExportInputParameter - The import/export request failed due to an invalid input parameter.\n\n * 400 PolybaseImportAuthenticationTypeNotSupported - Authentication type parameter is not support for PolybaseImport operation.\n\n * 400 DatabaseExtensionsInvalidOperationMode - Invalid operationMode parameter for database extension.\n\n * 400 DatabaseExtensionsInvalidStorageKeyType - The storage key type must by 'StorageAccessKey'.\n\n * 400 DatabaseExtensionsMissingStorageUri - Storage URI cannot be empty.\n\n * 400 InvalidSqlAuthType - ImportExport operation failed because the sql authentication type is invalid\n\n * 400 BlobAlreadyExist - ImportExport operation failed because the storage blob is already exists\n\n * 400 InvalidImportExportOperationResourceLocks - The Import/Export request is invalid due to locks on the Private Link resources.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 ImportExportJobError - The ImportExport operation has failed.\n\n * 400 BlockedByOutboundFirewall - The outbound firewall rules blocked the request.\n\n * 400 InvalidOperationType - Provide a valid operation type.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidImportExportParameter - The Import/Export request failed due to an invalid input parameter.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 InvalidImportExportStorageCredentials - Import/Export operation failed due to invalid storage credentials\n\n * 400 InvalidImportExportStorageAuthType - Import/Export operation failed due to invalid storage auth type\n\n * 400 InvalidImportExportStorageKeyFormat - Import/Export operation failed due to invalid storage key format\n\n * 400 LongImportExportStorageUri - Import/Export operation failed due to long storage URI\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 LargeExportDatabaseSize - Export operation failed because database is larger than max supported size\n\n * 400 UnSupportedImportExportEdition - ImportExport operation failed because it is targeting a invalid edition\n\n * 400 InvalidImportExportStorageURI - ImportExport operation failed because storage URI is invalid\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - Invalid request specifying a non-existent resource.\n\n * 404 ImportExportOperationIdNotFound - The operation Id for import or export cannot be found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 ImportExportOperationInProgress - There is an import or export operation in progress on the database.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 MissingImportExportInputParameters - Missing ImportExport input parameters.\n\n * 400 InvalidImportExportInputParameter - The import/export request failed due to an invalid input parameter.\n\n * 400 PolybaseImportAuthenticationTypeNotSupported - Authentication type parameter is not support for PolybaseImport operation.\n\n * 400 DatabaseExtensionsInvalidOperationMode - Invalid operationMode parameter for database extension.\n\n * 400 DatabaseExtensionsInvalidStorageKeyType - The storage key type must by 'StorageAccessKey'.\n\n * 400 DatabaseExtensionsMissingStorageUri - Storage URI cannot be empty.\n\n * 400 InvalidSqlAuthType - ImportExport operation failed because the sql authentication type is invalid\n\n * 400 BlobAlreadyExist - ImportExport operation failed because the storage blob is already exists\n\n * 400 InvalidImportExportOperationResourceLocks - The Import/Export request is invalid due to locks on the Private Link resources.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 ImportExportJobError - The ImportExport operation has failed.\n\n * 400 BlockedByOutboundFirewall - The outbound firewall rules blocked the request.\n\n * 400 InvalidOperationType - Provide a valid operation type.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidImportExportParameter - The Import/Export request failed due to an invalid input parameter.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 InvalidImportExportStorageCredentials - Import/Export operation failed due to invalid storage credentials\n\n * 400 InvalidImportExportStorageAuthType - Import/Export operation failed due to invalid storage auth type\n\n * 400 InvalidImportExportStorageKeyFormat - Import/Export operation failed due to invalid storage key format\n\n * 400 LongImportExportStorageUri - Import/Export operation failed due to long storage URI\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 LargeExportDatabaseSize - Export operation failed because database is larger than max supported size\n\n * 400 UnSupportedImportExportEdition - ImportExport operation failed because it is targeting a invalid edition\n\n * 400 InvalidImportExportStorageURI - ImportExport operation failed because storage URI is invalid\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - Invalid request specifying a non-existent resource.\n\n * 404 ImportExportOperationIdNotFound - The operation Id for import or export cannot be found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 ImportExportOperationInProgress - There is an import or export operation in progress on the database.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Importing the database is in progress." @@ -439,7 +463,10 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state\n\n * 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\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 * 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 * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } }, "202": { "description": "Refreshing external governance enablement status." @@ -1038,8 +1065,19 @@ "readOnly": true }, "minimalTlsVersion": { - "description": "Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'", - "type": "string" + "description": "Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3'", + "enum": [ + "None", + "1.0", + "1.1", + "1.2", + "1.3" + ], + "type": "string", + "x-ms-enum": { + "name": "MinimalTlsVersion", + "modelAsString": true + } }, "publicNetworkAccess": { "description": "Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter'", diff --git a/swagger-specs/sql/resource-manager/api-set.json b/swagger-specs/sql/resource-manager/api-set.json index a47cf0686..fb20c3142 100644 --- a/swagger-specs/sql/resource-manager/api-set.json +++ b/swagger-specs/sql/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Sql/stable/2014-04-01/dataMasking.json", "Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json", "Microsoft.Sql/stable/2014-04-01/metrics.json", "Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json", "Microsoft.Sql/stable/2014-04-01/serviceObjectives.json", "Microsoft.Sql/stable/2014-04-01-legacy/sql.core_legacy.json", "Microsoft.Sql/stable/2014-04-01-legacy/usages_legacy.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseAdvisors.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseAutomaticTuning.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseColumns.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseRecommendedActions.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseSchemas.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseSecurityAlertPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseTables.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseVulnerabilityAssesmentRuleBaselines.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseVulnerabilityAssessments.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseVulnerabilityAssessmentScans.json", "./Microsoft.Sql/preview/2020-11-01-preview/DataWarehouseUserActivities.json", "./Microsoft.Sql/preview/2020-11-01-preview/DeletedServers.json", "./Microsoft.Sql/preview/2020-11-01-preview/ElasticPoolOperations.json", "./Microsoft.Sql/preview/2020-11-01-preview/EncryptionProtectors.json", "./Microsoft.Sql/preview/2020-11-01-preview/FirewallRules.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobAgents.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobCredentials.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobExecutions.json", "./Microsoft.Sql/preview/2023-05-01-preview/JobPrivateEndpoints.json", "./Microsoft.Sql/preview/2020-11-01-preview/Jobs.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobStepExecutions.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobSteps.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobTargetExecutions.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobTargetGroups.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobVersions.json", "./Microsoft.Sql/preview/2020-11-01-preview/LocationCapabilities.json", "./Microsoft.Sql/preview/2020-11-01-preview/MaintenanceWindowOptions.json", "./Microsoft.Sql/preview/2020-11-01-preview/MaintenanceWindows.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedBackupShortTermRetentionPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseColumns.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseQueries.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseSchemas.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseSecurityAlertPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseSecurityEvents.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseTables.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseTransparentDataEncryption.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseVulnerabilityAssessmentRuleBaselines.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseVulnerabilityAssessments.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseVulnerabilityAssessmentScans.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceAdministrators.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceAzureADOnlyAuthentications.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceEncryptionProtectors.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceKeys.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceLongTermRetentionPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceOperations.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstancePrivateEndpointConnections.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstancePrivateLinkResources.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceTdeCertificates.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceVulnerabilityAssessments.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedServerSecurityAlertPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/Operations.json", "./Microsoft.Sql/preview/2022-08-01-preview/PrivateEndpointConnections.json", "./Microsoft.Sql/preview/2020-11-01-preview/PrivateLinkResources.json", "./Microsoft.Sql/preview/2020-11-01-preview/RecoverableManagedDatabases.json", "./Microsoft.Sql/preview/2020-11-01-preview/RestorePoints.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerAdvisors.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerAutomaticTuning.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerAzureADAdministrators.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerAzureADOnlyAuthentications.json", "./Microsoft.Sql/preview/2022-02-01-preview/ServerDevOpsAudit.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerDnsAliases.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerKeys.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerOperations.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerSecurityAlertPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerTrustGroups.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerVulnerabilityAssessments.json", "./Microsoft.Sql/preview/2020-11-01-preview/SqlAgent.json", "./Microsoft.Sql/preview/2020-11-01-preview/SubscriptionUsages.json", "./Microsoft.Sql/preview/2020-11-01-preview/SyncAgents.json", "./Microsoft.Sql/preview/2020-11-01-preview/SyncGroups.json", "./Microsoft.Sql/preview/2020-11-01-preview/SyncMembers.json", "./Microsoft.Sql/preview/2020-11-01-preview/TdeCertificates.json", "./Microsoft.Sql/preview/2020-11-01-preview/TimeZones.json", "./Microsoft.Sql/preview/2020-11-01-preview/VirtualNetworkRules.json", "./Microsoft.Sql/preview/2020-11-01-preview/WorkloadClassifiers.json", "./Microsoft.Sql/preview/2020-11-01-preview/WorkloadGroups.json", "./Microsoft.Sql/preview/2021-02-01-preview/BackupShortTermRetentionPolicies.json", "./Microsoft.Sql/preview/2021-02-01-preview/DatabaseExtensions.json", "./Microsoft.Sql/preview/2021-02-01-preview/DatabaseOperations.json", "./Microsoft.Sql/preview/2021-02-01-preview/DatabaseUsages.json", "./Microsoft.Sql/preview/2021-02-01-preview/LedgerDigestUploads.json", "./Microsoft.Sql/preview/2021-02-01-preview/OutboundFirewallRules.json", "./Microsoft.Sql/preview/2021-02-01-preview/Usages.json", "./Microsoft.Sql/preview/2021-05-01-preview/LongTermRetentionManagedInstanceBackups.json", "./Microsoft.Sql/preview/2021-05-01-preview/RestorableDroppedManagedDatabases.json", "./Microsoft.Sql/preview/2021-05-01-preview/ServerConnectionPolicies.json", "./Microsoft.Sql/preview/2021-11-01-preview/DistributedAvailabilityGroups.json", "./Microsoft.Sql/preview/2021-11-01-preview/ServerTrustCertificates.json", "./Microsoft.Sql/preview/2021-11-01-preview/EndpointCertificates.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseSensitivityLabels.json", "./Microsoft.Sql/preview/2020-11-01-preview/SensitivityLabels.json", "./Microsoft.Sql/preview/2021-11-01-preview/BlobAuditing.json", "./Microsoft.Sql/preview/2021-11-01-preview/DatabaseAdvancedThreatProtectionSettings.json", "./Microsoft.Sql/preview/2021-11-01-preview/ServerAdvancedThreatProtectionSettings.json", "./Microsoft.Sql/preview/2021-11-01-preview/ManagedServerDnsAliases.json", "./Microsoft.Sql/preview/2022-02-01-preview/ManagedDatabaseAdvancedThreatProtectionSettings.json", "./Microsoft.Sql/preview/2022-02-01-preview/ManagedInstanceAdvancedThreatProtectionSettings.json", "./Microsoft.Sql/preview/2022-02-01-preview/ReplicationLinks.json", "./Microsoft.Sql/preview/2022-05-01-preview/ManagedDatabaseMoveOperations.json", "./Microsoft.Sql/preview/2022-05-01-preview/ManagedInstanceDtcs.json", "./Microsoft.Sql/preview/2022-05-01-preview/SynapseLinkWorkspaces.json", "./Microsoft.Sql/preview/2022-05-01-preview/VirtualClusters.json", "./Microsoft.Sql/preview/2022-05-01-preview/InstanceFailoverGroups.json", "./Microsoft.Sql/preview/2022-05-01-preview/ManagedDatabaseRestoreDetails.json", "./Microsoft.Sql/preview/2022-08-01-preview/DatabaseEncryptionProtectorRevalidate.json", "./Microsoft.Sql/preview/2022-08-01-preview/DatabaseEncryptionProtectorRevert.json", "./Microsoft.Sql/preview/2023-02-01-preview/Databases.json", "./Microsoft.Sql/preview/2022-08-01-preview/ElasticPools.json", "./Microsoft.Sql/preview/2022-08-01-preview/ManagedDatabases.json", "./Microsoft.Sql/preview/2022-08-01-preview/ManagedInstances.json", "./Microsoft.Sql/preview/2022-08-01-preview/ManagedLedgerDigestUploads.json", "./Microsoft.Sql/preview/2022-08-01-preview/RecoverableDatabases.json", "./Microsoft.Sql/preview/2022-08-01-preview/RestorableDroppedDatabases.json", "./Microsoft.Sql/preview/2022-08-01-preview/ServerConfigurationOptions.json", "./Microsoft.Sql/preview/2022-08-01-preview/StartStopManagedInstanceSchedules.json", "./Microsoft.Sql/preview/2022-08-01-preview/TransparentDataEncryptions.json", "./Microsoft.Sql/preview/2022-11-01-preview/IPv6FirewallRules.json", "./Microsoft.Sql/preview/2022-11-01-preview/SqlVulnerabilityAssessmentBaseline.json", "./Microsoft.Sql/preview/2022-11-01-preview/SqlVulnerabilityAssessmentExecuteScan.json", "./Microsoft.Sql/preview/2022-11-01-preview/SqlVulnerabilityAssessmentRuleBaseline.json", "./Microsoft.Sql/preview/2022-11-01-preview/SqlVulnerabilityAssessmentScanResult.json", "./Microsoft.Sql/preview/2022-11-01-preview/SqlVulnerabilityAssessmentScans.json", "./Microsoft.Sql/preview/2022-11-01-preview/SqlVulnerabilityAssessmentsSettings.json", "./Microsoft.Sql/preview/2022-11-01-preview/DatabaseSqlVulnerabilityAssessmentBaselines.json", "./Microsoft.Sql/preview/2022-11-01-preview/DatabaseSqlVulnerabilityAssessmentExecuteScan.json", "./Microsoft.Sql/preview/2022-11-01-preview/DatabaseSqlVulnerabilityAssessmentRuleBaselines.json", "./Microsoft.Sql/preview/2022-11-01-preview/DatabaseSqlVulnerabilityAssessmentScanResult.json", "./Microsoft.Sql/preview/2022-11-01-preview/DatabaseSqlVulnerabilityAssessmentScans.json", "./Microsoft.Sql/preview/2022-11-01-preview/DatabaseSqlVulnerabilityAssessmentsSettings.json", "./Microsoft.Sql/preview/2023-02-01-preview/Servers.json", "./Microsoft.Sql/preview/2023-02-01-preview/FailoverGroups.json", "./Microsoft.Sql/preview/2023-05-01-preview/InstancePools.json", "./Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionBackups.json", "./Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionPolicies.json"], "name": "package-composite-v5"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.Sql/stable/2014-04-01/dataMasking.json", "Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json", "Microsoft.Sql/stable/2014-04-01/metrics.json", "Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json", "Microsoft.Sql/stable/2014-04-01/serviceObjectives.json", "Microsoft.Sql/stable/2014-04-01-legacy/sql.core_legacy.json", "Microsoft.Sql/stable/2014-04-01-legacy/usages_legacy.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseAdvisors.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseAutomaticTuning.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseColumns.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseRecommendedActions.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseSchemas.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseSecurityAlertPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseTables.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseVulnerabilityAssesmentRuleBaselines.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseVulnerabilityAssessments.json", "./Microsoft.Sql/preview/2020-11-01-preview/DatabaseVulnerabilityAssessmentScans.json", "./Microsoft.Sql/preview/2020-11-01-preview/DataWarehouseUserActivities.json", "./Microsoft.Sql/preview/2020-11-01-preview/DeletedServers.json", "./Microsoft.Sql/preview/2020-11-01-preview/ElasticPoolOperations.json", "./Microsoft.Sql/preview/2020-11-01-preview/EncryptionProtectors.json", "./Microsoft.Sql/preview/2020-11-01-preview/FirewallRules.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobAgents.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobCredentials.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobExecutions.json", "./Microsoft.Sql/preview/2023-05-01-preview/JobPrivateEndpoints.json", "./Microsoft.Sql/preview/2020-11-01-preview/Jobs.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobStepExecutions.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobSteps.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobTargetExecutions.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobTargetGroups.json", "./Microsoft.Sql/preview/2020-11-01-preview/JobVersions.json", "./Microsoft.Sql/preview/2020-11-01-preview/LocationCapabilities.json", "./Microsoft.Sql/preview/2020-11-01-preview/MaintenanceWindowOptions.json", "./Microsoft.Sql/preview/2020-11-01-preview/MaintenanceWindows.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedBackupShortTermRetentionPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseColumns.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseQueries.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseSchemas.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseSecurityAlertPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseSecurityEvents.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseTables.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseTransparentDataEncryption.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseVulnerabilityAssessmentRuleBaselines.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseVulnerabilityAssessments.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseVulnerabilityAssessmentScans.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceAdministrators.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceAzureADOnlyAuthentications.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceEncryptionProtectors.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceKeys.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceLongTermRetentionPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceOperations.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstancePrivateEndpointConnections.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstancePrivateLinkResources.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceTdeCertificates.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedInstanceVulnerabilityAssessments.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedServerSecurityAlertPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/Operations.json", "./Microsoft.Sql/preview/2022-08-01-preview/PrivateEndpointConnections.json", "./Microsoft.Sql/preview/2020-11-01-preview/PrivateLinkResources.json", "./Microsoft.Sql/preview/2020-11-01-preview/RecoverableManagedDatabases.json", "./Microsoft.Sql/preview/2020-11-01-preview/RestorePoints.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerAdvisors.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerAutomaticTuning.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerAzureADAdministrators.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerAzureADOnlyAuthentications.json", "./Microsoft.Sql/preview/2022-02-01-preview/ServerDevOpsAudit.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerDnsAliases.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerKeys.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerOperations.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerSecurityAlertPolicies.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerTrustGroups.json", "./Microsoft.Sql/preview/2020-11-01-preview/ServerVulnerabilityAssessments.json", "./Microsoft.Sql/preview/2020-11-01-preview/SqlAgent.json", "./Microsoft.Sql/preview/2020-11-01-preview/SubscriptionUsages.json", "./Microsoft.Sql/preview/2020-11-01-preview/SyncAgents.json", "./Microsoft.Sql/preview/2020-11-01-preview/SyncGroups.json", "./Microsoft.Sql/preview/2020-11-01-preview/SyncMembers.json", "./Microsoft.Sql/preview/2020-11-01-preview/TdeCertificates.json", "./Microsoft.Sql/preview/2020-11-01-preview/TimeZones.json", "./Microsoft.Sql/preview/2020-11-01-preview/VirtualNetworkRules.json", "./Microsoft.Sql/preview/2020-11-01-preview/WorkloadClassifiers.json", "./Microsoft.Sql/preview/2020-11-01-preview/WorkloadGroups.json", "./Microsoft.Sql/preview/2021-02-01-preview/BackupShortTermRetentionPolicies.json", "./Microsoft.Sql/preview/2021-02-01-preview/DatabaseExtensions.json", "./Microsoft.Sql/preview/2021-02-01-preview/DatabaseUsages.json", "./Microsoft.Sql/preview/2021-02-01-preview/LedgerDigestUploads.json", "./Microsoft.Sql/preview/2021-02-01-preview/OutboundFirewallRules.json", "./Microsoft.Sql/preview/2021-02-01-preview/Usages.json", "./Microsoft.Sql/preview/2021-05-01-preview/LongTermRetentionManagedInstanceBackups.json", "./Microsoft.Sql/preview/2021-05-01-preview/RestorableDroppedManagedDatabases.json", "./Microsoft.Sql/preview/2021-05-01-preview/ServerConnectionPolicies.json", "./Microsoft.Sql/preview/2021-11-01-preview/DistributedAvailabilityGroups.json", "./Microsoft.Sql/preview/2021-11-01-preview/ServerTrustCertificates.json", "./Microsoft.Sql/preview/2021-11-01-preview/EndpointCertificates.json", "./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseSensitivityLabels.json", "./Microsoft.Sql/preview/2020-11-01-preview/SensitivityLabels.json", "./Microsoft.Sql/preview/2021-11-01-preview/BlobAuditing.json", "./Microsoft.Sql/preview/2021-11-01-preview/DatabaseAdvancedThreatProtectionSettings.json", "./Microsoft.Sql/preview/2021-11-01-preview/ServerAdvancedThreatProtectionSettings.json", "./Microsoft.Sql/preview/2021-11-01-preview/ManagedServerDnsAliases.json", "./Microsoft.Sql/preview/2022-02-01-preview/ManagedDatabaseAdvancedThreatProtectionSettings.json", "./Microsoft.Sql/preview/2022-02-01-preview/ManagedInstanceAdvancedThreatProtectionSettings.json", "./Microsoft.Sql/preview/2022-05-01-preview/ManagedDatabaseMoveOperations.json", "./Microsoft.Sql/preview/2022-05-01-preview/ManagedInstanceDtcs.json", "./Microsoft.Sql/preview/2022-05-01-preview/SynapseLinkWorkspaces.json", "./Microsoft.Sql/preview/2022-05-01-preview/VirtualClusters.json", "./Microsoft.Sql/preview/2022-05-01-preview/InstanceFailoverGroups.json", "./Microsoft.Sql/preview/2022-05-01-preview/ManagedDatabaseRestoreDetails.json", "./Microsoft.Sql/preview/2022-08-01-preview/DatabaseEncryptionProtectorRevalidate.json", "./Microsoft.Sql/preview/2022-08-01-preview/DatabaseEncryptionProtectorRevert.json", "./Microsoft.Sql/preview/2023-02-01-preview/Databases.json", "./Microsoft.Sql/preview/2022-08-01-preview/ElasticPools.json", "./Microsoft.Sql/preview/2022-08-01-preview/ManagedDatabases.json", "./Microsoft.Sql/preview/2022-08-01-preview/ManagedInstances.json", "./Microsoft.Sql/preview/2022-08-01-preview/ManagedLedgerDigestUploads.json", "./Microsoft.Sql/preview/2022-08-01-preview/RecoverableDatabases.json", "./Microsoft.Sql/preview/2022-08-01-preview/RestorableDroppedDatabases.json", "./Microsoft.Sql/preview/2022-08-01-preview/ServerConfigurationOptions.json", "./Microsoft.Sql/preview/2022-08-01-preview/StartStopManagedInstanceSchedules.json", "./Microsoft.Sql/preview/2022-08-01-preview/TransparentDataEncryptions.json", "./Microsoft.Sql/preview/2022-11-01-preview/DatabaseOperations.json", "./Microsoft.Sql/preview/2022-11-01-preview/IPv6FirewallRules.json", "./Microsoft.Sql/preview/2022-11-01-preview/SqlVulnerabilityAssessmentBaseline.json", "./Microsoft.Sql/preview/2022-11-01-preview/SqlVulnerabilityAssessmentExecuteScan.json", "./Microsoft.Sql/preview/2022-11-01-preview/SqlVulnerabilityAssessmentRuleBaseline.json", "./Microsoft.Sql/preview/2022-11-01-preview/SqlVulnerabilityAssessmentScanResult.json", "./Microsoft.Sql/preview/2022-11-01-preview/SqlVulnerabilityAssessmentScans.json", "./Microsoft.Sql/preview/2022-11-01-preview/SqlVulnerabilityAssessmentsSettings.json", "./Microsoft.Sql/preview/2022-11-01-preview/DatabaseSqlVulnerabilityAssessmentBaselines.json", "./Microsoft.Sql/preview/2022-11-01-preview/DatabaseSqlVulnerabilityAssessmentExecuteScan.json", "./Microsoft.Sql/preview/2022-11-01-preview/DatabaseSqlVulnerabilityAssessmentRuleBaselines.json", "./Microsoft.Sql/preview/2022-11-01-preview/DatabaseSqlVulnerabilityAssessmentScanResult.json", "./Microsoft.Sql/preview/2022-11-01-preview/DatabaseSqlVulnerabilityAssessmentScans.json", "./Microsoft.Sql/preview/2022-11-01-preview/DatabaseSqlVulnerabilityAssessmentsSettings.json", "./Microsoft.Sql/preview/2023-05-01-preview/FailoverGroups.json", "./Microsoft.Sql/preview/2023-05-01-preview/InstancePools.json", "./Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionBackups.json", "./Microsoft.Sql/preview/2023-05-01-preview/LongTermRetentionPolicies.json", "./Microsoft.Sql/preview/2023-05-01-preview/Servers.json", "./Microsoft.Sql/preview/2023-05-01-preview/ReplicationLinks.json"], "name": "package-composite-v5"} \ No newline at end of file diff --git a/swagger-specs/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/stable/2022-02-01/sqlvm.json b/swagger-specs/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/stable/2022-02-01/sqlvm.json deleted file mode 100644 index 8b4fcc286..000000000 --- a/swagger-specs/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/stable/2022-02-01/sqlvm.json +++ /dev/null @@ -1,2350 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2022-02-01", - "title": "SqlVirtualMachineManagementClient", - "description": "The SQL virtual machine management API provides a RESTful set of web APIs that interact with Azure Compute, Network & Storage services to manage your SQL Server virtual machine. The API enables users to create, delete and retrieve a SQL virtual machine, SQL virtual machine group or availability group listener." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}": { - "get": { - "tags": [ - "AvailabilityGroupListeners" - ], - "description": "Gets an availability group listener.", - "operationId": "AvailabilityGroupListeners_Get", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineGroupName", - "in": "path", - "description": "Name of the SQL virtual machine group.", - "required": true, - "type": "string" - }, - { - "name": "availabilityGroupListenerName", - "in": "path", - "description": "Name of the availability group listener.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "The child resources to include in the response.", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the availability group listener.", - "schema": { - "$ref": "#/definitions/AvailabilityGroupListener" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 NoActivePrimaryInAG - None of the nodes in AvailabilityGroup are Primary\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 ExtVersionNotSupported - The virtual machine: {0} is running older version of SqlIaasExtension which is not supported by this operation. Please update the extension and retry the operation.\n\n * 400 InvalidReplicaRole - Invalid replica role: {0} specified for SQL VM: {1}.\n\n * 400 InvalidReplicaFailover - Invalid replica Failover: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaReadableSecondary - Invalid replica readable secondary: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaCommit - Invalid replica commit mode: {0} for SQL VM: {1}.\n\n * 400 ExpectedSynchronousCommitForAutomaticFailover - Invalid replica commit mode: {0} for SQL VM: {1}. {2} is expected for failover mode: {3}.\n\n * 400 NoPrimaryInAg - There are no replicas with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanOnePrimaryInAg - There are more than one replica with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanThreeSynchronousCommitInAg - There are more than three replica with commit mode as: {0}. There should be at most three replica with commit mode as: {0}\n\n * 400 MoreThanEightSecondariesInAg - There are more than eight secondary replica with secondary role. There should be at most eight replica with role as secondary.\n\n * 400 AlwaysOnNotEnabled - Always on feature is not enabled on Virtual machine: {0}.\n\n * 400 ExpectedReplicaNotPrimary - The VM: {0} does not host the primary replica.\n\n * 400 ListenerSqlVmsMismatchWithReplicaSqlVms - List of SQL VMs specified in Availability group does not match list of SQL VMs in listener config.\n\n * 400 ReplicaSqlvmHasDuplicateEntries - Replica configuration should be unique for each SQL virtual machine. We have found one or more configuration for the same SQL virtual machine resource.\n\n * 400 ReplicaDeleteNotAllowed - Replica deletion through SQL VM RP is not supported yet.\n\n * 400 OnlyBasicPublicIP - All VM specified should contain only Basic Public IP, when providing Loadbalancer Basic Sku.\n\n * 400 NICCannotUseMultipleLBsOfSameType - NIC: {0} cannot reference more than one load balancer of INTERNAL or PUBLIC type\n\n * 400 AGReplicaSQLStartupAccount - NT service account cannot be used as SQL startup account for AG setup. You should use a domain account.\n\n * 400 AgListenerMultiSubnetUpdateNotAllowed - Update of multi subnet AG listener is not allowed.\n\n * 400 ListenerIpSubnetVmSubnetMismatch - Listener static ip address subnet and VM subnet should be same\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 NoIpAvailable - No available IP.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ReplicasWithDifferentSqlStartupAccounts - Please make sure all your SQL server startup accounts in the specified replicas are the same. This is one of our prerequisites for setting up availability groups.\n\n * 409 ReplicasJoinedToMoreThanOneCluster - AG replicas are joined to more than one failover cluster. Please make sure all your replicas are joined to same failover cluster.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." - } - }, - "x-ms-examples": { - "Gets an availability group listener.": { - "$ref": "./examples/GetAvailabilityGroupListener.json" - } - } - }, - "put": { - "tags": [ - "AvailabilityGroupListeners" - ], - "description": "Creates or updates an availability group listener.", - "operationId": "AvailabilityGroupListeners_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineGroupName", - "in": "path", - "description": "Name of the SQL virtual machine group.", - "required": true, - "type": "string" - }, - { - "name": "availabilityGroupListenerName", - "in": "path", - "description": "Name of the availability group listener.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "The availability group listener.", - "required": true, - "schema": { - "$ref": "#/definitions/AvailabilityGroupListener" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the availability group listener.", - "schema": { - "$ref": "#/definitions/AvailabilityGroupListener" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 NoActivePrimaryInAG - None of the nodes in AvailabilityGroup are Primary\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 ExtVersionNotSupported - The virtual machine: {0} is running older version of SqlIaasExtension which is not supported by this operation. Please update the extension and retry the operation.\n\n * 400 InvalidReplicaRole - Invalid replica role: {0} specified for SQL VM: {1}.\n\n * 400 InvalidReplicaFailover - Invalid replica Failover: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaReadableSecondary - Invalid replica readable secondary: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaCommit - Invalid replica commit mode: {0} for SQL VM: {1}.\n\n * 400 ExpectedSynchronousCommitForAutomaticFailover - Invalid replica commit mode: {0} for SQL VM: {1}. {2} is expected for failover mode: {3}.\n\n * 400 NoPrimaryInAg - There are no replicas with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanOnePrimaryInAg - There are more than one replica with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanThreeSynchronousCommitInAg - There are more than three replica with commit mode as: {0}. There should be at most three replica with commit mode as: {0}\n\n * 400 MoreThanEightSecondariesInAg - There are more than eight secondary replica with secondary role. There should be at most eight replica with role as secondary.\n\n * 400 AlwaysOnNotEnabled - Always on feature is not enabled on Virtual machine: {0}.\n\n * 400 ExpectedReplicaNotPrimary - The VM: {0} does not host the primary replica.\n\n * 400 ListenerSqlVmsMismatchWithReplicaSqlVms - List of SQL VMs specified in Availability group does not match list of SQL VMs in listener config.\n\n * 400 ReplicaSqlvmHasDuplicateEntries - Replica configuration should be unique for each SQL virtual machine. We have found one or more configuration for the same SQL virtual machine resource.\n\n * 400 ReplicaDeleteNotAllowed - Replica deletion through SQL VM RP is not supported yet.\n\n * 400 OnlyBasicPublicIP - All VM specified should contain only Basic Public IP, when providing Loadbalancer Basic Sku.\n\n * 400 NICCannotUseMultipleLBsOfSameType - NIC: {0} cannot reference more than one load balancer of INTERNAL or PUBLIC type\n\n * 400 AGReplicaSQLStartupAccount - NT service account cannot be used as SQL startup account for AG setup. You should use a domain account.\n\n * 400 AgListenerMultiSubnetUpdateNotAllowed - Update of multi subnet AG listener is not allowed.\n\n * 400 ListenerIpSubnetVmSubnetMismatch - Listener static ip address subnet and VM subnet should be same\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 NoIpAvailable - No available IP.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ReplicasWithDifferentSqlStartupAccounts - Please make sure all your SQL server startup accounts in the specified replicas are the same. This is one of our prerequisites for setting up availability groups.\n\n * 409 ReplicasJoinedToMoreThanOneCluster - AG replicas are joined to more than one failover cluster. Please make sure all your replicas are joined to same failover cluster.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." - }, - "201": { - "description": "Successfully created the availability group listener.", - "schema": { - "$ref": "#/definitions/AvailabilityGroupListener" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Creates or updates an availability group listener using load balancer. This is used for VMs present in single subnet.": { - "$ref": "./examples/CreateOrUpdateAvailabilityGroupListener.json" - }, - "Creates or updates an availability group listener. This is used for VMs present in multi subnet": { - "$ref": "./examples/CreateOrUpdateAvailabilityGroupListenerWithMultiSubnet.json" - } - } - }, - "delete": { - "tags": [ - "AvailabilityGroupListeners" - ], - "description": "Deletes an availability group listener.", - "operationId": "AvailabilityGroupListeners_Delete", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineGroupName", - "in": "path", - "description": "Name of the SQL virtual machine group.", - "required": true, - "type": "string" - }, - { - "name": "availabilityGroupListenerName", - "in": "path", - "description": "Name of the availability group listener.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the availability group listener." - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 NoActivePrimaryInAG - None of the nodes in AvailabilityGroup are Primary\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 ExtVersionNotSupported - The virtual machine: {0} is running older version of SqlIaasExtension which is not supported by this operation. Please update the extension and retry the operation.\n\n * 400 InvalidReplicaRole - Invalid replica role: {0} specified for SQL VM: {1}.\n\n * 400 InvalidReplicaFailover - Invalid replica Failover: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaReadableSecondary - Invalid replica readable secondary: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaCommit - Invalid replica commit mode: {0} for SQL VM: {1}.\n\n * 400 ExpectedSynchronousCommitForAutomaticFailover - Invalid replica commit mode: {0} for SQL VM: {1}. {2} is expected for failover mode: {3}.\n\n * 400 NoPrimaryInAg - There are no replicas with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanOnePrimaryInAg - There are more than one replica with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanThreeSynchronousCommitInAg - There are more than three replica with commit mode as: {0}. There should be at most three replica with commit mode as: {0}\n\n * 400 MoreThanEightSecondariesInAg - There are more than eight secondary replica with secondary role. There should be at most eight replica with role as secondary.\n\n * 400 AlwaysOnNotEnabled - Always on feature is not enabled on Virtual machine: {0}.\n\n * 400 ExpectedReplicaNotPrimary - The VM: {0} does not host the primary replica.\n\n * 400 ListenerSqlVmsMismatchWithReplicaSqlVms - List of SQL VMs specified in Availability group does not match list of SQL VMs in listener config.\n\n * 400 ReplicaSqlvmHasDuplicateEntries - Replica configuration should be unique for each SQL virtual machine. We have found one or more configuration for the same SQL virtual machine resource.\n\n * 400 ReplicaDeleteNotAllowed - Replica deletion through SQL VM RP is not supported yet.\n\n * 400 OnlyBasicPublicIP - All VM specified should contain only Basic Public IP, when providing Loadbalancer Basic Sku.\n\n * 400 NICCannotUseMultipleLBsOfSameType - NIC: {0} cannot reference more than one load balancer of INTERNAL or PUBLIC type\n\n * 400 AGReplicaSQLStartupAccount - NT service account cannot be used as SQL startup account for AG setup. You should use a domain account.\n\n * 400 AgListenerMultiSubnetUpdateNotAllowed - Update of multi subnet AG listener is not allowed.\n\n * 400 ListenerIpSubnetVmSubnetMismatch - Listener static ip address subnet and VM subnet should be same\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 NoIpAvailable - No available IP.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ReplicasWithDifferentSqlStartupAccounts - Please make sure all your SQL server startup accounts in the specified replicas are the same. This is one of our prerequisites for setting up availability groups.\n\n * 409 ReplicasJoinedToMoreThanOneCluster - AG replicas are joined to more than one failover cluster. Please make sure all your replicas are joined to same failover cluster.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." - }, - "202": { - "description": "Deleting the availability group listener." - }, - "204": { - "description": "The availability group listener does not exist." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Deletes an availability group listener.": { - "$ref": "./examples/DeleteAvailabilityGroupListener.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners": { - "get": { - "tags": [ - "AvailabilityGroupListeners" - ], - "description": "Lists all availability group listeners in a SQL virtual machine group.", - "operationId": "AvailabilityGroupListeners_ListByGroup", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineGroupName", - "in": "path", - "description": "Name of the SQL virtual machine group.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved all availability group listeners in a SQL virtual machine group.", - "schema": { - "$ref": "#/definitions/AvailabilityGroupListenerListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 NoActivePrimaryInAG - None of the nodes in AvailabilityGroup are Primary\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 ExtVersionNotSupported - The virtual machine: {0} is running older version of SqlIaasExtension which is not supported by this operation. Please update the extension and retry the operation.\n\n * 400 InvalidReplicaRole - Invalid replica role: {0} specified for SQL VM: {1}.\n\n * 400 InvalidReplicaFailover - Invalid replica Failover: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaReadableSecondary - Invalid replica readable secondary: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaCommit - Invalid replica commit mode: {0} for SQL VM: {1}.\n\n * 400 ExpectedSynchronousCommitForAutomaticFailover - Invalid replica commit mode: {0} for SQL VM: {1}. {2} is expected for failover mode: {3}.\n\n * 400 NoPrimaryInAg - There are no replicas with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanOnePrimaryInAg - There are more than one replica with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanThreeSynchronousCommitInAg - There are more than three replica with commit mode as: {0}. There should be at most three replica with commit mode as: {0}\n\n * 400 MoreThanEightSecondariesInAg - There are more than eight secondary replica with secondary role. There should be at most eight replica with role as secondary.\n\n * 400 AlwaysOnNotEnabled - Always on feature is not enabled on Virtual machine: {0}.\n\n * 400 ExpectedReplicaNotPrimary - The VM: {0} does not host the primary replica.\n\n * 400 ListenerSqlVmsMismatchWithReplicaSqlVms - List of SQL VMs specified in Availability group does not match list of SQL VMs in listener config.\n\n * 400 ReplicaSqlvmHasDuplicateEntries - Replica configuration should be unique for each SQL virtual machine. We have found one or more configuration for the same SQL virtual machine resource.\n\n * 400 ReplicaDeleteNotAllowed - Replica deletion through SQL VM RP is not supported yet.\n\n * 400 OnlyBasicPublicIP - All VM specified should contain only Basic Public IP, when providing Loadbalancer Basic Sku.\n\n * 400 NICCannotUseMultipleLBsOfSameType - NIC: {0} cannot reference more than one load balancer of INTERNAL or PUBLIC type\n\n * 400 AGReplicaSQLStartupAccount - NT service account cannot be used as SQL startup account for AG setup. You should use a domain account.\n\n * 400 AgListenerMultiSubnetUpdateNotAllowed - Update of multi subnet AG listener is not allowed.\n\n * 400 ListenerIpSubnetVmSubnetMismatch - Listener static ip address subnet and VM subnet should be same\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 NoIpAvailable - No available IP.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ReplicasWithDifferentSqlStartupAccounts - Please make sure all your SQL server startup accounts in the specified replicas are the same. This is one of our prerequisites for setting up availability groups.\n\n * 409 ReplicasJoinedToMoreThanOneCluster - AG replicas are joined to more than one failover cluster. Please make sure all your replicas are joined to same failover cluster.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Lists all availability group listeners in a SQL virtual machine group.": { - "$ref": "./examples/ListByGroupAvailabilityGroupListener.json" - } - } - } - }, - "/providers/Microsoft.SqlVirtualMachine/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all of the available SQL Virtual Machine Rest API operations.", - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved operations.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "*** Error Responses: ***" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Lists all of the available SQL Virtual Machine Rest API operations.": { - "$ref": "./examples/ListOperation.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}": { - "get": { - "tags": [ - "SqlVirtualMachineGroups" - ], - "description": "Gets a SQL virtual machine group.", - "operationId": "SqlVirtualMachineGroups_Get", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineGroupName", - "in": "path", - "description": "Name of the SQL virtual machine group.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the SQL virtual machine group.", - "schema": { - "$ref": "#/definitions/SqlVirtualMachineGroup" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out." - } - }, - "x-ms-examples": { - "Gets a SQL virtual machine group.": { - "$ref": "./examples/GetSqlVirtualMachineGroup.json" - } - } - }, - "put": { - "tags": [ - "SqlVirtualMachineGroups" - ], - "description": "Creates or updates a SQL virtual machine group.", - "operationId": "SqlVirtualMachineGroups_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineGroupName", - "in": "path", - "description": "Name of the SQL virtual machine group.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "The SQL virtual machine group.", - "required": true, - "schema": { - "$ref": "#/definitions/SqlVirtualMachineGroup" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the SQL virtual machine group.", - "schema": { - "$ref": "#/definitions/SqlVirtualMachineGroup" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 InvalidStorageAccountCredentials - The storage account credentials provided are incorrect.\n\n * 400 InvalidStorageAccountType - Only storage account of type 'General-Purpose V2' is allowed for this operation.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out." - }, - "201": { - "description": "Successfully created the SQL virtual machine group.", - "schema": { - "$ref": "#/definitions/SqlVirtualMachineGroup" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Creates or updates a SQL virtual machine group.": { - "$ref": "./examples/CreateOrUpdateSqlVirtualMachineGroup.json" - } - } - }, - "delete": { - "tags": [ - "SqlVirtualMachineGroups" - ], - "description": "Deletes a SQL virtual machine group.", - "operationId": "SqlVirtualMachineGroups_Delete", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineGroupName", - "in": "path", - "description": "Name of the SQL virtual machine group.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the SQL virtual machine group." - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 NoActivePrimaryInAG - None of the nodes in AvailabilityGroup are Primary\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 ExtVersionNotSupported - The virtual machine: {0} is running older version of SqlIaasExtension which is not supported by this operation. Please update the extension and retry the operation.\n\n * 400 InvalidReplicaRole - Invalid replica role: {0} specified for SQL VM: {1}.\n\n * 400 InvalidReplicaFailover - Invalid replica Failover: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaReadableSecondary - Invalid replica readable secondary: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaCommit - Invalid replica commit mode: {0} for SQL VM: {1}.\n\n * 400 ExpectedSynchronousCommitForAutomaticFailover - Invalid replica commit mode: {0} for SQL VM: {1}. {2} is expected for failover mode: {3}.\n\n * 400 NoPrimaryInAg - There are no replicas with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanOnePrimaryInAg - There are more than one replica with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanThreeSynchronousCommitInAg - There are more than three replica with commit mode as: {0}. There should be at most three replica with commit mode as: {0}\n\n * 400 MoreThanEightSecondariesInAg - There are more than eight secondary replica with secondary role. There should be at most eight replica with role as secondary.\n\n * 400 AlwaysOnNotEnabled - Always on feature is not enabled on Virtual machine: {0}.\n\n * 400 ExpectedReplicaNotPrimary - The VM: {0} does not host the primary replica.\n\n * 400 ListenerSqlVmsMismatchWithReplicaSqlVms - List of SQL VMs specified in Availability group does not match list of SQL VMs in listener config.\n\n * 400 ReplicaSqlvmHasDuplicateEntries - Replica configuration should be unique for each SQL virtual machine. We have found one or more configuration for the same SQL virtual machine resource.\n\n * 400 ReplicaDeleteNotAllowed - Replica deletion through SQL VM RP is not supported yet.\n\n * 400 OnlyBasicPublicIP - All VM specified should contain only Basic Public IP, when providing Loadbalancer Basic Sku.\n\n * 400 NICCannotUseMultipleLBsOfSameType - NIC: {0} cannot reference more than one load balancer of INTERNAL or PUBLIC type\n\n * 400 AGReplicaSQLStartupAccount - NT service account cannot be used as SQL startup account for AG setup. You should use a domain account.\n\n * 400 AgListenerMultiSubnetUpdateNotAllowed - Update of multi subnet AG listener is not allowed.\n\n * 400 ListenerIpSubnetVmSubnetMismatch - Listener static ip address subnet and VM subnet should be same\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 NoIpAvailable - No available IP.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 InvalidStorageAccountCredentials - The storage account credentials provided are incorrect.\n\n * 400 InvalidStorageAccountType - Only storage account of type 'General-Purpose V2' is allowed for this operation.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ReplicasWithDifferentSqlStartupAccounts - Please make sure all your SQL server startup accounts in the specified replicas are the same. This is one of our prerequisites for setting up availability groups.\n\n * 409 ReplicasJoinedToMoreThanOneCluster - AG replicas are joined to more than one failover cluster. Please make sure all your replicas are joined to same failover cluster.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." - }, - "202": { - "description": "Deleting the SQL virtual machine group." - }, - "204": { - "description": "The specified SQL virtual machine group does not exist." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Deletes a SQL virtual machine group.": { - "$ref": "./examples/DeleteSqlVirtualMachineGroup.json" - } - } - }, - "patch": { - "tags": [ - "SqlVirtualMachineGroups" - ], - "description": "Updates SQL virtual machine group tags.", - "operationId": "SqlVirtualMachineGroups_Update", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineGroupName", - "in": "path", - "description": "Name of the SQL virtual machine group.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "The SQL virtual machine group.", - "required": true, - "schema": { - "$ref": "#/definitions/SqlVirtualMachineGroupUpdate" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the SQL virtual machine group.", - "schema": { - "$ref": "#/definitions/SqlVirtualMachineGroup" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 InvalidStorageAccountCredentials - The storage account credentials provided are incorrect.\n\n * 400 InvalidStorageAccountType - Only storage account of type 'General-Purpose V2' is allowed for this operation.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Updates a SQL virtual machine group tags.": { - "$ref": "./examples/UpdateSqlVirtualMachineGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups": { - "get": { - "tags": [ - "SqlVirtualMachineGroups" - ], - "description": "Gets all SQL virtual machine groups in a resource group.", - "operationId": "SqlVirtualMachineGroups_ListByResourceGroup", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved all SQL virtual machine groups in the resource group.", - "schema": { - "$ref": "#/definitions/SqlVirtualMachineGroupListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all SQL virtual machine groups in a resource group.": { - "$ref": "./examples/ListByResourceGroupSqlVirtualMachineGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups": { - "get": { - "tags": [ - "SqlVirtualMachineGroups" - ], - "description": "Gets all SQL virtual machine groups in a subscription.", - "operationId": "SqlVirtualMachineGroups_List", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved all SQL virtual machine groups in the subscription.", - "schema": { - "$ref": "#/definitions/SqlVirtualMachineGroupListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all SQL virtual machine groups in a subscription.": { - "$ref": "./examples/ListSubscriptionSqlVirtualMachineGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/sqlVirtualMachines": { - "get": { - "tags": [ - "SqlVirtualMachines" - ], - "description": "Gets the list of sql virtual machines in a SQL virtual machine group.", - "operationId": "SqlVirtualMachines_ListBySqlVmGroup", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineGroupName", - "in": "path", - "description": "Name of the SQL virtual machine group.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of sql virtual machines in a SQL virtual machine group.", - "schema": { - "$ref": "#/definitions/SqlVirtualMachineListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 InvalidStorageAccountCredentials - The storage account credentials provided are incorrect.\n\n * 400 InvalidStorageAccountType - Only storage account of type 'General-Purpose V2' is allowed for this operation.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets the list of sql virtual machines in a SQL virtual machine group.": { - "$ref": "./examples/ListBySqlVirtualMachineGroupSqlVirtualMachine.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines": { - "get": { - "tags": [ - "SqlVirtualMachines" - ], - "description": "Gets all SQL virtual machines in a subscription.", - "operationId": "SqlVirtualMachines_List", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved all SQL virtual machines in the subscription.", - "schema": { - "$ref": "#/definitions/SqlVirtualMachineListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all SQL virtual machines in a subscription.": { - "$ref": "./examples/ListSubscriptionSqlVirtualMachine.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}": { - "get": { - "tags": [ - "SqlVirtualMachines" - ], - "description": "Gets a SQL virtual machine.", - "operationId": "SqlVirtualMachines_Get", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineName", - "in": "path", - "description": "Name of the SQL virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "The child resources to include in the response.", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the SQL virtual machine.", - "schema": { - "$ref": "#/definitions/SqlVirtualMachine" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out." - } - }, - "x-ms-examples": { - "Gets a SQL virtual machine.": { - "$ref": "./examples/GetSqlVirtualMachine.json" - } - } - }, - "put": { - "tags": [ - "SqlVirtualMachines" - ], - "description": "Creates or updates a SQL virtual machine.", - "operationId": "SqlVirtualMachines_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineName", - "in": "path", - "description": "Name of the SQL virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "The SQL virtual machine.", - "required": true, - "schema": { - "$ref": "#/definitions/SqlVirtualMachine" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the SQL virtual machine.", - "schema": { - "$ref": "#/definitions/SqlVirtualMachine" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 Ext_CancelError - The operation was canceled\n\n * 409 Ext_VMAgentStatusCommunicationError - SQLIaaSExtension installation failed because azure guest agent service is not running or it is not able to establish outbound connection to storage account.\n\n * 409 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 409 Ext_ComputeError - Compute returned error on current operation.\n\n * 409 Ext_OperationPreempted - SQL VM operation has been preempted by a more recent operation like ResourceGroup drop, Resource move, VM drop or VM shutdown or VM redeploy.\n\n * 409 Ext_VMExtensionProvisioningError - There was an error while installing SqlIaasExtension on the virtual machine.\n\n * 409 Ext_VMExtensionProvisioningTimeout - SQL VM resource provisioning operation timed out.\n\n * 409 Ext_VMExtensionHandlerNonTransientError - SQLIaaSExtension installation failed due to an internal error. Please retry the installation.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out." - }, - "201": { - "description": "Successfully created the SQL virtual machine.", - "schema": { - "$ref": "#/definitions/SqlVirtualMachine" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Creates or updates a SQL virtual machine with min parameters.": { - "$ref": "./examples/CreateOrUpdateSqlVirtualMachineMIN.json" - }, - "Creates or updates a SQL virtual machine with max parameters.": { - "$ref": "./examples/CreateOrUpdateSqlVirtualMachineMAX.json" - }, - "Creates or updates a SQL virtual machine and joins it to a SQL virtual machine group.": { - "$ref": "./examples/CreateOrUpdateVirtualMachineWithVMGroup.json" - }, - "Creates or updates a SQL virtual machine for Storage Configuration Settings to NEW Data, Log and TempDB storage pool.": { - "$ref": "./examples/CreateOrUpdateSqlVirtualMachineStorageConfigurationNEW.json" - }, - "Creates or updates a SQL virtual machine for Storage Configuration Settings to EXTEND Data, Log or TempDB storage pool.": { - "$ref": "./examples/CreateOrUpdateSqlVirtualMachineStorageConfigurationEXTEND.json" - }, - "Creates or updates a SQL virtual machine for Automated Back up Settings with Weekly and Days of the week to run the back up.": { - "$ref": "./examples/CreateOrUpdateSqlVirtualMachineAutomatedBackupWeekly.json" - } - } - }, - "delete": { - "tags": [ - "SqlVirtualMachines" - ], - "description": "Deletes a SQL virtual machine.", - "operationId": "SqlVirtualMachines_Delete", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineName", - "in": "path", - "description": "Name of the SQL virtual machine.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the SQL virtual machine." - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out." - }, - "202": { - "description": "Deleting the SQL virtual machine." - }, - "204": { - "description": "The specified SQL virtual machine does not exist." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Deletes a SQL virtual machine.": { - "$ref": "./examples/DeleteSqlVirtualMachine.json" - } - } - }, - "patch": { - "tags": [ - "SqlVirtualMachines" - ], - "description": "Updates a SQL virtual machine.", - "operationId": "SqlVirtualMachines_Update", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineName", - "in": "path", - "description": "Name of the SQL virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "The SQL virtual machine.", - "required": true, - "schema": { - "$ref": "#/definitions/SqlVirtualMachineUpdate" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the SQL virtual machine.", - "schema": { - "$ref": "#/definitions/SqlVirtualMachine" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Updates a SQL virtual machine tags.": { - "$ref": "./examples/UpdateSqlVirtualMachine.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines": { - "get": { - "tags": [ - "SqlVirtualMachines" - ], - "description": "Gets all SQL virtual machines in a resource group.", - "operationId": "SqlVirtualMachines_ListByResourceGroup", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved all SQL virtual machines in the resource group.", - "schema": { - "$ref": "#/definitions/SqlVirtualMachineListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all SQL virtual machines in a resource group.": { - "$ref": "./examples/ListByResourceGroupSqlVirtualMachine.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/redeploy": { - "post": { - "tags": [ - "SqlVirtualMachines" - ], - "description": "Uninstalls and reinstalls the SQL Iaas Extension.", - "operationId": "SqlVirtualMachines_Redeploy", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineName", - "in": "path", - "description": "Name of the SQL virtual machine.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully redeployed the SQL virtual machine." - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out." - }, - "202": { - "description": "Accepted redeploying the SQL virtual machine." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Uninstalls and reinstalls the SQL Iaas Extension.": { - "$ref": "./examples/RedeploySqlVirtualMachine.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/startAssessment": { - "post": { - "tags": [ - "SqlVirtualMachines" - ], - "description": "Starts Assessment on SQL virtual machine.", - "operationId": "SqlVirtualMachines_StartAssessment", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "sqlVirtualMachineName", - "in": "path", - "description": "Name of the SQL virtual machine.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully started assessment on the SQL virtual machine." - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultiSubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out." - }, - "202": { - "description": "Accepted request to start assessment on SQL virtual machine." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Starts Assessment on SQL virtual machine": { - "$ref": "./examples/StartAssessmentOnSqlVirtualMachine.json" - } - } - } - } - }, - "definitions": { - "AvailabilityGroupListenerProperties": { - "description": "The properties of an availability group listener.", - "type": "object", - "properties": { - "provisioningState": { - "description": "Provisioning state to track the async operation status.", - "type": "string", - "readOnly": true - }, - "availabilityGroupName": { - "description": "Name of the availability group.", - "type": "string" - }, - "loadBalancerConfigurations": { - "description": "List of load balancer configurations for an availability group listener.", - "type": "array", - "items": { - "$ref": "#/definitions/LoadBalancerConfiguration" - } - }, - "multiSubnetIpConfigurations": { - "description": "List of multi subnet IP configurations for an AG listener.", - "type": "array", - "items": { - "$ref": "#/definitions/MultiSubnetIpConfiguration" - }, - "x-ms-identifiers": [] - }, - "createDefaultAvailabilityGroupIfNotExist": { - "description": "Create a default availability group if it does not exist.", - "type": "boolean" - }, - "port": { - "format": "int32", - "description": "Listener port.", - "type": "integer" - }, - "availabilityGroupConfiguration": { - "$ref": "#/definitions/AgConfiguration", - "description": "Availability Group configuration." - } - } - }, - "LoadBalancerConfiguration": { - "description": "A load balancer configuration for an availability group listener.", - "type": "object", - "properties": { - "privateIpAddress": { - "$ref": "#/definitions/PrivateIPAddress", - "description": "Private IP address." - }, - "publicIpAddressResourceId": { - "description": "Resource id of the public IP.", - "type": "string" - }, - "loadBalancerResourceId": { - "description": "Resource id of the load balancer.", - "type": "string" - }, - "probePort": { - "format": "int32", - "description": "Probe port.", - "type": "integer" - }, - "sqlVirtualMachineInstances": { - "description": "List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "MultiSubnetIpConfiguration": { - "description": "Multi subnet ip configuration for an availability group listener.", - "required": [ - "privateIpAddress", - "sqlVirtualMachineInstance" - ], - "type": "object", - "properties": { - "privateIpAddress": { - "$ref": "#/definitions/PrivateIPAddress", - "description": "Private IP address." - }, - "sqlVirtualMachineInstance": { - "description": "SQL virtual machine instance resource id that are enrolled into the availability group listener.", - "type": "string" - } - } - }, - "AgConfiguration": { - "description": "Availability group configuration.", - "type": "object", - "properties": { - "replicas": { - "description": "Replica configurations.", - "type": "array", - "items": { - "$ref": "#/definitions/AgReplica" - }, - "x-ms-identifiers": [] - } - } - }, - "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 - }, - "PrivateIPAddress": { - "description": "A private IP address bound to the availability group listener.", - "type": "object", - "properties": { - "ipAddress": { - "description": "Private IP address bound to the availability group listener.", - "type": "string" - }, - "subnetResourceId": { - "description": "Subnet used to include private IP.", - "type": "string" - } - } - }, - "AgReplica": { - "description": "Availability group replica configuration.", - "type": "object", - "properties": { - "sqlVirtualMachineInstanceId": { - "description": "Sql VirtualMachine Instance Id.", - "type": "string" - }, - "role": { - "description": "Replica Role in availability group.", - "enum": [ - "Primary", - "Secondary" - ], - "type": "string", - "x-ms-enum": { - "name": "Role", - "modelAsString": true - } - }, - "commit": { - "description": "Replica commit mode in availability group.", - "enum": [ - "Synchronous_Commit", - "Asynchronous_Commit" - ], - "type": "string", - "x-ms-enum": { - "name": "Commit", - "modelAsString": true - } - }, - "failover": { - "description": "Replica failover mode in availability group.", - "enum": [ - "Automatic", - "Manual" - ], - "type": "string", - "x-ms-enum": { - "name": "Failover", - "modelAsString": true - } - }, - "readableSecondary": { - "description": "Replica readable secondary mode in availability group.", - "enum": [ - "No", - "All", - "Read_Only" - ], - "type": "string", - "x-ms-enum": { - "name": "ReadableSecondary", - "modelAsString": true - } - } - } - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, - "AvailabilityGroupListener": { - "description": "A SQL Server availability group listener.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/AvailabilityGroupListenerProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - }, - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "readOnly": true - } - } - }, - "AvailabilityGroupListenerListResult": { - "description": "A list of availability group listeners.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/AvailabilityGroupListener" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "OperationListResult": { - "description": "Result of the request to list SQL operations.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "Operation": { - "description": "SQL REST API operation definition.", - "type": "object", - "properties": { - "name": { - "description": "The name of the operation being performed on this particular object.", - "type": "string", - "readOnly": true - }, - "display": { - "$ref": "#/definitions/OperationDisplay", - "description": "The localized display information for this particular operation / action.", - "readOnly": true - }, - "origin": { - "description": "The intended executor of the operation.", - "enum": [ - "user", - "system" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "OperationOrigin", - "modelAsString": true - } - }, - "properties": { - "description": "Additional descriptions for the operation.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "readOnly": true, - "x-ms-client-flatten": false - } - } - }, - "OperationDisplay": { - "description": "Display metadata associated with the operation.", - "type": "object", - "properties": { - "provider": { - "description": "The localized friendly form of the resource provider name.", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "The localized friendly form of the resource type related to this action/operation.", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "The localized friendly name for the operation.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The localized friendly description for the operation.", - "type": "string", - "readOnly": true - } - } - }, - "SqlVirtualMachineGroupProperties": { - "description": "The properties of a SQL virtual machine group.", - "type": "object", - "properties": { - "provisioningState": { - "description": "Provisioning state to track the async operation status.", - "type": "string", - "readOnly": true - }, - "sqlImageOffer": { - "description": "SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "sqlImageSku": { - "description": "SQL image sku.", - "enum": [ - "Developer", - "Enterprise" - ], - "type": "string", - "x-ms-enum": { - "name": "SqlVmGroupImageSku", - "modelAsString": true - }, - "x-ms-mutability": [ - "read", - "create" - ] - }, - "scaleType": { - "description": "Scale type.", - "enum": [ - "HA" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ScaleType", - "modelAsString": true - } - }, - "clusterManagerType": { - "description": "Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type.", - "enum": [ - "WSFC" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ClusterManagerType", - "modelAsString": true - } - }, - "clusterConfiguration": { - "description": "Cluster type.", - "enum": [ - "Domainful" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ClusterConfiguration", - "modelAsString": true - } - }, - "wsfcDomainProfile": { - "$ref": "#/definitions/WsfcDomainProfile", - "description": "Cluster Active Directory domain profile.", - "x-ms-mutability": [ - "read", - "create" - ] - } - } - }, - "WsfcDomainProfile": { - "description": "Active Directory account details to operate Windows Server Failover Cluster.", - "type": "object", - "properties": { - "domainFqdn": { - "description": "Fully qualified name of the domain.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "ouPath": { - "description": "Organizational Unit path in which the nodes and cluster will be present.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "clusterBootstrapAccount": { - "description": "Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "clusterOperatorAccount": { - "description": "Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.", - "type": "string", - "x-ms-mutability": [ - "read", - "update" - ] - }, - "sqlServiceAccount": { - "description": "Account name under which SQL service will run on all participating SQL virtual machines in the cluster.", - "type": "string", - "x-ms-mutability": [ - "read", - "update" - ] - }, - "fileShareWitnessPath": { - "description": "Optional path for fileshare witness.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "storageAccountUrl": { - "description": "Fully qualified ARM resource id of the witness storage account.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "storageAccountPrimaryKey": { - "description": "Primary key of the witness storage account.", - "type": "string", - "x-ms-mutability": [ - "create" - ] - }, - "clusterSubnetType": { - "description": "Cluster subnet type.", - "enum": [ - "SingleSubnet", - "MultiSubnet" - ], - "type": "string", - "x-ms-enum": { - "name": "ClusterSubnetType", - "modelAsString": true - }, - "x-ms-mutability": [ - "read", - "create" - ] - } - } - }, - "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" - } - } - } - }, - "SqlVirtualMachineGroup": { - "description": "A SQL virtual machine group.", - "required": [ - "location" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SqlVirtualMachineGroupProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - }, - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "readOnly": true - } - } - }, - "SqlVirtualMachineGroupUpdate": { - "description": "An update to a SQL virtual machine group.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "SqlVirtualMachineGroupListResult": { - "description": "A list of SQL virtual machine groups.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/SqlVirtualMachineGroup" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "SqlVirtualMachineListResult": { - "description": "A list of SQL virtual machines.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/SqlVirtualMachine" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "ResourceIdentity": { - "description": "Azure Active Directory identity configuration for a resource.", - "type": "object", - "properties": { - "principalId": { - "format": "uuid", - "description": "The Azure Active Directory principal id.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.", - "enum": [ - "None", - "SystemAssigned" - ], - "type": "string", - "x-ms-enum": { - "name": "IdentityType", - "modelAsString": true - } - }, - "tenantId": { - "format": "uuid", - "description": "The Azure Active Directory tenant id.", - "type": "string", - "readOnly": true - } - } - }, - "SqlVirtualMachineProperties": { - "description": "The SQL virtual machine properties.", - "type": "object", - "properties": { - "virtualMachineResourceId": { - "description": "ARM Resource id of underlying virtual machine created from SQL marketplace image.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "provisioningState": { - "description": "Provisioning state to track the async operation status.", - "type": "string", - "readOnly": true - }, - "sqlImageOffer": { - "description": "SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "sqlServerLicenseType": { - "description": "SQL Server license type.", - "enum": [ - "PAYG", - "AHUB", - "DR" - ], - "type": "string", - "x-ms-enum": { - "name": "SqlServerLicenseType", - "modelAsString": true - } - }, - "sqlManagement": { - "description": "SQL Server Management type.", - "enum": [ - "Full", - "LightWeight", - "NoAgent" - ], - "type": "string", - "x-ms-enum": { - "name": "SqlManagementMode", - "modelAsString": true - } - }, - "sqlImageSku": { - "description": "SQL Server edition type.", - "enum": [ - "Developer", - "Express", - "Standard", - "Enterprise", - "Web" - ], - "type": "string", - "x-ms-enum": { - "name": "SqlImageSku", - "modelAsString": true - } - }, - "sqlVirtualMachineGroupResourceId": { - "description": "ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of.", - "type": "string", - "x-ms-mutability": [ - "read", - "update" - ] - }, - "wsfcDomainCredentials": { - "$ref": "#/definitions/WsfcDomainCredentials", - "description": "Domain credentials for setting up Windows Server Failover Cluster for SQL availability group." - }, - "wsfcStaticIp": { - "description": "Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.", - "type": "string" - }, - "autoPatchingSettings": { - "$ref": "#/definitions/AutoPatchingSettings", - "description": "Auto patching settings for applying critical security updates to SQL virtual machine." - }, - "autoBackupSettings": { - "$ref": "#/definitions/AutoBackupSettings", - "description": "Auto backup settings for SQL Server." - }, - "keyVaultCredentialSettings": { - "$ref": "#/definitions/KeyVaultCredentialSettings", - "description": "Key vault credential settings." - }, - "serverConfigurationsManagementSettings": { - "$ref": "#/definitions/ServerConfigurationsManagementSettings", - "description": "SQL Server configuration management settings." - }, - "storageConfigurationSettings": { - "$ref": "#/definitions/StorageConfigurationSettings", - "description": "Storage Configuration Settings." - }, - "assessmentSettings": { - "$ref": "#/definitions/AssessmentSettings", - "description": "Assessment Settings." - } - } - }, - "WsfcDomainCredentials": { - "description": "Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.", - "type": "object", - "properties": { - "clusterBootstrapAccountPassword": { - "description": "Cluster bootstrap account password.", - "type": "string" - }, - "clusterOperatorAccountPassword": { - "description": "Cluster operator account password.", - "type": "string" - }, - "sqlServiceAccountPassword": { - "description": "SQL service account password.", - "type": "string" - } - } - }, - "AutoPatchingSettings": { - "description": "Set a patching window during which Windows and SQL patches will be applied.", - "type": "object", - "properties": { - "enable": { - "description": "Enable or disable autopatching on SQL virtual machine.", - "type": "boolean" - }, - "dayOfWeek": { - "description": "Day of week to apply the patch on.", - "enum": [ - "Everyday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], - "type": "string", - "x-ms-enum": { - "name": "DayOfWeek", - "modelAsString": false - } - }, - "maintenanceWindowStartingHour": { - "format": "int32", - "description": "Hour of the day when patching is initiated. Local VM time.", - "type": "integer" - }, - "maintenanceWindowDuration": { - "format": "int32", - "description": "Duration of patching.", - "type": "integer" - } - } - }, - "AutoBackupSettings": { - "description": "Configure backups for databases in your SQL virtual machine.", - "type": "object", - "properties": { - "enable": { - "description": "Enable or disable autobackup on SQL virtual machine.", - "type": "boolean" - }, - "enableEncryption": { - "description": "Enable or disable encryption for backup on SQL virtual machine.", - "type": "boolean" - }, - "retentionPeriod": { - "format": "int32", - "description": "Retention period of backup: 1-90 days.", - "type": "integer" - }, - "storageAccountUrl": { - "description": "Storage account url where backup will be taken to.", - "type": "string" - }, - "storageContainerName": { - "description": "Storage container name where backup will be taken to.", - "type": "string" - }, - "storageAccessKey": { - "description": "Storage account key where backup will be taken to.", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - }, - "password": { - "description": "Password for encryption on backup.", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - }, - "backupSystemDbs": { - "description": "Include or exclude system databases from auto backup.", - "type": "boolean" - }, - "backupScheduleType": { - "description": "Backup schedule type.", - "enum": [ - "Manual", - "Automated" - ], - "type": "string", - "x-ms-enum": { - "name": "BackupScheduleType", - "modelAsString": true - } - }, - "fullBackupFrequency": { - "description": "Frequency of full backups. In both cases, full backups begin during the next scheduled time window.", - "enum": [ - "Daily", - "Weekly" - ], - "type": "string", - "x-ms-enum": { - "name": "FullBackupFrequencyType", - "modelAsString": true - } - }, - "daysOfWeek": { - "description": "Days of the week for the backups when FullBackupFrequency is set to Weekly.", - "type": "array", - "items": { - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], - "type": "string", - "x-ms-enum": { - "name": "AutoBackupDaysOfWeek", - "modelAsString": true - } - } - }, - "fullBackupStartTime": { - "format": "int32", - "description": "Start time of a given day during which full backups can take place. 0-23 hours.", - "type": "integer" - }, - "fullBackupWindowHours": { - "format": "int32", - "description": "Duration of the time window of a given day during which full backups can take place. 1-23 hours.", - "type": "integer" - }, - "logBackupFrequency": { - "format": "int32", - "description": "Frequency of log backups. 5-60 minutes.", - "type": "integer" - } - } - }, - "KeyVaultCredentialSettings": { - "description": "Configure your SQL virtual machine to be able to connect to the Azure Key Vault service.", - "type": "object", - "properties": { - "enable": { - "description": "Enable or disable key vault credential setting.", - "type": "boolean" - }, - "credentialName": { - "description": "Credential name.", - "type": "string" - }, - "azureKeyVaultUrl": { - "description": "Azure Key Vault url.", - "type": "string" - }, - "servicePrincipalName": { - "description": "Service principal name to access key vault.", - "type": "string" - }, - "servicePrincipalSecret": { - "description": "Service principal name secret to access key vault.", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - } - } - }, - "ServerConfigurationsManagementSettings": { - "description": "Set the connectivity, storage and workload settings.", - "type": "object", - "properties": { - "sqlConnectivityUpdateSettings": { - "$ref": "#/definitions/SqlConnectivityUpdateSettings", - "description": "SQL connectivity type settings." - }, - "sqlWorkloadTypeUpdateSettings": { - "$ref": "#/definitions/SqlWorkloadTypeUpdateSettings", - "description": "SQL workload type settings." - }, - "sqlStorageUpdateSettings": { - "$ref": "#/definitions/SqlStorageUpdateSettings", - "description": "SQL storage update settings." - }, - "additionalFeaturesServerConfigurations": { - "$ref": "#/definitions/AdditionalFeaturesServerConfigurations", - "description": "Additional SQL feature settings." - }, - "sqlInstanceSettings": { - "$ref": "#/definitions/SQLInstanceSettings", - "description": "SQL Instance settings." - } - } - }, - "StorageConfigurationSettings": { - "description": "Storage Configurations for SQL Data, Log and TempDb.", - "type": "object", - "properties": { - "sqlDataSettings": { - "$ref": "#/definitions/SQLStorageSettings", - "description": "SQL Server Data Storage Settings." - }, - "sqlLogSettings": { - "$ref": "#/definitions/SQLStorageSettings", - "description": "SQL Server Log Storage Settings." - }, - "sqlTempDbSettings": { - "$ref": "#/definitions/SQLTempDbSettings", - "description": "SQL Server TempDb Storage Settings." - }, - "sqlSystemDbOnDataDisk": { - "description": "SQL Server SystemDb Storage on DataPool if true.", - "type": "boolean" - }, - "diskConfigurationType": { - "description": "Disk configuration to apply to SQL Server.", - "enum": [ - "NEW", - "EXTEND", - "ADD" - ], - "type": "string", - "x-ms-enum": { - "name": "DiskConfigurationType", - "modelAsString": true - } - }, - "storageWorkloadType": { - "description": "Storage workload type.", - "enum": [ - "GENERAL", - "OLTP", - "DW" - ], - "type": "string", - "x-ms-enum": { - "name": "StorageWorkloadType", - "modelAsString": true - }, - "x-ms-mutability": [ - "read", - "create" - ] - } - } - }, - "AssessmentSettings": { - "description": "Configure assessment for databases in your SQL virtual machine.", - "type": "object", - "properties": { - "enable": { - "description": "Enable or disable assessment feature on SQL virtual machine.", - "type": "boolean" - }, - "runImmediately": { - "description": "Run assessment immediately on SQL virtual machine.", - "type": "boolean" - }, - "schedule": { - "$ref": "#/definitions/Schedule", - "description": "Schedule for Assessment." - } - } - }, - "SqlConnectivityUpdateSettings": { - "description": "Set the access level and network port settings for SQL Server.", - "type": "object", - "properties": { - "connectivityType": { - "description": "SQL Server connectivity option.", - "enum": [ - "LOCAL", - "PRIVATE", - "PUBLIC" - ], - "type": "string", - "x-ms-enum": { - "name": "ConnectivityType", - "modelAsString": true - } - }, - "port": { - "format": "int32", - "description": "SQL Server port.", - "type": "integer" - }, - "sqlAuthUpdateUserName": { - "description": "SQL Server sysadmin login to create.", - "type": "string", - "x-ms-mutability": [ - "create" - ] - }, - "sqlAuthUpdatePassword": { - "description": "SQL Server sysadmin login password.", - "type": "string", - "x-ms-mutability": [ - "create" - ] - } - } - }, - "SqlWorkloadTypeUpdateSettings": { - "description": "Set workload type to optimize storage for SQL Server.", - "type": "object", - "properties": { - "sqlWorkloadType": { - "description": "SQL Server workload type.", - "enum": [ - "GENERAL", - "OLTP", - "DW" - ], - "type": "string", - "x-ms-enum": { - "name": "SqlWorkloadType", - "modelAsString": true - }, - "x-ms-mutability": [ - "read", - "create" - ] - } - } - }, - "SqlStorageUpdateSettings": { - "description": "Set disk storage settings for SQL Server.", - "type": "object", - "properties": { - "diskCount": { - "format": "int32", - "description": "Virtual machine disk count.", - "type": "integer" - }, - "startingDeviceId": { - "format": "int32", - "description": "Device id of the first disk to be updated.", - "type": "integer" - }, - "diskConfigurationType": { - "description": "Disk configuration to apply to SQL Server.", - "enum": [ - "NEW", - "EXTEND", - "ADD" - ], - "type": "string", - "x-ms-enum": { - "name": "DiskConfigurationType", - "modelAsString": true - } - } - } - }, - "AdditionalFeaturesServerConfigurations": { - "description": "Additional SQL Server feature settings.", - "type": "object", - "properties": { - "isRServicesEnabled": { - "description": "Enable or disable R services (SQL 2016 onwards).", - "type": "boolean" - } - } - }, - "SQLInstanceSettings": { - "description": "Set the server/instance-level settings for SQL Server.", - "type": "object", - "properties": { - "collation": { - "description": "SQL Server Collation.", - "type": "string" - }, - "maxDop": { - "format": "int32", - "description": "SQL Server MAXDOP.", - "type": "integer" - }, - "isOptimizeForAdHocWorkloadsEnabled": { - "description": "SQL Server Optimize for Adhoc workloads.", - "type": "boolean" - }, - "minServerMemoryMB": { - "format": "int32", - "description": "SQL Server minimum memory.", - "type": "integer" - }, - "maxServerMemoryMB": { - "format": "int32", - "description": "SQL Server maximum memory.", - "type": "integer" - }, - "isLpimEnabled": { - "description": "SQL Server LPIM.", - "type": "boolean" - }, - "isIfiEnabled": { - "description": "SQL Server IFI.", - "type": "boolean" - } - } - }, - "SQLStorageSettings": { - "description": "Set disk storage settings for SQL Server.", - "type": "object", - "properties": { - "luns": { - "description": "Logical Unit Numbers for the disks.", - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } - }, - "defaultFilePath": { - "description": "SQL Server default file path", - "type": "string" - } - } - }, - "SQLTempDbSettings": { - "type": "object", - "properties": { - "dataFileSize": { - "format": "int32", - "description": "SQL Server tempdb data file size", - "type": "integer" - }, - "dataGrowth": { - "format": "int32", - "description": "SQL Server tempdb data file autoGrowth size", - "type": "integer" - }, - "logFileSize": { - "format": "int32", - "description": "SQL Server tempdb log file size", - "type": "integer" - }, - "logGrowth": { - "format": "int32", - "description": "SQL Server tempdb log file autoGrowth size", - "type": "integer" - }, - "dataFileCount": { - "format": "int32", - "description": "SQL Server tempdb data file count", - "type": "integer" - }, - "persistFolder": { - "description": "SQL Server tempdb persist folder choice", - "type": "boolean" - }, - "persistFolderPath": { - "description": "SQL Server tempdb persist folder location", - "type": "string" - }, - "luns": { - "description": "Logical Unit Numbers for the disks.", - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } - }, - "defaultFilePath": { - "description": "SQL Server default file path", - "type": "string" - } - } - }, - "Schedule": { - "type": "object", - "properties": { - "enable": { - "description": "Enable or disable assessment schedule on SQL virtual machine.", - "type": "boolean" - }, - "weeklyInterval": { - "format": "int32", - "description": "Number of weeks to schedule between 2 assessment runs. Takes value from 1-6", - "type": "integer" - }, - "monthlyOccurrence": { - "format": "int32", - "description": "Occurrence of the DayOfWeek day within a month to schedule assessment. Takes values: 1,2,3,4 and -1. Use -1 for last DayOfWeek day of the month", - "type": "integer" - }, - "dayOfWeek": { - "description": "Day of the week to run assessment.", - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], - "type": "string", - "x-ms-enum": { - "name": "AssessmentDayOfWeek", - "modelAsString": false - } - }, - "startTime": { - "description": "Time of the day in HH:mm format. Eg. 17:30", - "type": "string" - } - } - }, - "SqlVirtualMachine": { - "description": "A SQL virtual machine.", - "required": [ - "location" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "identity": { - "$ref": "#/definitions/ResourceIdentity", - "description": "Azure Active Directory identity of the server.", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "properties": { - "$ref": "#/definitions/SqlVirtualMachineProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - }, - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "readOnly": true - } - } - }, - "SqlVirtualMachineUpdate": { - "description": "An update to a SQL virtual machine.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription ID that identifies an Azure subscription.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "API version to use for the request.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "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" - }, - "SqlVirtualMachineNameParameter": { - "name": "sqlVirtualMachineName", - "in": "path", - "description": "Name of the SQL virtual machine.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineGroupNameParameter": { - "name": "sqlVirtualMachineGroupNameParameter", - "in": "path", - "description": "Name of the SQL virtual machine group.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AvailabilityGroupListenerNameParameter": { - "name": "availabilityGroupListenerNameParameter", - "in": "path", - "description": "Name of the availability group listener.", - "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" - } - } - } -} diff --git a/swagger-specs/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/stable/2023-10-01/sqlvm.json b/swagger-specs/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/stable/2023-10-01/sqlvm.json new file mode 100644 index 000000000..493a65726 --- /dev/null +++ b/swagger-specs/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/stable/2023-10-01/sqlvm.json @@ -0,0 +1,2810 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-10-01", + "title": "SqlVirtualMachineManagementClient", + "description": "The SQL virtual machine management API provides a RESTful set of web APIs that interact with Azure Compute, Network & Storage services to manage your SQL Server virtual machine. The API enables users to create, delete and retrieve a SQL virtual machine, SQL virtual machine group or availability group listener." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}": { + "get": { + "tags": [ + "AvailabilityGroupListeners" + ], + "description": "Gets an availability group listener.", + "operationId": "AvailabilityGroupListeners_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "name": "availabilityGroupListenerName", + "in": "path", + "description": "Name of the availability group listener.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "The child resources to include in the response.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the availability group listener.", + "schema": { + "$ref": "#/definitions/AvailabilityGroupListener" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 NoActivePrimaryInAG - None of the nodes in AvailabilityGroup are Primary\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 ExtVersionNotSupported - The virtual machine: {0} is running older version of SqlIaasExtension which is not supported by this operation. Please update the extension and retry the operation.\n\n * 400 InvalidReplicaRole - Invalid replica role: {0} specified for SQL VM: {1}.\n\n * 400 InvalidReplicaFailover - Invalid replica Failover: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaReadableSecondary - Invalid replica readable secondary: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaCommit - Invalid replica commit mode: {0} for SQL VM: {1}.\n\n * 400 ExpectedSynchronousCommitForAutomaticFailover - Invalid replica commit mode: {0} for SQL VM: {1}. {2} is expected for failover mode: {3}.\n\n * 400 NoPrimaryInAg - There are no replicas with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanOnePrimaryInAg - There are more than one replica with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanThreeSynchronousCommitInAg - There are more than three replica with commit mode as: {0}. There should be at most three replica with commit mode as: {0}\n\n * 400 MoreThanEightSecondariesInAg - There are more than eight secondary replica with secondary role. There should be at most eight replica with role as secondary.\n\n * 400 AlwaysOnNotEnabled - Always on feature is not enabled on Virtual machine: {0}.\n\n * 400 ExpectedReplicaNotPrimary - The VM: {0} does not host the primary replica.\n\n * 400 ListenerSqlvmsMismatchWithReplicaSqlvms - List of SQL VMs specified in Availability group does not match list of SQL VMs in listener config.\n\n * 400 ReplicaSqlvmHasDuplicateEntries - Replica configuration should be unique for each SQL virtual machine. We have found one or more configuration for the same SQL virtual machine resource.\n\n * 400 ReplicaDeleteNotAllowed - Replica deletion through SQL VM RP is not supported yet.\n\n * 400 OnlyBasicPublicIP - All VM specified should contain only Basic Public IP, when providing Loadbalancer Basic Sku.\n\n * 400 NICCannotUseMultipleLBsOfSameType - NIC: {0} cannot reference more than one load balancer of INTERNAL or PUBLIC type\n\n * 400 AGReplicaSQLStartupAccount - NT service account cannot be used as SQL startup account for AG setup. You should use a domain account.\n\n * 400 AgListenerMultiSubnetUpdateNotAllowed - Update of multi subnet AG listener is not allowed.\n\n * 400 ListenerIpSubnetVmSubnetMismatch - Listener static ip address subnet and VM subnet should be same\n\n * 400 IpAddressEmpty - Cannot get the subnet mask when IP address is null or empty.\n\n * 400 InvalidIpAddress - Invalid address given for IP address.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 NoIpAvailable - No available IP.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 ReplicasWithDifferentSqlStartupAccounts - Please make sure all your SQL server startup accounts in the specified replicas are the same. This is one of our prerequisites for setting up availability groups.\n\n * 409 ReplicasJoinedToMoreThanOneCluster - AG replicas are joined to more than one failover cluster. Please make sure all your replicas are joined to same failover cluster.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets an availability group listener.": { + "$ref": "./examples/GetAvailabilityGroupListener.json" + } + } + }, + "put": { + "tags": [ + "AvailabilityGroupListeners" + ], + "description": "Creates or updates an availability group listener.", + "operationId": "AvailabilityGroupListeners_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "name": "availabilityGroupListenerName", + "in": "path", + "description": "Name of the availability group listener.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The availability group listener.", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilityGroupListener" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the availability group listener.", + "schema": { + "$ref": "#/definitions/AvailabilityGroupListener" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 NoActivePrimaryInAG - None of the nodes in AvailabilityGroup are Primary\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 ExtVersionNotSupported - The virtual machine: {0} is running older version of SqlIaasExtension which is not supported by this operation. Please update the extension and retry the operation.\n\n * 400 InvalidReplicaRole - Invalid replica role: {0} specified for SQL VM: {1}.\n\n * 400 InvalidReplicaFailover - Invalid replica Failover: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaReadableSecondary - Invalid replica readable secondary: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaCommit - Invalid replica commit mode: {0} for SQL VM: {1}.\n\n * 400 ExpectedSynchronousCommitForAutomaticFailover - Invalid replica commit mode: {0} for SQL VM: {1}. {2} is expected for failover mode: {3}.\n\n * 400 NoPrimaryInAg - There are no replicas with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanOnePrimaryInAg - There are more than one replica with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanThreeSynchronousCommitInAg - There are more than three replica with commit mode as: {0}. There should be at most three replica with commit mode as: {0}\n\n * 400 MoreThanEightSecondariesInAg - There are more than eight secondary replica with secondary role. There should be at most eight replica with role as secondary.\n\n * 400 AlwaysOnNotEnabled - Always on feature is not enabled on Virtual machine: {0}.\n\n * 400 ExpectedReplicaNotPrimary - The VM: {0} does not host the primary replica.\n\n * 400 ListenerSqlvmsMismatchWithReplicaSqlvms - List of SQL VMs specified in Availability group does not match list of SQL VMs in listener config.\n\n * 400 ReplicaSqlvmHasDuplicateEntries - Replica configuration should be unique for each SQL virtual machine. We have found one or more configuration for the same SQL virtual machine resource.\n\n * 400 ReplicaDeleteNotAllowed - Replica deletion through SQL VM RP is not supported yet.\n\n * 400 OnlyBasicPublicIP - All VM specified should contain only Basic Public IP, when providing Loadbalancer Basic Sku.\n\n * 400 NICCannotUseMultipleLBsOfSameType - NIC: {0} cannot reference more than one load balancer of INTERNAL or PUBLIC type\n\n * 400 AGReplicaSQLStartupAccount - NT service account cannot be used as SQL startup account for AG setup. You should use a domain account.\n\n * 400 AgListenerMultiSubnetUpdateNotAllowed - Update of multi subnet AG listener is not allowed.\n\n * 400 ListenerIpSubnetVmSubnetMismatch - Listener static ip address subnet and VM subnet should be same\n\n * 400 IpAddressEmpty - Cannot get the subnet mask when IP address is null or empty.\n\n * 400 InvalidIpAddress - Invalid address given for IP address.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 NoIpAvailable - No available IP.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 ReplicasWithDifferentSqlStartupAccounts - Please make sure all your SQL server startup accounts in the specified replicas are the same. This is one of our prerequisites for setting up availability groups.\n\n * 409 ReplicasJoinedToMoreThanOneCluster - AG replicas are joined to more than one failover cluster. Please make sure all your replicas are joined to same failover cluster.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "201": { + "description": "Successfully created the availability group listener.", + "schema": { + "$ref": "#/definitions/AvailabilityGroupListener" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Creates or updates an availability group listener using load balancer. This is used for VMs present in single subnet.": { + "$ref": "./examples/CreateOrUpdateAvailabilityGroupListener.json" + }, + "Creates or updates an availability group listener. This is used for VMs present in multi subnet": { + "$ref": "./examples/CreateOrUpdateAvailabilityGroupListenerWithMultiSubnet.json" + } + } + }, + "delete": { + "tags": [ + "AvailabilityGroupListeners" + ], + "description": "Deletes an availability group listener.", + "operationId": "AvailabilityGroupListeners_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "name": "availabilityGroupListenerName", + "in": "path", + "description": "Name of the availability group listener.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the availability group listener." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 NoActivePrimaryInAG - None of the nodes in AvailabilityGroup are Primary\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 ExtVersionNotSupported - The virtual machine: {0} is running older version of SqlIaasExtension which is not supported by this operation. Please update the extension and retry the operation.\n\n * 400 InvalidReplicaRole - Invalid replica role: {0} specified for SQL VM: {1}.\n\n * 400 InvalidReplicaFailover - Invalid replica Failover: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaReadableSecondary - Invalid replica readable secondary: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaCommit - Invalid replica commit mode: {0} for SQL VM: {1}.\n\n * 400 ExpectedSynchronousCommitForAutomaticFailover - Invalid replica commit mode: {0} for SQL VM: {1}. {2} is expected for failover mode: {3}.\n\n * 400 NoPrimaryInAg - There are no replicas with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanOnePrimaryInAg - There are more than one replica with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanThreeSynchronousCommitInAg - There are more than three replica with commit mode as: {0}. There should be at most three replica with commit mode as: {0}\n\n * 400 MoreThanEightSecondariesInAg - There are more than eight secondary replica with secondary role. There should be at most eight replica with role as secondary.\n\n * 400 AlwaysOnNotEnabled - Always on feature is not enabled on Virtual machine: {0}.\n\n * 400 ExpectedReplicaNotPrimary - The VM: {0} does not host the primary replica.\n\n * 400 ListenerSqlvmsMismatchWithReplicaSqlvms - List of SQL VMs specified in Availability group does not match list of SQL VMs in listener config.\n\n * 400 ReplicaSqlvmHasDuplicateEntries - Replica configuration should be unique for each SQL virtual machine. We have found one or more configuration for the same SQL virtual machine resource.\n\n * 400 ReplicaDeleteNotAllowed - Replica deletion through SQL VM RP is not supported yet.\n\n * 400 OnlyBasicPublicIP - All VM specified should contain only Basic Public IP, when providing Loadbalancer Basic Sku.\n\n * 400 NICCannotUseMultipleLBsOfSameType - NIC: {0} cannot reference more than one load balancer of INTERNAL or PUBLIC type\n\n * 400 AGReplicaSQLStartupAccount - NT service account cannot be used as SQL startup account for AG setup. You should use a domain account.\n\n * 400 AgListenerMultiSubnetUpdateNotAllowed - Update of multi subnet AG listener is not allowed.\n\n * 400 ListenerIpSubnetVmSubnetMismatch - Listener static ip address subnet and VM subnet should be same\n\n * 400 IpAddressEmpty - Cannot get the subnet mask when IP address is null or empty.\n\n * 400 InvalidIpAddress - Invalid address given for IP address.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 NoIpAvailable - No available IP.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 ReplicasWithDifferentSqlStartupAccounts - Please make sure all your SQL server startup accounts in the specified replicas are the same. This is one of our prerequisites for setting up availability groups.\n\n * 409 ReplicasJoinedToMoreThanOneCluster - AG replicas are joined to more than one failover cluster. Please make sure all your replicas are joined to same failover cluster.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Deleting the availability group listener.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The availability group listener does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Deletes an availability group listener.": { + "$ref": "./examples/DeleteAvailabilityGroupListener.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners": { + "get": { + "tags": [ + "AvailabilityGroupListeners" + ], + "description": "Lists all availability group listeners in a SQL virtual machine group.", + "operationId": "AvailabilityGroupListeners_ListByGroup", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved all availability group listeners in a SQL virtual machine group.", + "schema": { + "$ref": "#/definitions/AvailabilityGroupListenerListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 NoActivePrimaryInAG - None of the nodes in AvailabilityGroup are Primary\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 ExtVersionNotSupported - The virtual machine: {0} is running older version of SqlIaasExtension which is not supported by this operation. Please update the extension and retry the operation.\n\n * 400 InvalidReplicaRole - Invalid replica role: {0} specified for SQL VM: {1}.\n\n * 400 InvalidReplicaFailover - Invalid replica Failover: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaReadableSecondary - Invalid replica readable secondary: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaCommit - Invalid replica commit mode: {0} for SQL VM: {1}.\n\n * 400 ExpectedSynchronousCommitForAutomaticFailover - Invalid replica commit mode: {0} for SQL VM: {1}. {2} is expected for failover mode: {3}.\n\n * 400 NoPrimaryInAg - There are no replicas with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanOnePrimaryInAg - There are more than one replica with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanThreeSynchronousCommitInAg - There are more than three replica with commit mode as: {0}. There should be at most three replica with commit mode as: {0}\n\n * 400 MoreThanEightSecondariesInAg - There are more than eight secondary replica with secondary role. There should be at most eight replica with role as secondary.\n\n * 400 AlwaysOnNotEnabled - Always on feature is not enabled on Virtual machine: {0}.\n\n * 400 ExpectedReplicaNotPrimary - The VM: {0} does not host the primary replica.\n\n * 400 ListenerSqlvmsMismatchWithReplicaSqlvms - List of SQL VMs specified in Availability group does not match list of SQL VMs in listener config.\n\n * 400 ReplicaSqlvmHasDuplicateEntries - Replica configuration should be unique for each SQL virtual machine. We have found one or more configuration for the same SQL virtual machine resource.\n\n * 400 ReplicaDeleteNotAllowed - Replica deletion through SQL VM RP is not supported yet.\n\n * 400 OnlyBasicPublicIP - All VM specified should contain only Basic Public IP, when providing Loadbalancer Basic Sku.\n\n * 400 NICCannotUseMultipleLBsOfSameType - NIC: {0} cannot reference more than one load balancer of INTERNAL or PUBLIC type\n\n * 400 AGReplicaSQLStartupAccount - NT service account cannot be used as SQL startup account for AG setup. You should use a domain account.\n\n * 400 AgListenerMultiSubnetUpdateNotAllowed - Update of multi subnet AG listener is not allowed.\n\n * 400 ListenerIpSubnetVmSubnetMismatch - Listener static ip address subnet and VM subnet should be same\n\n * 400 IpAddressEmpty - Cannot get the subnet mask when IP address is null or empty.\n\n * 400 InvalidIpAddress - Invalid address given for IP address.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 NoIpAvailable - No available IP.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 ReplicasWithDifferentSqlStartupAccounts - Please make sure all your SQL server startup accounts in the specified replicas are the same. This is one of our prerequisites for setting up availability groups.\n\n * 409 ReplicasJoinedToMoreThanOneCluster - AG replicas are joined to more than one failover cluster. Please make sure all your replicas are joined to same failover cluster.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists all availability group listeners in a SQL virtual machine group.": { + "$ref": "./examples/ListByGroupAvailabilityGroupListener.json" + } + } + } + }, + "/providers/Microsoft.SqlVirtualMachine/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available SQL Virtual Machine Rest API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists all of the available SQL Virtual Machine Rest API operations.": { + "$ref": "./examples/ListOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}": { + "get": { + "tags": [ + "SqlVirtualMachineGroups" + ], + "description": "Gets a SQL virtual machine group.", + "operationId": "SqlVirtualMachineGroups_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the SQL virtual machine group.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroup" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a SQL virtual machine group.": { + "$ref": "./examples/GetSqlVirtualMachineGroup.json" + } + } + }, + "put": { + "tags": [ + "SqlVirtualMachineGroups" + ], + "description": "Creates or updates a SQL virtual machine group.", + "operationId": "SqlVirtualMachineGroups_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL virtual machine group.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroup" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the SQL virtual machine group.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroup" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid. Sql VM Group allowed values are Enterprise or Developer.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "201": { + "description": "Successfully created the SQL virtual machine group.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroup" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Creates or updates a SQL virtual machine group.": { + "$ref": "./examples/CreateOrUpdateSqlVirtualMachineGroup.json" + } + } + }, + "delete": { + "tags": [ + "SqlVirtualMachineGroups" + ], + "description": "Deletes a SQL virtual machine group.", + "operationId": "SqlVirtualMachineGroups_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL virtual machine group." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 NoActivePrimaryInAG - None of the nodes in AvailabilityGroup are Primary\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 ExtVersionNotSupported - The virtual machine: {0} is running older version of SqlIaasExtension which is not supported by this operation. Please update the extension and retry the operation.\n\n * 400 InvalidReplicaRole - Invalid replica role: {0} specified for SQL VM: {1}.\n\n * 400 InvalidReplicaFailover - Invalid replica Failover: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaReadableSecondary - Invalid replica readable secondary: {0} for SQL VM: {1}.\n\n * 400 InvalidReplicaCommit - Invalid replica commit mode: {0} for SQL VM: {1}.\n\n * 400 ExpectedSynchronousCommitForAutomaticFailover - Invalid replica commit mode: {0} for SQL VM: {1}. {2} is expected for failover mode: {3}.\n\n * 400 NoPrimaryInAg - There are no replicas with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanOnePrimaryInAg - There are more than one replica with primary role. There should be exactly one replica with role as primary.\n\n * 400 MoreThanThreeSynchronousCommitInAg - There are more than three replica with commit mode as: {0}. There should be at most three replica with commit mode as: {0}\n\n * 400 MoreThanEightSecondariesInAg - There are more than eight secondary replica with secondary role. There should be at most eight replica with role as secondary.\n\n * 400 AlwaysOnNotEnabled - Always on feature is not enabled on Virtual machine: {0}.\n\n * 400 ExpectedReplicaNotPrimary - The VM: {0} does not host the primary replica.\n\n * 400 ListenerSqlvmsMismatchWithReplicaSqlvms - List of SQL VMs specified in Availability group does not match list of SQL VMs in listener config.\n\n * 400 ReplicaSqlvmHasDuplicateEntries - Replica configuration should be unique for each SQL virtual machine. We have found one or more configuration for the same SQL virtual machine resource.\n\n * 400 ReplicaDeleteNotAllowed - Replica deletion through SQL VM RP is not supported yet.\n\n * 400 OnlyBasicPublicIP - All VM specified should contain only Basic Public IP, when providing Loadbalancer Basic Sku.\n\n * 400 NICCannotUseMultipleLBsOfSameType - NIC: {0} cannot reference more than one load balancer of INTERNAL or PUBLIC type\n\n * 400 AGReplicaSQLStartupAccount - NT service account cannot be used as SQL startup account for AG setup. You should use a domain account.\n\n * 400 AgListenerMultiSubnetUpdateNotAllowed - Update of multi subnet AG listener is not allowed.\n\n * 400 ListenerIpSubnetVmSubnetMismatch - Listener static ip address subnet and VM subnet should be same\n\n * 400 IpAddressEmpty - Cannot get the subnet mask when IP address is null or empty.\n\n * 400 InvalidIpAddress - Invalid address given for IP address.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 NoIpAvailable - No available IP.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid. Sql VM Group allowed values are Enterprise or Developer.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 ReplicasWithDifferentSqlStartupAccounts - Please make sure all your SQL server startup accounts in the specified replicas are the same. This is one of our prerequisites for setting up availability groups.\n\n * 409 ReplicasJoinedToMoreThanOneCluster - AG replicas are joined to more than one failover cluster. Please make sure all your replicas are joined to same failover cluster.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Deleting the SQL virtual machine group.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The specified SQL virtual machine group does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Deletes a SQL virtual machine group.": { + "$ref": "./examples/DeleteSqlVirtualMachineGroup.json" + } + } + }, + "patch": { + "tags": [ + "SqlVirtualMachineGroups" + ], + "description": "Updates SQL virtual machine group tags.", + "operationId": "SqlVirtualMachineGroups_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL virtual machine group.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroupUpdate" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the SQL virtual machine group.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroup" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid. Sql VM Group allowed values are Enterprise or Developer.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Updates a SQL virtual machine group tags.": { + "$ref": "./examples/UpdateSqlVirtualMachineGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups": { + "get": { + "tags": [ + "SqlVirtualMachineGroups" + ], + "description": "Gets all SQL virtual machine groups in a resource group.", + "operationId": "SqlVirtualMachineGroups_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved all SQL virtual machine groups in the resource group.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL virtual machine groups in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlVirtualMachineGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups": { + "get": { + "tags": [ + "SqlVirtualMachineGroups" + ], + "description": "Gets all SQL virtual machine groups in a subscription.", + "operationId": "SqlVirtualMachineGroups_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved all SQL virtual machine groups in the subscription.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL virtual machine groups in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlVirtualMachineGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/sqlVirtualMachines": { + "get": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Gets the list of sql virtual machines in a SQL virtual machine group.", + "operationId": "SqlVirtualMachines_ListBySqlVmGroup", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of sql virtual machines in a SQL virtual machine group.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid. Sql VM Group allowed values are Enterprise or Developer.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of sql virtual machines in a SQL virtual machine group.": { + "$ref": "./examples/ListBySqlVirtualMachineGroupSqlVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines": { + "get": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Gets all SQL virtual machines in a subscription.", + "operationId": "SqlVirtualMachines_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved all SQL virtual machines in the subscription.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL virtual machines in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/startAssessment": { + "post": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Starts SQL best practices Assessment on SQL virtual machine.", + "operationId": "SqlVirtualMachines_StartAssessment", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SqlVirtualMachineNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 DuplicateTargetDatabaseName - Two or more target databases have the same name: '{0}'.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 LeastPrivilegeModeEnableNotSupported - Least Privilege mode is not supported on LightWeight or NoAgent extension mode.\n\n * 400 LeastPrivilegeModeChangeNotSupported - Cannot disable Least Privilege mode once enabled. \n\n * 400 VmOSUnsupportedForAzureAD - OS is unsupported for Azure AD authentication.\n\n * 400 SqlVersionUnsupportedForAzureAD - SQL version is unsupported for Azure AD authentication.\n\n * 400 EnableAzureADInProvisionUnsupported - Enable Azure AD authentication in provision is unsupported.\n\n * 400 MSIClientIdRequired - MSI client Id is required for Azure AD authentication.\n\n * 400 AzureADAuthenticationNotAllowed - Configuring Azure AD authentication is currently not allowed.\n\n * 400 CannotFindExtensionVersion - Cannot determine SQL IaaS Extension version.\n\n * 400 LeastPrivilegeModeOnlySupportedForSQL2012AndAbove - Least privilege mode is only supported for SQL server 2012 and above versions.\n\n * 400 InvalidLunForNotUseStoragePool - Invalid LUN specified for storage configuration settings. Only one lun should be provided to build the drive if not using storage pool.\n\n * 400 ConflictStoragePoolConfigForUseSameDrive - UseStoragePool values are different while set to share the same drive. UseStoragePool value will be considered as True by default if not specified otherwise.\n\n * 400 StoragePoolConfigNotSupportedInExtend - UseStoragePool parameter is not supported in EXTEND operations.\n\n * 400 StoragePoolConfigNotAllowed - Configuring storage pool option when creating/updating sql vm is not allowed at the moment.\n\n * 400 PowerBiVmsNotSupported - Creating SQL Virtual Machine Resource for PowerBI VM images is not supported.\n\n * 400 SubscriptionFeatureRegistrationsApiCallFailed - API call to check if subscription is registered to the feature has failed\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 MissingPatchParameters - Missing PATCH parameters on the request.\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 InvalidMIResourceId - Invalid value given for Managed Identity Resource Id. Specify a valid value.\n\n * 400 MismatchMIResourceId - The provided User assigned identity is not associated with the Virtual Machine.\n\n * 400 ManagedIdentityNotEnabled - The provided identity type is not enabled on the Virtual Machine.\n\n * 400 IncorrectAdditionalVmPatch - The value provided for AdditionalVmPatch is invalid. \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 FailedToGetRestoreStatusFromTableStorage - Failed to get restore status from table storage.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted request to start SQL best practices Assessment on SQL virtual machine.", + "headers": { + "Location": { + "type": "string" + } + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Starts SQL best practices Assessment on SQL virtual machine": { + "$ref": "./examples/StartAssessmentOnSqlVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/fetchDCAssessment": { + "post": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Starts SQL best practices Assessment with Disk Config rules on SQL virtual machine", + "operationId": "SqlVirtualMachines_FetchDCAssessment", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SqlVirtualMachineNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Disk Config Assessment property", + "required": true, + "schema": { + "$ref": "#/definitions/DiskConfigAssessmentRequest" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 DuplicateTargetDatabaseName - Two or more target databases have the same name: '{0}'.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 LeastPrivilegeModeEnableNotSupported - Least Privilege mode is not supported on LightWeight or NoAgent extension mode.\n\n * 400 LeastPrivilegeModeChangeNotSupported - Cannot disable Least Privilege mode once enabled. \n\n * 400 VmOSUnsupportedForAzureAD - OS is unsupported for Azure AD authentication.\n\n * 400 SqlVersionUnsupportedForAzureAD - SQL version is unsupported for Azure AD authentication.\n\n * 400 EnableAzureADInProvisionUnsupported - Enable Azure AD authentication in provision is unsupported.\n\n * 400 MSIClientIdRequired - MSI client Id is required for Azure AD authentication.\n\n * 400 AzureADAuthenticationNotAllowed - Configuring Azure AD authentication is currently not allowed.\n\n * 400 CannotFindExtensionVersion - Cannot determine SQL IaaS Extension version.\n\n * 400 LeastPrivilegeModeOnlySupportedForSQL2012AndAbove - Least privilege mode is only supported for SQL server 2012 and above versions.\n\n * 400 InvalidLunForNotUseStoragePool - Invalid LUN specified for storage configuration settings. Only one lun should be provided to build the drive if not using storage pool.\n\n * 400 ConflictStoragePoolConfigForUseSameDrive - UseStoragePool values are different while set to share the same drive. UseStoragePool value will be considered as True by default if not specified otherwise.\n\n * 400 StoragePoolConfigNotSupportedInExtend - UseStoragePool parameter is not supported in EXTEND operations.\n\n * 400 StoragePoolConfigNotAllowed - Configuring storage pool option when creating/updating sql vm is not allowed at the moment.\n\n * 400 PowerBiVmsNotSupported - Creating SQL Virtual Machine Resource for PowerBI VM images is not supported.\n\n * 400 SubscriptionFeatureRegistrationsApiCallFailed - API call to check if subscription is registered to the feature has failed\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 MissingPatchParameters - Missing PATCH parameters on the request.\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 InvalidMIResourceId - Invalid value given for Managed Identity Resource Id. Specify a valid value.\n\n * 400 MismatchMIResourceId - The provided User assigned identity is not associated with the Virtual Machine.\n\n * 400 ManagedIdentityNotEnabled - The provided identity type is not enabled on the Virtual Machine.\n\n * 400 IncorrectAdditionalVmPatch - The value provided for AdditionalVmPatch is invalid. \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 FailedToGetRestoreStatusFromTableStorage - Failed to get restore status from table storage.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted request to start Disk Config Assessment on SQL virtual machine.", + "headers": { + "Location": { + "type": "string" + } + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Starts SQL best practices Assessment with Disk Config rules on SQL virtual machine": { + "$ref": "./examples/StartDiskConfigAssessmentOnSqlVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/redeploy": { + "post": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Uninstalls and reinstalls the SQL IaaS Extension.", + "operationId": "SqlVirtualMachines_Redeploy", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SqlVirtualMachineNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 DuplicateTargetDatabaseName - Two or more target databases have the same name: '{0}'.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 LeastPrivilegeModeEnableNotSupported - Least Privilege mode is not supported on LightWeight or NoAgent extension mode.\n\n * 400 LeastPrivilegeModeChangeNotSupported - Cannot disable Least Privilege mode once enabled. \n\n * 400 VmOSUnsupportedForAzureAD - OS is unsupported for Azure AD authentication.\n\n * 400 SqlVersionUnsupportedForAzureAD - SQL version is unsupported for Azure AD authentication.\n\n * 400 EnableAzureADInProvisionUnsupported - Enable Azure AD authentication in provision is unsupported.\n\n * 400 MSIClientIdRequired - MSI client Id is required for Azure AD authentication.\n\n * 400 AzureADAuthenticationNotAllowed - Configuring Azure AD authentication is currently not allowed.\n\n * 400 CannotFindExtensionVersion - Cannot determine SQL IaaS Extension version.\n\n * 400 LeastPrivilegeModeOnlySupportedForSQL2012AndAbove - Least privilege mode is only supported for SQL server 2012 and above versions.\n\n * 400 InvalidLunForNotUseStoragePool - Invalid LUN specified for storage configuration settings. Only one lun should be provided to build the drive if not using storage pool.\n\n * 400 ConflictStoragePoolConfigForUseSameDrive - UseStoragePool values are different while set to share the same drive. UseStoragePool value will be considered as True by default if not specified otherwise.\n\n * 400 StoragePoolConfigNotSupportedInExtend - UseStoragePool parameter is not supported in EXTEND operations.\n\n * 400 StoragePoolConfigNotAllowed - Configuring storage pool option when creating/updating sql vm is not allowed at the moment.\n\n * 400 PowerBiVmsNotSupported - Creating SQL Virtual Machine Resource for PowerBI VM images is not supported.\n\n * 400 SubscriptionFeatureRegistrationsApiCallFailed - API call to check if subscription is registered to the feature has failed\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 MissingPatchParameters - Missing PATCH parameters on the request.\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 InvalidMIResourceId - Invalid value given for Managed Identity Resource Id. Specify a valid value.\n\n * 400 MismatchMIResourceId - The provided User assigned identity is not associated with the Virtual Machine.\n\n * 400 ManagedIdentityNotEnabled - The provided identity type is not enabled on the Virtual Machine.\n\n * 400 IncorrectAdditionalVmPatch - The value provided for AdditionalVmPatch is invalid. \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 FailedToGetRestoreStatusFromTableStorage - Failed to get restore status from table storage.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted redeploying the SQL virtual machine.", + "headers": { + "Location": { + "type": "string" + } + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Uninstalls and reinstalls the SQL IaaS Extension.": { + "$ref": "./examples/RedeploySqlVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}": { + "get": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Gets a SQL virtual machine.", + "operationId": "SqlVirtualMachines_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SqlVirtualMachineNameParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "The child resources to include in the response.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the SQL virtual machine.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachine" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 DuplicateTargetDatabaseName - Two or more target databases have the same name: '{0}'.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 LeastPrivilegeModeEnableNotSupported - Least Privilege mode is not supported on LightWeight or NoAgent extension mode.\n\n * 400 LeastPrivilegeModeChangeNotSupported - Cannot disable Least Privilege mode once enabled. \n\n * 400 VmOSUnsupportedForAzureAD - OS is unsupported for Azure AD authentication.\n\n * 400 SqlVersionUnsupportedForAzureAD - SQL version is unsupported for Azure AD authentication.\n\n * 400 EnableAzureADInProvisionUnsupported - Enable Azure AD authentication in provision is unsupported.\n\n * 400 MSIClientIdRequired - MSI client Id is required for Azure AD authentication.\n\n * 400 AzureADAuthenticationNotAllowed - Configuring Azure AD authentication is currently not allowed.\n\n * 400 CannotFindExtensionVersion - Cannot determine SQL IaaS Extension version.\n\n * 400 LeastPrivilegeModeOnlySupportedForSQL2012AndAbove - Least privilege mode is only supported for SQL server 2012 and above versions.\n\n * 400 InvalidLunForNotUseStoragePool - Invalid LUN specified for storage configuration settings. Only one lun should be provided to build the drive if not using storage pool.\n\n * 400 ConflictStoragePoolConfigForUseSameDrive - UseStoragePool values are different while set to share the same drive. UseStoragePool value will be considered as True by default if not specified otherwise.\n\n * 400 StoragePoolConfigNotSupportedInExtend - UseStoragePool parameter is not supported in EXTEND operations.\n\n * 400 StoragePoolConfigNotAllowed - Configuring storage pool option when creating/updating sql vm is not allowed at the moment.\n\n * 400 PowerBiVmsNotSupported - Creating SQL Virtual Machine Resource for PowerBI VM images is not supported.\n\n * 400 SubscriptionFeatureRegistrationsApiCallFailed - API call to check if subscription is registered to the feature has failed\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 MissingPatchParameters - Missing PATCH parameters on the request.\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 InvalidMIResourceId - Invalid value given for Managed Identity Resource Id. Specify a valid value.\n\n * 400 MismatchMIResourceId - The provided User assigned identity is not associated with the Virtual Machine.\n\n * 400 ManagedIdentityNotEnabled - The provided identity type is not enabled on the Virtual Machine.\n\n * 400 IncorrectAdditionalVmPatch - The value provided for AdditionalVmPatch is invalid. \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 FailedToGetRestoreStatusFromTableStorage - Failed to get restore status from table storage.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a SQL virtual machine.": { + "$ref": "./examples/GetSqlVirtualMachine.json" + } + } + }, + "put": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Creates or updates a SQL virtual machine.", + "operationId": "SqlVirtualMachines_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SqlVirtualMachineNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL virtual machine.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlVirtualMachine" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the SQL virtual machine.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachine" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 DuplicateTargetDatabaseName - Two or more target databases have the same name: '{0}'.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 LeastPrivilegeModeEnableNotSupported - Least Privilege mode is not supported on LightWeight or NoAgent extension mode.\n\n * 400 LeastPrivilegeModeChangeNotSupported - Cannot disable Least Privilege mode once enabled. \n\n * 400 VmOSUnsupportedForAzureAD - OS is unsupported for Azure AD authentication.\n\n * 400 SqlVersionUnsupportedForAzureAD - SQL version is unsupported for Azure AD authentication.\n\n * 400 EnableAzureADInProvisionUnsupported - Enable Azure AD authentication in provision is unsupported.\n\n * 400 MSIClientIdRequired - MSI client Id is required for Azure AD authentication.\n\n * 400 AzureADAuthenticationNotAllowed - Configuring Azure AD authentication is currently not allowed.\n\n * 400 CannotFindExtensionVersion - Cannot determine SQL IaaS Extension version.\n\n * 400 LeastPrivilegeModeOnlySupportedForSQL2012AndAbove - Least privilege mode is only supported for SQL server 2012 and above versions.\n\n * 400 InvalidLunForNotUseStoragePool - Invalid LUN specified for storage configuration settings. Only one lun should be provided to build the drive if not using storage pool.\n\n * 400 ConflictStoragePoolConfigForUseSameDrive - UseStoragePool values are different while set to share the same drive. UseStoragePool value will be considered as True by default if not specified otherwise.\n\n * 400 StoragePoolConfigNotSupportedInExtend - UseStoragePool parameter is not supported in EXTEND operations.\n\n * 400 StoragePoolConfigNotAllowed - Configuring storage pool option when creating/updating sql vm is not allowed at the moment.\n\n * 400 PowerBiVmsNotSupported - Creating SQL Virtual Machine Resource for PowerBI VM images is not supported.\n\n * 400 SubscriptionFeatureRegistrationsApiCallFailed - API call to check if subscription is registered to the feature has failed\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 MissingPatchParameters - Missing PATCH parameters on the request.\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 InvalidMIResourceId - Invalid value given for Managed Identity Resource Id. Specify a valid value.\n\n * 400 MismatchMIResourceId - The provided User assigned identity is not associated with the Virtual Machine.\n\n * 400 ManagedIdentityNotEnabled - The provided identity type is not enabled on the Virtual Machine.\n\n * 400 IncorrectAdditionalVmPatch - The value provided for AdditionalVmPatch is invalid. \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 409 Ext_VMExtensionProvisioningError - There was an error while installing SqlIaasExtension on the virtual machine.\n\n * 409 Ext_ComputeError - Compute returned error on current operation.\n\n * 409 Ext_VMAgentStatusCommunicationError - SQLIaaSExtension installation failed because azure guest agent service is not running or it is not able to establish outbound connection to storage account.\n\n * 409 Ext_CancelError - The operation was canceled\n\n * 409 Ext_VMExtensionHandlerNonTransientError - SQLIaaSExtension installation failed due to an internal error. Please retry the installation.\n\n * 409 Ext_VMExtensionProvisioningTimeout - SQL VM resource provisioning operation timed out.\n\n * 409 Ext_OperationPreempted - SQL VM operation has been preempted by a more recent operation like ResourceGroup drop, Resource move, VM drop or VM shutdown or VM redeploy.\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 FailedToGetRestoreStatusFromTableStorage - Failed to get restore status from table storage.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "201": { + "description": "Successfully created the SQL virtual machine.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachine" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Creates or updates a SQL virtual machine with min parameters.": { + "$ref": "./examples/CreateOrUpdateSqlVirtualMachineMIN.json" + }, + "Creates or updates a SQL virtual machine with max parameters.": { + "$ref": "./examples/CreateOrUpdateSqlVirtualMachineMAX.json" + }, + "Creates or updates a SQL virtual machine and joins it to a SQL virtual machine group.": { + "$ref": "./examples/CreateOrUpdateVirtualMachineWithVMGroup.json" + }, + "Creates or updates a SQL virtual machine for Storage Configuration Settings to NEW Data, Log and TempDB storage pool.": { + "$ref": "./examples/CreateOrUpdateSqlVirtualMachineStorageConfigurationNEW.json" + }, + "Creates or updates a SQL virtual machine for Storage Configuration Settings to EXTEND Data, Log or TempDB storage pool.": { + "$ref": "./examples/CreateOrUpdateSqlVirtualMachineStorageConfigurationEXTEND.json" + }, + "Creates or updates a SQL virtual machine for Automated Back up Settings with Weekly and Days of the week to run the back up.": { + "$ref": "./examples/CreateOrUpdateSqlVirtualMachineAutomatedBackupWeekly.json" + }, + "Creates or updates a SQL virtual machine to enable the usage of Virtual Machine managed identity.": { + "$ref": "./examples/CreateOrUpdateSqlVirtualMachineVmIdentitySettings.json" + } + } + }, + "delete": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Deletes a SQL virtual machine.", + "operationId": "SqlVirtualMachines_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SqlVirtualMachineNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL virtual machine." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 DuplicateTargetDatabaseName - Two or more target databases have the same name: '{0}'.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 LeastPrivilegeModeEnableNotSupported - Least Privilege mode is not supported on LightWeight or NoAgent extension mode.\n\n * 400 LeastPrivilegeModeChangeNotSupported - Cannot disable Least Privilege mode once enabled. \n\n * 400 VmOSUnsupportedForAzureAD - OS is unsupported for Azure AD authentication.\n\n * 400 SqlVersionUnsupportedForAzureAD - SQL version is unsupported for Azure AD authentication.\n\n * 400 EnableAzureADInProvisionUnsupported - Enable Azure AD authentication in provision is unsupported.\n\n * 400 MSIClientIdRequired - MSI client Id is required for Azure AD authentication.\n\n * 400 AzureADAuthenticationNotAllowed - Configuring Azure AD authentication is currently not allowed.\n\n * 400 CannotFindExtensionVersion - Cannot determine SQL IaaS Extension version.\n\n * 400 LeastPrivilegeModeOnlySupportedForSQL2012AndAbove - Least privilege mode is only supported for SQL server 2012 and above versions.\n\n * 400 InvalidLunForNotUseStoragePool - Invalid LUN specified for storage configuration settings. Only one lun should be provided to build the drive if not using storage pool.\n\n * 400 ConflictStoragePoolConfigForUseSameDrive - UseStoragePool values are different while set to share the same drive. UseStoragePool value will be considered as True by default if not specified otherwise.\n\n * 400 StoragePoolConfigNotSupportedInExtend - UseStoragePool parameter is not supported in EXTEND operations.\n\n * 400 StoragePoolConfigNotAllowed - Configuring storage pool option when creating/updating sql vm is not allowed at the moment.\n\n * 400 PowerBiVmsNotSupported - Creating SQL Virtual Machine Resource for PowerBI VM images is not supported.\n\n * 400 SubscriptionFeatureRegistrationsApiCallFailed - API call to check if subscription is registered to the feature has failed\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 MissingPatchParameters - Missing PATCH parameters on the request.\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 InvalidMIResourceId - Invalid value given for Managed Identity Resource Id. Specify a valid value.\n\n * 400 MismatchMIResourceId - The provided User assigned identity is not associated with the Virtual Machine.\n\n * 400 ManagedIdentityNotEnabled - The provided identity type is not enabled on the Virtual Machine.\n\n * 400 IncorrectAdditionalVmPatch - The value provided for AdditionalVmPatch is invalid. \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 FailedToGetRestoreStatusFromTableStorage - Failed to get restore status from table storage.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Deleting the SQL virtual machine.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The specified SQL virtual machine does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Deletes a SQL virtual machine.": { + "$ref": "./examples/DeleteSqlVirtualMachine.json" + } + } + }, + "patch": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Updates SQL virtual machine tags.", + "operationId": "SqlVirtualMachines_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SqlVirtualMachineNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL virtual machine.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlVirtualMachineUpdate" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the SQL virtual machine.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachine" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 DuplicateTargetDatabaseName - Two or more target databases have the same name: '{0}'.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 LeastPrivilegeModeEnableNotSupported - Least Privilege mode is not supported on LightWeight or NoAgent extension mode.\n\n * 400 LeastPrivilegeModeChangeNotSupported - Cannot disable Least Privilege mode once enabled. \n\n * 400 VmOSUnsupportedForAzureAD - OS is unsupported for Azure AD authentication.\n\n * 400 SqlVersionUnsupportedForAzureAD - SQL version is unsupported for Azure AD authentication.\n\n * 400 EnableAzureADInProvisionUnsupported - Enable Azure AD authentication in provision is unsupported.\n\n * 400 MSIClientIdRequired - MSI client Id is required for Azure AD authentication.\n\n * 400 AzureADAuthenticationNotAllowed - Configuring Azure AD authentication is currently not allowed.\n\n * 400 CannotFindExtensionVersion - Cannot determine SQL IaaS Extension version.\n\n * 400 LeastPrivilegeModeOnlySupportedForSQL2012AndAbove - Least privilege mode is only supported for SQL server 2012 and above versions.\n\n * 400 InvalidLunForNotUseStoragePool - Invalid LUN specified for storage configuration settings. Only one lun should be provided to build the drive if not using storage pool.\n\n * 400 ConflictStoragePoolConfigForUseSameDrive - UseStoragePool values are different while set to share the same drive. UseStoragePool value will be considered as True by default if not specified otherwise.\n\n * 400 StoragePoolConfigNotSupportedInExtend - UseStoragePool parameter is not supported in EXTEND operations.\n\n * 400 StoragePoolConfigNotAllowed - Configuring storage pool option when creating/updating sql vm is not allowed at the moment.\n\n * 400 PowerBiVmsNotSupported - Creating SQL Virtual Machine Resource for PowerBI VM images is not supported.\n\n * 400 SubscriptionFeatureRegistrationsApiCallFailed - API call to check if subscription is registered to the feature has failed\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 MissingPatchParameters - Missing PATCH parameters on the request.\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 InvalidMIResourceId - Invalid value given for Managed Identity Resource Id. Specify a valid value.\n\n * 400 MismatchMIResourceId - The provided User assigned identity is not associated with the Virtual Machine.\n\n * 400 ManagedIdentityNotEnabled - The provided identity type is not enabled on the Virtual Machine.\n\n * 400 IncorrectAdditionalVmPatch - The value provided for AdditionalVmPatch is invalid. \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 FailedToGetRestoreStatusFromTableStorage - Failed to get restore status from table storage.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Updates a SQL virtual machine tags.": { + "$ref": "./examples/UpdateSqlVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines": { + "get": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Gets all SQL virtual machines in a resource group.", + "operationId": "SqlVirtualMachines_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved all SQL virtual machines in the resource group.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 DuplicateTargetDatabaseName - Two or more target databases have the same name: '{0}'.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 LeastPrivilegeModeEnableNotSupported - Least Privilege mode is not supported on LightWeight or NoAgent extension mode.\n\n * 400 LeastPrivilegeModeChangeNotSupported - Cannot disable Least Privilege mode once enabled. \n\n * 400 VmOSUnsupportedForAzureAD - OS is unsupported for Azure AD authentication.\n\n * 400 SqlVersionUnsupportedForAzureAD - SQL version is unsupported for Azure AD authentication.\n\n * 400 EnableAzureADInProvisionUnsupported - Enable Azure AD authentication in provision is unsupported.\n\n * 400 MSIClientIdRequired - MSI client Id is required for Azure AD authentication.\n\n * 400 AzureADAuthenticationNotAllowed - Configuring Azure AD authentication is currently not allowed.\n\n * 400 CannotFindExtensionVersion - Cannot determine SQL IaaS Extension version.\n\n * 400 LeastPrivilegeModeOnlySupportedForSQL2012AndAbove - Least privilege mode is only supported for SQL server 2012 and above versions.\n\n * 400 InvalidLunForNotUseStoragePool - Invalid LUN specified for storage configuration settings. Only one lun should be provided to build the drive if not using storage pool.\n\n * 400 ConflictStoragePoolConfigForUseSameDrive - UseStoragePool values are different while set to share the same drive. UseStoragePool value will be considered as True by default if not specified otherwise.\n\n * 400 StoragePoolConfigNotSupportedInExtend - UseStoragePool parameter is not supported in EXTEND operations.\n\n * 400 StoragePoolConfigNotAllowed - Configuring storage pool option when creating/updating sql vm is not allowed at the moment.\n\n * 400 PowerBiVmsNotSupported - Creating SQL Virtual Machine Resource for PowerBI VM images is not supported.\n\n * 400 SubscriptionFeatureRegistrationsApiCallFailed - API call to check if subscription is registered to the feature has failed\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 MissingPatchParameters - Missing PATCH parameters on the request.\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 InvalidMIResourceId - Invalid value given for Managed Identity Resource Id. Specify a valid value.\n\n * 400 MismatchMIResourceId - The provided User assigned identity is not associated with the Virtual Machine.\n\n * 400 ManagedIdentityNotEnabled - The provided identity type is not enabled on the Virtual Machine.\n\n * 400 IncorrectAdditionalVmPatch - The value provided for AdditionalVmPatch is invalid. \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 FailedToGetRestoreStatusFromTableStorage - Failed to get restore status from table storage.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL virtual machines in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}/troubleshoot": { + "post": { + "tags": [ + "SqlVirtualMachineTroubleshoot" + ], + "description": "Starts SQL virtual machine troubleshooting.", + "operationId": "SqlVirtualMachineTroubleshoot_Troubleshoot", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SqlVirtualMachineNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL virtual machine troubleshooting entity.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlVmTroubleshooting" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully started SQL virtual machine troubleshooting.", + "schema": { + "$ref": "#/definitions/SqlVmTroubleshooting" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStartEndTime - Invalid time window. Start time cannot be greater than end time\n\n * 400 InvalidTroubleshootingScenario - Invalid troubleshooting scenario provided.\n\n * 400 InvalidTimeSpecified - Invalid time specified\n\n * 400 RestoreJobIdsMismatch - Restore Job Id mismatch, current restore job id is {0} while input is {1}.\n\n * 400 RestoreJobSetToAutoCutover - Restore Job is set to AutoCutover. No Operation will be accept except Cancel.\n\n * 400 DuplicateTargetDatabaseName - Two or more target databases have the same name: '{0}'.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}. Please specify the value of property 'SqlManagement' as {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for {2}.\n\n * 400 SqlVmInValidState - Cannot delete SqlVm since it's provisioned.\n\n * 400 ClusterOperatorAccountIsEmpty - Cannot add a VM to a SQLVM Group when cluster operator account is null or empty. Please update the group resource: {0} with the cluster operator account.\n\n * 400 SqlServiceAccountIsEmpty - Cannot add a VM to a SQLVM Group when SQL service account is null or empty. Please update the group resource: {0} with the SQL service account.\n\n * 400 UnknownSqlManagementMode - Cannot update the SQL management mode to {0}, please use one of the supported values.\n\n * 400 CandidateCurrentTimeIsAfterRegEndTime - Cannot register candidate entity as current time {0} is after allowed end time {1}.\n\n * 400 CandidateRegStartTimeIsAfterRegEndTime - Cannot register candidate entity as allowed start time {0} is after allowed end time {1}.\n\n * 400 VmOsTypeNotFound - OS type is not found.\n\n * 400 SqlLicenseManagementNotAllowed - Please set the License type of sql vm resource to null. License type manageability is currently not supported in this cloud.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 InvalidSqlSkuUpdate - SqlImageSku property cannot be updated when license type management is blocked.\n\n * 400 VmOsVersionIsUnsupported - OS version is unsupported.\n\n * 400 RedeployIsNotSupported - Redeploy is not supported when SqlVm is not provisioned.\n\n * 400 InvalidLightweightMode - Invalid SQL VM Management mode. Please change SQL VM property 'SqlManagement' to FULL\n\n * 400 InvalidAssessmentSettingsEnableIsFalse - Invalid assessment settings specified. Enable must be set to true to use other assessment settings.\n\n * 400 SqlInstanceSettingsSet1NotAllowed - SQL Instance Settings MAXDOP, and Collation are not allowed to be configured if the Feature Switch is disabled\n\n * 400 InvalidAssessmentScheduleSettings - Invalid assessment schedule settings specified.\n\n * 400 LinuxDistroIsNotSupported - Linux distro is unsupported\n\n * 400 SqlServerSettingCollationNotAllowedToUpdate - SQL Server collation is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory (MB) cannot be greater than Max Server Memory (MB)\n\n * 400 SqlInstanceSettingsSet2NotAllowed - SQL Instance Settings Optimize for adhoc workloads, Min server memory (MB) and Max server memory (MB) are not allowed to be configured if the Feature Switch is disabled\n\n * 400 ClusterIpShouldBeEmpty - Argument wsfcStaticIp should be empty for single subnet listener\n\n * 400 InvalidClusterIpAddress - Invalid cluster ip address provided.\n\n * 400 SqlServerSettingLPIMNotAllowedToUpdate - SQL Server Lock Pages In Memory is not allowed to be updated in manageability.\n\n * 400 SqlServerSettingIFINotAllowedToUpdate - SQL Server IFI is not allowed to be updated in manageability.\n\n * 400 LeastPrivilegeModeEnableNotSupported - Least Privilege mode is not supported on LightWeight or NoAgent extension mode.\n\n * 400 LeastPrivilegeModeChangeNotSupported - Cannot disable Least Privilege mode once enabled. \n\n * 400 VmOSUnsupportedForAzureAD - OS is unsupported for Azure AD authentication.\n\n * 400 SqlVersionUnsupportedForAzureAD - SQL version is unsupported for Azure AD authentication.\n\n * 400 EnableAzureADInProvisionUnsupported - Enable Azure AD authentication in provision is unsupported.\n\n * 400 MSIClientIdRequired - MSI client Id is required for Azure AD authentication.\n\n * 400 AzureADAuthenticationNotAllowed - Configuring Azure AD authentication is currently not allowed.\n\n * 400 CannotFindExtensionVersion - Cannot determine SQL IaaS Extension version.\n\n * 400 LeastPrivilegeModeOnlySupportedForSQL2012AndAbove - Least privilege mode is only supported for SQL server 2012 and above versions.\n\n * 400 InvalidLunForNotUseStoragePool - Invalid LUN specified for storage configuration settings. Only one lun should be provided to build the drive if not using storage pool.\n\n * 400 ConflictStoragePoolConfigForUseSameDrive - UseStoragePool values are different while set to share the same drive. UseStoragePool value will be considered as True by default if not specified otherwise.\n\n * 400 StoragePoolConfigNotSupportedInExtend - UseStoragePool parameter is not supported in EXTEND operations.\n\n * 400 StoragePoolConfigNotAllowed - Configuring storage pool option when creating/updating sql vm is not allowed at the moment.\n\n * 400 PowerBiVmsNotSupported - Creating SQL Virtual Machine Resource for PowerBI VM images is not supported.\n\n * 400 SubscriptionFeatureRegistrationsApiCallFailed - API call to check if subscription is registered to the feature has failed\n\n * 400 InvalidFileSizeSpecified - Invalid Request. File Size cannot be negative\n\n * 400 MissingPatchParameters - Missing PATCH parameters on the request.\n\n * 400 InvalidFileCountSpecified - Invalid Request. File Count cannot be negative \n\n * 400 InvalidMIResourceId - Invalid value given for Managed Identity Resource Id. Specify a valid value.\n\n * 400 MismatchMIResourceId - The provided User assigned identity is not associated with the Virtual Machine.\n\n * 400 ManagedIdentityNotEnabled - The provided identity type is not enabled on the Virtual Machine.\n\n * 400 IncorrectAdditionalVmPatch - The value provided for AdditionalVmPatch is invalid. \n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 AadAppDisabled - Microsoft AAD app SQLVMResourceProviderAuth ({0}) is disabled in your tenant.\n\n * 400 InternalAPIAccessDenied - Internal API Access denied. App Id {0} is not valid to use this API.\n\n * 400 InvalidSQLAuthPasswordLength - SQL auth password should not be greater than 128 characters\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 IPNotAvailable - IP {0} is not available{1}. Consider using one from ({2})\n\n * 409 IpAddressAlreadyReserved - IP address reserved for this listener already exists. Please use the IP address\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 429 SqlVmGroupGmsaNotAllowed - GMSA account is not supported yet.\n\n * 429 SqlVmGroupGmsaInfoInvalid - GMSA info such as SqlServiceAccount is not valid.\n\n * 429 TooManyRequestsReceived - Request throttled due to too many requests.\n\n * 429 ArgumentMissingForSetup - Argument is missing for setup. Please provide a value for the argument.\n\n * 429 MultisubnetOperationNotAllowed - Multi subnet HA setup operation is not allowed.\n\n * 500 FailedToGetRestoreStatusFromTableStorage - Failed to get restore status from table storage.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 StorageAccountUnexpectedError - Unexpected error for storage account.\n\n * 500 SqlVmEntityNotFound - SQL VM entity not found.\n\n * 500 RestoreJobEntityNotFound - Restore job entity not found.\n\n * 500 RpPluginSubstatusHAStatusMissing - Resource provider plugin substatus is missing HA status.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted request to start SQL virtual machine troubleshooting.", + "headers": { + "Location": { + "type": "string" + } + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Start SQL virtual machine troubleshooting operation": { + "$ref": "./examples/TroubleshootSqlVirtualMachine.json" + } + } + } + } + }, + "definitions": { + "AvailabilityGroupListenerProperties": { + "description": "The properties of an availability group listener.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state to track the async operation status.", + "type": "string", + "readOnly": true + }, + "availabilityGroupName": { + "description": "Name of the availability group.", + "type": "string" + }, + "loadBalancerConfigurations": { + "description": "List of load balancer configurations for an availability group listener.", + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancerConfiguration" + }, + "x-ms-identifiers": [] + }, + "multiSubnetIpConfigurations": { + "description": "List of multi subnet IP configurations for an AG listener.", + "type": "array", + "items": { + "$ref": "#/definitions/MultiSubnetIpConfiguration" + }, + "x-ms-identifiers": [] + }, + "createDefaultAvailabilityGroupIfNotExist": { + "description": "Create a default availability group if it does not exist.", + "type": "boolean" + }, + "port": { + "format": "int32", + "description": "Listener port.", + "type": "integer" + }, + "availabilityGroupConfiguration": { + "$ref": "#/definitions/AgConfiguration", + "description": "Availability Group configuration." + } + } + }, + "LoadBalancerConfiguration": { + "description": "A load balancer configuration for an availability group listener.", + "type": "object", + "properties": { + "privateIpAddress": { + "$ref": "#/definitions/PrivateIPAddress", + "description": "Private IP address." + }, + "publicIpAddressResourceId": { + "description": "Resource id of the public IP.", + "type": "string" + }, + "loadBalancerResourceId": { + "description": "Resource id of the load balancer.", + "type": "string" + }, + "probePort": { + "format": "int32", + "description": "Probe port.", + "type": "integer" + }, + "sqlVirtualMachineInstances": { + "description": "List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "MultiSubnetIpConfiguration": { + "description": "Multi subnet ip configuration for an availability group listener.", + "required": [ + "privateIpAddress", + "sqlVirtualMachineInstance" + ], + "type": "object", + "properties": { + "privateIpAddress": { + "$ref": "#/definitions/PrivateIPAddress", + "description": "Private IP address." + }, + "sqlVirtualMachineInstance": { + "description": "SQL virtual machine instance resource id that are enrolled into the availability group listener.", + "type": "string" + } + } + }, + "AgConfiguration": { + "description": "Availability group configuration.", + "type": "object", + "properties": { + "replicas": { + "description": "Replica configurations.", + "type": "array", + "items": { + "$ref": "#/definitions/AgReplica" + }, + "x-ms-identifiers": [] + } + } + }, + "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 + }, + "PrivateIPAddress": { + "description": "A private IP address bound to the availability group listener.", + "type": "object", + "properties": { + "ipAddress": { + "description": "Private IP address bound to the availability group listener.", + "type": "string" + }, + "subnetResourceId": { + "description": "Subnet used to include private IP.", + "type": "string" + } + } + }, + "AgReplica": { + "description": "Availability group replica configuration.", + "type": "object", + "properties": { + "sqlVirtualMachineInstanceId": { + "description": "Sql VirtualMachine Instance Id.", + "type": "string" + }, + "role": { + "description": "Replica Role in availability group.", + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "Role", + "modelAsString": true + } + }, + "commit": { + "description": "Replica commit mode in availability group.", + "enum": [ + "Synchronous_Commit", + "Asynchronous_Commit" + ], + "type": "string", + "x-ms-enum": { + "name": "Commit", + "modelAsString": true + } + }, + "failover": { + "description": "Replica failover mode in availability group.", + "enum": [ + "Automatic", + "Manual" + ], + "type": "string", + "x-ms-enum": { + "name": "Failover", + "modelAsString": true + } + }, + "readableSecondary": { + "description": "Replica readable secondary mode in availability group.", + "enum": [ + "No", + "All", + "Read_Only" + ], + "type": "string", + "x-ms-enum": { + "name": "ReadableSecondary", + "modelAsString": true + } + } + } + }, + "ProxyResource": { + "description": "ARM proxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "AvailabilityGroupListener": { + "description": "A SQL Server availability group listener.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AvailabilityGroupListenerProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "AvailabilityGroupListenerListResult": { + "description": "A list of availability group listeners.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/AvailabilityGroupListener" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "OperationListResult": { + "description": "Result of the request to list SQL operations.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "SQL REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string", + "readOnly": true + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The localized display information for this particular operation / action.", + "readOnly": true + }, + "origin": { + "description": "The intended executor of the operation.", + "enum": [ + "user", + "system" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "properties": { + "description": "Additional descriptions for the operation.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "readOnly": true, + "x-ms-client-flatten": false + } + } + }, + "OperationDisplay": { + "description": "Display metadata associated with the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string", + "readOnly": true + } + } + }, + "SqlVirtualMachineGroupProperties": { + "description": "The properties of a SQL virtual machine group.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state to track the async operation status.", + "type": "string", + "readOnly": true + }, + "sqlImageOffer": { + "description": "SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sqlImageSku": { + "description": "SQL image sku.", + "enum": [ + "Developer", + "Enterprise" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlVmGroupImageSku", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scaleType": { + "description": "Scale type.", + "enum": [ + "HA" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ScaleType", + "modelAsString": true + } + }, + "clusterManagerType": { + "description": "Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type.", + "enum": [ + "WSFC" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ClusterManagerType", + "modelAsString": true + } + }, + "clusterConfiguration": { + "description": "Cluster type.", + "enum": [ + "Domainful" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ClusterConfiguration", + "modelAsString": true + } + }, + "wsfcDomainProfile": { + "$ref": "#/definitions/WsfcDomainProfile", + "description": "Cluster Active Directory domain profile.", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "WsfcDomainProfile": { + "description": "Active Directory account details to operate Windows Server Failover Cluster.", + "type": "object", + "properties": { + "domainFqdn": { + "description": "Fully qualified name of the domain.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ouPath": { + "description": "Organizational Unit path in which the nodes and cluster will be present.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "clusterBootstrapAccount": { + "description": "Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "clusterOperatorAccount": { + "description": "Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.", + "type": "string", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "sqlServiceAccount": { + "description": "Account name under which SQL service will run on all participating SQL virtual machines in the cluster.", + "type": "string", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "isSqlServiceAccountGmsa": { + "description": "The flag to check if SQL service account is GMSA.", + "type": "boolean", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "fileShareWitnessPath": { + "description": "Optional path for fileshare witness.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "storageAccountUrl": { + "description": "Fully qualified ARM resource id of the witness storage account.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "storageAccountPrimaryKey": { + "description": "Primary key of the witness storage account.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "clusterSubnetType": { + "description": "Cluster subnet type.", + "enum": [ + "SingleSubnet", + "MultiSubnet" + ], + "type": "string", + "x-ms-enum": { + "name": "ClusterSubnetType", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "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" + } + } + } + }, + "SqlVirtualMachineGroup": { + "description": "A SQL virtual machine group.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlVirtualMachineGroupProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "SqlVirtualMachineGroupUpdate": { + "description": "An update to a SQL virtual machine group.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlVirtualMachineGroupListResult": { + "description": "A list of SQL virtual machine groups.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlVirtualMachineGroup" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlVirtualMachineListResult": { + "description": "A list of SQL virtual machines.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlVirtualMachine" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ResourceIdentity": { + "description": "Azure Active Directory identity configuration for a resource.", + "type": "object", + "properties": { + "principalId": { + "format": "uuid", + "description": "The Azure Active Directory principal id.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "tenantId": { + "format": "uuid", + "description": "The Azure Active Directory tenant id.", + "type": "string", + "readOnly": true + } + } + }, + "SqlVirtualMachineProperties": { + "description": "The SQL virtual machine properties.", + "type": "object", + "properties": { + "virtualMachineResourceId": { + "description": "ARM Resource id of underlying virtual machine created from SQL marketplace image.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "Provisioning state to track the async operation status.", + "type": "string", + "readOnly": true + }, + "sqlImageOffer": { + "description": "SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sqlServerLicenseType": { + "description": "SQL Server license type.", + "enum": [ + "PAYG", + "AHUB", + "DR" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "sqlManagement": { + "description": "SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it.", + "enum": [ + "Full", + "LightWeight", + "NoAgent" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlManagementMode", + "modelAsString": true + } + }, + "leastPrivilegeMode": { + "description": "SQL IaaS Agent least privilege mode.", + "default": "NotSet", + "enum": [ + "Enabled", + "NotSet" + ], + "type": "string", + "x-ms-enum": { + "name": "LeastPrivilegeMode", + "modelAsString": true + } + }, + "sqlImageSku": { + "description": "SQL Server edition type.", + "enum": [ + "Developer", + "Express", + "Standard", + "Enterprise", + "Web" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlImageSku", + "modelAsString": true + } + }, + "sqlVirtualMachineGroupResourceId": { + "description": "ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of.", + "type": "string", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "wsfcDomainCredentials": { + "$ref": "#/definitions/WsfcDomainCredentials", + "description": "Domain credentials for setting up Windows Server Failover Cluster for SQL availability group." + }, + "wsfcStaticIp": { + "description": "Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.", + "type": "string" + }, + "autoPatchingSettings": { + "$ref": "#/definitions/AutoPatchingSettings", + "description": "Auto patching settings for applying critical security updates to SQL virtual machine." + }, + "autoBackupSettings": { + "$ref": "#/definitions/AutoBackupSettings", + "description": "Auto backup settings for SQL Server." + }, + "keyVaultCredentialSettings": { + "$ref": "#/definitions/KeyVaultCredentialSettings", + "description": "Key vault credential settings." + }, + "serverConfigurationsManagementSettings": { + "$ref": "#/definitions/ServerConfigurationsManagementSettings", + "description": "SQL Server configuration management settings." + }, + "storageConfigurationSettings": { + "$ref": "#/definitions/StorageConfigurationSettings", + "description": "Storage Configuration Settings." + }, + "troubleshootingStatus": { + "$ref": "#/definitions/TroubleshootingStatus", + "description": "Troubleshooting status", + "readOnly": true + }, + "assessmentSettings": { + "$ref": "#/definitions/AssessmentSettings", + "description": "SQL best practices Assessment Settings." + }, + "enableAutomaticUpgrade": { + "description": "Enable automatic upgrade of Sql IaaS extension Agent.", + "default": false, + "type": "boolean" + }, + "additionalVmPatch": { + "description": "Additional VM Patching solution enabled on the Virtual Machine", + "enum": [ + "WU", + "WUMU", + "WSUS" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AdditionalOsPatch", + "modelAsString": true + } + }, + "virtualMachineIdentitySettings": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "Virtual Machine Identity details used for Sql IaaS extension configurations." + }, + "osType": { + "description": "Operating System of the current SQL Virtual Machine.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OsType", + "modelAsString": false + } + } + } + }, + "WsfcDomainCredentials": { + "description": "Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.", + "type": "object", + "properties": { + "clusterBootstrapAccountPassword": { + "description": "Cluster bootstrap account password.", + "type": "string" + }, + "clusterOperatorAccountPassword": { + "description": "Cluster operator account password.", + "type": "string" + }, + "sqlServiceAccountPassword": { + "description": "SQL service account password.", + "type": "string" + } + } + }, + "AutoPatchingSettings": { + "description": "Set a patching window during which Windows and SQL patches will be applied.", + "type": "object", + "properties": { + "enable": { + "description": "Enable or disable autopatching on SQL virtual machine.", + "type": "boolean" + }, + "dayOfWeek": { + "description": "Day of week to apply the patch on.", + "enum": [ + "Everyday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "maintenanceWindowStartingHour": { + "format": "int32", + "description": "Hour of the day when patching is initiated. Local VM time.", + "type": "integer" + }, + "maintenanceWindowDuration": { + "format": "int32", + "description": "Duration of patching.", + "type": "integer" + }, + "additionalVmPatch": { + "description": "Additional Patch to be enable or enabled on the SQL Virtual Machine.", + "default": "NotSet", + "enum": [ + "NotSet", + "MicrosoftUpdate" + ], + "type": "string", + "x-ms-enum": { + "name": "AdditionalVmPatch", + "modelAsString": true + } + } + } + }, + "AutoBackupSettings": { + "description": "Configure backups for databases in your SQL virtual machine.", + "type": "object", + "properties": { + "enable": { + "description": "Enable or disable autobackup on SQL virtual machine.", + "type": "boolean" + }, + "enableEncryption": { + "description": "Enable or disable encryption for backup on SQL virtual machine.", + "type": "boolean" + }, + "retentionPeriod": { + "format": "int32", + "description": "Retention period of backup: 1-90 days.", + "type": "integer" + }, + "storageAccountUrl": { + "description": "Storage account url where backup will be taken to.", + "type": "string" + }, + "storageContainerName": { + "description": "Storage container name where backup will be taken to.", + "type": "string" + }, + "storageAccessKey": { + "description": "Storage account key where backup will be taken to.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "password": { + "description": "Password for encryption on backup.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "backupSystemDbs": { + "description": "Include or exclude system databases from auto backup.", + "type": "boolean" + }, + "backupScheduleType": { + "description": "Backup schedule type.", + "enum": [ + "Manual", + "Automated" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupScheduleType", + "modelAsString": true + } + }, + "fullBackupFrequency": { + "description": "Frequency of full backups. In both cases, full backups begin during the next scheduled time window.", + "enum": [ + "Daily", + "Weekly" + ], + "type": "string", + "x-ms-enum": { + "name": "FullBackupFrequencyType", + "modelAsString": true + } + }, + "daysOfWeek": { + "description": "Days of the week for the backups when FullBackupFrequency is set to Weekly.", + "type": "array", + "items": { + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoBackupDaysOfWeek", + "modelAsString": true + } + } + }, + "fullBackupStartTime": { + "format": "int32", + "description": "Start time of a given day during which full backups can take place. 0-23 hours.", + "type": "integer" + }, + "fullBackupWindowHours": { + "format": "int32", + "description": "Duration of the time window of a given day during which full backups can take place. 1-23 hours.", + "type": "integer" + }, + "logBackupFrequency": { + "format": "int32", + "description": "Frequency of log backups. 5-60 minutes.", + "type": "integer" + } + } + }, + "KeyVaultCredentialSettings": { + "description": "Configure your SQL virtual machine to be able to connect to the Azure Key Vault service.", + "type": "object", + "properties": { + "enable": { + "description": "Enable or disable key vault credential setting.", + "type": "boolean" + }, + "credentialName": { + "description": "Credential name.", + "type": "string" + }, + "azureKeyVaultUrl": { + "description": "Azure Key Vault url.", + "type": "string" + }, + "servicePrincipalName": { + "description": "Service principal name to access key vault.", + "type": "string" + }, + "servicePrincipalSecret": { + "description": "Service principal name secret to access key vault.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + } + } + }, + "ServerConfigurationsManagementSettings": { + "description": "Set the connectivity, storage and workload settings.", + "type": "object", + "properties": { + "sqlConnectivityUpdateSettings": { + "$ref": "#/definitions/SqlConnectivityUpdateSettings", + "description": "SQL connectivity type settings." + }, + "sqlWorkloadTypeUpdateSettings": { + "$ref": "#/definitions/SqlWorkloadTypeUpdateSettings", + "description": "SQL workload type settings." + }, + "sqlStorageUpdateSettings": { + "$ref": "#/definitions/SqlStorageUpdateSettings", + "description": "SQL storage update settings." + }, + "additionalFeaturesServerConfigurations": { + "$ref": "#/definitions/AdditionalFeaturesServerConfigurations", + "description": "Additional SQL feature settings." + }, + "sqlInstanceSettings": { + "$ref": "#/definitions/SQLInstanceSettings", + "description": "SQL Instance settings." + }, + "azureAdAuthenticationSettings": { + "$ref": "#/definitions/AADAuthenticationSettings", + "description": "Azure AD authentication Settings." + } + } + }, + "StorageConfigurationSettings": { + "description": "Storage Configurations for SQL Data, Log and TempDb.", + "type": "object", + "properties": { + "sqlDataSettings": { + "$ref": "#/definitions/SQLStorageSettings", + "description": "SQL Server Data Storage Settings." + }, + "sqlLogSettings": { + "$ref": "#/definitions/SQLStorageSettings", + "description": "SQL Server Log Storage Settings." + }, + "sqlTempDbSettings": { + "$ref": "#/definitions/SQLTempDbSettings", + "description": "SQL Server TempDb Storage Settings." + }, + "sqlSystemDbOnDataDisk": { + "description": "SQL Server SystemDb Storage on DataPool if true.", + "type": "boolean" + }, + "diskConfigurationType": { + "description": "Disk configuration to apply to SQL Server.", + "enum": [ + "NEW", + "EXTEND", + "ADD" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskConfigurationType", + "modelAsString": true + } + }, + "storageWorkloadType": { + "description": "Storage workload type.", + "enum": [ + "GENERAL", + "OLTP", + "DW" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageWorkloadType", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "enableStorageConfigBlade": { + "description": "Enable SQL IaaS Agent storage configuration blade in Azure Portal.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "update" + ] + } + } + }, + "TroubleshootingStatus": { + "description": "Status of last troubleshooting operation on this SQL VM", + "type": "object", + "properties": { + "rootCause": { + "description": "Root cause of the issue", + "type": "string", + "readOnly": true + }, + "lastTriggerTimeUtc": { + "format": "date-time", + "description": "Last troubleshooting trigger time in UTC timezone", + "type": "string", + "readOnly": true + }, + "startTimeUtc": { + "format": "date-time", + "description": "Start time in UTC timezone.", + "type": "string", + "readOnly": true + }, + "endTimeUtc": { + "format": "date-time", + "description": "End time in UTC timezone.", + "type": "string", + "readOnly": true + }, + "troubleshootingScenario": { + "description": "SQL VM troubleshooting scenario.", + "default": "UnhealthyReplica", + "enum": [ + "UnhealthyReplica" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TroubleshootingScenario", + "modelAsString": true + } + }, + "properties": { + "$ref": "#/definitions/TroubleshootingAdditionalProperties", + "description": "Troubleshooting properties", + "readOnly": true + } + } + }, + "AssessmentSettings": { + "description": "Configure SQL best practices Assessment for databases in your SQL virtual machine.", + "type": "object", + "properties": { + "enable": { + "description": "Enable or disable SQL best practices Assessment feature on SQL virtual machine.", + "type": "boolean" + }, + "runImmediately": { + "description": "Run SQL best practices Assessment immediately on SQL virtual machine.", + "type": "boolean" + }, + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "Schedule for SQL best practices Assessment." + } + } + }, + "VirtualMachineIdentity": { + "description": "Virtual Machine Identity details used for Sql IaaS extension configurations.", + "type": "object", + "properties": { + "type": { + "description": "Identity type of the virtual machine. Specify None to opt-out of Managed Identities.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "VmIdentityType", + "modelAsString": true + } + }, + "resourceId": { + "description": "ARM Resource Id of the identity. Only required when UserAssigned identity is selected.", + "type": "string", + "format": "arm-id" + } + } + }, + "SqlConnectivityUpdateSettings": { + "description": "Set the access level and network port settings for SQL Server.", + "type": "object", + "properties": { + "connectivityType": { + "description": "SQL Server connectivity option.", + "enum": [ + "LOCAL", + "PRIVATE", + "PUBLIC" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectivityType", + "modelAsString": true + } + }, + "port": { + "format": "int32", + "description": "SQL Server port.", + "type": "integer" + }, + "sqlAuthUpdateUserName": { + "description": "SQL Server sysadmin login to create.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "sqlAuthUpdatePassword": { + "description": "SQL Server sysadmin login password.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + } + } + }, + "SqlWorkloadTypeUpdateSettings": { + "description": "Set workload type to optimize storage for SQL Server.", + "type": "object", + "properties": { + "sqlWorkloadType": { + "description": "SQL Server workload type.", + "enum": [ + "GENERAL", + "OLTP", + "DW" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlWorkloadType", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "SqlStorageUpdateSettings": { + "description": "Set disk storage settings for SQL Server.", + "type": "object", + "properties": { + "diskCount": { + "format": "int32", + "description": "Virtual machine disk count.", + "type": "integer" + }, + "startingDeviceId": { + "format": "int32", + "description": "Device id of the first disk to be updated.", + "type": "integer" + }, + "diskConfigurationType": { + "description": "Disk configuration to apply to SQL Server.", + "enum": [ + "NEW", + "EXTEND", + "ADD" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskConfigurationType", + "modelAsString": true + } + } + } + }, + "AdditionalFeaturesServerConfigurations": { + "description": "Additional SQL Server feature settings.", + "type": "object", + "properties": { + "isRServicesEnabled": { + "description": "Enable or disable R services (SQL 2016 onwards).", + "type": "boolean" + } + } + }, + "SQLInstanceSettings": { + "description": "Set the server/instance-level settings for SQL Server.", + "type": "object", + "properties": { + "collation": { + "description": "SQL Server Collation.", + "type": "string" + }, + "maxDop": { + "format": "int32", + "description": "SQL Server MAXDOP.", + "type": "integer" + }, + "isOptimizeForAdHocWorkloadsEnabled": { + "description": "SQL Server Optimize for Adhoc workloads.", + "type": "boolean" + }, + "minServerMemoryMB": { + "format": "int32", + "description": "SQL Server minimum memory.", + "type": "integer" + }, + "maxServerMemoryMB": { + "format": "int32", + "description": "SQL Server maximum memory.", + "type": "integer" + }, + "isLpimEnabled": { + "description": "SQL Server LPIM.", + "type": "boolean" + }, + "isIfiEnabled": { + "description": "SQL Server IFI.", + "type": "boolean" + } + } + }, + "AADAuthenticationSettings": { + "description": "Enable AAD authentication for SQL VM.", + "type": "object", + "properties": { + "clientId": { + "description": "The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity", + "type": "string" + } + } + }, + "SQLStorageSettings": { + "description": "Set disk storage settings for SQL Server.", + "type": "object", + "properties": { + "luns": { + "description": "Logical Unit Numbers for the disks.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "defaultFilePath": { + "description": "SQL Server default file path", + "type": "string" + }, + "useStoragePool": { + "description": "Use storage pool to build a drive if true or not provided", + "type": "boolean" + } + } + }, + "SQLTempDbSettings": { + "description": "Set tempDb storage settings for SQL Server.", + "type": "object", + "properties": { + "dataFileSize": { + "format": "int32", + "description": "SQL Server tempdb data file size", + "type": "integer" + }, + "dataGrowth": { + "format": "int32", + "description": "SQL Server tempdb data file autoGrowth size", + "type": "integer" + }, + "logFileSize": { + "format": "int32", + "description": "SQL Server tempdb log file size", + "type": "integer" + }, + "logGrowth": { + "format": "int32", + "description": "SQL Server tempdb log file autoGrowth size", + "type": "integer" + }, + "dataFileCount": { + "format": "int32", + "description": "SQL Server tempdb data file count", + "type": "integer" + }, + "persistFolder": { + "description": "SQL Server tempdb persist folder choice", + "type": "boolean" + }, + "persistFolderPath": { + "description": "SQL Server tempdb persist folder location", + "type": "string" + }, + "luns": { + "description": "Logical Unit Numbers for the disks.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "defaultFilePath": { + "description": "SQL Server default file path", + "type": "string" + }, + "useStoragePool": { + "description": "Use storage pool to build a drive if true or not provided", + "type": "boolean" + } + } + }, + "TroubleshootingAdditionalProperties": { + "description": "SQL VM Troubleshooting additional properties.", + "type": "object", + "properties": { + "unhealthyReplicaInfo": { + "$ref": "#/definitions/UnhealthyReplicaInfo", + "description": "The unhealthy replica information" + } + } + }, + "Schedule": { + "description": "Set assessment schedule for SQL Server.", + "type": "object", + "properties": { + "enable": { + "description": "Enable or disable assessment schedule on SQL virtual machine.", + "type": "boolean" + }, + "weeklyInterval": { + "format": "int32", + "description": "Number of weeks to schedule between 2 assessment runs. Takes value from 1-6", + "type": "integer" + }, + "monthlyOccurrence": { + "format": "int32", + "description": "Occurrence of the DayOfWeek day within a month to schedule assessment. Takes values: 1,2,3,4 and -1. Use -1 for last DayOfWeek day of the month", + "type": "integer" + }, + "dayOfWeek": { + "description": "Day of the week to run assessment.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "AssessmentDayOfWeek", + "modelAsString": false + } + }, + "startTime": { + "description": "Time of the day in HH:mm format. Eg. 17:30", + "type": "string" + } + } + }, + "UnhealthyReplicaInfo": { + "description": "SQL VM Troubleshoot UnhealthyReplica scenario information.", + "type": "object", + "properties": { + "availabilityGroupName": { + "description": "The name of the availability group", + "type": "string" + } + } + }, + "SqlVirtualMachine": { + "description": "A SQL virtual machine.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "DO NOT USE. This value will be deprecated. Azure Active Directory identity of the server.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "$ref": "#/definitions/SqlVirtualMachineProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "DiskConfigAssessmentRequest": { + "description": "Configure disk config assessment for databases in your SQL virtual machine.", + "type": "object", + "properties": { + "runDiskConfigRules": { + "description": "Boolean to run disk config Assessment. Use false to fetch past Assessment.", + "type": "boolean" + } + } + }, + "SqlVirtualMachineUpdate": { + "description": "An update to a SQL virtual machine.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlVmTroubleshooting": { + "description": "Details required for SQL VM troubleshooting", + "type": "object", + "properties": { + "startTimeUtc": { + "format": "date-time", + "description": "Start time in UTC timezone.", + "type": "string" + }, + "endTimeUtc": { + "format": "date-time", + "description": "End time in UTC timezone.", + "type": "string" + }, + "troubleshootingScenario": { + "description": "SQL VM troubleshooting scenario.", + "default": "UnhealthyReplica", + "enum": [ + "UnhealthyReplica" + ], + "type": "string", + "x-ms-enum": { + "name": "TroubleshootingScenario", + "modelAsString": true + } + }, + "properties": { + "$ref": "#/definitions/TroubleshootingAdditionalProperties", + "description": "Troubleshooting properties" + }, + "virtualMachineResourceId": { + "description": "Virtual machine resource id for response.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "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" + }, + "SqlVirtualMachineNameParameter": { + "name": "sqlVirtualMachineName", + "in": "path", + "description": "Name of the SQL virtual machine.", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 1, + "pattern": "^((?!_)[^\\\\/\"'\\[\\]:|<>+=;,?*@&]{1,64}(?
Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", - "operationId": "SupportTickets_List", - "parameters": [ - { - "name": "$top", - "in": "query", - "description": "The number of values to return in the collection. Default is 25 and max is 100.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation. We support 'odata v4.0' filter semantics. [Learn more](https://docs.microsoft.com/odata/concepts/queryoptions-overview). _Status_, _ServiceId_, and _ProblemClassificationId_ filters can only be used with Equals ('eq') operator. For _CreatedDate_ filter, the supported operators are Greater Than ('gt') and Greater Than or Equals ('ge'). When using both filters, combine them using the logical 'AND'." - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved support tickets.", - "schema": { - "$ref": "#/definitions/SupportTicketsListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ExceptionResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List support tickets for a subscription": { - "$ref": "./examples/ListSupportTicketsBySubscription.json" - }, - "List support tickets in open state for a subscription": { - "$ref": "./examples/ListSupportTicketsInOpenStateBySubscription.json" - }, - "List support tickets created on or after a certain date and in open state for a subscription": { - "$ref": "./examples/ListSupportTicketsCreatedOnOrAfterAndInOpenStateBySubscription.json" - }, - "List support tickets with a certain service id for a subscription": { - "$ref": "./examples/ListSupportTicketsServiceIdEqualsForSubscription.json" - }, - "List support tickets with a certain problem classification id for a subscription": { - "$ref": "./examples/ListSupportTicketsProblemClassificationIdEqualsForSubscription.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}": { - "get": { - "tags": [ - "SupportTickets" - ], - "description": "Get ticket details for an Azure subscription. Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", - "operationId": "SupportTickets_Get", - "parameters": [ - { - "name": "supportTicketName", - "in": "path", - "description": "Support ticket name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved support ticket.", - "schema": { - "$ref": "#/definitions/SupportTicketDetails" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ExceptionResponse" - } - } - }, - "x-ms-examples": { - "Get details of a subscription ticket": { - "$ref": "./examples/GetSubscriptionSupportTicketDetails.json" - } - } - }, - "patch": { - "tags": [ - "SupportTickets" - ], - "description": "This API allows you to update the severity level, ticket status, and your contact information in the support ticket.

Note: The severity levels cannot be changed if a support ticket is actively being worked upon by an Azure support engineer. In such a case, contact your support engineer to request severity update by adding a new communication using the Communications API.

Changing the ticket status to _closed_ is allowed only on an unassigned case. When an engineer is actively working on the ticket, send your ticket closure request by sending a note to your engineer.", - "operationId": "SupportTickets_Update", - "parameters": [ - { - "name": "supportTicketName", - "in": "path", - "description": "Support ticket name.", - "required": true, - "type": "string" - }, - { - "name": "updateSupportTicket", - "in": "body", - "description": "UpdateSupportTicket object.", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateSupportTicket" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated support ticket.", - "schema": { - "$ref": "#/definitions/SupportTicketDetails" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ExceptionResponse" - } - } - }, - "x-ms-examples": { - "Update severity of a support ticket": { - "$ref": "./examples/UpdateSeverityOfSupportTicketForSubscription.json" - }, - "Update contact details of a support ticket": { - "$ref": "./examples/UpdateContactDetailsOfSupportTicketForSubscription.json" - }, - "Update status of a support ticket": { - "$ref": "./examples/UpdateStatusOfSupportTicketForSubscription.json" - } - } - }, - "put": { - "tags": [ - "SupportTickets" - ], - "description": "Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription. Learn the [prerequisites](https://aka.ms/supportAPI) required to create a support ticket.

Always call the Services and ProblemClassifications API to get the most recent set of services and problem categories required for support ticket creation.

Adding attachments is not currently supported via the API. To add a file to an existing support ticket, visit the [Manage support ticket](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest) page in the Azure portal, select the support ticket, and use the file upload control to add a new file.

Providing consent to share diagnostic information with Azure support is currently not supported via the API. The Azure support engineer working on your ticket will reach out to you for consent if your issue requires gathering diagnostic information from your Azure resources.

**Creating a support ticket for on-behalf-of**: Include _x-ms-authorization-auxiliary_ header to provide an auxiliary token as per [documentation](https://docs.microsoft.com/azure/azure-resource-manager/management/authenticate-multi-tenant). The primary token will be from the tenant for whom a support ticket is being raised against the subscription, i.e. Cloud solution provider (CSP) customer tenant. The auxiliary token will be from the Cloud solution provider (CSP) partner tenant.", - "operationId": "SupportTickets_Create", - "parameters": [ - { - "name": "supportTicketName", - "in": "path", - "description": "Support ticket name.", - "required": true, - "type": "string" - }, - { - "name": "createSupportTicketParameters", - "in": "body", - "description": "Support ticket request payload.", - "required": true, - "schema": { - "$ref": "#/definitions/SupportTicketDetails" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - SupportTicket created successfully.", - "schema": { - "$ref": "#/definitions/SupportTicketDetails" - } - }, - "202": { - "description": "Accepted, SupportTicket will be created asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ExceptionResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "Create a ticket for Billing related issues": { - "$ref": "./examples/CreateBillingSupportTicketForSubscription.json" - }, - "Create a ticket for Subscription Management related issues": { - "$ref": "./examples/CreateSubMgmtSupportTicketForSubscription.json" - }, - "Create a ticket for Technical issue related to a specific resource": { - "$ref": "./examples/CreateTechnicalSupportTicketForSubscription.json" - }, - "Create a ticket to request Quota increase for Compute VM Cores": { - "$ref": "./examples/CreateCoresQuotaTicketForSubscription.json" - }, - "Create a ticket to request Quota increase for Low-priority cores for a Batch account": { - "$ref": "./examples/CreateBatchQuotaTicketForSpecificBatchAccountForLowPriorityCores.json" - }, - "Create a ticket to request Quota increase for specific VM family cores for a Batch account": { - "$ref": "./examples/CreateBatchQuotaTicketForSpecificBatchAccountForDedicatedCores.json" - }, - "Create a ticket to request Quota increase for Pools for a Batch account": { - "$ref": "./examples/CreateBatchQuotaTicketForSpecificBatchAccountForPools.json" - }, - "Create a ticket to request Quota increase for Active Jobs and Job Schedules for a Batch account": { - "$ref": "./examples/CreateBatchQuotaTicketForSpecificBatchAccountForActiveJobs.json" - }, - "Create a ticket to request Quota increase for Batch accounts for a subscription": { - "$ref": "./examples/CreateBatchQuotaTicketForSubscription.json" - }, - "Create a ticket to request Quota increase for DTUs for SQL Database": { - "$ref": "./examples/CreateSqlDatabaseQuotaTicketForDTUs.json" - }, - "Create a ticket to request Quota increase for Servers for SQL Database": { - "$ref": "./examples/CreateSqlDatabaseQuotaTicketForServers.json" - }, - "Create a ticket to request Quota increase for DTUs for Azure Synapse Analytics": { - "$ref": "./examples/CreateSqlDatawarehouseQuotaTicketForDTUs.json" - }, - "Create a ticket to request Quota increase for Servers for Azure Synapse Analytics": { - "$ref": "./examples/CreateSqlDatawarehouseQuotaTicketForServers.json" - }, - "Create a ticket to request Quota increase for specific VM family cores for Machine Learning service": { - "$ref": "./examples/CreateMachineLearningQuotaTicketForDedicatedCores.json" - }, - "Create a ticket to request Quota increase for Low-priority cores for Machine Learning service": { - "$ref": "./examples/CreateMachineLearningQuotaTicketForLowPriorityCores.json" - }, - "Create a ticket to request Quota increase for Azure SQL managed instance": { - "$ref": "./examples/CreateSqlManagedInstanceQuotaTicket.json" - }, - "Create a ticket to request Quota increase for services that do not require additional details in the quotaTicketDetails object": { - "$ref": "./examples/CreateGenericQuotaTicket.json" - }, - "Create a ticket to request Quota increase for Azure Lab Services for a subscription": { - "$ref": "./examples/CreateALSQuotaRequestForSubscription.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/checkNameAvailability": { - "post": { - "tags": [ - "Communications" - ], - "description": "Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.", - "operationId": "Communications_CheckNameAvailability", - "x-ms-examples": { - "Checks whether name is available for Communication resource": { - "$ref": "./examples/CheckNameAvailabilityForSupportTicketCommunication.json" - } - }, - "parameters": [ - { - "name": "supportTicketName", - "in": "path", - "description": "Support ticket name.", - "required": true, - "type": "string" - }, - { - "name": "checkNameAvailabilityInput", - "in": "body", - "description": "Input to check.", - "required": true, - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityInput" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityOutput" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ExceptionResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications": { - "get": { - "tags": [ - "Communications" - ], - "description": "Lists all communications (attachments not included) for a support ticket.

You can also filter support ticket communications by _CreatedDate_ or _CommunicationType_ using the $filter parameter. The only type of communication supported today is _Web_. Output will be a paged result with _nextLink_, using which you can retrieve the next set of Communication results.

Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", - "operationId": "Communications_List", - "parameters": [ - { - "name": "supportTicketName", - "in": "path", - "description": "Support ticket name.", - "required": true, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The number of values to return in the collection. Default is 10 and max is 10.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation. You can filter by communicationType and createdDate properties. CommunicationType supports Equals ('eq') operator and createdDate supports Greater Than ('gt') and Greater Than or Equals ('ge') operators. You may combine the CommunicationType and CreatedDate filters by Logical And ('and') operator." - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved communications for a support ticket.", - "schema": { - "$ref": "#/definitions/CommunicationsListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ExceptionResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List communications for a subscription support ticket": { - "$ref": "./examples/ListCommunicationsForSubscriptionSupportTicket.json" - }, - "List web communications for a subscription support ticket": { - "$ref": "./examples/ListWebCommunicationsForSubscriptionSupportTicket.json" - }, - "List web communication created on or after a specific date for a subscription support ticket": { - "$ref": "./examples/ListWebCommunicationsForSubscriptionSupportTicketCreatedOnOrAfter.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}": { - "get": { - "tags": [ - "Communications" - ], - "description": "Returns communication details for a support ticket.", - "operationId": "Communications_Get", - "parameters": [ - { - "name": "supportTicketName", - "in": "path", - "description": "Support ticket name.", - "required": true, - "type": "string" - }, - { - "name": "communicationName", - "in": "path", - "description": "Communication name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved communication details.", - "schema": { - "$ref": "#/definitions/CommunicationDetails" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ExceptionResponse" - } - } - }, - "x-ms-examples": { - "Get communication details for a subscription support ticket": { - "$ref": "./examples/GetCommunicationDetailsForSubscriptionSupportTicket.json" - } - } - }, - "put": { - "tags": [ - "Communications" - ], - "description": "Adds a new customer communication to an Azure support ticket.", - "operationId": "Communications_Create", - "parameters": [ - { - "name": "supportTicketName", - "in": "path", - "description": "Support ticket name.", - "required": true, - "type": "string" - }, - { - "name": "communicationName", - "in": "path", - "description": "Communication name.", - "required": true, - "type": "string" - }, - { - "name": "createCommunicationParameters", - "in": "body", - "description": "Communication object.", - "required": true, - "schema": { - "$ref": "#/definitions/CommunicationDetails" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Communication created successfully.", - "schema": { - "$ref": "#/definitions/CommunicationDetails" - } - }, - "202": { - "description": "Accepted - Communication will be created asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ExceptionResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "AddCommunicationToSubscriptionTicket": { - "$ref": "./examples/CreateSupportTicketCommunication.json" - } - } - } - } - }, - "definitions": { - "OperationsListResult": { - "description": "The list of operations supported by Microsoft Support resource provider.", - "properties": { - "value": { - "description": "The list of operations supported by Microsoft Support resource provider.", - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "Operation": { - "description": "The operation supported by Microsoft Support resource provider.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}.", - "type": "string", - "readOnly": true - }, - "display": { - "description": "The object that describes the operation.", - "properties": { - "description": { - "description": "The description of the operation.", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "The action that users can perform, based on their permission level.", - "type": "string", - "readOnly": true - }, - "provider": { - "description": "Service provider: Microsoft Support.", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string", - "readOnly": true - } - } - } - } - }, - "ServicesListResult": { - "description": "Collection of Service resources.", - "type": "object", - "properties": { - "value": { - "description": "List of Service resources.", - "type": "array", - "items": { - "$ref": "#/definitions/Service" - } - } - } - }, - "Service": { - "description": "Object that represents a Service resource.", - "type": "object", - "properties": { - "id": { - "description": "Id of the resource.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Name of the resource.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Type of the resource 'Microsoft.Support/services'.", - "type": "string", - "readOnly": true - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServiceProperties", - "description": "Properties of the resource." - } - } - }, - "ServiceProperties": { - "description": "Details about an Azure service available for support ticket creation.", - "type": "object", - "properties": { - "displayName": { - "description": "Localized name of the Azure service.", - "type": "string" - }, - "resourceTypes": { - "description": "ARM Resource types.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ProblemClassificationsListResult": { - "description": "Collection of ProblemClassification resources.", - "type": "object", - "properties": { - "value": { - "description": "List of ProblemClassification resources.", - "type": "array", - "items": { - "$ref": "#/definitions/ProblemClassification" - } - } - } - }, - "ProblemClassification": { - "description": "ProblemClassification resource object.", - "type": "object", - "properties": { - "id": { - "description": "Id of the resource.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Name of the resource.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Type of the resource 'Microsoft.Support/problemClassification'.", - "type": "string", - "readOnly": true - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ProblemClassificationProperties", - "description": "Properties of the resource." - } - } - }, - "ProblemClassificationProperties": { - "description": "Details about a problem classification available for an Azure service.", - "type": "object", - "properties": { - "displayName": { - "description": "Localized name of problem classification.", - "type": "string" - } - } - }, - "CheckNameAvailabilityInput": { - "description": "Input of CheckNameAvailability API.", - "type": "object", - "required": [ - "name", - "type" - ], - "properties": { - "name": { - "description": "The resource name to validate.", - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Support/supportTickets", - "Microsoft.Support/communications" - ], - "x-ms-enum": { - "name": "Type", - "modelAsString": false - }, - "description": "The type of resource." - } - } - }, - "CheckNameAvailabilityOutput": { - "description": "Output of check name availability API.", - "type": "object", - "properties": { - "nameAvailable": { - "description": "Indicates whether the name is available.", - "readOnly": true, - "type": "boolean" - }, - "reason": { - "description": "The reason why the name is not available.", - "readOnly": true, - "type": "string" - }, - "message": { - "description": "The detailed error message describing why the name is not available.", - "readOnly": true, - "type": "string" - } - } - }, - "SupportTicketsListResult": { - "description": "Object that represents a collection of SupportTicket resources.", - "type": "object", - "properties": { - "value": { - "description": "List of SupportTicket resources.", - "type": "array", - "items": { - "$ref": "#/definitions/SupportTicketDetails" - } - }, - "nextLink": { - "description": "The URI to fetch the next page of SupportTicket resources.", - "type": "string" - } - } - }, - "SupportTicketDetails": { - "x-ms-azure-resource": true, - "description": "Object that represents SupportTicketDetails resource.", - "type": "object", - "properties": { - "id": { - "description": "Id of the resource.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Name of the resource.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Type of the resource 'Microsoft.Support/supportTickets'.", - "type": "string", - "readOnly": true - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SupportTicketDetailsProperties", - "description": "Properties of the resource." - } - } - }, - "CommunicationsListResult": { - "description": "Collection of Communication resources.", - "type": "object", - "properties": { - "value": { - "description": "List of Communication resources.", - "type": "array", - "items": { - "$ref": "#/definitions/CommunicationDetails" - } - }, - "nextLink": { - "description": "The URI to fetch the next page of Communication resources.", - "type": "string" - } - } - }, - "CommunicationDetails": { - "x-ms-azure-resource": true, - "description": "Object that represents a Communication resource.", - "type": "object", - "properties": { - "id": { - "description": "Id of the resource.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Name of the resource.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Type of the resource 'Microsoft.Support/communications'.", - "type": "string", - "readOnly": true - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/CommunicationDetailsProperties", - "description": "Properties of the resource." - } - } - }, - "CommunicationDetailsProperties": { - "description": "Describes the properties of a communication resource.", - "required": [ - "subject", - "body" - ], - "type": "object", - "properties": { - "communicationType": { - "description": "Communication type.", - "enum": [ - "web", - "phone" - ], - "type": "string", - "x-ms-enum": { - "name": "CommunicationType", - "modelAsString": true - }, - "readOnly": true - }, - "communicationDirection": { - "description": "Direction of communication.", - "enum": [ - "inbound", - "outbound" - ], - "type": "string", - "x-ms-enum": { - "name": "CommunicationDirection", - "modelAsString": true - }, - "readOnly": true - }, - "sender": { - "description": "Email address of the sender. This property is required if called by a service principal.", - "type": "string" - }, - "subject": { - "description": "Subject of the communication.", - "type": "string" - }, - "body": { - "description": "Body of the communication.", - "type": "string" - }, - "createdDate": { - "format": "date-time", - "description": "Time in UTC (ISO 8601 format) when the communication was created.", - "type": "string", - "readOnly": true - } - } - }, - "SupportTicketDetailsProperties": { - "description": "Describes the properties of a support ticket.", - "required": [ - "serviceId", - "title", - "description", - "problemClassificationId", - "severity", - "contactDetails" - ], - "type": "object", - "properties": { - "supportTicketId": { - "description": "System generated support ticket Id that is unique.", - "type": "string" - }, - "description": { - "description": "Detailed description of the question or issue.", - "type": "string" - }, - "problemClassificationId": { - "description": "Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing.", - "type": "string" - }, - "problemClassificationDisplayName": { - "type": "string", - "description": "Localized name of problem classification.", - "readOnly": true - }, - "severity": { - "description": "A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers.", - "enum": [ - "minimal", - "moderate", - "critical", - "highestcriticalimpact" - ], - "type": "string", - "x-ms-enum": { - "name": "SeverityLevel", - "modelAsString": true - } - }, - "enrollmentId": { - "description": "Enrollment Id associated with the support ticket.", - "type": "string", - "readOnly": true - }, - "require24X7Response": { - "description": "Indicates if this requires a 24x7 response from Azure.", - "type": "boolean" - }, - "contactDetails": { - "$ref": "#/definitions/ContactProfile", - "description": "Contact information of the user requesting to create a support ticket." - }, - "serviceLevelAgreement": { - "$ref": "#/definitions/ServiceLevelAgreement", - "description": "Service Level Agreement information for this support ticket." - }, - "supportEngineer": { - "$ref": "#/definitions/SupportEngineer", - "description": "Information about the support engineer working on this support ticket." - }, - "supportPlanType": { - "description": "Support plan type associated with the support ticket.", - "type": "string", - "readOnly": true - }, - "title": { - "description": "Title of the support ticket.", - "type": "string" - }, - "problemStartTime": { - "format": "date-time", - "description": "Time in UTC (ISO 8601 format) when the problem started.", - "type": "string" - }, - "serviceId": { - "description": "This is the resource Id of the Azure service resource associated with the support ticket.", - "type": "string" - }, - "serviceDisplayName": { - "type": "string", - "description": "Localized name of the Azure service.", - "readOnly": true - }, - "status": { - "description": "Status of the support ticket.", - "type": "string", - "readOnly": true - }, - "createdDate": { - "format": "date-time", - "description": "Time in UTC (ISO 8601 format) when the support ticket was created.", - "type": "string", - "readOnly": true - }, - "modifiedDate": { - "format": "date-time", - "description": "Time in UTC (ISO 8601 format) when the support ticket was last modified.", - "type": "string", - "readOnly": true - }, - "technicalTicketDetails": { - "$ref": "#/definitions/TechnicalTicketDetails", - "description": "Additional ticket details associated with a technical support ticket request." - }, - "quotaTicketDetails": { - "$ref": "#/definitions/QuotaTicketDetails", - "description": "Additional ticket details associated with a quota support ticket request." - } - } - }, - "ServiceLevelAgreement": { - "description": "Service Level Agreement details for a support ticket.", - "type": "object", - "properties": { - "startTime": { - "format": "date-time", - "description": "Time in UTC (ISO 8601 format) when the service level agreement starts.", - "type": "string", - "readOnly": true - }, - "expirationTime": { - "format": "date-time", - "description": "Time in UTC (ISO 8601 format) when the service level agreement expires.", - "type": "string", - "readOnly": true - }, - "slaMinutes": { - "description": "Service Level Agreement in minutes.", - "type": "integer", - "format": "int32", - "readOnly": true - } - } - }, - "SupportEngineer": { - "description": "Support engineer information.", - "type": "object", - "properties": { - "emailAddress": { - "description": "Email address of the Azure Support engineer assigned to the support ticket.", - "type": "string", - "readOnly": true - } - } - }, - "ExceptionResponse": { - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/ServiceError", - "description": "The API error details." - } - }, - "description": "The API error." - }, - "ServiceError": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The error code." - }, - "message": { - "type": "string", - "description": "The error message." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceErrorDetail" - }, - "x-ms-identifiers": [], - "description": "The list of error details.", - "readOnly": true - } - }, - "description": "The API error details." - }, - "ServiceErrorDetail": { - "type": "object", - "properties": { - "code": { - "type": "string", - "readOnly": true, - "description": "The error code." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "The error message." - }, - "target": { - "type": "string", - "description": "The target of the error." - } - }, - "description": "The error details." - }, - "ContactProfile": { - "description": "Contact information associated with the support ticket.", - "required": [ - "firstName", - "lastName", - "preferredContactMethod", - "primaryEmailAddress", - "preferredTimeZone", - "country", - "preferredSupportLanguage" - ], - "type": "object", - "properties": { - "firstName": { - "description": "First name.", - "type": "string" - }, - "lastName": { - "description": "Last name.", - "type": "string" - }, - "preferredContactMethod": { - "description": "Preferred contact method.", - "enum": [ - "email", - "phone" - ], - "type": "string", - "x-ms-enum": { - "name": "PreferredContactMethod", - "modelAsString": true - } - }, - "primaryEmailAddress": { - "description": "Primary email address.", - "type": "string" - }, - "additionalEmailAddresses": { - "description": "Additional email addresses listed will be copied on any correspondence about the support ticket.", - "type": "array", - "items": { - "type": "string" - } - }, - "phoneNumber": { - "description": "Phone number. This is required if preferred contact method is phone.", - "type": "string" - }, - "preferredTimeZone": { - "description": "Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values).", - "type": "string" - }, - "country": { - "description": "Country of the user. This is the ISO 3166-1 alpha-3 code.", - "type": "string" - }, - "preferredSupportLanguage": { - "description": "Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German.", - "type": "string" - } - } - }, - "UpdateContactProfile": { - "description": "Contact information associated with the support ticket.", - "type": "object", - "properties": { - "firstName": { - "description": "First name.", - "type": "string" - }, - "lastName": { - "description": "Last name.", - "type": "string" - }, - "preferredContactMethod": { - "description": "Preferred contact method.", - "enum": [ - "email", - "phone" - ], - "type": "string", - "x-ms-enum": { - "name": "PreferredContactMethod", - "modelAsString": true - } - }, - "primaryEmailAddress": { - "description": "Primary email address.", - "type": "string" - }, - "additionalEmailAddresses": { - "description": "Email addresses listed will be copied on any correspondence about the support ticket.", - "type": "array", - "items": { - "type": "string" - } - }, - "phoneNumber": { - "description": "Phone number. This is required if preferred contact method is phone.", - "type": "string" - }, - "preferredTimeZone": { - "description": "Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values).", - "type": "string" - }, - "country": { - "description": "Country of the user. This is the ISO 3166-1 alpha-3 code.", - "type": "string" - }, - "preferredSupportLanguage": { - "description": "Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response/). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German.", - "type": "string" - } - } - }, - "TechnicalTicketDetails": { - "description": "Additional information for technical support ticket.", - "type": "object", - "properties": { - "resourceId": { - "description": "This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created.", - "type": "string" - } - } - }, - "QuotaTicketDetails": { - "description": "Additional set of information required for quota increase support ticket for certain quota types, e.g.: Virtual machine cores. Get complete details about Quota payload support request along with examples at [Support quota request](https://aka.ms/supportrpquotarequestpayload).", - "type": "object", - "properties": { - "quotaChangeRequestSubType": { - "description": "Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase.", - "type": "string" - }, - "quotaChangeRequestVersion": { - "description": "Quota change request version.", - "type": "string" - }, - "quotaChangeRequests": { - "description": "This property is required for providing the region and new quota limits.", - "type": "array", - "items": { - "$ref": "#/definitions/QuotaChangeRequest" - }, - "x-ms-identifiers": [ - "region" - ] - } - } - }, - "QuotaChangeRequest": { - "description": "This property is required for providing the region and new quota limits.", - "type": "object", - "properties": { - "region": { - "description": "Region for which the quota increase request is being made.", - "type": "string" - }, - "payload": { - "description": "Payload of the quota increase request.", - "type": "string" - } - } - }, - "UpdateSupportTicket": { - "description": "Updates severity, ticket status, and contact details in the support ticket.", - "type": "object", - "properties": { - "severity": { - "description": "Severity level.", - "enum": [ - "minimal", - "moderate", - "critical", - "highestcriticalimpact" - ], - "type": "string", - "x-ms-enum": { - "name": "SeverityLevel", - "modelAsString": true - } - }, - "status": { - "description": "Status to be updated on the ticket.", - "enum": [ - "open", - "closed" - ], - "type": "string", - "x-ms-enum": { - "name": "Status", - "modelAsString": true - } - }, - "contactDetails": { - "$ref": "#/definitions/UpdateContactProfile", - "description": "Contact details to be updated on the support ticket." - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Azure subscription Id." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "API version." - } - } -} diff --git a/swagger-specs/support/resource-manager/Microsoft.Support/stable/2024-04-01/support.json b/swagger-specs/support/resource-manager/Microsoft.Support/stable/2024-04-01/support.json new file mode 100644 index 000000000..169b4c6b3 --- /dev/null +++ b/swagger-specs/support/resource-manager/Microsoft.Support/stable/2024-04-01/support.json @@ -0,0 +1,3075 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-04-01", + "title": "Microsoft.Support", + "description": "Microsoft Azure Support Resource Provider." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "paths": { + "/providers/Microsoft.Support/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "This lists all the available Microsoft Support REST API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of operations.", + "schema": { + "$ref": "#/definitions/OperationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Get all operations": { + "$ref": "./examples/ListOperations.json" + } + } + } + }, + "/providers/Microsoft.Support/services": { + "get": { + "tags": [ + "Services" + ], + "description": "Lists all the Azure services available for support ticket creation. For **Technical** issues, select the Service Id that maps to the Azure service/product as displayed in the **Services** drop-down list on the Azure portal's [New support request](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview) page. Always use the service and its corresponding problem classification(s) obtained programmatically for support ticket creation. This practice ensures that you always have the most recent set of service and problem classification Ids.", + "operationId": "Services_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of the Azure services available for support.", + "schema": { + "$ref": "#/definitions/ServicesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Gets list of services for which a support ticket can be created": { + "$ref": "./examples/ListServices.json" + } + } + } + }, + "/providers/Microsoft.Support/services/{serviceName}": { + "get": { + "tags": [ + "Services" + ], + "description": "Gets a specific Azure service for support ticket creation.", + "operationId": "Services_Get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "Name of the Azure service.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Azure service for support ticket creation.", + "schema": { + "$ref": "#/definitions/Service" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets details of the Azure service": { + "$ref": "./examples/GetService.json" + } + } + } + }, + "/providers/Microsoft.Support/services/{serviceName}/problemClassifications": { + "get": { + "tags": [ + "ProblemClassifications" + ], + "description": "Lists all the problem classifications (categories) available for a specific Azure service. Always use the service and problem classifications obtained programmatically. This practice ensures that you always have the most recent set of service and problem classification Ids.", + "operationId": "ProblemClassifications_List", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "Name of the Azure service for which the problem classifications need to be retrieved.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of problem classifications for the specified Azure service.", + "schema": { + "$ref": "#/definitions/ProblemClassificationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Gets list of problemClassifications for a service for which a support ticket can be created": { + "$ref": "./examples/ListProblemClassifications.json" + } + } + } + }, + "/providers/Microsoft.Support/services/{serviceName}/problemClassifications/{problemClassificationName}": { + "get": { + "tags": [ + "ProblemClassifications" + ], + "description": "Get problem classification details for a specific Azure service.", + "operationId": "ProblemClassifications_Get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "Name of the Azure service available for support.", + "required": true, + "type": "string" + }, + { + "name": "problemClassificationName", + "in": "path", + "description": "Name of problem classification.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved problem classification details.", + "schema": { + "$ref": "#/definitions/ProblemClassification" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets details of problemClassification for Azure service": { + "$ref": "./examples/GetProblemClassification.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Support/checkNameAvailability": { + "post": { + "tags": [ + "SupportTickets" + ], + "description": "Check the availability of a resource name. This API should be used to check the uniqueness of the name for support ticket creation for the selected subscription.", + "operationId": "SupportTickets_CheckNameAvailability", + "x-ms-examples": { + "Checks whether name is available for a subscription support ticket resource": { + "$ref": "./examples/CheckNameAvailabilityWithSubscription.json" + } + }, + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Support/checkNameAvailability": { + "post": { + "tags": [ + "SupportTickets" + ], + "description": "Check the availability of a resource name. This API should be used to check the uniqueness of the name for support ticket creation for the selected subscription.", + "operationId": "SupportTicketsNoSubscription_CheckNameAvailability", + "x-ms-examples": { + "Checks whether name is available for SupportTicket resource": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets": { + "get": { + "tags": [ + "SupportTickets" + ], + "description": "Lists all the support tickets for an Azure subscription. You can also filter the support tickets by _Status_, _CreatedDate_, _ServiceId_, and _ProblemClassificationId_ using the $filter parameter. Output will be a paged result with _nextLink_, using which you can retrieve the next set of support tickets.

Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", + "operationId": "SupportTickets_List", + "parameters": [ + { + "name": "$top", + "in": "query", + "description": "The number of values to return in the collection. Default is 25 and max is 100.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. We support 'odata v4.0' filter semantics. [Learn more](https://docs.microsoft.com/odata/concepts/queryoptions-overview). _Status_, _ServiceId_, and _ProblemClassificationId_ filters can only be used with Equals ('eq') operator. For _CreatedDate_ filter, the supported operators are Greater Than ('gt') and Greater Than or Equals ('ge'). When using both filters, combine them using the logical 'AND'." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved support tickets.", + "schema": { + "$ref": "#/definitions/SupportTicketsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List support tickets for a subscription": { + "$ref": "./examples/ListSupportTicketsBySubscription.json" + }, + "List support tickets in open state for a subscription": { + "$ref": "./examples/ListSupportTicketsInOpenStateBySubscription.json" + }, + "List support tickets created on or after a certain date and in open state for a subscription": { + "$ref": "./examples/ListSupportTicketsCreatedOnOrAfterAndInOpenStateBySubscription.json" + }, + "List support tickets in updating state for a subscription": { + "$ref": "./examples/ListSupportTicketsInUpdatingStateBySubscription.json" + }, + "List support tickets created on or after a certain date and in updating state for a subscription": { + "$ref": "./examples/ListSupportTicketsCreatedOnOrAfterAndInUpdatingStateBySubscription.json" + }, + "List support tickets with a certain service id for a subscription": { + "$ref": "./examples/ListSupportTicketsServiceIdEqualsForSubscription.json" + }, + "List support tickets with a certain problem classification id for a subscription": { + "$ref": "./examples/ListSupportTicketsProblemClassificationIdEqualsForSubscription.json" + } + } + } + }, + "/providers/Microsoft.Support/supportTickets": { + "get": { + "tags": [ + "SupportTickets" + ], + "description": "Lists all the support tickets.

You can also filter the support tickets by Status, CreatedDate, , ServiceId, and ProblemClassificationId using the $filter parameter. Output will be a paged result with nextLink, using which you can retrieve the next set of support tickets.

Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", + "operationId": "SupportTicketsNoSubscription_List", + "parameters": [ + { + "name": "$top", + "in": "query", + "description": "The number of values to return in the collection. Default is 25 and max is 100.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. We support 'odata v4.0' filter semantics. Learn more
Status , ServiceId, and ProblemClassificationId filters can only be used with 'eq' operator. For CreatedDate filter, the supported operators are 'gt' and 'ge'. When using both filters, combine them using the logical 'AND'." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved support tickets.", + "schema": { + "$ref": "#/definitions/SupportTicketsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List support tickets": { + "$ref": "./examples/ListSupportTickets.json" + }, + "List support tickets in open state": { + "$ref": "./examples/ListSupportTicketsInOpenState.json" + }, + "List support tickets created on or after a certain date and in open state": { + "$ref": "./examples/ListSupportTicketsCreatedOnOrAfterAndInOpenState.json" + }, + "List support tickets in updating state": { + "$ref": "./examples/ListSupportTicketsInUpdatingState.json" + }, + "List support tickets created on or after a certain date and in updating state": { + "$ref": "./examples/ListSupportTicketsCreatedOnOrAfterAndInUpdatingState.json" + }, + "List support tickets with a certain service id": { + "$ref": "./examples/ListSupportTicketsServiceIdEquals.json" + }, + "List support tickets with a certain problem classification id": { + "$ref": "./examples/ListSupportTicketsProblemClassificationIdEquals.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}": { + "get": { + "tags": [ + "SupportTickets" + ], + "description": "Get ticket details for an Azure subscription. Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", + "operationId": "SupportTickets_Get", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved support ticket.", + "schema": { + "$ref": "#/definitions/SupportTicketDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of a subscription ticket": { + "$ref": "./examples/GetSubscriptionSupportTicketDetails.json" + } + } + }, + "patch": { + "tags": [ + "SupportTickets" + ], + "description": "This API allows you to update the severity level, ticket status, advanced diagnostic consent and your contact information in the support ticket.

Note: The severity levels cannot be changed if a support ticket is actively being worked upon by an Azure support engineer. In such a case, contact your support engineer to request severity update by adding a new communication using the Communications API.", + "operationId": "SupportTickets_Update", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "name": "updateSupportTicket", + "in": "body", + "description": "UpdateSupportTicket object.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateSupportTicket" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated support ticket.", + "schema": { + "$ref": "#/definitions/SupportTicketDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update severity of a subscription support ticket": { + "$ref": "./examples/UpdateSeverityOfSupportTicketForSubscription.json" + }, + "Update contact details of a subscription support ticket": { + "$ref": "./examples/UpdateContactDetailsOfSupportTicketForSubscription.json" + }, + "Update status of a subscription support ticket": { + "$ref": "./examples/UpdateStatusOfSupportTicketForSubscription.json" + }, + "Update advanced diagnostic consent of a subscription support ticket": { + "$ref": "./examples/UpdateAdvancedDiagnosticConsentOfSupportTicketForSubscription.json" + } + } + }, + "put": { + "tags": [ + "SupportTickets" + ], + "description": "Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription. Learn the [prerequisites](https://aka.ms/supportAPI) required to create a support ticket.

Always call the Services and ProblemClassifications API to get the most recent set of services and problem categories required for support ticket creation.

Adding attachments is not currently supported via the API. To add a file to an existing support ticket, visit the [Manage support ticket](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest) page in the Azure portal, select the support ticket, and use the file upload control to add a new file.

Providing consent to share diagnostic information with Azure support is currently not supported via the API. The Azure support engineer working on your ticket will reach out to you for consent if your issue requires gathering diagnostic information from your Azure resources.

**Creating a support ticket for on-behalf-of**: Include _x-ms-authorization-auxiliary_ header to provide an auxiliary token as per [documentation](https://docs.microsoft.com/azure/azure-resource-manager/management/authenticate-multi-tenant). The primary token will be from the tenant for whom a support ticket is being raised against the subscription, i.e. Cloud solution provider (CSP) customer tenant. The auxiliary token will be from the Cloud solution provider (CSP) partner tenant.", + "operationId": "SupportTickets_Create", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "name": "createSupportTicketParameters", + "in": "body", + "description": "Support ticket request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/SupportTicketDetails" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - SupportTicket created successfully.", + "schema": { + "$ref": "#/definitions/SupportTicketDetails" + } + }, + "202": { + "description": "Accepted, SupportTicket will be created asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create a ticket for Billing related issues": { + "$ref": "./examples/CreateBillingSupportTicketForSubscription.json" + }, + "Create a ticket for Subscription Management related issues for a subscription": { + "$ref": "./examples/CreateSubMgmtSupportTicketForSubscription.json" + }, + "Create a ticket for Technical issue related to a specific resource for a subscription": { + "$ref": "./examples/CreateTechnicalSupportTicketForSubscription.json" + }, + "Create a ticket to request Quota increase for Compute VM Cores": { + "$ref": "./examples/CreateCoresQuotaTicketForSubscription.json" + }, + "Create a ticket to request Quota increase for Low-priority cores for a Batch account": { + "$ref": "./examples/CreateBatchQuotaTicketForSpecificBatchAccountForLowPriorityCores.json" + }, + "Create a ticket to request Quota increase for specific VM family cores for a Batch account": { + "$ref": "./examples/CreateBatchQuotaTicketForSpecificBatchAccountForDedicatedCores.json" + }, + "Create a ticket to request Quota increase for Pools for a Batch account": { + "$ref": "./examples/CreateBatchQuotaTicketForSpecificBatchAccountForPools.json" + }, + "Create a ticket to request Quota increase for Active Jobs and Job Schedules for a Batch account": { + "$ref": "./examples/CreateBatchQuotaTicketForSpecificBatchAccountForActiveJobs.json" + }, + "Create a ticket to request Quota increase for Batch accounts for a subscription": { + "$ref": "./examples/CreateBatchQuotaTicketForSubscription.json" + }, + "Create a ticket to request Quota increase for DTUs for SQL Database": { + "$ref": "./examples/CreateSqlDatabaseQuotaTicketForDTUs.json" + }, + "Create a ticket to request Quota increase for Servers for SQL Database": { + "$ref": "./examples/CreateSqlDatabaseQuotaTicketForServers.json" + }, + "Create a ticket to request Quota increase for DTUs for Azure Synapse Analytics": { + "$ref": "./examples/CreateSqlDatawarehouseQuotaTicketForDTUs.json" + }, + "Create a ticket to request Quota increase for Servers for Azure Synapse Analytics": { + "$ref": "./examples/CreateSqlDatawarehouseQuotaTicketForServers.json" + }, + "Create a ticket to request Quota increase for specific VM family cores for Machine Learning service": { + "$ref": "./examples/CreateMachineLearningQuotaTicketForDedicatedCores.json" + }, + "Create a ticket to request Quota increase for Low-priority cores for Machine Learning service": { + "$ref": "./examples/CreateMachineLearningQuotaTicketForLowPriorityCores.json" + }, + "Create a ticket to request Quota increase for Azure SQL managed instance": { + "$ref": "./examples/CreateSqlManagedInstanceQuotaTicket.json" + }, + "Create a ticket to request Quota increase for services that do not require additional details in the quotaTicketDetails object": { + "$ref": "./examples/CreateGenericQuotaTicket.json" + } + } + } + }, + "/providers/Microsoft.Support/supportTickets/{supportTicketName}": { + "get": { + "tags": [ + "SupportTickets" + ], + "description": "Gets details for a specific support ticket. Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", + "operationId": "SupportTicketsNoSubscription_Get", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved support ticket.", + "schema": { + "$ref": "#/definitions/SupportTicketDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of a ticket": { + "$ref": "./examples/GetSupportTicketDetails.json" + } + } + }, + "patch": { + "tags": [ + "SupportTickets" + ], + "description": "This API allows you to update the severity level, ticket status, and your contact information in the support ticket.

Note: The severity levels cannot be changed if a support ticket is actively being worked upon by an Azure support engineer. In such a case, contact your support engineer to request severity update by adding a new communication using the Communications API.", + "operationId": "SupportTicketsNoSubscription_Update", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "name": "updateSupportTicket", + "in": "body", + "description": "UpdateSupportTicket object.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateSupportTicket" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated support ticket.", + "schema": { + "$ref": "#/definitions/SupportTicketDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update severity of a support ticket": { + "$ref": "./examples/UpdateSeverityOfSupportTicket.json" + }, + "Update contact details of a support ticket": { + "$ref": "./examples/UpdateContactDetailsOfSupportTicket.json" + }, + "Update status of a support ticket": { + "$ref": "./examples/UpdateStatusOfSupportTicket.json" + }, + "Update advanced diagnostic consent of a support ticket": { + "$ref": "./examples/UpdateAdvancedDiagnosticConsentOfSupportTicket.json" + } + } + }, + "put": { + "tags": [ + "SupportTickets" + ], + "description": "Creates a new support ticket for Billing, and Subscription Management issues. Learn the [prerequisites](https://aka.ms/supportAPI) required to create a support ticket.

Always call the Services and ProblemClassifications API to get the most recent set of services and problem categories required for support ticket creation.

Adding attachments is not currently supported via the API. To add a file to an existing support ticket, visit the [Manage support ticket](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest) page in the Azure portal, select the support ticket, and use the file upload control to add a new file.

Providing consent to share diagnostic information with Azure support is currently not supported via the API. The Azure support engineer working on your ticket will reach out to you for consent if your issue requires gathering diagnostic information from your Azure resources.

", + "operationId": "SupportTicketsNoSubscription_Create", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "name": "createSupportTicketParameters", + "in": "body", + "description": "Support ticket request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/SupportTicketDetails" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - SupportTicket created successfully.", + "schema": { + "$ref": "#/definitions/SupportTicketDetails" + } + }, + "202": { + "description": "Accepted, SupportTicket will be created asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create a ticket for Billing related issues": { + "$ref": "./examples/CreateBillingSupportTicket.json" + }, + "Create a ticket for Subscription Management related issues": { + "$ref": "./examples/CreateSubMgmtSupportTicket.json" + }, + "Create a ticket for Technical issue related to a specific resource": { + "$ref": "./examples/CreateTechnicalSupportTicket.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/checkNameAvailability": { + "post": { + "tags": [ + "Communications" + ], + "description": "Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.", + "operationId": "Communications_CheckNameAvailability", + "x-ms-examples": { + "Checks whether name is available for Communication resource for a subscription support ticket": { + "$ref": "./examples/CheckNameAvailabilityForSupportTicketCommunication.json" + } + }, + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Support/supportTickets/{supportTicketName}/checkNameAvailability": { + "post": { + "tags": [ + "Communications" + ], + "description": "Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.", + "operationId": "CommunicationsNoSubscription_CheckNameAvailability", + "x-ms-examples": { + "Checks whether name is available for Communication resource": { + "$ref": "./examples/CheckNameAvailabilityForNoSubscriptionSupportTicketCommunication.json" + } + }, + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications": { + "get": { + "tags": [ + "Communications" + ], + "description": "Lists all communications (attachments not included) for a support ticket.

You can also filter support ticket communications by _CreatedDate_ or _CommunicationType_ using the $filter parameter. The only type of communication supported today is _Web_. Output will be a paged result with _nextLink_, using which you can retrieve the next set of Communication results.

Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", + "operationId": "Communications_List", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The number of values to return in the collection. Default is 10 and max is 10.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. You can filter by communicationType and createdDate properties. CommunicationType supports Equals ('eq') operator and createdDate supports Greater Than ('gt') and Greater Than or Equals ('ge') operators. You may combine the CommunicationType and CreatedDate filters by Logical And ('and') operator." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved communications for a support ticket.", + "schema": { + "$ref": "#/definitions/CommunicationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List communications for a subscription support ticket": { + "$ref": "./examples/ListCommunicationsForSubscriptionSupportTicket.json" + }, + "List web communications for a subscription support ticket": { + "$ref": "./examples/ListWebCommunicationsForSubscriptionSupportTicket.json" + }, + "List web communication created on or after a specific date for a subscription support ticket": { + "$ref": "./examples/ListWebCommunicationsForSubscriptionSupportTicketCreatedOnOrAfter.json" + } + } + } + }, + "/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications": { + "get": { + "tags": [ + "Communications" + ], + "description": "Lists all communications (attachments not included) for a support ticket.

You can also filter support ticket communications by _CreatedDate_ or _CommunicationType_ using the $filter parameter. The only type of communication supported today is _Web_. Output will be a paged result with _nextLink_, using which you can retrieve the next set of Communication results.

Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", + "operationId": "CommunicationsNoSubscription_List", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name", + "required": true, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The number of values to return in the collection. Default is 10 and max is 10.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. You can filter by communicationType and createdDate properties. CommunicationType supports Equals ('eq') operator and createdDate supports Greater Than ('gt') and Greater Than or Equals ('ge') operators. You may combine the CommunicationType and CreatedDate filters by Logical And ('and') operator." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved communications for a support ticket.", + "schema": { + "$ref": "#/definitions/CommunicationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List communications for a no-subscription support ticket": { + "$ref": "./examples/ListCommunicationsForSupportTicket.json" + }, + "List web communications for a no-subscription support ticket": { + "$ref": "./examples/ListWebCommunicationsForSupportTicket.json" + }, + "List web communication created on or after a specific date for a no-subscription support ticket": { + "$ref": "./examples/ListWebCommunicationsForSupportTicketCreatedOnOrAfter.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}": { + "get": { + "tags": [ + "Communications" + ], + "description": "Returns communication details for a support ticket.", + "operationId": "Communications_Get", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "name": "communicationName", + "in": "path", + "description": "Communication name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved communication details.", + "schema": { + "$ref": "#/definitions/CommunicationDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get communication details for a subscription support ticket": { + "$ref": "./examples/GetCommunicationDetailsForSubscriptionSupportTicket.json" + } + } + }, + "put": { + "tags": [ + "Communications" + ], + "description": "Adds a new customer communication to an Azure support ticket.", + "operationId": "Communications_Create", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "name": "communicationName", + "in": "path", + "description": "Communication name.", + "required": true, + "type": "string" + }, + { + "name": "createCommunicationParameters", + "in": "body", + "description": "Communication object.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunicationDetails" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Communication created successfully.", + "schema": { + "$ref": "#/definitions/CommunicationDetails" + } + }, + "202": { + "description": "Accepted - Communication will be created asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "AddCommunicationToSubscriptionTicket": { + "$ref": "./examples/CreateSupportTicketCommunication.json" + } + } + } + }, + "/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}": { + "get": { + "tags": [ + "Communications" + ], + "description": "Returns communication details for a support ticket.", + "operationId": "CommunicationsNoSubscription_Get", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "name": "communicationName", + "in": "path", + "description": "Communication name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved communication details.", + "schema": { + "$ref": "#/definitions/CommunicationDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get communication details for a no-subscription support ticket": { + "$ref": "./examples/GetCommunicationDetailsForSupportTicket.json" + } + } + }, + "put": { + "tags": [ + "Communications" + ], + "description": "Adds a new customer communication to an Azure support ticket.", + "operationId": "CommunicationsNoSubscription_Create", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "name": "communicationName", + "in": "path", + "description": "Communication name.", + "required": true, + "type": "string" + }, + { + "name": "createCommunicationParameters", + "in": "body", + "description": "Communication object.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunicationDetails" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Communication created successfully.", + "schema": { + "$ref": "#/definitions/CommunicationDetails" + } + }, + "202": { + "description": "Accepted - Communication will be created asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "AddCommunicationToNoSubscriptionTicket": { + "$ref": "./examples/CreateNoSubscriptionSupportTicketCommunication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts": { + "get": { + "tags": [ + "ChatTranscripts" + ], + "description": "Lists all chat transcripts for a support ticket under subscription", + "operationId": "ChatTranscripts_List", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved chat transcripts for a support ticket under a subscription.", + "schema": { + "$ref": "#/definitions/ChatTranscriptsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List chat transcripts for a subscription support ticket": { + "$ref": "./examples/ListChatTranscriptsForSubscriptionSupportTicket.json" + } + } + } + }, + "/providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts": { + "get": { + "tags": [ + "ChatTranscripts" + ], + "description": "Lists all chat transcripts for a support ticket", + "operationId": "ChatTranscriptsNoSubscription_List", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved chat transcripts for a support ticket.", + "schema": { + "$ref": "#/definitions/ChatTranscriptsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List chat transcripts for a no-subscription support ticket": { + "$ref": "./examples/ListChatTranscriptsForSupportTicket.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts/{chatTranscriptName}": { + "get": { + "tags": [ + "ChatTranscripts" + ], + "description": "Returns chatTranscript details for a support ticket under a subscription.", + "operationId": "ChatTranscripts_Get", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "name": "chatTranscriptName", + "in": "path", + "description": "ChatTranscript name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved chat transcript details for a subscription ticket.", + "schema": { + "$ref": "#/definitions/ChatTranscriptDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get chat transcript details for a subscription support ticket": { + "$ref": "./examples/GetchatTranscriptDetailsForSubscriptionSupportTicket.json" + } + } + } + }, + "/providers/Microsoft.Support/supportTickets/{supportTicketName}/chatTranscripts/{chatTranscriptName}": { + "get": { + "tags": [ + "chatTranscripts" + ], + "description": "Returns chatTranscript details for a no subscription support ticket.", + "operationId": "ChatTranscriptsNoSubscription_Get", + "parameters": [ + { + "name": "supportTicketName", + "in": "path", + "description": "Support ticket name.", + "required": true, + "type": "string" + }, + { + "name": "chatTranscriptName", + "in": "path", + "description": "ChatTranscript name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved chat transcript details.", + "schema": { + "$ref": "#/definitions/ChatTranscriptDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get chat transcript details for a subscription support ticket": { + "$ref": "./examples/GetchatTranscriptDetailsForSupportTicket.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}": { + "get": { + "tags": [ + "FileWorkspaces" + ], + "description": "Gets details for a specific file workspace in an Azure subscription.", + "operationId": "FileWorkspaces_Get", + "parameters": [ + { + "name": "fileWorkspaceName", + "in": "path", + "description": "File Workspace Name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved file workspace.", + "schema": { + "$ref": "#/definitions/FileWorkspaceDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of a subscription file workspace": { + "$ref": "./examples/GetFileWorkspaceDetailsForSubscription.json" + } + } + }, + "put": { + "tags": [ + "FileWorkspaces" + ], + "description": "Creates a new file workspace for the specified subscription.", + "operationId": "FileWorkspaces_Create", + "parameters": [ + { + "name": "fileWorkspaceName", + "in": "path", + "description": "File workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z_\\-. ]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - File workspace created successfully", + "schema": { + "$ref": "#/definitions/FileWorkspaceDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a file workspace for a subscription": { + "$ref": "./examples/CreateFileWorkspaceForSubscription.json" + } + } + } + }, + "/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}": { + "get": { + "tags": [ + "FileWorkspaces" + ], + "description": "Gets details for a specific file workspace.", + "operationId": "FileWorkspacesNoSubscription_Get", + "parameters": [ + { + "name": "fileWorkspaceName", + "in": "path", + "description": "File Workspace Name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved file workspace.", + "schema": { + "$ref": "#/definitions/FileWorkspaceDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of a file workspace": { + "$ref": "./examples/GetFileWorkspaceDetails.json" + } + } + }, + "put": { + "tags": [ + "FileWorkspaces" + ], + "description": "Creates a new file workspace.", + "operationId": "FileWorkspacesNoSubscription_Create", + "parameters": [ + { + "name": "fileWorkspaceName", + "in": "path", + "description": "File workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z_\\-. ]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - File workspace created successfully", + "schema": { + "$ref": "#/definitions/FileWorkspaceDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a file workspace": { + "$ref": "./examples/CreateFileWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files": { + "get": { + "tags": [ + "Files" + ], + "description": "Lists all the Files information under a workspace for an Azure subscription.", + "operationId": "Files_List", + "parameters": [ + { + "name": "fileWorkspaceName", + "in": "path", + "description": "File Workspace Name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved files under a file workspace.", + "schema": { + "$ref": "#/definitions/FilesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List files under a workspace for a subscription": { + "$ref": "./examples/ListFilesForSubscriptionUnderFileWorkspace.json" + } + } + } + }, + "/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files": { + "get": { + "tags": [ + "Files" + ], + "description": "Lists all the Files information under a workspace for an Azure subscription.", + "operationId": "FilesNoSubscription_List", + "parameters": [ + { + "name": "fileWorkspaceName", + "in": "path", + "description": "File Workspace Name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved files under a file workspace.", + "schema": { + "$ref": "#/definitions/FilesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List files under a workspace": { + "$ref": "./examples/ListFilesUnderFileWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}": { + "get": { + "tags": [ + "Files" + ], + "description": "Returns details of a specific file in a work space.", + "operationId": "Files_Get", + "parameters": [ + { + "name": "fileWorkspaceName", + "in": "path", + "description": "File Workspace Name", + "required": true, + "type": "string" + }, + { + "name": "fileName", + "in": "path", + "description": "File Name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved file details.", + "schema": { + "$ref": "#/definitions/FileDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of a subscription file": { + "$ref": "./examples/GetFileDetailsForSubscription.json" + } + } + }, + "put": { + "tags": [ + "Files" + ], + "description": "Creates a new file under a workspace for the specified subscription.", + "operationId": "Files_Create", + "parameters": [ + { + "name": "fileWorkspaceName", + "in": "path", + "description": "File workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z_\\-. ]+$" + }, + { + "name": "fileName", + "in": "path", + "description": "File name.", + "required": true, + "type": "string" + }, + { + "name": "createFileParameters", + "in": "body", + "description": "Create file object", + "required": true, + "schema": { + "$ref": "#/definitions/FileDetails" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - File created successfully", + "schema": { + "$ref": "#/definitions/FileDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a file under a subscription workspace": { + "$ref": "./examples/CreateFileForSubscription.json" + } + } + } + }, + "/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}": { + "get": { + "tags": [ + "Files" + ], + "description": "Returns details of a specific file in a work space.", + "operationId": "FilesNoSubscription_Get", + "parameters": [ + { + "name": "fileWorkspaceName", + "in": "path", + "description": "File Workspace Name", + "required": true, + "type": "string" + }, + { + "name": "fileName", + "in": "path", + "description": "File Name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved file details.", + "schema": { + "$ref": "#/definitions/FileDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of a subscription file": { + "$ref": "./examples/GetFileDetails.json" + } + } + }, + "put": { + "tags": [ + "Files" + ], + "description": "Creates a new file under a workspace.", + "operationId": "FilesNoSubscription_Create", + "parameters": [ + { + "name": "fileWorkspaceName", + "in": "path", + "description": "File workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z_\\-. ]+$" + }, + { + "name": "fileName", + "in": "path", + "description": "File name.", + "required": true, + "type": "string" + }, + { + "name": "createFileParameters", + "in": "body", + "description": "Create file object", + "required": true, + "schema": { + "$ref": "#/definitions/FileDetails" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - File created successfully", + "schema": { + "$ref": "#/definitions/FileDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a file workspace": { + "$ref": "./examples/CreateFile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}/upload": { + "post": { + "tags": [ + "Files" + ], + "description": "This API allows you to upload content to a file", + "operationId": "Files_Upload", + "parameters": [ + { + "name": "fileWorkspaceName", + "in": "path", + "description": "File WorkspaceName", + "required": true, + "type": "string" + }, + { + "name": "fileName", + "in": "path", + "description": "File Name", + "required": true, + "type": "string" + }, + { + "name": "uploadFile", + "in": "body", + "description": "UploadFile object", + "required": true, + "schema": { + "$ref": "#/definitions/UploadFile" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Successfully uploaded file content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UploadFileForSubscription": { + "$ref": "./examples/UploadFileForSubscription.json" + } + } + } + }, + "/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}/upload": { + "post": { + "tags": [ + "Files" + ], + "description": "This API allows you to upload content to a file", + "operationId": "FilesNoSubscription_Upload", + "parameters": [ + { + "name": "fileWorkspaceName", + "in": "path", + "description": "File WorkspaceName", + "required": true, + "type": "string" + }, + { + "name": "fileName", + "in": "path", + "description": "File Name", + "required": true, + "type": "string" + }, + { + "name": "uploadFile", + "in": "body", + "description": "UploadFile object", + "required": true, + "schema": { + "$ref": "#/definitions/UploadFile" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Successfully uploaded file content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UploadFile": { + "$ref": "./examples/UploadFile.json" + } + } + } + } + }, + "definitions": { + "OperationsListResult": { + "description": "The list of operations supported by Microsoft Support resource provider.", + "properties": { + "value": { + "description": "The list of operations supported by Microsoft Support resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Operation": { + "description": "The operation supported by Microsoft Support resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "The object that describes the operation.", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The action that users can perform, based on their permission level.", + "type": "string", + "readOnly": true + }, + "provider": { + "description": "Service provider: Microsoft Support.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "ServicesListResult": { + "description": "Collection of Service resources.", + "type": "object", + "properties": { + "value": { + "description": "List of Service resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Service" + } + } + } + }, + "Service": { + "description": "Object that represents a Service resource.", + "type": "object", + "properties": { + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the resource 'Microsoft.Support/services'.", + "type": "string", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceProperties", + "description": "Properties of the resource." + } + } + }, + "ServiceProperties": { + "description": "Details about an Azure service available for support ticket creation.", + "type": "object", + "properties": { + "displayName": { + "description": "Localized name of the Azure service.", + "type": "string" + }, + "resourceTypes": { + "description": "ARM Resource types.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProblemClassificationsListResult": { + "description": "Collection of ProblemClassification resources.", + "type": "object", + "properties": { + "value": { + "description": "List of ProblemClassification resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProblemClassification" + } + } + } + }, + "ProblemClassification": { + "description": "ProblemClassification resource object.", + "type": "object", + "properties": { + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the resource 'Microsoft.Support/problemClassification'.", + "type": "string", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProblemClassificationProperties", + "description": "Properties of the resource." + } + } + }, + "ProblemClassificationProperties": { + "description": "Details about a problem classification available for an Azure service.", + "type": "object", + "properties": { + "displayName": { + "description": "Localized name of problem classification.", + "type": "string" + }, + "secondaryConsentEnabled": { + "description": "This property indicates whether secondary consent is present for problem classification", + "type": "array", + "items": { + "$ref": "#/definitions/SecondaryConsentEnabled" + }, + "x-ms-identifiers": [] + } + } + }, + "SecondaryConsentEnabled": { + "description": "This property indicates whether secondary consent is present for problem classification.", + "type": "object", + "properties": { + "description": { + "description": "User consent description.", + "type": "string" + }, + "type": { + "description": "The Azure service for which secondary consent is needed for case creation.", + "type": "string" + } + } + }, + "CheckNameAvailabilityInput": { + "description": "Input of CheckNameAvailability API.", + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The resource name to validate.", + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Support/supportTickets", + "Microsoft.Support/communications" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource." + } + } + }, + "CheckNameAvailabilityOutput": { + "description": "Output of check name availability API.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available.", + "readOnly": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why the name is not available.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the name is not available.", + "readOnly": true, + "type": "string" + } + } + }, + "SupportTicketsListResult": { + "description": "Object that represents a collection of SupportTicket resources.", + "type": "object", + "properties": { + "value": { + "description": "List of SupportTicket resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SupportTicketDetails" + } + }, + "nextLink": { + "description": "The URI to fetch the next page of SupportTicket resources.", + "type": "string" + } + } + }, + "SupportTicketDetails": { + "x-ms-azure-resource": true, + "description": "Object that represents SupportTicketDetails resource.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the resource 'Microsoft.Support/supportTickets'.", + "type": "string", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SupportTicketDetailsProperties", + "description": "Properties of the resource." + } + } + }, + "CommunicationsListResult": { + "description": "Collection of Communication resources.", + "type": "object", + "properties": { + "value": { + "description": "List of Communication resources.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationDetails" + } + }, + "nextLink": { + "description": "The URI to fetch the next page of Communication resources.", + "type": "string" + } + } + }, + "CommunicationDetails": { + "x-ms-azure-resource": true, + "description": "Object that represents a Communication resource.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the resource 'Microsoft.Support/communications'.", + "type": "string", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommunicationDetailsProperties", + "description": "Properties of the resource." + } + } + }, + "CommunicationDetailsProperties": { + "description": "Describes the properties of a communication resource.", + "required": [ + "subject", + "body" + ], + "type": "object", + "properties": { + "communicationType": { + "description": "Communication type.", + "enum": [ + "web", + "phone" + ], + "type": "string", + "x-ms-enum": { + "name": "CommunicationType", + "modelAsString": true + }, + "readOnly": true + }, + "communicationDirection": { + "description": "Direction of communication.", + "enum": [ + "inbound", + "outbound" + ], + "type": "string", + "x-ms-enum": { + "name": "CommunicationDirection", + "modelAsString": true + }, + "readOnly": true + }, + "sender": { + "description": "Email address of the sender. This property is required if called by a service principal.", + "type": "string" + }, + "subject": { + "description": "Subject of the communication.", + "type": "string" + }, + "body": { + "description": "Body of the communication.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "Time in UTC (ISO 8601 format) when the communication was created.", + "type": "string", + "readOnly": true + } + } + }, + "SupportTicketDetailsProperties": { + "description": "Describes the properties of a support ticket.", + "required": [ + "serviceId", + "title", + "description", + "problemClassificationId", + "severity", + "contactDetails", + "advancedDiagnosticConsent" + ], + "type": "object", + "properties": { + "supportTicketId": { + "description": "System generated support ticket Id that is unique.", + "type": "string" + }, + "description": { + "description": "Detailed description of the question or issue.", + "type": "string" + }, + "problemClassificationId": { + "description": "Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing.", + "type": "string" + }, + "problemClassificationDisplayName": { + "type": "string", + "description": "Localized name of problem classification.", + "readOnly": true + }, + "severity": { + "description": "A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers.", + "enum": [ + "minimal", + "moderate", + "critical", + "highestcriticalimpact" + ], + "type": "string", + "x-ms-enum": { + "name": "SeverityLevel", + "modelAsString": true + } + }, + "enrollmentId": { + "description": "Enrollment Id associated with the support ticket.", + "type": "string" + }, + "require24X7Response": { + "description": "Indicates if this requires a 24x7 response from Azure.", + "type": "boolean" + }, + "advancedDiagnosticConsent": { + "description": "Advanced diagnostic consent to be updated on the support ticket.", + "enum": [ + "Yes", + "No" + ], + "type": "string", + "x-ms-enum": { + "name": "Consent", + "modelAsString": true + } + }, + "problemScopingQuestions": { + "description": "Problem scoping questions associated with the support ticket.", + "type": "string" + }, + "supportPlanId": { + "description": "Support plan id associated with the support ticket.", + "type": "string" + }, + "contactDetails": { + "$ref": "#/definitions/ContactProfile", + "description": "Contact information of the user requesting to create a support ticket." + }, + "serviceLevelAgreement": { + "$ref": "#/definitions/ServiceLevelAgreement", + "description": "Service Level Agreement information for this support ticket." + }, + "supportEngineer": { + "$ref": "#/definitions/SupportEngineer", + "description": "Information about the support engineer working on this support ticket." + }, + "supportPlanType": { + "description": "Support plan type associated with the support ticket.", + "type": "string", + "readOnly": true + }, + "supportPlanDisplayName": { + "description": "Support plan type associated with the support ticket.", + "type": "string", + "readOnly": true + }, + "title": { + "description": "Title of the support ticket.", + "type": "string" + }, + "problemStartTime": { + "format": "date-time", + "description": "Time in UTC (ISO 8601 format) when the problem started.", + "type": "string" + }, + "serviceId": { + "description": "This is the resource Id of the Azure service resource associated with the support ticket.", + "type": "string" + }, + "serviceDisplayName": { + "type": "string", + "description": "Localized name of the Azure service.", + "readOnly": true + }, + "status": { + "description": "Status of the support ticket.", + "type": "string", + "readOnly": true + }, + "createdDate": { + "format": "date-time", + "description": "Time in UTC (ISO 8601 format) when the support ticket was created.", + "type": "string", + "readOnly": true + }, + "modifiedDate": { + "format": "date-time", + "description": "Time in UTC (ISO 8601 format) when the support ticket was last modified.", + "type": "string", + "readOnly": true + }, + "fileWorkspaceName": { + "description": "File workspace name.", + "type": "string" + }, + "isTemporaryTicket": { + "description": "This property indicates if support ticket is a temporary ticket.", + "enum": [ + "Yes", + "No" + ], + "type": "string", + "x-ms-enum": { + "name": "IsTemporaryTicket", + "modelAsString": true + }, + "readOnly": true + }, + "technicalTicketDetails": { + "$ref": "#/definitions/TechnicalTicketDetails", + "description": "Additional ticket details associated with a technical support ticket request." + }, + "quotaTicketDetails": { + "$ref": "#/definitions/QuotaTicketDetails", + "description": "Additional ticket details associated with a quota support ticket request." + }, + "secondaryConsent": { + "description": "This property indicates secondary consents for the support ticket", + "type": "array", + "items": { + "$ref": "#/definitions/SecondaryConsent" + }, + "x-ms-identifiers": [] + } + } + }, + "ServiceLevelAgreement": { + "description": "Service Level Agreement details for a support ticket.", + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "Time in UTC (ISO 8601 format) when the service level agreement starts.", + "type": "string", + "readOnly": true + }, + "expirationTime": { + "format": "date-time", + "description": "Time in UTC (ISO 8601 format) when the service level agreement expires.", + "type": "string", + "readOnly": true + }, + "slaMinutes": { + "description": "Service Level Agreement in minutes.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "SupportEngineer": { + "description": "Support engineer information.", + "type": "object", + "properties": { + "emailAddress": { + "description": "Email address of the Azure Support engineer assigned to the support ticket.", + "type": "string", + "readOnly": true + } + } + }, + "ContactProfile": { + "description": "Contact information associated with the support ticket.", + "required": [ + "firstName", + "lastName", + "preferredContactMethod", + "primaryEmailAddress", + "preferredTimeZone", + "country", + "preferredSupportLanguage" + ], + "type": "object", + "properties": { + "firstName": { + "description": "First name.", + "type": "string" + }, + "lastName": { + "description": "Last name.", + "type": "string" + }, + "preferredContactMethod": { + "description": "Preferred contact method.", + "enum": [ + "email", + "phone" + ], + "type": "string", + "x-ms-enum": { + "name": "PreferredContactMethod", + "modelAsString": true + } + }, + "primaryEmailAddress": { + "description": "Primary email address.", + "type": "string" + }, + "additionalEmailAddresses": { + "description": "Additional email addresses listed will be copied on any correspondence about the support ticket.", + "type": "array", + "items": { + "type": "string" + } + }, + "phoneNumber": { + "description": "Phone number. This is required if preferred contact method is phone.", + "type": "string" + }, + "preferredTimeZone": { + "description": "Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values).", + "type": "string" + }, + "country": { + "description": "Country of the user. This is the ISO 3166-1 alpha-3 code.", + "type": "string" + }, + "preferredSupportLanguage": { + "description": "Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German.", + "type": "string" + } + } + }, + "UpdateContactProfile": { + "description": "Contact information associated with the support ticket.", + "type": "object", + "properties": { + "firstName": { + "description": "First name.", + "type": "string" + }, + "lastName": { + "description": "Last name.", + "type": "string" + }, + "preferredContactMethod": { + "description": "Preferred contact method.", + "enum": [ + "email", + "phone" + ], + "type": "string", + "x-ms-enum": { + "name": "PreferredContactMethod", + "modelAsString": true + } + }, + "primaryEmailAddress": { + "description": "Primary email address.", + "type": "string" + }, + "additionalEmailAddresses": { + "description": "Email addresses listed will be copied on any correspondence about the support ticket.", + "type": "array", + "items": { + "type": "string" + } + }, + "phoneNumber": { + "description": "Phone number. This is required if preferred contact method is phone.", + "type": "string" + }, + "preferredTimeZone": { + "description": "Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values).", + "type": "string" + }, + "country": { + "description": "Country of the user. This is the ISO 3166-1 alpha-3 code.", + "type": "string" + }, + "preferredSupportLanguage": { + "description": "Preferred language of support from Azure. Support languages vary based on the severity you choose for your support ticket. Learn more at [Azure Severity and responsiveness](https://azure.microsoft.com/support/plans/response/). Use the standard language-country code. Valid values are 'en-us' for English, 'zh-hans' for Chinese, 'es-es' for Spanish, 'fr-fr' for French, 'ja-jp' for Japanese, 'ko-kr' for Korean, 'ru-ru' for Russian, 'pt-br' for Portuguese, 'it-it' for Italian, 'zh-tw' for Chinese and 'de-de' for German.", + "type": "string" + } + } + }, + "TechnicalTicketDetails": { + "description": "Additional information for technical support ticket.", + "type": "object", + "properties": { + "resourceId": { + "description": "This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created.", + "type": "string" + } + } + }, + "QuotaTicketDetails": { + "description": "Additional set of information required for quota increase support ticket for certain quota types, e.g.: Virtual machine cores. Get complete details about Quota payload support request along with examples at [Support quota request](https://aka.ms/supportrpquotarequestpayload).", + "type": "object", + "properties": { + "quotaChangeRequestSubType": { + "description": "Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase.", + "type": "string" + }, + "quotaChangeRequestVersion": { + "description": "Quota change request version.", + "type": "string" + }, + "quotaChangeRequests": { + "description": "This property is required for providing the region and new quota limits.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaChangeRequest" + }, + "x-ms-identifiers": [ + "region" + ] + } + } + }, + "QuotaChangeRequest": { + "description": "This property is required for providing the region and new quota limits.", + "type": "object", + "properties": { + "region": { + "description": "Region for which the quota increase request is being made.", + "type": "string" + }, + "payload": { + "description": "Payload of the quota increase request.", + "type": "string" + } + } + }, + "SecondaryConsent": { + "description": "This property indicates secondary consent for the support ticket.", + "type": "object", + "properties": { + "userConsent": { + "description": "User consent value provided", + "enum": [ + "Yes", + "No" + ], + "type": "string", + "x-ms-enum": { + "name": "UserConsent", + "modelAsString": true + } + }, + "type": { + "description": "The service name for which the secondary consent is being provided. The value needs to be retrieved from the Problem Classification API response.", + "type": "string" + } + } + }, + "UpdateSupportTicket": { + "description": "Updates severity, ticket status, contact details, advanced diagnostic consent and secondary consent in the support ticket.", + "type": "object", + "properties": { + "severity": { + "description": "Severity level.", + "enum": [ + "minimal", + "moderate", + "critical", + "highestcriticalimpact" + ], + "type": "string", + "x-ms-enum": { + "name": "SeverityLevel", + "modelAsString": true + } + }, + "status": { + "description": "Status to be updated on the ticket.", + "enum": [ + "open", + "closed" + ], + "type": "string", + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "contactDetails": { + "$ref": "#/definitions/UpdateContactProfile", + "description": "Contact details to be updated on the support ticket." + }, + "advancedDiagnosticConsent": { + "description": "Advanced diagnostic consent to be updated on the support ticket.", + "enum": [ + "Yes", + "No" + ], + "type": "string", + "x-ms-enum": { + "name": "Consent", + "modelAsString": true + } + }, + "secondaryConsent": { + "description": "This property indicates secondary consents for the support ticket", + "type": "array", + "items": { + "$ref": "#/definitions/SecondaryConsent" + }, + "x-ms-identifiers": [] + } + } + }, + "ChatTranscriptsListResult": { + "description": "Collection of Chat Transcripts resources.", + "type": "object", + "properties": { + "value": { + "description": "List of Chat Transcripts resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatTranscriptDetails" + } + }, + "nextLink": { + "description": "The URI to fetch the next page of Chat Transcripts resources.", + "type": "string" + } + } + }, + "ChatTranscriptDetails": { + "x-ms-azure-resource": true, + "description": "Object that represents a Chat Transcript resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ChatTranscriptDetailsProperties", + "description": "Properties of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ChatTranscriptDetailsProperties": { + "description": "Describes the properties of a Chat Transcript Details resource.", + "type": "object", + "properties": { + "messages": { + "description": "List of chat transcript communication resources.", + "type": "array", + "items": { + "$ref": "#/definitions/MessageProperties" + }, + "x-ms-identifiers": [] + }, + "startTime": { + "format": "date-time", + "description": "Time in UTC (ISO 8601 format) when the chat began.", + "type": "string", + "readOnly": true + } + } + }, + "MessageProperties": { + "description": "Describes the properties of a Message Details resource.", + "type": "object", + "properties": { + "contentType": { + "description": "Content type.", + "type": "string", + "x-ms-enum": { + "name": "TranscriptContentType", + "modelAsString": true + }, + "readOnly": true + }, + "communicationDirection": { + "description": "Direction of communication.", + "enum": [ + "inbound", + "outbound" + ], + "type": "string", + "x-ms-enum": { + "name": "CommunicationDirection", + "modelAsString": true + }, + "readOnly": true + }, + "sender": { + "description": "Name of the sender.", + "type": "string" + }, + "body": { + "description": "Body of the communication.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "Time in UTC (ISO 8601 format) when the communication was created.", + "type": "string", + "readOnly": true + } + } + }, + "FileWorkspaceDetails": { + "x-ms-azure-resource": true, + "description": "Object that represents FileWorkspaceDetails resource", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FileWorkspaceDetailsProperties", + "description": "Properties of the resource" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "FileWorkspaceDetailsProperties": { + "description": "Describes the properties of a file workspace.", + "type": "object", + "properties": { + "createdOn": { + "format": "date-time", + "description": "Time in UTC (ISO 8601 format) when file workspace was created.", + "type": "string", + "readOnly": true + }, + "expirationTime": { + "format": "date-time", + "description": "Time in UTC (ISO 8601 format) when file workspace is going to expire.", + "type": "string", + "readOnly": true + } + } + }, + "FilesListResult": { + "description": "Object that represents a collection of File resources.", + "type": "object", + "properties": { + "value": { + "description": "List of File resources.", + "type": "array", + "items": { + "$ref": "#/definitions/FileDetails" + } + }, + "nextLink": { + "description": "The URI to fetch the next page of File resources.", + "type": "string" + } + } + }, + "FileDetails": { + "x-ms-azure-resource": true, + "description": "Object that represents File Details resource", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FileDetailsProperties", + "description": "Properties of the resource" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "FileDetailsProperties": { + "description": "Describes the properties of a file.", + "type": "object", + "properties": { + "createdOn": { + "format": "date-time", + "description": "Time in UTC (ISO 8601 format) when file workspace was created.", + "type": "string", + "readOnly": true + }, + "chunkSize": { + "description": "Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB).", + "type": "integer", + "format": "int32" + }, + "fileSize": { + "description": "Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes.", + "type": "integer", + "format": "int32" + }, + "numberOfChunks": { + "description": "Number of chunks to be uploaded. The maximum number of allowed chunks is 2.", + "type": "integer", + "format": "int32" + } + } + }, + "UploadFile": { + "description": "File content associated with the file under a workspace.", + "type": "object", + "properties": { + "content": { + "description": "File Content in base64 encoded format", + "type": "string" + }, + "chunkIndex": { + "description": "Index of the uploaded chunk (Index starts at 0)", + "type": "integer", + "format": "int32" + } + } + } + } +} diff --git a/swagger-specs/support/resource-manager/api-set.json b/swagger-specs/support/resource-manager/api-set.json index 300036960..d1ace399e 100644 --- a/swagger-specs/support/resource-manager/api-set.json +++ b/swagger-specs/support/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Support/stable/2020-04-01/support.json"], "name": "package-2020-04"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.Support/stable/2024-04-01/support.json"], "name": "package-2024-04"} \ No newline at end of file diff --git a/swagger-specs/vmware/resource-manager/Microsoft.AVS/stable/2023-03-01/vmware.json b/swagger-specs/vmware/resource-manager/Microsoft.AVS/stable/2023-03-01/vmware.json deleted file mode 100644 index 5af8f7c20..000000000 --- a/swagger-specs/vmware/resource-manager/Microsoft.AVS/stable/2023-03-01/vmware.json +++ /dev/null @@ -1,8366 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure VMware Solution API", - "description": "Azure VMware Solution API", - "version": "2023-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "parameters": { - "privateCloudName": { - "name": "privateCloudName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the private cloud", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._]+$" - }, - "clusterName": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the cluster in the private cloud", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._]+$" - }, - "hcxEnterpriseSiteName": { - "name": "hcxEnterpriseSiteName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the HCX Enterprise Site in the private cloud", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._]+$" - }, - "addonName": { - "name": "addonName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the addon for the private cloud", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._]+$" - }, - "authorizationName": { - "name": "authorizationName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the ExpressRoute Circuit Authorization in the private cloud", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._]+$" - }, - "globalReachConnectionName": { - "name": "globalReachConnectionName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the global reach connection in the private cloud", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._]+$" - }, - "segmentId": { - "name": "segmentId", - "in": "path", - "required": true, - "type": "string", - "description": "NSX Segment identifier. Generally the same as the Segment's display name", - "x-ms-parameter-location": "method" - }, - "dhcpId": { - "name": "dhcpId", - "in": "path", - "required": true, - "type": "string", - "description": "NSX DHCP identifier. Generally the same as the DHCP display name", - "x-ms-parameter-location": "method" - }, - "portMirroringId": { - "name": "portMirroringId", - "in": "path", - "required": true, - "type": "string", - "description": "NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name", - "x-ms-parameter-location": "method" - }, - "vmGroupId": { - "name": "vmGroupId", - "in": "path", - "required": true, - "type": "string", - "description": "NSX VM Group identifier. Generally the same as the VM Group's display name", - "x-ms-parameter-location": "method" - }, - "virtualMachineId": { - "name": "virtualMachineId", - "in": "path", - "required": true, - "type": "string", - "description": "Virtual Machine identifier", - "x-ms-parameter-location": "method" - }, - "gatewayId": { - "name": "gatewayId", - "in": "path", - "required": true, - "type": "string", - "description": "NSX Gateway identifier. Generally the same as the Gateway's display name", - "x-ms-parameter-location": "method" - }, - "dnsServiceId": { - "name": "dnsServiceId", - "in": "path", - "required": true, - "type": "string", - "description": "NSX DNS Service identifier. Generally the same as the DNS Service's display name", - "x-ms-parameter-location": "method" - }, - "dnsZoneId": { - "name": "dnsZoneId", - "in": "path", - "required": true, - "type": "string", - "description": "NSX DNS Zone identifier. Generally the same as the DNS Zone's display name", - "x-ms-parameter-location": "method" - }, - "publicIPId": { - "name": "publicIPId", - "in": "path", - "required": true, - "type": "string", - "description": "NSX Public IP Block identifier. Generally the same as the Public IP Block's display name", - "x-ms-parameter-location": "method" - }, - "datastoreName": { - "name": "datastoreName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the datastore in the private cloud cluster", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._]+$" - }, - "cloudLinkName": { - "name": "cloudLinkName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the cloud link resource", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._]+$" - }, - "placementPolicyName": { - "name": "placementPolicyName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._]+$" - }, - "scriptExecutionName": { - "name": "scriptExecutionName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the user-invoked script execution resource", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._]+$" - }, - "scriptPackageName": { - "name": "scriptPackageName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the script package in the private cloud", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._@]+$" - }, - "scriptCmdletName": { - "name": "scriptCmdletName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the script cmdlet resource in the script package in the private cloud", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._]+$" - }, - "scriptOutputStreamType": { - "name": "scriptOutputStreamType", - "in": "body", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Information", - "Warning", - "Output", - "Error" - ], - "x-ms-enum": { - "name": "ScriptOutputStreamType", - "modelAsString": true - } - } - }, - "description": "Name of the desired output stream to return. If not provided, will return all. An empty array will return nothing", - "x-ms-parameter-location": "method" - }, - "workloadNetworkName": { - "name": "workloadNetworkName", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "WorkloadNetworkName", - "modelAsString": true - }, - "description": "Name for the workload network in the private cloud", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._]+$" - }, - "provisionedNetworkName": { - "name": "provisionedNetworkName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the provisioned network in the private cloud", - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/providers/Microsoft.AVS/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all of the available operations", - "operationId": "Operations_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request has succeeded", - "schema": { - "$ref": "#/definitions/OperationList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkTrialAvailability": { - "post": { - "tags": [ - "Locations" - ], - "description": "Return trial status for subscription by region", - "operationId": "Locations_CheckTrialAvailability", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "Azure region" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "sku", - "in": "body", - "required": false, - "description": "The sku to check for trial availability", - "schema": { - "$ref": "#/definitions/Sku" - } - } - ], - "responses": { - "200": { - "description": "Request has succeeded", - "schema": { - "$ref": "#/definitions/Trial" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Locations_CheckTrialAvailability": { - "$ref": "./examples/Locations_CheckTrialAvailability.json" - }, - "Locations_CheckTrialAvailabilityWithSku": { - "$ref": "./examples/Locations_CheckTrialAvailabilityWithSku.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkQuotaAvailability": { - "post": { - "tags": [ - "Locations" - ], - "description": "Return quota for subscription by region", - "operationId": "Locations_CheckQuotaAvailability", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "Azure region" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request has succeeded", - "schema": { - "$ref": "#/definitions/Quota" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Locations_CheckQuotaAvailability": { - "$ref": "./examples/Locations_CheckQuotaAvailability.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds": { - "get": { - "operationId": "PrivateClouds_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "PrivateClouds" - ], - "summary": "List private clouds in a resource group", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PrivateCloudList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateClouds_List": { - "$ref": "./examples/PrivateClouds_List.json" - }, - "PrivateClouds_List_Stretched": { - "$ref": "./examples/PrivateClouds_List_Stretched.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AVS/privateClouds": { - "get": { - "operationId": "PrivateClouds_ListInSubscription", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "PrivateClouds" - ], - "summary": "List private clouds in a subscription", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PrivateCloudList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateClouds_ListInSubscription": { - "$ref": "./examples/PrivateClouds_ListInSubscription.json" - }, - "PrivateClouds_ListInSubscription_Stretched": { - "$ref": "./examples/PrivateClouds_ListInSubscription_Stretched.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}": { - "get": { - "operationId": "PrivateClouds_Get", - "tags": [ - "PrivateClouds" - ], - "summary": "Get a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PrivateCloud" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateClouds_Get": { - "$ref": "./examples/PrivateClouds_Get.json" - }, - "PrivateClouds_Get_Stretched": { - "$ref": "./examples/PrivateClouds_Get_Stretched.json" - } - } - }, - "put": { - "operationId": "PrivateClouds_CreateOrUpdate", - "x-ms-long-running-operation": true, - "tags": [ - "PrivateClouds" - ], - "summary": "Create or update a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "name": "privateCloud", - "description": "The private cloud", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PrivateCloud" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PrivateCloud" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/PrivateCloud" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateClouds_CreateOrUpdate": { - "$ref": "./examples/PrivateClouds_CreateOrUpdate.json" - }, - "PrivateClouds_CreateOrUpdate_Stretched": { - "$ref": "./examples/PrivateClouds_CreateOrUpdate_Stretched.json" - } - } - }, - "patch": { - "operationId": "PrivateClouds_Update", - "x-ms-long-running-operation": true, - "tags": [ - "PrivateClouds" - ], - "summary": "Update a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "name": "privateCloudUpdate", - "description": "The private cloud properties to be updated", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PrivateCloudUpdate" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PrivateCloud" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/PrivateCloud" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateClouds_Update": { - "$ref": "./examples/PrivateClouds_Update.json" - }, - "PrivateClouds_Update_Stretched": { - "$ref": "./examples/PrivateClouds_Update_Stretched.json" - } - } - }, - "delete": { - "operationId": "PrivateClouds_Delete", - "x-ms-long-running-operation": true, - "tags": [ - "PrivateClouds" - ], - "summary": "Delete a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No private cloud to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateClouds_Delete": { - "$ref": "./examples/PrivateClouds_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateVcenterPassword": { - "post": { - "operationId": "PrivateClouds_RotateVcenterPassword", - "tags": [ - "PrivateClouds" - ], - "summary": "Rotate the vCenter password", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The password rotation has started" - }, - "204": { - "description": "The password rotation was successful" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateClouds_RotateVcenterPassword": { - "$ref": "./examples/PrivateClouds_RotateVcenterPassword.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateNsxtPassword": { - "post": { - "operationId": "PrivateClouds_RotateNsxtPassword", - "tags": [ - "PrivateClouds" - ], - "summary": "Rotate the NSX-T Manager password", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The password rotation has started" - }, - "204": { - "description": "The password rotation was successful" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateClouds_RotateNsxtPassword": { - "$ref": "./examples/PrivateClouds_RotateNsxtPassword.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters": { - "get": { - "operationId": "Clusters_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "Clusters" - ], - "summary": "List clusters in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/ClusterList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Clusters_List": { - "$ref": "./examples/Clusters_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}": { - "get": { - "operationId": "Clusters_Get", - "tags": [ - "Clusters" - ], - "summary": "Get a cluster by name in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Clusters_Get": { - "$ref": "./examples/Clusters_Get.json" - } - } - }, - "put": { - "operationId": "Clusters_CreateOrUpdate", - "x-ms-long-running-operation": true, - "tags": [ - "Clusters" - ], - "summary": "Create or update a cluster in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "privateCloudName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the private cloud." - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "name": "cluster", - "description": "A cluster in the private cloud", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Clusters_CreateOrUpdate": { - "$ref": "./examples/Clusters_CreateOrUpdate.json" - } - } - }, - "patch": { - "operationId": "Clusters_Update", - "x-ms-long-running-operation": true, - "tags": [ - "Clusters" - ], - "summary": "Update a cluster in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "name": "clusterUpdate", - "description": "The cluster properties to be updated", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterUpdate" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Clusters_Update": { - "$ref": "./examples/Clusters_Update.json" - } - } - }, - "delete": { - "operationId": "Clusters_Delete", - "x-ms-long-running-operation": true, - "tags": [ - "Clusters" - ], - "summary": "Delete a cluster in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No cluster to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Clusters_Delete": { - "$ref": "./examples/Clusters_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/listZones": { - "post": { - "operationId": "Clusters_ListZones", - "tags": [ - "Cluster", - "Zone" - ], - "summary": "List hosts by zone in a cluster", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK, zones information is returned", - "schema": { - "$ref": "#/definitions/ClusterZoneList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Clusters_ListZoneData": { - "$ref": "./examples/Clusters_ListZones.json" - }, - "Clusters_ListZoneData_Stretched": { - "$ref": "./examples/Clusters_ListZones_Stretched.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores": { - "get": { - "operationId": "Datastores_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "Datastores" - ], - "summary": "List datastores in a private cloud cluster", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/DatastoreList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Datastores_List": { - "$ref": "./examples/Datastores_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}": { - "get": { - "operationId": "Datastores_Get", - "tags": [ - "Datastores" - ], - "summary": "Get a datastore in a private cloud cluster", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "#/parameters/datastoreName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Datastore" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Datastores_Get": { - "$ref": "./examples/Datastores_Get.json" - } - } - }, - "put": { - "operationId": "Datastores_CreateOrUpdate", - "x-ms-long-running-operation": true, - "tags": [ - "Datastores" - ], - "summary": "Create or update a datastore in a private cloud cluster", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "#/parameters/datastoreName" - }, - { - "name": "datastore", - "description": "A datastore in a private cloud cluster", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Datastore" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Datastore" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/Datastore" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Datastores_CreateOrUpdate": { - "$ref": "./examples/Datastores_CreateOrUpdate.json" - } - } - }, - "delete": { - "operationId": "Datastores_Delete", - "x-ms-long-running-operation": true, - "tags": [ - "Datastores" - ], - "summary": "Delete a datastore in a private cloud cluster", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "#/parameters/datastoreName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No datastore to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Datastores_Delete": { - "$ref": "./examples/Datastores_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/listAdminCredentials": { - "post": { - "operationId": "PrivateClouds_ListAdminCredentials", - "tags": [ - "PrivateClouds" - ], - "summary": "List the admin credentials for the private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/AdminCredentials" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateClouds_ListAdminCredentials": { - "$ref": "./examples/PrivateClouds_ListAdminCredentials.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites": { - "get": { - "operationId": "HcxEnterpriseSites_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "HcxEnterpriseSites" - ], - "summary": "List HCX on-premises key in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/HcxEnterpriseSiteList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "HcxEnterpriseSites_List": { - "$ref": "./examples/HcxEnterpriseSites_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}": { - "get": { - "operationId": "HcxEnterpriseSites_Get", - "tags": [ - "HcxEnterpriseSites" - ], - "summary": "Get an HCX on-premises key by name in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/hcxEnterpriseSiteName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/HcxEnterpriseSite" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "HcxEnterpriseSites_Get": { - "$ref": "./examples/HcxEnterpriseSites_Get.json" - } - } - }, - "put": { - "operationId": "HcxEnterpriseSites_CreateOrUpdate", - "tags": [ - "HcxEnterpriseSites" - ], - "summary": "Create or update an activation key for on-premises HCX site", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "privateCloudName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the private cloud." - }, - { - "$ref": "#/parameters/hcxEnterpriseSiteName" - }, - { - "name": "hcxEnterpriseSite", - "description": "The HCX Enterprise Site", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/HcxEnterpriseSite" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful update", - "schema": { - "$ref": "#/definitions/HcxEnterpriseSite" - } - }, - "201": { - "description": "successful create", - "schema": { - "$ref": "#/definitions/HcxEnterpriseSite" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "HcxEnterpriseSites_CreateOrUpdate": { - "$ref": "./examples/HcxEnterpriseSites_CreateOrUpdate.json" - } - } - }, - "delete": { - "operationId": "HcxEnterpriseSites_Delete", - "tags": [ - "HcxEnterpriseSites" - ], - "summary": "Delete HCX on-premises key in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/hcxEnterpriseSiteName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "204": { - "description": "No Content. No HCX Enterprise Site to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "HcxEnterpriseSites_Delete": { - "$ref": "./examples/HcxEnterpriseSites_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations": { - "get": { - "operationId": "Authorizations_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "Authorizations" - ], - "summary": "List ExpressRoute Circuit Authorizations in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/ExpressRouteAuthorizationList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Authorizations_List": { - "$ref": "./examples/Authorizations_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}": { - "get": { - "operationId": "Authorizations_Get", - "tags": [ - "Authorizations" - ], - "summary": "Get an ExpressRoute Circuit Authorization by name in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/authorizationName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/ExpressRouteAuthorization" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Authorizations_Get": { - "$ref": "./examples/Authorizations_Get.json" - } - } - }, - "put": { - "operationId": "Authorizations_CreateOrUpdate", - "x-ms-long-running-operation": true, - "tags": [ - "Authorizations" - ], - "summary": "Create or update an ExpressRoute Circuit Authorization in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "privateCloudName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the private cloud." - }, - { - "$ref": "#/parameters/authorizationName" - }, - { - "name": "authorization", - "description": "An ExpressRoute Circuit Authorization", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ExpressRouteAuthorization" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/ExpressRouteAuthorization" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/ExpressRouteAuthorization" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Authorizations_CreateOrUpdate": { - "$ref": "./examples/Authorizations_CreateOrUpdate.json" - } - } - }, - "delete": { - "operationId": "Authorizations_Delete", - "x-ms-long-running-operation": true, - "tags": [ - "Authorizations" - ], - "summary": "Delete an ExpressRoute Circuit Authorization in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/authorizationName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No ExpressRoute Circuit Authorization to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Authorizations_Delete": { - "$ref": "./examples/Authorizations_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections": { - "get": { - "operationId": "GlobalReachConnections_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "GlobalReachConnections" - ], - "summary": "List global reach connections in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/GlobalReachConnectionList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GlobalReachConnections_List": { - "$ref": "./examples/GlobalReachConnections_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}": { - "get": { - "operationId": "GlobalReachConnections_Get", - "tags": [ - "GlobalReachConnections" - ], - "summary": "Get a global reach connection by name in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/globalReachConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/GlobalReachConnection" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GlobalReachConnections_Get": { - "$ref": "./examples/GlobalReachConnections_Get.json" - } - } - }, - "put": { - "operationId": "GlobalReachConnections_CreateOrUpdate", - "x-ms-long-running-operation": true, - "tags": [ - "GlobalReachConnections" - ], - "summary": "Create or update a global reach connection in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "privateCloudName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the private cloud." - }, - { - "$ref": "#/parameters/globalReachConnectionName" - }, - { - "name": "globalReachConnection", - "description": "A global reach connection in the private cloud", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/GlobalReachConnection" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/GlobalReachConnection" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/GlobalReachConnection" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GlobalReachConnections_CreateOrUpdate": { - "$ref": "./examples/GlobalReachConnections_CreateOrUpdate.json" - } - } - }, - "delete": { - "operationId": "GlobalReachConnections_Delete", - "x-ms-long-running-operation": true, - "tags": [ - "GlobalReachConnections" - ], - "summary": "Delete a global reach connection in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/globalReachConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No global reach connection to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GlobalReachConnections_Delete": { - "$ref": "./examples/GlobalReachConnections_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/{workloadNetworkName}": { - "get": { - "operationId": "WorkloadNetworks_Get", - "tags": [ - "WorkloadNetworks" - ], - "summary": "Get a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/workloadNetworkName" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetwork" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_Get": { - "$ref": "./examples/WorkloadNetworks_Get.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks": { - "get": { - "operationId": "WorkloadNetworks_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "WorkloadNetworks" - ], - "summary": "List of workload networks in a private cloud.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_List": { - "$ref": "./examples/WorkloadNetworks_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments": { - "get": { - "operationId": "WorkloadNetworks_ListSegments", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "WorkloadNetworks" - ], - "summary": "List of segments in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkSegmentsList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_ListSegments": { - "$ref": "./examples/WorkloadNetworks_ListSegments.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}": { - "get": { - "operationId": "WorkloadNetworks_GetSegment", - "tags": [ - "WorkloadNetworks" - ], - "summary": "Get a segment by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/segmentId" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkSegment" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_GetSegment": { - "$ref": "./examples/WorkloadNetworks_GetSegments.json" - } - } - }, - "put": { - "operationId": "WorkloadNetworks_CreateSegments", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Create a segment by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/segmentId" - }, - { - "name": "workloadNetworkSegment", - "description": "NSX Segment", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkloadNetworkSegment" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkSegment" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkSegment" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_CreateSegments": { - "$ref": "./examples/WorkloadNetworks_CreateSegments.json" - } - } - }, - "patch": { - "operationId": "WorkloadNetworks_UpdateSegments", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Create or update a segment by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/segmentId" - }, - { - "name": "workloadNetworkSegment", - "description": "NSX Segment", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkloadNetworkSegment" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkSegment" - } - }, - "202": { - "description": "Accepted. The patch will complete asynchronously" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_UpdateSegments": { - "$ref": "./examples/WorkloadNetworks_UpdateSegments.json" - } - } - }, - "delete": { - "operationId": "WorkloadNetworks_DeleteSegment", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Delete a segment by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/segmentId" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No segment to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_DeleteSegment": { - "$ref": "./examples/WorkloadNetworks_DeleteSegments.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations": { - "get": { - "operationId": "WorkloadNetworks_ListDhcp", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "WorkloadNetworks" - ], - "summary": "List dhcp in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDhcpList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_ListDhcp": { - "$ref": "./examples/WorkloadNetworks_ListDhcpConfigurations.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}": { - "get": { - "operationId": "WorkloadNetworks_GetDhcp", - "tags": [ - "WorkloadNetworks" - ], - "summary": "Get dhcp by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/dhcpId" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDhcp" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_GetDhcp": { - "$ref": "./examples/WorkloadNetworks_GetDhcpConfigurations.json" - } - } - }, - "put": { - "operationId": "WorkloadNetworks_CreateDhcp", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Create dhcp by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/dhcpId" - }, - { - "name": "workloadNetworkDhcp", - "description": "NSX DHCP", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkloadNetworkDhcp" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDhcp" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDhcp" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_CreateDhcp": { - "$ref": "./examples/WorkloadNetworks_CreateDhcpConfigurations.json" - } - } - }, - "patch": { - "operationId": "WorkloadNetworks_UpdateDhcp", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Create or update dhcp by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/dhcpId" - }, - { - "name": "workloadNetworkDhcp", - "description": "NSX DHCP", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkloadNetworkDhcp" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDhcp" - } - }, - "202": { - "description": "Accepted. The patch will complete asynchronously" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_UpdateDhcp": { - "$ref": "./examples/WorkloadNetworks_UpdateDhcpConfigurations.json" - } - } - }, - "delete": { - "operationId": "WorkloadNetworks_DeleteDhcp", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Delete dhcp by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/dhcpId" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No DHCP configuration to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_DeleteDhcp": { - "$ref": "./examples/WorkloadNetworks_DeleteDhcpConfigurations.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways": { - "get": { - "operationId": "WorkloadNetworks_ListGateways", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "WorkloadNetworks" - ], - "summary": "List of gateways in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkGatewayList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_ListGateways": { - "$ref": "./examples/WorkloadNetworks_ListGateways.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways/{gatewayId}": { - "get": { - "operationId": "WorkloadNetworks_GetGateway", - "tags": [ - "WorkloadNetworks" - ], - "summary": "Get a gateway by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/gatewayId" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkGateway" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_GetGateway": { - "$ref": "./examples/WorkloadNetworks_GetGateway.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles": { - "get": { - "operationId": "WorkloadNetworks_ListPortMirroring", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "WorkloadNetworks" - ], - "summary": "List of port mirroring profiles in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkPortMirroringList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_ListPortMirroring": { - "$ref": "./examples/WorkloadNetworks_ListPortMirroringProfiles.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}": { - "get": { - "operationId": "WorkloadNetworks_GetPortMirroring", - "tags": [ - "WorkloadNetworks" - ], - "summary": "Get a port mirroring profile by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/portMirroringId" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkPortMirroring" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_GetPortMirroring": { - "$ref": "./examples/WorkloadNetworks_GetPortMirroringProfiles.json" - } - } - }, - "put": { - "operationId": "WorkloadNetworks_CreatePortMirroring", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Create a port mirroring profile by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/portMirroringId" - }, - { - "name": "workloadNetworkPortMirroring", - "description": "NSX port mirroring", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkloadNetworkPortMirroring" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkPortMirroring" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkPortMirroring" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_CreatePortMirroring": { - "$ref": "./examples/WorkloadNetworks_CreatePortMirroringProfiles.json" - } - } - }, - "patch": { - "operationId": "WorkloadNetworks_UpdatePortMirroring", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Create or update a port mirroring profile by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/portMirroringId" - }, - { - "name": "workloadNetworkPortMirroring", - "description": "NSX port mirroring", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkloadNetworkPortMirroring" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkPortMirroring" - } - }, - "202": { - "description": "Accepted. The patch will complete asynchronously" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_UpdatePortMirroring": { - "$ref": "./examples/WorkloadNetworks_UpdatePortMirroringProfiles.json" - } - } - }, - "delete": { - "operationId": "WorkloadNetworks_DeletePortMirroring", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Delete a port mirroring profile by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/portMirroringId" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No port mirroring profile to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_DeletePortMirroring": { - "$ref": "./examples/WorkloadNetworks_DeletePortMirroringProfiles.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups": { - "get": { - "operationId": "WorkloadNetworks_ListVMGroups", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "WorkloadNetworks" - ], - "summary": "List of vm groups in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkVMGroupsList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_ListVMGroups": { - "$ref": "./examples/WorkloadNetworks_ListVMGroups.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}": { - "get": { - "operationId": "WorkloadNetworks_GetVMGroup", - "tags": [ - "WorkloadNetworks" - ], - "summary": "Get a vm group by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/vmGroupId" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkVMGroup" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_GetVMGroup": { - "$ref": "./examples/WorkloadNetworks_GetVMGroups.json" - } - } - }, - "put": { - "operationId": "WorkloadNetworks_CreateVMGroup", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Create a vm group by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/vmGroupId" - }, - { - "name": "workloadNetworkVMGroup", - "description": "NSX VM Group", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkloadNetworkVMGroup" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkVMGroup" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkVMGroup" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_CreateVMGroup": { - "$ref": "./examples/WorkloadNetworks_CreateVMGroups.json" - } - } - }, - "patch": { - "operationId": "WorkloadNetworks_UpdateVMGroup", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Create or update a vm group by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/vmGroupId" - }, - { - "name": "workloadNetworkVMGroup", - "description": "NSX VM Group", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkloadNetworkVMGroup" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkVMGroup" - } - }, - "202": { - "description": "Accepted. The patch will complete asynchronously" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_UpdateVMGroup": { - "$ref": "./examples/WorkloadNetworks_UpdateVMGroups.json" - } - } - }, - "delete": { - "operationId": "WorkloadNetworks_DeleteVMGroup", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Delete a vm group by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/vmGroupId" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No VM group to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_DeleteVMGroup": { - "$ref": "./examples/WorkloadNetworks_DeleteVMGroups.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines": { - "get": { - "operationId": "WorkloadNetworks_ListVirtualMachines", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "WorkloadNetworks" - ], - "summary": "List of virtual machines in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkVirtualMachinesList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_ListVirtualMachines": { - "$ref": "./examples/WorkloadNetworks_ListVirtualMachines.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines/{virtualMachineId}": { - "get": { - "operationId": "WorkloadNetworks_GetVirtualMachine", - "tags": [ - "WorkloadNetworks" - ], - "summary": "Get a virtual machine by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/virtualMachineId" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkVirtualMachine" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_GetVirtualMachine": { - "$ref": "./examples/WorkloadNetworks_GetVirtualMachine.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices": { - "get": { - "operationId": "WorkloadNetworks_ListDnsServices", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "WorkloadNetworks" - ], - "summary": "List of DNS services in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsServicesList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_ListDnsServices": { - "$ref": "./examples/WorkloadNetworks_ListDnsServices.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}": { - "get": { - "operationId": "WorkloadNetworks_GetDnsService", - "tags": [ - "WorkloadNetworks" - ], - "summary": "Get a DNS service by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/dnsServiceId" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsService" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_GetDnsService": { - "$ref": "./examples/WorkloadNetworks_GetDnsServices.json" - } - } - }, - "put": { - "operationId": "WorkloadNetworks_CreateDnsService", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Create a DNS service by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/dnsServiceId" - }, - { - "name": "workloadNetworkDnsService", - "description": "NSX DNS Service", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsService" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsService" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsService" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_CreateDnsService": { - "$ref": "./examples/WorkloadNetworks_CreateDnsServices.json" - } - } - }, - "patch": { - "operationId": "WorkloadNetworks_UpdateDnsService", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Create or update a DNS service by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/dnsServiceId" - }, - { - "name": "workloadNetworkDnsService", - "description": "NSX DNS Service", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsService" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsService" - } - }, - "202": { - "description": "Accepted. The patch will complete asynchronously" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_UpdateDnsService": { - "$ref": "./examples/WorkloadNetworks_UpdateDnsServices.json" - } - } - }, - "delete": { - "operationId": "WorkloadNetworks_DeleteDnsService", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Delete a DNS service by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/dnsServiceId" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No VM group to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_DeleteDnsService": { - "$ref": "./examples/WorkloadNetworks_DeleteDnsServices.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones": { - "get": { - "operationId": "WorkloadNetworks_ListDnsZones", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "WorkloadNetworks" - ], - "summary": "List of DNS zones in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsZonesList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_ListDnsZones": { - "$ref": "./examples/WorkloadNetworks_ListDnsZones.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}": { - "get": { - "operationId": "WorkloadNetworks_GetDnsZone", - "tags": [ - "WorkloadNetworks" - ], - "summary": "Get a DNS zone by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/dnsZoneId" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsZone" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_GetDnsZone": { - "$ref": "./examples/WorkloadNetworks_GetDnsZones.json" - } - } - }, - "put": { - "operationId": "WorkloadNetworks_CreateDnsZone", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Create a DNS zone by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/dnsZoneId" - }, - { - "name": "workloadNetworkDnsZone", - "description": "NSX DNS Zone", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsZone" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsZone" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsZone" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_CreateDnsZone": { - "$ref": "./examples/WorkloadNetworks_CreateDnsZones.json" - } - } - }, - "patch": { - "operationId": "WorkloadNetworks_UpdateDnsZone", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Create or update a DNS zone by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/dnsZoneId" - }, - { - "name": "workloadNetworkDnsZone", - "description": "NSX DNS Zone", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsZone" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkDnsZone" - } - }, - "202": { - "description": "Accepted. The patch will complete asynchronously" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_UpdateDnsZone": { - "$ref": "./examples/WorkloadNetworks_UpdateDnsZones.json" - } - } - }, - "delete": { - "operationId": "WorkloadNetworks_DeleteDnsZone", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Delete a DNS zone by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/dnsZoneId" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No VM group to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_DeleteDnsZone": { - "$ref": "./examples/WorkloadNetworks_DeleteDnsZones.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs": { - "get": { - "operationId": "WorkloadNetworks_ListPublicIPs", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "WorkloadNetworks" - ], - "summary": "List of Public IP Blocks in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkPublicIPsList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_ListPublicIPs": { - "$ref": "./examples/WorkloadNetworks_ListPublicIPs.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}": { - "get": { - "operationId": "WorkloadNetworks_GetPublicIP", - "tags": [ - "WorkloadNetworks" - ], - "summary": "Get a Public IP Block by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/publicIPId" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkPublicIP" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_GetPublicIP": { - "$ref": "./examples/WorkloadNetworks_GetPublicIPs.json" - } - } - }, - "put": { - "operationId": "WorkloadNetworks_CreatePublicIP", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Create a Public IP Block by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/publicIPId" - }, - { - "name": "workloadNetworkPublicIP", - "description": "NSX Public IP Block", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkloadNetworkPublicIP" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkPublicIP" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/WorkloadNetworkPublicIP" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_CreatePublicIP": { - "$ref": "./examples/WorkloadNetworks_CreatePublicIPs.json" - } - } - }, - "delete": { - "operationId": "WorkloadNetworks_DeletePublicIP", - "x-ms-long-running-operation": true, - "tags": [ - "WorkloadNetworks" - ], - "summary": "Delete a Public IP Block by id in a private cloud workload network.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/publicIPId" - }, - { - "$ref": "#/parameters/privateCloudName" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No VM group to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkloadNetworks_DeletePublicIP": { - "$ref": "./examples/WorkloadNetworks_DeletePublicIPs.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks": { - "get": { - "operationId": "CloudLinks_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "CloudLinks" - ], - "summary": "List cloud link in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/CloudLinkList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CloudLinks_List": { - "$ref": "./examples/CloudLinks_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks/{cloudLinkName}": { - "get": { - "operationId": "CloudLinks_Get", - "tags": [ - "CloudLinks" - ], - "summary": "Get an cloud link by name in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/cloudLinkName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/CloudLink" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CloudLinks_Get": { - "$ref": "./examples/CloudLinks_Get.json" - } - } - }, - "put": { - "operationId": "CloudLinks_CreateOrUpdate", - "x-ms-long-running-operation": true, - "tags": [ - "CloudLinks" - ], - "summary": "Create or update a cloud link in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "privateCloudName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the private cloud." - }, - { - "$ref": "#/parameters/cloudLinkName" - }, - { - "name": "cloudLink", - "description": "A cloud link in the private cloud", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CloudLink" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/CloudLink" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/CloudLink" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CloudLinks_CreateOrUpdate": { - "$ref": "./examples/CloudLinks_CreateOrUpdate.json" - } - } - }, - "delete": { - "operationId": "CloudLinks_Delete", - "x-ms-long-running-operation": true, - "tags": [ - "CloudLinks" - ], - "summary": "Delete a cloud link in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/cloudLinkName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No cloud link to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CloudLinks_Delete": { - "$ref": "./examples/CloudLinks_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons": { - "get": { - "operationId": "Addons_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "Addons" - ], - "summary": "List addons in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/AddonList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Addons_List": { - "$ref": "./examples/Addons_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}": { - "get": { - "operationId": "Addons_Get", - "tags": [ - "Addons" - ], - "summary": "Get an addon by name in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/addonName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Addon" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Addons_Get_SRM": { - "$ref": "./examples/Addons_Get_SRM.json" - }, - "Addons_Get_VR": { - "$ref": "./examples/Addons_Get_VR.json" - }, - "Addons_Get_HCX": { - "$ref": "./examples/Addons_Get_HCX.json" - }, - "Addons_Get_ArcReg": { - "$ref": "./examples/Addons_Get_ArcReg.json" - } - } - }, - "put": { - "operationId": "Addons_CreateOrUpdate", - "x-ms-long-running-operation": true, - "tags": [ - "Addons" - ], - "summary": "Create or update a addon in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "privateCloudName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the private cloud." - }, - { - "$ref": "#/parameters/addonName" - }, - { - "name": "addon", - "description": "A addon in the private cloud", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Addon" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Addon" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/Addon" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Addons_CreateOrUpdate_SRM": { - "$ref": "./examples/Addons_CreateOrUpdate_SRM.json" - }, - "Addons_CreateOrUpdate_VR": { - "$ref": "./examples/Addons_CreateOrUpdate_VR.json" - }, - "Addons_CreateOrUpdate_HCX": { - "$ref": "./examples/Addons_CreateOrUpdate_HCX.json" - }, - "Addons_CreateOrUpdate_Arc": { - "$ref": "./examples/Addons_CreateOrUpdate_ArcReg.json" - } - } - }, - "delete": { - "operationId": "Addons_Delete", - "x-ms-long-running-operation": true, - "tags": [ - "Addons" - ], - "summary": "Delete a addon in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/addonName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No addon to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Addons_Delete": { - "$ref": "./examples/Addons_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines": { - "get": { - "operationId": "VirtualMachines_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "VirtualMachines" - ], - "summary": "List of virtual machines in a private cloud cluster", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/VirtualMachinesList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ListClusterVirtualMachines": { - "$ref": "./examples/VirtualMachines_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines/{virtualMachineId}": { - "get": { - "operationId": "VirtualMachines_Get", - "tags": [ - "VirtualMachines" - ], - "summary": "Get a virtual machine by id in a private cloud cluster", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "#/parameters/virtualMachineId" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/VirtualMachine" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GetVirtualMachine": { - "$ref": "./examples/VirtualMachines_Get.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines/{virtualMachineId}/restrictMovement": { - "post": { - "x-ms-long-running-operation": true, - "operationId": "VirtualMachines_RestrictMovement", - "tags": [ - "VirtualMachines", - "PlacementPolicies" - ], - "summary": "Enable or disable DRS-driven VM movement restriction", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "#/parameters/virtualMachineId" - }, - { - "name": "restrictMovement", - "description": "Whether VM DRS-driven movement is restricted (Enabled) or not (Disabled)", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineRestrictMovement" - } - } - ], - "responses": { - "202": { - "description": "Started flow to set/unset restrictedMovement of VM" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "VirtualMachine_RestrictMovement": { - "$ref": "./examples/VirtualMachines_RestrictMovement.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies": { - "get": { - "operationId": "PlacementPolicies_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "PlacementPolicies" - ], - "summary": "List placement policies in a private cloud cluster", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PlacementPoliciesList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PlacementPolicies_List": { - "$ref": "./examples/PlacementPolicies_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}": { - "get": { - "operationId": "PlacementPolicies_Get", - "tags": [ - "PlacementPolicies" - ], - "summary": "Get a placement policy by name in a private cloud cluster", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "#/parameters/placementPolicyName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PlacementPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PlacementPolicies_Get": { - "$ref": "./examples/PlacementPolicies_Get.json" - } - } - }, - "put": { - "operationId": "PlacementPolicies_CreateOrUpdate", - "x-ms-long-running-operation": true, - "tags": [ - "PlacementPolicies" - ], - "summary": "Create or update a placement policy in a private cloud cluster", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "#/parameters/placementPolicyName" - }, - { - "name": "placementPolicy", - "description": "A placement policy in the private cloud cluster", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PlacementPolicy" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PlacementPolicy" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/PlacementPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PlacementPolicies_CreateOrUpdate": { - "$ref": "./examples/PlacementPolicies_CreateOrUpdate.json" - } - } - }, - "patch": { - "operationId": "PlacementPolicies_Update", - "x-ms-long-running-operation": true, - "tags": [ - "PlacementPolicies" - ], - "summary": "Update a placement policy in a private cloud cluster", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "#/parameters/placementPolicyName" - }, - { - "name": "placementPolicyUpdate", - "description": "The placement policy properties that may be updated", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PlacementPolicyUpdate" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PlacementPolicy" - } - }, - "202": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/PlacementPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PlacementPolicies_Update": { - "$ref": "./examples/PlacementPolicies_Update.json" - } - } - }, - "delete": { - "operationId": "PlacementPolicies_Delete", - "x-ms-long-running-operation": true, - "tags": [ - "PlacementPolicies" - ], - "summary": "Delete a placement policy in a private cloud cluster", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "#/parameters/placementPolicyName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No policy to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PlacementPolicies_Delete": { - "$ref": "./examples/PlacementPolicies_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages": { - "get": { - "tags": [ - "Scripts" - ], - "description": "List script packages available to run on the private cloud", - "operationId": "ScriptPackages_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request has succeeded", - "schema": { - "$ref": "#/definitions/ScriptPackagesList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ScriptPackages_List": { - "$ref": "./examples/ScriptPackages_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}": { - "get": { - "tags": [ - "Scripts" - ], - "description": "Get a script package available to run on a private cloud", - "operationId": "ScriptPackages_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/scriptPackageName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request has succeeded", - "schema": { - "$ref": "#/definitions/ScriptPackage" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ScriptPackages_Get": { - "$ref": "./examples/ScriptPackages_Get.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}/scriptCmdlets": { - "get": { - "tags": [ - "Scripts" - ], - "description": "List script cmdlet resources available for a private cloud to create a script execution resource on a private cloud", - "operationId": "ScriptCmdlets_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/scriptPackageName" - } - ], - "responses": { - "200": { - "description": "Request has succeeded", - "schema": { - "$ref": "#/definitions/ScriptCmdletsList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ScriptCmdlets_List": { - "$ref": "./examples/ScriptCmdlets_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}/scriptCmdlets/{scriptCmdletName}": { - "get": { - "tags": [ - "Scripts" - ], - "description": "Return information about a script cmdlet resource in a specific package on a private cloud", - "operationId": "ScriptCmdlets_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/scriptPackageName" - }, - { - "$ref": "#/parameters/scriptCmdletName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request has succeeded", - "schema": { - "$ref": "#/definitions/ScriptCmdlet" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ScriptCmdlets_Get": { - "$ref": "./examples/ScriptCmdlets_Get.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions": { - "get": { - "operationId": "ScriptExecutions_List", - "tags": [ - "Scripts" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "summary": "List script executions in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/ScriptExecutionsList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ScriptExecutions_List": { - "$ref": "./examples/ScriptExecutions_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}": { - "get": { - "operationId": "ScriptExecutions_Get", - "tags": [ - "Scripts" - ], - "summary": "Get an script execution by name in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/scriptExecutionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/ScriptExecution" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ScriptExecutions_Get": { - "$ref": "./examples/ScriptExecutions_Get.json" - } - } - }, - "put": { - "operationId": "ScriptExecutions_CreateOrUpdate", - "x-ms-long-running-operation": true, - "tags": [ - "Scripts" - ], - "summary": "Create or update a script execution in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "privateCloudName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the private cloud." - }, - { - "$ref": "#/parameters/scriptExecutionName" - }, - { - "name": "scriptExecution", - "description": "A script running in the private cloud", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ScriptExecution" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/ScriptExecution" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/ScriptExecution" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ScriptExecutions_CreateOrUpdate": { - "$ref": "./examples/ScriptExecutions_CreateOrUpdate.json" - } - } - }, - "delete": { - "operationId": "ScriptExecutions_Delete", - "x-ms-long-running-operation": true, - "tags": [ - "Scripts" - ], - "summary": "Cancel a ScriptExecution in a private cloud", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/scriptExecutionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No script to cancel" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ScriptExecutions_Delete": { - "$ref": "./examples/ScriptExecutions_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}/getExecutionLogs": { - "post": { - "tags": [ - "Scripts" - ], - "description": "Return the logs for a script execution resource", - "operationId": "ScriptExecutions_GetExecutionLogs", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/scriptExecutionName" - }, - { - "$ref": "#/parameters/scriptOutputStreamType" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request has succeeded", - "schema": { - "$ref": "#/definitions/ScriptExecution" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ScriptExecutions_GetExecutionLogs": { - "$ref": "./examples/ScriptExecutions_GetExecutionLogs.json" - } - } - } - } - }, - "definitions": { - "Trial": { - "type": "object", - "description": "Subscription trial availability", - "properties": { - "status": { - "description": "Trial status", - "type": "string", - "enum": [ - "TrialAvailable", - "TrialUsed", - "TrialDisabled" - ], - "readOnly": true, - "x-ms-enum": { - "name": "TrialStatus", - "modelAsString": true - } - }, - "availableHosts": { - "description": "Number of trial hosts available", - "type": "integer", - "format": "int32", - "readOnly": true - } - } - }, - "Quota": { - "type": "object", - "description": "Subscription quotas", - "properties": { - "hostsRemaining": { - "description": "Remaining hosts quota by sku type", - "type": "object", - "readOnly": true, - "additionalProperties": { - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "quotaEnabled": { - "description": "Host quota is active for current subscription", - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "readOnly": true, - "x-ms-enum": { - "name": "QuotaEnabled", - "modelAsString": true - } - } - } - }, - "Resource": { - "type": "object", - "description": "The core properties of ARM resources", - "properties": { - "id": { - "description": "Resource ID.", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Resource name.", - "readOnly": true, - "type": "string" - }, - "type": { - "description": "Resource type.", - "readOnly": true, - "type": "string" - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "type": "object", - "description": "The resource model definition for a ARM tracked top level resource", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "description": "Resource tags", - "$ref": "#/definitions/ResourceTags" - } - } - }, - "ResourceTags": { - "description": "Resource tags", - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ] - }, - "ProxyResource": { - "type": "object", - "description": "The resource model definition for a ARM proxy resource", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "OperationList": { - "type": "object", - "description": "Pageable list of operations", - "properties": { - "value": { - "description": "List of operations", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Operation" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "Operation": { - "description": "A REST API operation", - "type": "object", - "properties": { - "name": { - "description": "Name of the operation being performed on this object", - "type": "string", - "readOnly": true - }, - "display": { - "type": "object", - "description": "Contains the localized display information for this operation", - "readOnly": true, - "properties": { - "provider": { - "description": "Localized friendly form of the resource provider name", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "Localized friendly form of the resource type related to this operation", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "Localized friendly name for the operation", - "type": "string", - "readOnly": true - }, - "description": { - "description": "Localized friendly description for the operation", - "type": "string", - "readOnly": true - } - } - }, - "isDataAction": { - "description": "Gets or sets a value indicating whether the operation is a data action or not", - "type": "boolean" - }, - "origin": { - "description": "Origin of the operation", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/OperationProperties", - "description": "Properties of the operation" - } - } - }, - "OperationProperties": { - "description": "Extra Operation properties", - "type": "object", - "properties": { - "serviceSpecification": { - "$ref": "#/definitions/ServiceSpecification", - "description": "Service specifications of the operation" - } - } - }, - "ServiceSpecification": { - "description": "Service specification payload", - "type": "object", - "properties": { - "logSpecifications": { - "description": "Specifications of the Log for Azure Monitoring", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/LogSpecification" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "metricSpecifications": { - "description": "Specifications of the Metrics for Azure Monitoring", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/MetricSpecification" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "LogSpecification": { - "description": "Specifications of the Log for Azure Monitoring", - "type": "object", - "properties": { - "name": { - "description": "Name of the log", - "type": "string" - }, - "displayName": { - "description": "Localized friendly display name of the log", - "type": "string" - }, - "blobDuration": { - "description": "Blob duration of the log", - "type": "string" - } - } - }, - "MetricSpecification": { - "description": "Specifications of the Metrics for Azure Monitoring", - "type": "object", - "properties": { - "name": { - "description": "Name of the metric", - "type": "string" - }, - "displayName": { - "description": "Localized friendly display name of the metric", - "type": "string" - }, - "displayDescription": { - "description": "Localized friendly description of the metric", - "type": "string" - }, - "unit": { - "description": "Unit that makes sense for the metric", - "type": "string" - }, - "category": { - "description": "Name of the metric category that the metric belongs to. A metric can only belong to a single category.", - "type": "string" - }, - "aggregationType": { - "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", - "type": "string" - }, - "supportedAggregationTypes": { - "description": "Supported aggregation types", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "supportedTimeGrainTypes": { - "description": "Supported time grain types", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "fillGapWithZero": { - "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.", - "type": "boolean" - }, - "dimensions": { - "description": "Dimensions of the metric", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/MetricDimension" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "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" - } - } - }, - "MetricDimension": { - "description": "Specifications of the Dimension of metrics", - "type": "object", - "properties": { - "name": { - "description": "Name of the dimension", - "type": "string" - }, - "displayName": { - "description": "Localized friendly display name of the dimension", - "type": "string" - }, - "internalName": { - "description": "Name of the dimension as it appears in MDM", - "type": "string" - }, - "toBeExportedForShoebox": { - "description": "A boolean flag indicating whether this dimension should be included for the shoebox export scenario", - "type": "boolean" - } - } - }, - "ExpressRouteAuthorization": { - "type": "object", - "description": "ExpressRoute Circuit Authorization", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "The properties of an ExpressRoute Circuit Authorization resource", - "$ref": "#/definitions/ExpressRouteAuthorizationProperties", - "x-ms-client-flatten": true, - "readOnly": true - } - } - }, - "ExpressRouteAuthorizationProperties": { - "type": "object", - "description": "The properties of an ExpressRoute Circuit Authorization resource", - "properties": { - "provisioningState": { - "description": "The state of the ExpressRoute Circuit Authorization provisioning", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Updating", - "Canceled" - ], - "x-ms-enum": { - "name": "ExpressRouteAuthorizationProvisioningState", - "modelAsString": true - } - }, - "expressRouteAuthorizationId": { - "description": "The ID of the ExpressRoute Circuit Authorization", - "type": "string", - "readOnly": true - }, - "expressRouteAuthorizationKey": { - "description": "The key of the ExpressRoute Circuit Authorization", - "type": "string", - "readOnly": true - }, - "expressRouteId": { - "type": "string", - "description": "The ID of the ExpressRoute Circuit" - } - } - }, - "ExpressRouteAuthorizationList": { - "type": "object", - "description": "A paged list of ExpressRoute Circuit Authorizations", - "properties": { - "value": { - "description": "The items on a page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ExpressRouteAuthorization" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "Circuit": { - "type": "object", - "description": "An ExpressRoute Circuit", - "properties": { - "primarySubnet": { - "type": "string", - "readOnly": true, - "description": "CIDR of primary subnet" - }, - "secondarySubnet": { - "type": "string", - "readOnly": true, - "description": "CIDR of secondary subnet" - }, - "expressRouteID": { - "type": "string", - "readOnly": true, - "description": "Identifier of the ExpressRoute Circuit (Microsoft Colo only)" - }, - "expressRoutePrivatePeeringID": { - "type": "string", - "readOnly": true, - "description": "ExpressRoute Circuit private peering identifier" - } - } - }, - "EncryptionKeyVaultProperties": { - "type": "object", - "description": "An Encryption Key", - "properties": { - "keyName": { - "type": "string", - "description": "The name of the key." - }, - "keyVersion": { - "type": "string", - "description": "The version of the key." - }, - "autoDetectedKeyVersion": { - "type": "string", - "readOnly": true, - "description": "The auto-detected version of the key if versionType is auto-detected." - }, - "keyVaultUrl": { - "type": "string", - "description": "The URL of the vault." - }, - "keyState": { - "type": "string", - "description": "The state of key provided", - "readOnly": true, - "enum": [ - "Connected", - "AccessDenied" - ], - "x-ms-enum": { - "name": "EncryptionKeyStatus", - "modelAsString": true - } - }, - "versionType": { - "type": "string", - "description": "Property of the key if user provided or auto detected", - "readOnly": true, - "enum": [ - "Fixed", - "AutoDetected" - ], - "x-ms-enum": { - "name": "EncryptionVersionType", - "modelAsString": true - } - } - } - }, - "Encryption": { - "type": "object", - "description": "The properties of customer managed encryption key", - "properties": { - "status": { - "description": "Status of customer managed encryption key", - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "EncryptionState", - "modelAsString": true - } - }, - "keyVaultProperties": { - "description": "The key vault where the encryption key is stored", - "$ref": "#/definitions/EncryptionKeyVaultProperties" - } - } - }, - "Endpoints": { - "type": "object", - "description": "Endpoint addresses", - "properties": { - "nsxtManager": { - "description": "Endpoint for the NSX-T Data Center manager", - "type": "string", - "readOnly": true - }, - "vcsa": { - "description": "Endpoint for Virtual Center Server Appliance", - "type": "string", - "readOnly": true - }, - "hcxCloudManager": { - "description": "Endpoint for the HCX Cloud Manager", - "type": "string", - "readOnly": true - } - } - }, - "IdentitySource": { - "type": "object", - "description": "vCenter Single Sign On Identity Source", - "properties": { - "name": { - "description": "The name of the identity source", - "type": "string" - }, - "alias": { - "description": "The domain's NetBIOS name", - "type": "string" - }, - "domain": { - "description": "The domain's dns name", - "type": "string" - }, - "baseUserDN": { - "description": "The base distinguished name for users", - "type": "string" - }, - "baseGroupDN": { - "description": "The base distinguished name for groups", - "type": "string" - }, - "primaryServer": { - "description": "Primary server URL", - "type": "string" - }, - "secondaryServer": { - "description": "Secondary server URL", - "type": "string" - }, - "ssl": { - "description": "Protect LDAP communication using SSL certificate (LDAPS)", - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "SslEnum", - "modelAsString": true - } - }, - "username": { - "description": "The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group", - "type": "string" - }, - "password": { - "description": "The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.", - "type": "string", - "x-ms-secret": true - } - } - }, - "AvailabilityProperties": { - "type": "object", - "description": "The properties describing private cloud availability zone distribution", - "properties": { - "strategy": { - "description": "The availability strategy for the private cloud", - "type": "string", - "enum": [ - "SingleZone", - "DualZone" - ], - "x-ms-enum": { - "name": "AvailabilityStrategy", - "modelAsString": true - } - }, - "zone": { - "description": "The primary availability zone for the private cloud", - "type": "integer", - "format": "int32" - }, - "secondaryZone": { - "description": "The secondary availability zone for the private cloud", - "type": "integer", - "format": "int32" - } - } - }, - "PrivateCloud": { - "type": "object", - "description": "A private cloud resource", - "required": [ - "location", - "sku" - ], - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "sku": { - "description": "The private cloud SKU", - "$ref": "#/definitions/Sku" - }, - "properties": { - "description": "The properties of a private cloud resource", - "$ref": "#/definitions/PrivateCloudProperties", - "x-ms-client-flatten": true - }, - "identity": { - "$ref": "#/definitions/PrivateCloudIdentity", - "description": "The identity of the private cloud, if configured." - } - } - }, - "PrivateCloudUpdate": { - "type": "object", - "description": "An update to a private cloud resource", - "properties": { - "tags": { - "description": "Resource tags", - "$ref": "#/definitions/ResourceTags" - }, - "properties": { - "description": "The updatable properties of a private cloud resource", - "$ref": "#/definitions/PrivateCloudUpdateProperties", - "x-ms-client-flatten": true - }, - "identity": { - "$ref": "#/definitions/PrivateCloudIdentity", - "description": "The identity of the private cloud, if configured." - } - } - }, - "PrivateCloudUpdateProperties": { - "type": "object", - "description": "The properties of a private cloud resource that may be updated", - "properties": { - "managementCluster": { - "description": "The default cluster used for management", - "$ref": "#/definitions/ManagementCluster" - }, - "internet": { - "description": "Connectivity to internet is enabled or disabled", - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "default": "Disabled", - "x-ms-enum": { - "name": "InternetEnum", - "modelAsString": true - } - }, - "identitySources": { - "description": "vCenter Single Sign On Identity Sources", - "type": "array", - "items": { - "$ref": "#/definitions/IdentitySource" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "availability": { - "description": "Properties describing how the cloud is distributed across availability zones", - "$ref": "#/definitions/AvailabilityProperties", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "encryption": { - "description": "Customer managed key encryption, can be enabled or disabled", - "$ref": "#/definitions/Encryption" - }, - "extendedNetworkBlocks": { - "description": "Array of additional networks noncontiguous with networkBlock. Networks must be unique and non-overlapping across VNet in your subscription, on-premise, and this privateCloud networkBlock attribute. Make sure the CIDR format conforms to (A.B.C.D/X).", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "PrivateCloudProperties": { - "type": "object", - "description": "The properties of a private cloud resource", - "required": [ - "managementCluster", - "networkBlock" - ], - "allOf": [ - { - "$ref": "#/definitions/PrivateCloudUpdateProperties" - } - ], - "properties": { - "provisioningState": { - "description": "The provisioning state", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Cancelled", - "Pending", - "Building", - "Deleting", - "Updating", - "Canceled" - ], - "x-ms-enum": { - "name": "PrivateCloudProvisioningState", - "modelAsString": true - } - }, - "circuit": { - "description": "An ExpressRoute Circuit", - "$ref": "#/definitions/Circuit" - }, - "endpoints": { - "description": "The endpoints", - "readOnly": true, - "$ref": "#/definitions/Endpoints" - }, - "networkBlock": { - "description": "The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "managementNetwork": { - "description": "Network used to access vCenter Server and NSX-T Manager", - "type": "string", - "readOnly": true - }, - "provisioningNetwork": { - "description": "Used for virtual machine cold migration, cloning, and snapshot migration", - "type": "string", - "readOnly": true - }, - "vmotionNetwork": { - "description": "Used for live migration of virtual machines", - "type": "string", - "readOnly": true - }, - "vcenterPassword": { - "description": "Optionally, set the vCenter admin password when the private cloud is created", - "type": "string", - "x-ms-secret": true - }, - "nsxtPassword": { - "description": "Optionally, set the NSX-T Manager password when the private cloud is created", - "type": "string", - "x-ms-secret": true - }, - "vcenterCertificateThumbprint": { - "description": "Thumbprint of the vCenter Server SSL certificate", - "type": "string", - "readOnly": true - }, - "nsxtCertificateThumbprint": { - "description": "Thumbprint of the NSX-T Manager SSL certificate", - "type": "string", - "readOnly": true - }, - "externalCloudLinks": { - "description": "Array of cloud link IDs from other clouds that connect to this one", - "type": "array", - "readOnly": true, - "items": { - "type": "string" - } - }, - "secondaryCircuit": { - "description": "A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud", - "$ref": "#/definitions/Circuit" - }, - "nsxPublicIpQuotaRaised": { - "description": "Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024", - "type": "string", - "readOnly": true, - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "nsxPublicIpQuotaRaisedEnum", - "modelAsString": true - } - } - } - }, - "Cluster": { - "type": "object", - "description": "A cluster resource", - "required": [ - "sku" - ], - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "sku": { - "description": "The cluster SKU", - "$ref": "#/definitions/Sku" - }, - "properties": { - "description": "The properties of a cluster resource", - "$ref": "#/definitions/ClusterProperties", - "x-ms-client-flatten": true - } - } - }, - "ClusterUpdate": { - "type": "object", - "description": "An update of a cluster resource", - "properties": { - "properties": { - "description": "The properties of a cluster resource that may be updated", - "$ref": "#/definitions/ClusterUpdateProperties", - "x-ms-client-flatten": true - } - } - }, - "ClusterUpdateProperties": { - "type": "object", - "description": "The properties of a cluster that may be updated", - "properties": { - "clusterSize": { - "description": "The cluster size", - "type": "integer", - "format": "int32" - }, - "hosts": { - "description": "The hosts", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ClusterProvisioningState": { - "description": "The state of the cluster provisioning", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Cancelled", - "Deleting", - "Updating", - "Canceled" - ], - "x-ms-enum": { - "name": "ClusterProvisioningState", - "modelAsString": true - } - }, - "CommonClusterProperties": { - "type": "object", - "description": "The common properties of a cluster", - "properties": { - "clusterSize": { - "description": "The cluster size", - "type": "integer", - "format": "int32" - }, - "provisioningState": { - "description": "The state of the cluster provisioning", - "$ref": "#/definitions/ClusterProvisioningState" - }, - "clusterId": { - "description": "The identity", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "hosts": { - "description": "The hosts", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ManagementCluster": { - "type": "object", - "description": "The properties of a management cluster", - "required": [ - "clusterSize" - ], - "allOf": [ - { - "$ref": "#/definitions/CommonClusterProperties" - } - ] - }, - "ClusterProperties": { - "type": "object", - "description": "The properties of a cluster", - "allOf": [ - { - "$ref": "#/definitions/CommonClusterProperties" - } - ] - }, - "PrivateCloudList": { - "type": "object", - "description": "A paged list of private clouds", - "properties": { - "value": { - "description": "The items on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/PrivateCloud" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "ClusterList": { - "type": "object", - "description": "A paged list of clusters", - "properties": { - "value": { - "description": "The items on a page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Cluster" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "Addon": { - "type": "object", - "description": "An addon resource", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "The properties of an addon resource", - "$ref": "#/definitions/AddonProperties", - "x-ms-client-flatten": false - } - } - }, - "AddonProperties": { - "type": "object", - "description": "The properties of an addon", - "discriminator": "addonType", - "properties": { - "addonType": { - "description": "The type of private cloud addon", - "type": "string", - "enum": [ - "SRM", - "VR", - "HCX", - "Arc" - ], - "x-ms-enum": { - "name": "AddonType", - "modelAsString": true - } - }, - "provisioningState": { - "description": "The state of the addon provisioning", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Cancelled", - "Building", - "Deleting", - "Updating", - "Canceled" - ], - "x-ms-enum": { - "name": "AddonProvisioningState", - "modelAsString": true - } - } - }, - "required": [ - "addonType" - ] - }, - "AddonSrmProperties": { - "type": "object", - "description": "The properties of a Site Recovery Manager (SRM) addon", - "x-ms-discriminator-value": "SRM", - "allOf": [ - { - "$ref": "#/definitions/AddonProperties" - } - ], - "properties": { - "licenseKey": { - "description": "The Site Recovery Manager (SRM) license", - "type": "string" - } - } - }, - "AddonVrProperties": { - "type": "object", - "description": "The properties of a vSphere Replication (VR) addon", - "x-ms-discriminator-value": "VR", - "allOf": [ - { - "$ref": "#/definitions/AddonProperties" - } - ], - "properties": { - "vrsCount": { - "description": "The vSphere Replication Server (VRS) count", - "type": "integer", - "format": "int32" - } - }, - "required": [ - "vrsCount" - ] - }, - "AddonHcxProperties": { - "type": "object", - "description": "The properties of an HCX addon", - "x-ms-discriminator-value": "HCX", - "allOf": [ - { - "$ref": "#/definitions/AddonProperties" - } - ], - "properties": { - "offer": { - "description": "The HCX offer, example VMware MaaS Cloud Provider (Enterprise)", - "type": "string" - } - }, - "required": [ - "offer" - ] - }, - "AddonArcProperties": { - "type": "object", - "description": "The properties of an Arc addon", - "x-ms-discriminator-value": "Arc", - "allOf": [ - { - "$ref": "#/definitions/AddonProperties" - } - ], - "properties": { - "vCenter": { - "description": "The VMware vCenter resource ID", - "type": "string" - } - } - }, - "AddonList": { - "type": "object", - "description": "A paged list of addons", - "properties": { - "value": { - "description": "The items on a page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Addon" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "DatastoreList": { - "type": "object", - "description": "A paged list of datastores", - "properties": { - "value": { - "description": "The items on a page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Datastore" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "Datastore": { - "type": "object", - "description": "A datastore resource", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "The properties of a datastore resource", - "$ref": "#/definitions/DatastoreProperties", - "x-ms-client-flatten": true - } - } - }, - "DatastoreProperties": { - "type": "object", - "description": "The properties of a datastore", - "properties": { - "provisioningState": { - "description": "The state of the datastore provisioning", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Cancelled", - "Pending", - "Creating", - "Updating", - "Deleting", - "Canceled" - ], - "x-ms-enum": { - "name": "DatastoreProvisioningState", - "modelAsString": true - } - }, - "netAppVolume": { - "description": "An Azure NetApp Files volume", - "$ref": "#/definitions/NetAppVolume" - }, - "diskPoolVolume": { - "description": "An iSCSI volume", - "$ref": "#/definitions/DiskPoolVolume" - }, - "status": { - "description": "The operational status of the datastore", - "type": "string", - "readOnly": true, - "enum": [ - "Unknown", - "Accessible", - "Inaccessible", - "Attached", - "Detached", - "LostCommunication", - "DeadOrError" - ], - "x-ms-enum": { - "name": "DatastoreStatus", - "modelAsString": true - } - } - } - }, - "NetAppVolume": { - "type": "object", - "description": "An Azure NetApp Files volume from Microsoft.NetApp provider", - "properties": { - "id": { - "type": "string", - "description": "Azure resource ID of the NetApp volume" - } - }, - "required": [ - "id" - ] - }, - "DiskPoolVolume": { - "type": "object", - "description": "An iSCSI volume from Microsoft.StoragePool provider", - "properties": { - "targetId": { - "type": "string", - "description": "Azure resource ID of the iSCSI target" - }, - "lunName": { - "type": "string", - "description": "Name of the LUN to be used for datastore" - }, - "mountOption": { - "type": "string", - "description": "Mode that describes whether the LUN has to be mounted as a datastore or attached as a LUN", - "enum": [ - "MOUNT", - "ATTACH" - ], - "x-ms-enum": { - "name": "MountOptionEnum", - "modelAsString": true - }, - "default": "MOUNT" - }, - "path": { - "type": "string", - "description": "Device path", - "readOnly": true - } - }, - "required": [ - "targetId", - "lunName" - ] - }, - "AdminCredentials": { - "type": "object", - "description": "Administrative credentials for accessing vCenter and NSX-T", - "properties": { - "nsxtUsername": { - "description": "NSX-T Manager username", - "type": "string", - "readOnly": true - }, - "nsxtPassword": { - "description": "NSX-T Manager password", - "type": "string", - "readOnly": true, - "x-ms-secret": true - }, - "vcenterUsername": { - "description": "vCenter admin username", - "type": "string", - "readOnly": true - }, - "vcenterPassword": { - "description": "vCenter admin password", - "type": "string", - "readOnly": true, - "x-ms-secret": true - } - } - }, - "Sku": { - "type": "object", - "description": "The resource model definition representing SKU", - "properties": { - "name": { - "type": "string", - "description": "The name of the SKU." - } - }, - "required": [ - "name" - ] - }, - "HcxEnterpriseSiteList": { - "type": "object", - "description": "A paged list of HCX Enterprise Sites", - "properties": { - "value": { - "description": "The items on a page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/HcxEnterpriseSite" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "HcxEnterpriseSite": { - "type": "object", - "description": "An HCX Enterprise Site resource", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "The properties of an HCX Enterprise Site resource", - "$ref": "#/definitions/HcxEnterpriseSiteProperties", - "x-ms-client-flatten": true, - "readOnly": true - } - } - }, - "HcxEnterpriseSiteProperties": { - "type": "object", - "description": "The properties of an HCX Enterprise Site", - "properties": { - "activationKey": { - "description": "The activation key", - "type": "string", - "readOnly": true - }, - "status": { - "description": "The status of the HCX Enterprise Site", - "type": "string", - "readOnly": true, - "enum": [ - "Available", - "Consumed", - "Deactivated", - "Deleted" - ], - "x-ms-enum": { - "name": "HcxEnterpriseSiteStatus", - "modelAsString": true - } - } - } - }, - "GlobalReachConnectionList": { - "type": "object", - "description": "A paged list of global reach connections", - "properties": { - "value": { - "description": "The items on a page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/GlobalReachConnection" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "GlobalReachConnection": { - "type": "object", - "description": "A global reach connection resource", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "The properties of a global reach connection resource", - "$ref": "#/definitions/GlobalReachConnectionProperties", - "x-ms-client-flatten": true - } - } - }, - "GlobalReachConnectionProperties": { - "type": "object", - "description": "The properties of a global reach connection", - "properties": { - "provisioningState": { - "description": "The state of the ExpressRoute Circuit Authorization provisioning", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Updating", - "Canceled" - ], - "x-ms-enum": { - "name": "GlobalReachConnectionProvisioningState", - "modelAsString": true - } - }, - "addressPrefix": { - "description": "The network used for global reach carved out from the original network block provided for the private cloud", - "type": "string", - "readOnly": true - }, - "authorizationKey": { - "description": "Authorization key from the peer express route used for the global reach connection", - "type": "string" - }, - "circuitConnectionStatus": { - "description": "The connection status of the global reach connection", - "type": "string", - "readOnly": true, - "enum": [ - "Connected", - "Connecting", - "Disconnected" - ], - "x-ms-enum": { - "name": "GlobalReachConnectionStatus", - "modelAsString": true - } - }, - "peerExpressRouteCircuit": { - "type": "string", - "description": "Identifier of the ExpressRoute Circuit to peer with in the global reach connection" - }, - "expressRouteId": { - "type": "string", - "description": "The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection" - } - } - }, - "CloudLinkList": { - "type": "object", - "description": "A paged list of cloud links", - "properties": { - "value": { - "description": "The items on a page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/CloudLink" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "CloudLink": { - "type": "object", - "description": "A cloud link resource", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "The properties of a cloud link.", - "$ref": "#/definitions/CloudLinkProperties", - "x-ms-client-flatten": true - } - } - }, - "CloudLinkProperties": { - "type": "object", - "description": "The properties of a cloud link.", - "properties": { - "status": { - "description": "The state of the cloud link.", - "type": "string", - "readOnly": true, - "enum": [ - "Active", - "Building", - "Deleting", - "Failed", - "Disconnected" - ], - "x-ms-enum": { - "name": "CloudLinkStatus", - "modelAsString": true - } - }, - "linkedCloud": { - "type": "string", - "description": "Identifier of the other private cloud participating in the link." - } - } - }, - "WorkloadNetworkSegmentSubnet": { - "type": "object", - "description": "Subnet configuration for segment", - "properties": { - "dhcpRanges": { - "description": "DHCP Range assigned for subnet.", - "type": "array", - "items": { - "type": "string" - } - }, - "gatewayAddress": { - "description": "Gateway address.", - "type": "string" - } - } - }, - "WorkloadNetworkSegmentPortVif": { - "type": "object", - "description": "Ports and any VIF attached to segment.", - "properties": { - "portName": { - "description": "Name of port or VIF attached to segment.", - "type": "string" - } - } - }, - "WorkloadNetworkSegmentProperties": { - "type": "object", - "description": "NSX Segment Properties", - "properties": { - "displayName": { - "description": "Display name of the segment.", - "type": "string" - }, - "connectedGateway": { - "description": "Gateway which to connect segment to.", - "type": "string" - }, - "subnet": { - "description": "Subnet which to connect segment to.", - "$ref": "#/definitions/WorkloadNetworkSegmentSubnet" - }, - "portVif": { - "description": "Port Vif which segment is associated with.", - "type": "array", - "items": { - "$ref": "#/definitions/WorkloadNetworkSegmentPortVif" - }, - "x-ms-identifiers": [ - "portName" - ], - "readOnly": true - }, - "status": { - "description": "Segment status.", - "type": "string", - "enum": [ - "SUCCESS", - "FAILURE" - ], - "x-ms-enum": { - "name": "SegmentStatusEnum", - "modelAsString": true - }, - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning state", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Building", - "Deleting", - "Updating", - "Canceled" - ], - "x-ms-enum": { - "name": "WorkloadNetworkSegmentProvisioningState", - "modelAsString": true - } - }, - "revision": { - "description": "NSX revision number.", - "type": "integer", - "format": "int64" - } - } - }, - "WorkloadNetwork": { - "type": "object", - "description": "Workload Network", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "WorkloadNetworkSegment": { - "type": "object", - "description": "NSX Segment", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "description": "The properties of a Workload Segment proxy resource.", - "$ref": "#/definitions/WorkloadNetworkSegmentProperties", - "x-ms-client-flatten": true - } - } - }, - "WorkloadNetworkList": { - "type": "object", - "description": "A list of workload networks", - "properties": { - "value": { - "description": "The items on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/WorkloadNetwork" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "WorkloadNetworkSegmentsList": { - "type": "object", - "description": "A list of NSX Segments", - "properties": { - "value": { - "description": "The items on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/WorkloadNetworkSegment" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "WorkloadNetworkDhcpEntity": { - "type": "object", - "description": "Base class for WorkloadNetworkDhcpServer and WorkloadNetworkDhcpRelay to inherit from", - "discriminator": "dhcpType", - "properties": { - "dhcpType": { - "description": "Type of DHCP: SERVER or RELAY.", - "type": "string", - "enum": [ - "SERVER", - "RELAY" - ], - "x-ms-enum": { - "name": "DhcpTypeEnum", - "modelAsString": true - } - }, - "displayName": { - "description": "Display name of the DHCP entity.", - "type": "string" - }, - "segments": { - "description": "NSX Segments consuming DHCP.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning state", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Building", - "Deleting", - "Updating", - "Canceled" - ], - "x-ms-enum": { - "name": "WorkloadNetworkDhcpProvisioningState", - "modelAsString": true - } - }, - "revision": { - "description": "NSX revision number.", - "type": "integer", - "format": "int64" - } - }, - "required": [ - "dhcpType" - ] - }, - "WorkloadNetworkDhcpServer": { - "type": "object", - "description": "NSX DHCP Server", - "x-ms-discriminator-value": "SERVER", - "allOf": [ - { - "$ref": "#/definitions/WorkloadNetworkDhcpEntity" - } - ], - "properties": { - "serverAddress": { - "description": "DHCP Server Address.", - "type": "string" - }, - "leaseTime": { - "description": "DHCP Server Lease Time.", - "type": "integer", - "format": "int64" - } - } - }, - "WorkloadNetworkDhcpRelay": { - "type": "object", - "description": "NSX DHCP Relay", - "x-ms-discriminator-value": "RELAY", - "allOf": [ - { - "$ref": "#/definitions/WorkloadNetworkDhcpEntity" - } - ], - "properties": { - "serverAddresses": { - "description": "DHCP Relay Addresses. Max 3.", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1, - "maxItems": 3 - } - } - }, - "WorkloadNetworkDhcp": { - "type": "object", - "description": "NSX DHCP", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "description": "DHCP properties.", - "$ref": "#/definitions/WorkloadNetworkDhcpEntity", - "x-ms-client-flatten": false - } - } - }, - "WorkloadNetworkDhcpList": { - "type": "object", - "description": "A list of NSX dhcp entities", - "properties": { - "value": { - "description": "The items on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/WorkloadNetworkDhcp" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "WorkloadNetworkPortMirroringProperties": { - "type": "object", - "description": "NSX Port Mirroring Properties", - "properties": { - "displayName": { - "description": "Display name of the port mirroring profile.", - "type": "string" - }, - "direction": { - "description": "Direction of port mirroring profile.", - "type": "string", - "enum": [ - "INGRESS", - "EGRESS", - "BIDIRECTIONAL" - ], - "x-ms-enum": { - "name": "PortMirroringDirectionEnum", - "modelAsString": true - } - }, - "source": { - "description": "Source VM Group.", - "type": "string" - }, - "destination": { - "description": "Destination VM Group.", - "type": "string" - }, - "status": { - "description": "Port Mirroring Status.", - "type": "string", - "enum": [ - "SUCCESS", - "FAILURE" - ], - "x-ms-enum": { - "name": "PortMirroringStatusEnum", - "modelAsString": true - }, - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning state", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Building", - "Deleting", - "Updating", - "Canceled" - ], - "x-ms-enum": { - "name": "WorkloadNetworkPortMirroringProvisioningState", - "modelAsString": true - } - }, - "revision": { - "description": "NSX revision number.", - "type": "integer", - "format": "int64" - } - } - }, - "WorkloadNetworkPortMirroring": { - "type": "object", - "description": "NSX Port Mirroring", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "description": "Port Mirroring Properties.", - "$ref": "#/definitions/WorkloadNetworkPortMirroringProperties", - "x-ms-client-flatten": true - } - } - }, - "WorkloadNetworkPortMirroringList": { - "type": "object", - "description": "A list of NSX Port Mirroring", - "properties": { - "value": { - "description": "The items on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/WorkloadNetworkPortMirroring" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "WorkloadNetworkVMGroupProperties": { - "type": "object", - "description": "NSX VM Group Properties", - "properties": { - "displayName": { - "description": "Display name of the VM group.", - "type": "string" - }, - "members": { - "description": "Virtual machine members of this group.", - "type": "array", - "items": { - "type": "string" - } - }, - "status": { - "description": "VM Group status.", - "type": "string", - "enum": [ - "SUCCESS", - "FAILURE" - ], - "x-ms-enum": { - "name": "VMGroupStatusEnum", - "modelAsString": true - }, - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning state", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Building", - "Deleting", - "Updating", - "Canceled" - ], - "x-ms-enum": { - "name": "WorkloadNetworkVMGroupProvisioningState", - "modelAsString": true - } - }, - "revision": { - "description": "NSX revision number.", - "type": "integer", - "format": "int64" - } - } - }, - "WorkloadNetworkVMGroup": { - "type": "object", - "description": "NSX VM Group", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "description": "VM Group properties.", - "$ref": "#/definitions/WorkloadNetworkVMGroupProperties", - "x-ms-client-flatten": true - } - } - }, - "WorkloadNetworkVMGroupsList": { - "type": "object", - "description": "A list of NSX VM Groups", - "properties": { - "value": { - "description": "The items on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/WorkloadNetworkVMGroup" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "WorkloadNetworkVirtualMachineProperties": { - "type": "object", - "description": "NSX Virtual Machine Properties", - "properties": { - "displayName": { - "description": "Display name of the VM.", - "type": "string" - }, - "vmType": { - "description": "Virtual machine type.", - "type": "string", - "enum": [ - "REGULAR", - "EDGE", - "SERVICE" - ], - "x-ms-enum": { - "name": "VMTypeEnum", - "modelAsString": true - }, - "readOnly": true - } - } - }, - "WorkloadNetworkVirtualMachine": { - "type": "object", - "description": "NSX Virtual Machine", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "description": "Virtual machine properties.", - "$ref": "#/definitions/WorkloadNetworkVirtualMachineProperties", - "x-ms-client-flatten": true - } - } - }, - "WorkloadNetworkVirtualMachinesList": { - "type": "object", - "description": "A list of NSX Virtual Machines", - "properties": { - "value": { - "description": "The items on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/WorkloadNetworkVirtualMachine" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "WorkloadNetworkGatewayProperties": { - "type": "object", - "description": "Properties of a NSX Gateway.", - "properties": { - "displayName": { - "description": "Display name of the DHCP entity.", - "type": "string" - }, - "path": { - "description": "NSX Gateway Path.", - "type": "string", - "readOnly": true - } - } - }, - "WorkloadNetworkGateway": { - "type": "object", - "description": "NSX Gateway.", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "description": "Gateway properties.", - "$ref": "#/definitions/WorkloadNetworkGatewayProperties", - "x-ms-client-flatten": true - } - } - }, - "WorkloadNetworkGatewayList": { - "type": "object", - "description": "A list of NSX Gateways", - "properties": { - "value": { - "description": "The items on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/WorkloadNetworkGateway" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "WorkloadNetworkDnsServiceProperties": { - "type": "object", - "description": "NSX DNS Service Properties", - "properties": { - "displayName": { - "description": "Display name of the DNS Service.", - "type": "string" - }, - "dnsServiceIp": { - "description": "DNS service IP of the DNS Service.", - "type": "string" - }, - "defaultDnsZone": { - "description": "Default DNS zone of the DNS Service.", - "type": "string" - }, - "fqdnZones": { - "description": "FQDN zones of the DNS Service.", - "type": "array", - "items": { - "type": "string" - } - }, - "logLevel": { - "description": "DNS Service log level.", - "type": "string", - "enum": [ - "DEBUG", - "INFO", - "WARNING", - "ERROR", - "FATAL" - ], - "x-ms-enum": { - "name": "DnsServiceLogLevelEnum", - "modelAsString": true - } - }, - "status": { - "description": "DNS Service status.", - "type": "string", - "enum": [ - "SUCCESS", - "FAILURE" - ], - "x-ms-enum": { - "name": "DnsServiceStatusEnum", - "modelAsString": true - }, - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning state", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Building", - "Deleting", - "Updating", - "Canceled" - ], - "x-ms-enum": { - "name": "WorkloadNetworkDnsServiceProvisioningState", - "modelAsString": true - } - }, - "revision": { - "description": "NSX revision number.", - "type": "integer", - "format": "int64" - } - } - }, - "WorkloadNetworkDnsService": { - "type": "object", - "description": "NSX DNS Service", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "description": "DNS Service properties", - "$ref": "#/definitions/WorkloadNetworkDnsServiceProperties", - "x-ms-client-flatten": true - } - } - }, - "WorkloadNetworkDnsServicesList": { - "type": "object", - "description": "A list of NSX DNS Services", - "properties": { - "value": { - "description": "The items on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/WorkloadNetworkDnsService" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "WorkloadNetworkDnsZoneProperties": { - "type": "object", - "description": "NSX DNS Zone Properties", - "properties": { - "displayName": { - "description": "Display name of the DNS Zone.", - "type": "string" - }, - "domain": { - "description": "Domain names of the DNS Zone.", - "type": "array", - "items": { - "type": "string" - } - }, - "dnsServerIps": { - "description": "DNS Server IP array of the DNS Zone.", - "type": "array", - "items": { - "type": "string" - } - }, - "sourceIp": { - "description": "Source IP of the DNS Zone.", - "type": "string" - }, - "dnsServices": { - "description": "Number of DNS Services using the DNS zone.", - "type": "integer", - "format": "int64" - }, - "provisioningState": { - "description": "The provisioning state", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Building", - "Deleting", - "Updating", - "Canceled" - ], - "x-ms-enum": { - "name": "WorkloadNetworkDnsZoneProvisioningState", - "modelAsString": true - } - }, - "revision": { - "description": "NSX revision number.", - "type": "integer", - "format": "int64" - } - } - }, - "WorkloadNetworkDnsZone": { - "type": "object", - "description": "NSX DNS Zone", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "description": "DNS Zone properties", - "$ref": "#/definitions/WorkloadNetworkDnsZoneProperties", - "x-ms-client-flatten": true - } - } - }, - "WorkloadNetworkDnsZonesList": { - "type": "object", - "description": "A list of NSX DNS Zones", - "properties": { - "value": { - "description": "The items on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/WorkloadNetworkDnsZone" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "WorkloadNetworkPublicIPProperties": { - "type": "object", - "description": "NSX Public IP Block Properties", - "properties": { - "displayName": { - "description": "Display name of the Public IP Block.", - "type": "string" - }, - "numberOfPublicIPs": { - "description": "Number of Public IPs requested.", - "type": "integer", - "format": "int64" - }, - "publicIPBlock": { - "description": "CIDR Block of the Public IP Block.", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning state", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Building", - "Deleting", - "Updating", - "Canceled" - ], - "x-ms-enum": { - "name": "WorkloadNetworkPublicIPProvisioningState", - "modelAsString": true - } - } - } - }, - "WorkloadNetworkPublicIP": { - "type": "object", - "description": "NSX Public IP Block", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "description": "Public IP Block properties", - "$ref": "#/definitions/WorkloadNetworkPublicIPProperties", - "x-ms-client-flatten": true - } - } - }, - "WorkloadNetworkPublicIPsList": { - "type": "object", - "description": "A list of NSX Public IP Blocks", - "properties": { - "value": { - "description": "The items on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/WorkloadNetworkPublicIP" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "VirtualMachineRestrictMovementState": { - "description": "Whether VM DRS-driven movement is restricted (enabled) or not (disabled)", - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "virtualMachineRestrictMovementState", - "modelAsString": true - } - }, - "VirtualMachineRestrictMovement": { - "type": "object", - "description": "Set VM DRS-driven movement to restricted (enabled) or not (disabled)", - "properties": { - "restrictMovement": { - "$ref": "#/definitions/VirtualMachineRestrictMovementState" - } - } - }, - "VirtualMachineProperties": { - "type": "object", - "description": "Virtual Machine Properties", - "properties": { - "displayName": { - "description": "Display name of the VM.", - "type": "string", - "readOnly": true - }, - "moRefId": { - "description": "Virtual machine managed object reference id", - "type": "string", - "readOnly": true - }, - "folderPath": { - "description": "Path to virtual machine's folder starting from datacenter virtual machine folder", - "type": "string", - "readOnly": true - }, - "restrictMovement": { - "$ref": "#/definitions/VirtualMachineRestrictMovementState", - "readOnly": true - } - } - }, - "VirtualMachine": { - "type": "object", - "description": "Virtual Machine", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "description": "Virtual machine properties.", - "$ref": "#/definitions/VirtualMachineProperties", - "x-ms-client-flatten": true - } - } - }, - "VirtualMachinesList": { - "type": "object", - "description": "A list of Virtual Machines", - "properties": { - "value": { - "description": "The items to be displayed on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/VirtualMachine" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "PlacementPolicyProperties": { - "type": "object", - "description": "Abstract placement policy properties", - "discriminator": "type", - "properties": { - "type": { - "description": "placement policy type", - "type": "string", - "enum": [ - "VmVm", - "VmHost" - ], - "x-ms-enum": { - "name": "PlacementPolicyType", - "modelAsString": true - } - }, - "state": { - "description": "Whether the placement policy is enabled or disabled", - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "PlacementPolicyState", - "modelAsString": true - } - }, - "displayName": { - "description": "Display name of the placement policy", - "type": "string" - }, - "provisioningState": { - "description": "The provisioning state", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Building", - "Deleting", - "Updating", - "Canceled" - ], - "x-ms-enum": { - "name": "PlacementPolicyProvisioningState", - "modelAsString": true - } - } - }, - "required": [ - "type" - ] - }, - "VmVmPlacementPolicyProperties": { - "type": "object", - "description": "VM-VM placement policy properties", - "x-ms-discriminator-value": "VmVm", - "allOf": [ - { - "$ref": "#/definitions/PlacementPolicyProperties" - } - ], - "properties": { - "vmMembers": { - "description": "Virtual machine members list", - "type": "array", - "items": { - "type": "string" - } - }, - "affinityType": { - "description": "placement policy affinity type", - "$ref": "#/definitions/AffinityType" - } - }, - "required": [ - "vmMembers", - "affinityType" - ] - }, - "VmHostPlacementPolicyProperties": { - "type": "object", - "description": "VM-Host placement policy properties", - "x-ms-discriminator-value": "VmHost", - "allOf": [ - { - "$ref": "#/definitions/PlacementPolicyProperties" - } - ], - "properties": { - "vmMembers": { - "description": "Virtual machine members list", - "type": "array", - "items": { - "type": "string" - } - }, - "hostMembers": { - "description": "Host members list", - "type": "array", - "items": { - "type": "string" - } - }, - "affinityType": { - "description": "placement policy affinity type", - "$ref": "#/definitions/AffinityType" - }, - "affinityStrength": { - "description": "vm-host placement policy affinity strength (should/must)", - "$ref": "#/definitions/AffinityStrength" - }, - "azureHybridBenefitType": { - "description": "placement policy azure hybrid benefit opt-in type", - "$ref": "#/definitions/AzureHybridBenefitType" - } - }, - "required": [ - "vmMembers", - "hostMembers", - "affinityType" - ] - }, - "PlacementPolicy": { - "type": "object", - "description": "A vSphere Distributed Resource Scheduler (DRS) placement policy", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "placement policy properties", - "$ref": "#/definitions/PlacementPolicyProperties", - "x-ms-client-flatten": false - } - } - }, - "PlacementPoliciesList": { - "type": "object", - "description": "Represents list of placement policies", - "properties": { - "value": { - "description": "The items on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/PlacementPolicy" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "PlacementPolicyUpdate": { - "type": "object", - "description": "An update of a DRS placement policy resource", - "properties": { - "properties": { - "description": "The properties of a placement policy resource that may be updated", - "$ref": "#/definitions/PlacementPolicyUpdateProperties", - "x-ms-client-flatten": true - } - } - }, - "PlacementPolicyUpdateProperties": { - "type": "object", - "description": "The properties of a placement policy resource that may be updated", - "properties": { - "state": { - "description": "Whether the placement policy is enabled or disabled", - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "PlacementPolicyState", - "modelAsString": true - } - }, - "vmMembers": { - "description": "Virtual machine members list", - "type": "array", - "items": { - "type": "string" - } - }, - "hostMembers": { - "description": "Host members list", - "type": "array", - "items": { - "type": "string" - } - }, - "affinityStrength": { - "description": "vm-host placement policy affinity strength (should/must)", - "$ref": "#/definitions/AffinityStrength" - }, - "azureHybridBenefitType": { - "description": "placement policy azure hybrid benefit opt-in type", - "$ref": "#/definitions/AzureHybridBenefitType" - } - } - }, - "AffinityType": { - "description": "Placement policy affinity type", - "type": "string", - "enum": [ - "Affinity", - "AntiAffinity" - ], - "x-ms-enum": { - "name": "AffinityType", - "modelAsString": true - } - }, - "AffinityStrength": { - "description": "VM-Host placement policy affinity strength (should/must)", - "type": "string", - "enum": [ - "Should", - "Must" - ], - "x-ms-enum": { - "name": "AffinityStrength", - "modelAsString": true - } - }, - "AzureHybridBenefitType": { - "description": "Placement policy hosts opt-in Azure Hybrid Benefit type", - "type": "string", - "enum": [ - "SqlHost", - "None" - ], - "x-ms-enum": { - "name": "AzureHybridBenefitType", - "modelAsString": true - } - }, - "ScriptPackageProperties": { - "type": "object", - "description": "Properties of a Script Package subresource", - "properties": { - "description": { - "description": "User friendly description of the package", - "type": "string", - "readOnly": true - }, - "version": { - "description": "Module version", - "type": "string", - "readOnly": true - }, - "company": { - "description": "Company that created and supports the package", - "type": "string", - "readOnly": true - }, - "uri": { - "description": "Link to support by the package vendor", - "type": "string", - "readOnly": true - } - } - }, - "ScriptPackagesList": { - "type": "object", - "description": "A list of the available script packages", - "properties": { - "value": { - "description": "List of script package resources", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ScriptPackage" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "ScriptPackage": { - "type": "object", - "description": "Script Package resources available for execution", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "description": "ScriptPackage resource properties", - "$ref": "#/definitions/ScriptPackageProperties", - "x-ms-client-flatten": true - } - } - }, - "ScriptParameter": { - "type": "object", - "description": "An parameter that the script will accept", - "properties": { - "type": { - "type": "string", - "readOnly": true, - "description": "The type of parameter the script is expecting. psCredential is a PSCredentialObject", - "enum": [ - "String", - "SecureString", - "Credential", - "Int", - "Bool", - "Float" - ], - "x-ms-enum": { - "name": "ScriptParameterTypes", - "modelAsString": true - } - }, - "name": { - "type": "string", - "description": "The parameter name that the script will expect a parameter value for" - }, - "description": { - "type": "string", - "readOnly": true, - "description": "User friendly description of the parameter" - }, - "visibility": { - "description": "Should this parameter be visible to arm and passed in the parameters argument when executing", - "type": "string", - "readOnly": true, - "enum": [ - "Visible", - "Hidden" - ], - "x-ms-enum": { - "name": "VisibilityParameterEnum", - "modelAsString": true - } - }, - "optional": { - "description": "Is this parameter required or optional", - "type": "string", - "readOnly": true, - "enum": [ - "Optional", - "Required" - ], - "x-ms-enum": { - "name": "OptionalParamEnum", - "modelAsString": true - } - } - } - }, - "ScriptCmdlet": { - "type": "object", - "description": "A cmdlet available for script execution", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "description": "The properties of a script cmdlet resource", - "$ref": "#/definitions/ScriptCmdletProperties", - "x-ms-client-flatten": true - } - } - }, - "ScriptCmdletProperties": { - "type": "object", - "description": "Properties of a pre-canned script", - "properties": { - "description": { - "description": "Description of the scripts functionality", - "type": "string", - "readOnly": true - }, - "timeout": { - "description": "Recommended time limit for execution", - "type": "string", - "readOnly": true - }, - "parameters": { - "description": "Parameters the script will accept", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ScriptParameter" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "ScriptCmdletsList": { - "type": "object", - "description": "Pageable list of scripts/cmdlets", - "properties": { - "value": { - "description": "List of scripts", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ScriptCmdlet" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "ScriptExecutionParameter": { - "type": "object", - "discriminator": "type", - "description": "The arguments passed in to the execution", - "properties": { - "name": { - "type": "string", - "description": "The parameter name" - }, - "type": { - "description": "The type of execution parameter", - "type": "string", - "enum": [ - "Value", - "SecureValue", - "Credential" - ], - "x-ms-enum": { - "name": "ScriptExecutionParameterType", - "modelAsString": true - } - } - }, - "required": [ - "type", - "name" - ] - }, - "ScriptExecution": { - "type": "object", - "description": "An instance of a script executed by a user - custom or AVS", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "description": "The properties of a script execution resource", - "$ref": "#/definitions/ScriptExecutionProperties", - "x-ms-client-flatten": true - } - } - }, - "ScriptExecutionProperties": { - "type": "object", - "description": "Properties of a user-invoked script", - "properties": { - "scriptCmdletId": { - "description": "A reference to the script cmdlet resource if user is running a AVS script", - "type": "string" - }, - "parameters": { - "description": "Parameters the script will accept", - "type": "array", - "items": { - "$ref": "#/definitions/ScriptExecutionParameter" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "hiddenParameters": { - "description": "Parameters that will be hidden/not visible to ARM, such as passwords and credentials", - "type": "array", - "items": { - "$ref": "#/definitions/ScriptExecutionParameter" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "failureReason": { - "type": "string", - "description": "Error message if the script was able to run, but if the script itself had errors or powershell threw an exception" - }, - "timeout": { - "description": "Time limit for execution", - "type": "string" - }, - "retention": { - "description": "Time to live for the resource. If not provided, will be available for 60 days", - "type": "string" - }, - "submittedAt": { - "description": "Time the script execution was submitted", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "startedAt": { - "description": "Time the script execution was started", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "finishedAt": { - "description": "Time the script execution was finished", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "provisioningState": { - "description": "The state of the script execution resource", - "type": "string", - "readOnly": true, - "enum": [ - "Pending", - "Running", - "Succeeded", - "Failed", - "Cancelling", - "Cancelled", - "Deleting", - "Canceled" - ], - "x-ms-enum": { - "name": "ScriptExecutionProvisioningState", - "modelAsString": true - } - }, - "output": { - "description": "Standard output stream from the powershell execution", - "type": "array", - "items": { - "type": "string" - } - }, - "namedOutputs": { - "description": "User-defined dictionary.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Dictionary in pair." - } - }, - "information": { - "description": "Standard information out stream from the powershell execution", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "warnings": { - "description": "Standard warning out stream from the powershell execution", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "errors": { - "description": "Standard error output stream from the powershell execution", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - } - }, - "required": [ - "timeout" - ] - }, - "ScriptExecutionsList": { - "type": "object", - "description": "Pageable list of script executions", - "properties": { - "value": { - "description": "List of scripts", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ScriptExecution" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "ScriptSecureStringExecutionParameter": { - "type": "object", - "description": "a plain text value execution parameter", - "x-ms-discriminator-value": "SecureValue", - "allOf": [ - { - "$ref": "#/definitions/ScriptExecutionParameter" - } - ], - "properties": { - "secureValue": { - "type": "string", - "description": "A secure value for the passed parameter, not to be stored in logs", - "x-ms-secret": true - } - } - }, - "ScriptStringExecutionParameter": { - "type": "object", - "description": "a plain text value execution parameter", - "x-ms-discriminator-value": "Value", - "allOf": [ - { - "$ref": "#/definitions/ScriptExecutionParameter" - } - ], - "properties": { - "value": { - "type": "string", - "description": "The value for the passed parameter" - } - } - }, - "PSCredentialExecutionParameter": { - "type": "object", - "description": "a powershell credential object", - "x-ms-discriminator-value": "Credential", - "allOf": [ - { - "$ref": "#/definitions/ScriptExecutionParameter" - } - ], - "properties": { - "username": { - "description": "username for login", - "type": "string" - }, - "password": { - "description": "password for login", - "type": "string" - } - }, - "x-ms-secret": true - }, - "PrivateCloudIdentity": { - "type": "object", - "properties": { - "principalId": { - "readOnly": true, - "type": "string", - "description": "The principal ID of private cloud identity. This property will only be provided for a system assigned identity." - }, - "tenantId": { - "readOnly": true, - "type": "string", - "description": "The tenant ID associated with the private cloud. This property will only be provided for a system assigned identity." - }, - "type": { - "type": "string", - "description": "The type of identity used for the private cloud. The type 'SystemAssigned' refers to an implicitly created identity. The type 'None' will remove any identities from the Private Cloud.", - "enum": [ - "SystemAssigned", - "None" - ], - "x-ms-enum": { - "name": "ResourceIdentityType", - "modelAsString": true - } - } - }, - "description": "Identity for the virtual machine." - }, - "ClusterZone": { - "type": "object", - "properties": { - "hosts": { - "readOnly": true, - "type": "array", - "items": { - "type": "string" - }, - "description": "List of hosts belonging to the availability zone in a cluster" - }, - "zone": { - "readOnly": true, - "type": "string", - "description": "Availability zone identifier" - } - }, - "description": "Zone and associated hosts info" - }, - "ClusterZoneList": { - "type": "object", - "properties": { - "zones": { - "type": "array", - "description": "Zone and associated hosts info", - "items": { - "$ref": "#/definitions/ClusterZone" - }, - "x-ms-identifiers": [ - "zone" - ] - } - }, - "description": "List of all zones and associated hosts for a cluster" - } - } -} diff --git a/swagger-specs/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json b/swagger-specs/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json new file mode 100644 index 000000000..e50c56d87 --- /dev/null +++ b/swagger-specs/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/vmware.json @@ -0,0 +1,11464 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure VMware Solution API", + "version": "2023-09-01", + "description": "Azure VMware Solution API", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Locations" + }, + { + "name": "PrivateClouds" + }, + { + "name": "Clusters" + }, + { + "name": "Datastores" + }, + { + "name": "HcxEnterpriseSites" + }, + { + "name": "Authorizations" + }, + { + "name": "GlobalReachConnections" + }, + { + "name": "WorkloadNetworks" + }, + { + "name": "WorkloadNetworkSegments" + }, + { + "name": "WorkloadNetworkGateways" + }, + { + "name": "WorkloadNetworkVirtualMachines" + }, + { + "name": "CloudLinks" + }, + { + "name": "Addons" + }, + { + "name": "VirtualMachines" + }, + { + "name": "PlacementPolicies" + }, + { + "name": "ScriptPackages" + }, + { + "name": "ScriptCmdlets" + }, + { + "name": "ScriptExecutions" + }, + { + "name": "IscsiPaths" + } + ], + "paths": { + "/providers/Microsoft.AVS/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkQuotaAvailability": { + "post": { + "operationId": "Locations_CheckQuotaAvailability", + "tags": [ + "Locations" + ], + "description": "Return quota for subscription by region", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Quota" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Locations_CheckQuotaAvailability": { + "$ref": "./examples/Locations_CheckQuotaAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkTrialAvailability": { + "post": { + "operationId": "Locations_CheckTrialAvailability", + "tags": [ + "Locations" + ], + "description": "Return trial status for subscription by region", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "sku", + "in": "body", + "description": "Optionally, check for a specific SKU", + "required": false, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Trial" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Locations_CheckTrialAvailability": { + "$ref": "./examples/Locations_CheckTrialAvailability.json" + }, + "Locations_CheckTrialAvailabilityWithSku": { + "$ref": "./examples/Locations_CheckTrialAvailabilityWithSku.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AVS/privateClouds": { + "get": { + "operationId": "PrivateClouds_ListInSubscription", + "tags": [ + "PrivateClouds" + ], + "description": "List PrivateCloud resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateCloudListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateClouds_ListInSubscription": { + "$ref": "./examples/PrivateClouds_ListInSubscription.json" + }, + "PrivateClouds_ListInSubscription_Stretched": { + "$ref": "./examples/PrivateClouds_ListInSubscription_Stretched.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds": { + "get": { + "operationId": "PrivateClouds_List", + "tags": [ + "PrivateClouds" + ], + "description": "List PrivateCloud resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateCloudListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateClouds_List": { + "$ref": "./examples/PrivateClouds_List.json" + }, + "PrivateClouds_List_Stretched": { + "$ref": "./examples/PrivateClouds_List_Stretched.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}": { + "get": { + "operationId": "PrivateClouds_Get", + "tags": [ + "PrivateClouds" + ], + "description": "Get a PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateCloud" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateClouds_Get": { + "$ref": "./examples/PrivateClouds_Get.json" + }, + "PrivateClouds_Get_Stretched": { + "$ref": "./examples/PrivateClouds_Get_Stretched.json" + } + } + }, + "put": { + "operationId": "PrivateClouds_CreateOrUpdate", + "tags": [ + "PrivateClouds" + ], + "description": "Create a PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "privateCloud", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateCloud" + }, + "x-ms-client-name": "privateCloud" + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateCloud' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateCloud" + } + }, + "201": { + "description": "Resource 'PrivateCloud' create operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateCloud" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateClouds_CreateOrUpdate": { + "$ref": "./examples/PrivateClouds_CreateOrUpdate.json" + }, + "PrivateClouds_CreateOrUpdate_Stretched": { + "$ref": "./examples/PrivateClouds_CreateOrUpdate_Stretched.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "PrivateClouds_Update", + "tags": [ + "PrivateClouds" + ], + "description": "Update a PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "privateCloudUpdate", + "in": "body", + "description": "The private cloud properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateCloudUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateCloud" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PrivateCloud" + }, + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateClouds_Update": { + "$ref": "./examples/PrivateClouds_Update.json" + }, + "PrivateClouds_Update_Stretched": { + "$ref": "./examples/PrivateClouds_Update_Stretched.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "PrivateClouds_Delete", + "tags": [ + "PrivateClouds" + ], + "description": "Delete a PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateClouds_Delete": { + "$ref": "./examples/PrivateClouds_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons": { + "get": { + "operationId": "Addons_List", + "tags": [ + "Addons" + ], + "description": "List Addon resources by PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AddonListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Addons_List": { + "$ref": "./examples/Addons_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}": { + "get": { + "operationId": "Addons_Get", + "tags": [ + "Addons" + ], + "description": "Get a Addon", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "addonName", + "in": "path", + "description": "Name of the addon.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Addon" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Addons_Get_ArcReg": { + "$ref": "./examples/Addons_Get_ArcReg.json" + }, + "Addons_Get_HCX": { + "$ref": "./examples/Addons_Get_HCX.json" + }, + "Addons_Get_SRM": { + "$ref": "./examples/Addons_Get_SRM.json" + }, + "Addons_Get_VR": { + "$ref": "./examples/Addons_Get_VR.json" + } + } + }, + "put": { + "operationId": "Addons_CreateOrUpdate", + "tags": [ + "Addons" + ], + "description": "Create a Addon", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "addonName", + "in": "path", + "description": "Name of the addon.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "addon", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Addon" + }, + "x-ms-client-name": "addon" + } + ], + "responses": { + "200": { + "description": "Resource 'Addon' update operation succeeded", + "schema": { + "$ref": "#/definitions/Addon" + } + }, + "201": { + "description": "Resource 'Addon' create operation succeeded", + "schema": { + "$ref": "#/definitions/Addon" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Addons_CreateOrUpdate_ArcReg": { + "$ref": "./examples/Addons_CreateOrUpdate_ArcReg.json" + }, + "Addons_CreateOrUpdate_HCX": { + "$ref": "./examples/Addons_CreateOrUpdate_HCX.json" + }, + "Addons_CreateOrUpdate_SRM": { + "$ref": "./examples/Addons_CreateOrUpdate_SRM.json" + }, + "Addons_CreateOrUpdate_VR": { + "$ref": "./examples/Addons_CreateOrUpdate_VR.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Addons_Delete", + "tags": [ + "Addons" + ], + "description": "Delete a Addon", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "addonName", + "in": "path", + "description": "Name of the addon.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Addons_Delete": { + "$ref": "./examples/Addons_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations": { + "get": { + "operationId": "Authorizations_List", + "tags": [ + "Authorizations" + ], + "description": "List ExpressRouteAuthorization resources by PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ExpressRouteAuthorizationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Authorizations_List": { + "$ref": "./examples/Authorizations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}": { + "get": { + "operationId": "Authorizations_Get", + "tags": [ + "Authorizations" + ], + "description": "Get a ExpressRouteAuthorization", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "authorizationName", + "in": "path", + "description": "Name of the ExpressRoute Circuit Authorization", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ExpressRouteAuthorization" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Authorizations_Get": { + "$ref": "./examples/Authorizations_Get.json" + } + } + }, + "put": { + "operationId": "Authorizations_CreateOrUpdate", + "tags": [ + "Authorizations" + ], + "description": "Create a ExpressRouteAuthorization", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "authorizationName", + "in": "path", + "description": "Name of the ExpressRoute Circuit Authorization", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "authorization", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteAuthorization" + }, + "x-ms-client-name": "authorization" + } + ], + "responses": { + "200": { + "description": "Resource 'ExpressRouteAuthorization' update operation succeeded", + "schema": { + "$ref": "#/definitions/ExpressRouteAuthorization" + } + }, + "201": { + "description": "Resource 'ExpressRouteAuthorization' create operation succeeded", + "schema": { + "$ref": "#/definitions/ExpressRouteAuthorization" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Authorizations_CreateOrUpdate": { + "$ref": "./examples/Authorizations_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Authorizations_Delete", + "tags": [ + "Authorizations" + ], + "description": "Delete a ExpressRouteAuthorization", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "authorizationName", + "in": "path", + "description": "Name of the ExpressRoute Circuit Authorization", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Authorizations_Delete": { + "$ref": "./examples/Authorizations_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks": { + "get": { + "operationId": "CloudLinks_List", + "tags": [ + "CloudLinks" + ], + "description": "List CloudLink resources by PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudLinkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudLinks_List": { + "$ref": "./examples/CloudLinks_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/cloudLinks/{cloudLinkName}": { + "get": { + "operationId": "CloudLinks_Get", + "tags": [ + "CloudLinks" + ], + "description": "Get a CloudLink", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "cloudLinkName", + "in": "path", + "description": "Name of the cloud link.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudLink" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudLinks_Get": { + "$ref": "./examples/CloudLinks_Get.json" + } + } + }, + "put": { + "operationId": "CloudLinks_CreateOrUpdate", + "tags": [ + "CloudLinks" + ], + "description": "Create a CloudLink", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "cloudLinkName", + "in": "path", + "description": "Name of the cloud link.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "cloudLink", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudLink" + }, + "x-ms-client-name": "cloudLink" + } + ], + "responses": { + "200": { + "description": "Resource 'CloudLink' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudLink" + } + }, + "201": { + "description": "Resource 'CloudLink' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudLink" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudLinks_CreateOrUpdate": { + "$ref": "./examples/CloudLinks_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudLinks_Delete", + "tags": [ + "CloudLinks" + ], + "description": "Delete a CloudLink", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "cloudLinkName", + "in": "path", + "description": "Name of the cloud link.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudLinks_Delete": { + "$ref": "./examples/CloudLinks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters": { + "get": { + "operationId": "Clusters_List", + "tags": [ + "Clusters" + ], + "description": "List Cluster resources by PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Clusters_List": { + "$ref": "./examples/Clusters_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}": { + "get": { + "operationId": "Clusters_Get", + "tags": [ + "Clusters" + ], + "description": "Get a Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Clusters_Get": { + "$ref": "./examples/Clusters_Get.json" + } + } + }, + "put": { + "operationId": "Clusters_CreateOrUpdate", + "tags": [ + "Clusters" + ], + "description": "Create a Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "cluster", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "x-ms-client-name": "cluster" + } + ], + "responses": { + "200": { + "description": "Resource 'Cluster' update operation succeeded", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "Resource 'Cluster' create operation succeeded", + "schema": { + "$ref": "#/definitions/Cluster" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Clusters_CreateOrUpdate": { + "$ref": "./examples/Clusters_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Clusters_Update", + "tags": [ + "Clusters" + ], + "description": "Update a Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterUpdate", + "in": "body", + "description": "The cluster properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Cluster" + }, + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Clusters_Update": { + "$ref": "./examples/Clusters_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Clusters_Delete", + "tags": [ + "Clusters" + ], + "description": "Delete a Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Clusters_Delete": { + "$ref": "./examples/Clusters_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores": { + "get": { + "operationId": "Datastores_List", + "tags": [ + "Datastores" + ], + "description": "List Datastore resources by Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatastoreListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Datastores_List": { + "$ref": "./examples/Datastores_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}": { + "get": { + "operationId": "Datastores_Get", + "tags": [ + "Datastores" + ], + "description": "Get a Datastore", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "datastoreName", + "in": "path", + "description": "Name of the datastore", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Datastore" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Datastores_Get": { + "$ref": "./examples/Datastores_Get.json" + } + } + }, + "put": { + "operationId": "Datastores_CreateOrUpdate", + "tags": [ + "Datastores" + ], + "description": "Create a Datastore", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "datastoreName", + "in": "path", + "description": "Name of the datastore", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "datastore", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Datastore" + }, + "x-ms-client-name": "datastore" + } + ], + "responses": { + "200": { + "description": "Resource 'Datastore' update operation succeeded", + "schema": { + "$ref": "#/definitions/Datastore" + } + }, + "201": { + "description": "Resource 'Datastore' create operation succeeded", + "schema": { + "$ref": "#/definitions/Datastore" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Datastores_CreateOrUpdate": { + "$ref": "./examples/Datastores_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Datastores_Delete", + "tags": [ + "Datastores" + ], + "description": "Delete a Datastore", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "datastoreName", + "in": "path", + "description": "Name of the datastore", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Datastores_Delete": { + "$ref": "./examples/Datastores_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/listZones": { + "post": { + "operationId": "Clusters_ListZones", + "tags": [ + "Clusters" + ], + "description": "List hosts by zone in a cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterZoneList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Clusters_ListZones": { + "$ref": "./examples/Clusters_ListZones.json" + }, + "Clusters_ListZones_Stretched": { + "$ref": "./examples/Clusters_ListZones_Stretched.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies": { + "get": { + "operationId": "PlacementPolicies_List", + "tags": [ + "PlacementPolicies" + ], + "description": "List PlacementPolicy resources by Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PlacementPolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PlacementPolicies_List": { + "$ref": "./examples/PlacementPolicies_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}": { + "get": { + "operationId": "PlacementPolicies_Get", + "tags": [ + "PlacementPolicies" + ], + "description": "Get a PlacementPolicy", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "placementPolicyName", + "in": "path", + "description": "Name of the placement policy.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PlacementPolicy" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PlacementPolicies_Get": { + "$ref": "./examples/PlacementPolicies_Get.json" + } + } + }, + "put": { + "operationId": "PlacementPolicies_CreateOrUpdate", + "tags": [ + "PlacementPolicies" + ], + "description": "Create a PlacementPolicy", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "placementPolicyName", + "in": "path", + "description": "Name of the placement policy.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "placementPolicy", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PlacementPolicy" + }, + "x-ms-client-name": "placementPolicy" + } + ], + "responses": { + "200": { + "description": "Resource 'PlacementPolicy' update operation succeeded", + "schema": { + "$ref": "#/definitions/PlacementPolicy" + } + }, + "201": { + "description": "Resource 'PlacementPolicy' create operation succeeded", + "schema": { + "$ref": "#/definitions/PlacementPolicy" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PlacementPolicies_CreateOrUpdate": { + "$ref": "./examples/PlacementPolicies_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "PlacementPolicies_Update", + "tags": [ + "PlacementPolicies" + ], + "description": "Update a PlacementPolicy", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "placementPolicyName", + "in": "path", + "description": "Name of the placement policy.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "placementPolicyUpdate", + "in": "body", + "description": "The placement policy properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/PlacementPolicyUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PlacementPolicy" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/PlacementPolicy" + }, + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PlacementPolicies_Update": { + "$ref": "./examples/PlacementPolicies_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "PlacementPolicies_Delete", + "tags": [ + "PlacementPolicies" + ], + "description": "Delete a PlacementPolicy", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "placementPolicyName", + "in": "path", + "description": "Name of the placement policy.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PlacementPolicies_Delete": { + "$ref": "./examples/PlacementPolicies_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines": { + "get": { + "operationId": "VirtualMachines_List", + "tags": [ + "VirtualMachines" + ], + "description": "List VirtualMachine resources by Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachines_List": { + "$ref": "./examples/VirtualMachines_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines/{virtualMachineId}": { + "get": { + "operationId": "VirtualMachines_Get", + "tags": [ + "VirtualMachines" + ], + "description": "Get a VirtualMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "virtualMachineId", + "in": "path", + "description": "ID of the virtual machine.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachines_Get": { + "$ref": "./examples/VirtualMachines_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines/{virtualMachineId}/restrictMovement": { + "post": { + "operationId": "VirtualMachines_RestrictMovement", + "tags": [ + "VirtualMachines" + ], + "description": "Enable or disable DRS-driven VM movement restriction", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "clusterName", + "in": "path", + "description": "Name of the cluster", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "virtualMachineId", + "in": "path", + "description": "ID of the virtual machine.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "restrictMovement", + "in": "body", + "description": "The body type of the operation request.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineRestrictMovement" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VirtualMachines_RestrictMovement": { + "$ref": "./examples/VirtualMachines_RestrictMovement.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections": { + "get": { + "operationId": "GlobalReachConnections_List", + "tags": [ + "GlobalReachConnections" + ], + "description": "List GlobalReachConnection resources by PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalReachConnectionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GlobalReachConnections_List": { + "$ref": "./examples/GlobalReachConnections_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}": { + "get": { + "operationId": "GlobalReachConnections_Get", + "tags": [ + "GlobalReachConnections" + ], + "description": "Get a GlobalReachConnection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "globalReachConnectionName", + "in": "path", + "description": "Name of the global reach connection", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalReachConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GlobalReachConnections_Get": { + "$ref": "./examples/GlobalReachConnections_Get.json" + } + } + }, + "put": { + "operationId": "GlobalReachConnections_CreateOrUpdate", + "tags": [ + "GlobalReachConnections" + ], + "description": "Create a GlobalReachConnection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "globalReachConnectionName", + "in": "path", + "description": "Name of the global reach connection", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "globalReachConnection", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GlobalReachConnection" + }, + "x-ms-client-name": "globalReachConnection" + } + ], + "responses": { + "200": { + "description": "Resource 'GlobalReachConnection' update operation succeeded", + "schema": { + "$ref": "#/definitions/GlobalReachConnection" + } + }, + "201": { + "description": "Resource 'GlobalReachConnection' create operation succeeded", + "schema": { + "$ref": "#/definitions/GlobalReachConnection" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GlobalReachConnections_CreateOrUpdate": { + "$ref": "./examples/GlobalReachConnections_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "GlobalReachConnections_Delete", + "tags": [ + "GlobalReachConnections" + ], + "description": "Delete a GlobalReachConnection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "globalReachConnectionName", + "in": "path", + "description": "Name of the global reach connection", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GlobalReachConnections_Delete": { + "$ref": "./examples/GlobalReachConnections_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites": { + "get": { + "operationId": "HcxEnterpriseSites_List", + "tags": [ + "HcxEnterpriseSites" + ], + "description": "List HcxEnterpriseSite resources by PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HcxEnterpriseSiteListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HcxEnterpriseSites_List": { + "$ref": "./examples/HcxEnterpriseSites_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}": { + "get": { + "operationId": "HcxEnterpriseSites_Get", + "tags": [ + "HcxEnterpriseSites" + ], + "description": "Get a HcxEnterpriseSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "hcxEnterpriseSiteName", + "in": "path", + "description": "Name of the HCX Enterprise Site", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HcxEnterpriseSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HcxEnterpriseSites_Get": { + "$ref": "./examples/HcxEnterpriseSites_Get.json" + } + } + }, + "put": { + "operationId": "HcxEnterpriseSites_CreateOrUpdate", + "tags": [ + "HcxEnterpriseSites" + ], + "description": "Create a HcxEnterpriseSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "hcxEnterpriseSiteName", + "in": "path", + "description": "Name of the HCX Enterprise Site", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "hcxEnterpriseSite", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/HcxEnterpriseSite" + }, + "x-ms-client-name": "hcxEnterpriseSite" + } + ], + "responses": { + "200": { + "description": "Resource 'HcxEnterpriseSite' update operation succeeded", + "schema": { + "$ref": "#/definitions/HcxEnterpriseSite" + } + }, + "201": { + "description": "Resource 'HcxEnterpriseSite' create operation succeeded", + "schema": { + "$ref": "#/definitions/HcxEnterpriseSite" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HcxEnterpriseSites_CreateOrUpdate": { + "$ref": "./examples/HcxEnterpriseSites_CreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "HcxEnterpriseSites_Delete", + "tags": [ + "HcxEnterpriseSites" + ], + "description": "Delete a HcxEnterpriseSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "hcxEnterpriseSiteName", + "in": "path", + "description": "Name of the HCX Enterprise Site", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HcxEnterpriseSites_Delete": { + "$ref": "./examples/HcxEnterpriseSites_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/iscsiPaths": { + "get": { + "operationId": "IscsiPaths_ListByPrivateCloud", + "tags": [ + "IscsiPaths" + ], + "description": "List IscsiPath resources by PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IscsiPathListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IscsiPaths_ListByPrivateCloud": { + "$ref": "./examples/IscsiPaths_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/iscsiPaths/default": { + "get": { + "operationId": "IscsiPaths_Get", + "tags": [ + "IscsiPaths" + ], + "description": "Get a IscsiPath", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IscsiPath" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IscsiPaths_Get": { + "$ref": "./examples/IscsiPaths_Get.json" + } + } + }, + "put": { + "operationId": "IscsiPaths_CreateOrUpdate", + "tags": [ + "IscsiPaths" + ], + "description": "Create a IscsiPath", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IscsiPath" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IscsiPath' update operation succeeded", + "schema": { + "$ref": "#/definitions/IscsiPath" + } + }, + "201": { + "description": "Resource 'IscsiPath' create operation succeeded", + "schema": { + "$ref": "#/definitions/IscsiPath" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IscsiPaths_CreateOrUpdate": { + "$ref": "./examples/IscsiPaths_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IscsiPaths_Delete", + "tags": [ + "IscsiPaths" + ], + "description": "Delete a IscsiPath", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IscsiPaths_Delete": { + "$ref": "./examples/IscsiPaths_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/listAdminCredentials": { + "post": { + "operationId": "PrivateClouds_ListAdminCredentials", + "tags": [ + "PrivateClouds" + ], + "description": "List the admin credentials for the private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AdminCredentials" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateClouds_ListAdminCredentials": { + "$ref": "./examples/PrivateClouds_ListAdminCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateNsxtPassword": { + "post": { + "operationId": "PrivateClouds_RotateNsxtPassword", + "tags": [ + "PrivateClouds" + ], + "description": "Rotate the NSX-T Manager password", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Action completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateClouds_RotateNsxtPassword": { + "$ref": "./examples/PrivateClouds_RotateNsxtPassword.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateVcenterPassword": { + "post": { + "operationId": "PrivateClouds_RotateVcenterPassword", + "tags": [ + "PrivateClouds" + ], + "description": "Rotate the vCenter password", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Action completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateClouds_RotateVcenterPassword": { + "$ref": "./examples/PrivateClouds_RotateVcenterPassword.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions": { + "get": { + "operationId": "ScriptExecutions_List", + "tags": [ + "ScriptExecutions" + ], + "description": "List ScriptExecution resources by PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScriptExecutionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScriptExecutions_List": { + "$ref": "./examples/ScriptExecutions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}": { + "get": { + "operationId": "ScriptExecutions_Get", + "tags": [ + "ScriptExecutions" + ], + "description": "Get a ScriptExecution", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "scriptExecutionName", + "in": "path", + "description": "Name of the script cmdlet.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScriptExecution" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScriptExecutions_Get": { + "$ref": "./examples/ScriptExecutions_Get.json" + } + } + }, + "put": { + "operationId": "ScriptExecutions_CreateOrUpdate", + "tags": [ + "ScriptExecutions" + ], + "description": "Create a ScriptExecution", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "scriptExecutionName", + "in": "path", + "description": "Name of the script cmdlet.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "scriptExecution", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ScriptExecution" + }, + "x-ms-client-name": "scriptExecution" + } + ], + "responses": { + "200": { + "description": "Resource 'ScriptExecution' update operation succeeded", + "schema": { + "$ref": "#/definitions/ScriptExecution" + } + }, + "201": { + "description": "Resource 'ScriptExecution' create operation succeeded", + "schema": { + "$ref": "#/definitions/ScriptExecution" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScriptExecutions_CreateOrUpdate": { + "$ref": "./examples/ScriptExecutions_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ScriptExecutions_Delete", + "tags": [ + "ScriptExecutions" + ], + "description": "Delete a ScriptExecution", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "scriptExecutionName", + "in": "path", + "description": "Name of the script cmdlet.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScriptExecutions_Delete": { + "$ref": "./examples/ScriptExecutions_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}/getExecutionLogs": { + "post": { + "operationId": "ScriptExecutions_GetExecutionLogs", + "tags": [ + "ScriptExecutions" + ], + "description": "Return the logs for a script execution resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "scriptExecutionName", + "in": "path", + "description": "Name of the script cmdlet.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "scriptOutputStreamType", + "in": "body", + "description": "Name of the desired output stream to return. If not provided, will return all. An empty array will return nothing.", + "required": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ScriptOutputStreamType" + } + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScriptExecution" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScriptExecutions_GetExecutionLogs": { + "$ref": "./examples/ScriptExecutions_GetExecutionLogs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages": { + "get": { + "operationId": "ScriptPackages_List", + "tags": [ + "ScriptPackages" + ], + "description": "List ScriptPackage resources by PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScriptPackageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScriptPackages_List": { + "$ref": "./examples/ScriptPackages_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}": { + "get": { + "operationId": "ScriptPackages_Get", + "tags": [ + "ScriptPackages" + ], + "description": "Get a ScriptPackage", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "scriptPackageName", + "in": "path", + "description": "Name of the script package.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._@]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScriptPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScriptPackages_Get": { + "$ref": "./examples/ScriptPackages_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}/scriptCmdlets": { + "get": { + "operationId": "ScriptCmdlets_List", + "tags": [ + "ScriptCmdlets" + ], + "description": "List ScriptCmdlet resources by ScriptPackage", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "scriptPackageName", + "in": "path", + "description": "Name of the script package.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._@]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScriptCmdletListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScriptCmdlets_List": { + "$ref": "./examples/ScriptCmdlets_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}/scriptCmdlets/{scriptCmdletName}": { + "get": { + "operationId": "ScriptCmdlets_Get", + "tags": [ + "ScriptCmdlets" + ], + "description": "Get a ScriptCmdlet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "scriptPackageName", + "in": "path", + "description": "Name of the script package.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._@]+$" + }, + { + "name": "scriptCmdletName", + "in": "path", + "description": "Name of the script cmdlet.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScriptCmdlet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScriptCmdlets_Get": { + "$ref": "./examples/ScriptCmdlets_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks": { + "get": { + "operationId": "WorkloadNetworks_List", + "tags": [ + "WorkloadNetworks" + ], + "description": "List WorkloadNetwork resources by PrivateCloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_List": { + "$ref": "./examples/WorkloadNetworks_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default": { + "get": { + "operationId": "WorkloadNetworks_Get", + "tags": [ + "WorkloadNetworks" + ], + "description": "Get a WorkloadNetwork", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetwork" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_Get": { + "$ref": "./examples/WorkloadNetworks_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations": { + "get": { + "operationId": "WorkloadNetworks_ListDhcp", + "description": "List WorkloadNetworkDhcp resources by WorkloadNetwork", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDhcpListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_ListDhcp": { + "$ref": "./examples/WorkloadNetworks_ListDhcp.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}": { + "get": { + "operationId": "WorkloadNetworks_GetDhcp", + "description": "Get a WorkloadNetworkDhcp", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DhcpIdParameter" + }, + { + "$ref": "#/parameters/PrivateCloudNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDhcp" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_GetDhcp": { + "$ref": "./examples/WorkloadNetworks_GetDhcp.json" + } + } + }, + "put": { + "operationId": "WorkloadNetworks_CreateDhcp", + "description": "Create a WorkloadNetworkDhcp", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "dhcpId", + "in": "path", + "description": "The ID of the DHCP configuration", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "workloadNetworkDhcp", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadNetworkDhcp" + }, + "x-ms-client-name": "workloadNetworkDhcp" + } + ], + "responses": { + "200": { + "description": "Resource 'WorkloadNetworkDhcp' update operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDhcp" + } + }, + "201": { + "description": "Resource 'WorkloadNetworkDhcp' create operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDhcp" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_CreateDhcp": { + "$ref": "./examples/WorkloadNetworks_CreateDhcp.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "WorkloadNetworks_UpdateDhcp", + "description": "Update a WorkloadNetworkDhcp", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "dhcpId", + "in": "path", + "description": "The ID of the DHCP configuration", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "workloadNetworkDhcp", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadNetworkDhcpUpdate" + }, + "x-ms-client-name": "workloadNetworkDhcp" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDhcp" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_UpdateDhcp": { + "$ref": "./examples/WorkloadNetworks_UpdateDhcp.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "WorkloadNetworks_DeleteDhcp", + "description": "Delete a WorkloadNetworkDhcp", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "dhcpId", + "in": "path", + "description": "The ID of the DHCP configuration", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_DeleteDhcp": { + "$ref": "./examples/WorkloadNetworks_DeleteDhcp.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices": { + "get": { + "operationId": "WorkloadNetworks_ListDnsServices", + "description": "List WorkloadNetworkDnsService resources by WorkloadNetwork", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsServiceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_ListDnsServices": { + "$ref": "./examples/WorkloadNetworks_ListDnsServices.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}": { + "get": { + "operationId": "WorkloadNetworks_GetDnsService", + "description": "Get a WorkloadNetworkDnsService", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "dnsServiceId", + "in": "path", + "description": "ID of the DNS service.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsService" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_GetDnsService": { + "$ref": "./examples/WorkloadNetworks_GetDnsService.json" + } + } + }, + "put": { + "operationId": "WorkloadNetworks_CreateDnsService", + "description": "Create a WorkloadNetworkDnsService", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "dnsServiceId", + "in": "path", + "description": "ID of the DNS service.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "workloadNetworkDnsService", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsService" + }, + "x-ms-client-name": "workloadNetworkDnsService" + } + ], + "responses": { + "200": { + "description": "Resource 'WorkloadNetworkDnsService' update operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsService" + } + }, + "201": { + "description": "Resource 'WorkloadNetworkDnsService' create operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsService" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_CreateDnsService": { + "$ref": "./examples/WorkloadNetworks_CreateDnsService.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "WorkloadNetworks_UpdateDnsService", + "description": "Update a WorkloadNetworkDnsService", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "dnsServiceId", + "in": "path", + "description": "ID of the DNS service.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "workloadNetworkDnsService", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsServiceUpdate" + }, + "x-ms-client-name": "workloadNetworkDnsService" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsService" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_UpdateDnsService": { + "$ref": "./examples/WorkloadNetworks_UpdateDnsService.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "WorkloadNetworks_DeleteDnsService", + "description": "Delete a WorkloadNetworkDnsService", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsServiceIdParameter" + }, + { + "$ref": "#/parameters/PrivateCloudNameParameter" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_DeleteDnsService": { + "$ref": "./examples/WorkloadNetworks_DeleteDnsService.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones": { + "get": { + "operationId": "WorkloadNetworks_ListDnsZones", + "description": "List WorkloadNetworkDnsZone resources by WorkloadNetwork", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsZoneListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_ListDnsZones": { + "$ref": "./examples/WorkloadNetworks_ListDnsZones.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}": { + "get": { + "operationId": "WorkloadNetworks_GetDnsZone", + "description": "Get a WorkloadNetworkDnsZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "dnsZoneId", + "in": "path", + "description": "ID of the DNS zone.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsZone" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_GetDnsZone": { + "$ref": "./examples/WorkloadNetworks_GetDnsZone.json" + } + } + }, + "put": { + "operationId": "WorkloadNetworks_CreateDnsZone", + "description": "Create a WorkloadNetworkDnsZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "dnsZoneId", + "in": "path", + "description": "ID of the DNS zone.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "workloadNetworkDnsZone", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsZone" + }, + "x-ms-client-name": "workloadNetworkDnsZone" + } + ], + "responses": { + "200": { + "description": "Resource 'WorkloadNetworkDnsZone' update operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsZone" + } + }, + "201": { + "description": "Resource 'WorkloadNetworkDnsZone' create operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsZone" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_CreateDnsZone": { + "$ref": "./examples/WorkloadNetworks_CreateDnsZone.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "WorkloadNetworks_UpdateDnsZone", + "description": "Update a WorkloadNetworkDnsZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "dnsZoneId", + "in": "path", + "description": "ID of the DNS zone.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "workloadNetworkDnsZone", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsZoneUpdate" + }, + "x-ms-client-name": "workloadNetworkDnsZone" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkDnsZone" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_UpdateDnsZone": { + "$ref": "./examples/WorkloadNetworks_UpdateDnsZone.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "WorkloadNetworks_DeleteDnsZone", + "description": "Delete a WorkloadNetworkDnsZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsZoneIdParameter" + }, + { + "$ref": "#/parameters/PrivateCloudNameParameter" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_DeleteDnsZone": { + "$ref": "./examples/WorkloadNetworks_DeleteDnsZone.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways": { + "get": { + "operationId": "WorkloadNetworks_ListGateways", + "tags": [ + "WorkloadNetworkGateways" + ], + "description": "List WorkloadNetworkGateway resources by WorkloadNetwork", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkGatewayListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_ListGateways": { + "$ref": "./examples/WorkloadNetworks_ListGateways.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways/{gatewayId}": { + "get": { + "operationId": "WorkloadNetworks_GetGateway", + "tags": [ + "WorkloadNetworkGateways" + ], + "description": "Get a WorkloadNetworkGateway", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "The ID of the NSX Gateway", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkGateway" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_GetGateway": { + "$ref": "./examples/WorkloadNetworks_GetGateway.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles": { + "get": { + "operationId": "WorkloadNetworks_ListPortMirroring", + "description": "List WorkloadNetworkPortMirroring resources by WorkloadNetwork", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkPortMirroringListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_ListPortMirroring": { + "$ref": "./examples/WorkloadNetworks_ListPortMirroring.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}": { + "get": { + "operationId": "WorkloadNetworks_GetPortMirroring", + "description": "Get a WorkloadNetworkPortMirroring", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "portMirroringId", + "in": "path", + "description": "ID of the NSX port mirroring profile.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkPortMirroring" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_GetPortMirroring": { + "$ref": "./examples/WorkloadNetworks_GetPortMirroring.json" + } + } + }, + "put": { + "operationId": "WorkloadNetworks_CreatePortMirroring", + "description": "Create a WorkloadNetworkPortMirroring", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "portMirroringId", + "in": "path", + "description": "ID of the NSX port mirroring profile.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "workloadNetworkPortMirroring", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadNetworkPortMirroring" + }, + "x-ms-client-name": "workloadNetworkPortMirroring" + } + ], + "responses": { + "200": { + "description": "Resource 'WorkloadNetworkPortMirroring' update operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkPortMirroring" + } + }, + "201": { + "description": "Resource 'WorkloadNetworkPortMirroring' create operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkPortMirroring" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_CreatePortMirroring": { + "$ref": "./examples/WorkloadNetworks_CreatePortMirroring.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "WorkloadNetworks_UpdatePortMirroring", + "description": "Update a WorkloadNetworkPortMirroring", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "portMirroringId", + "in": "path", + "description": "ID of the NSX port mirroring profile.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "workloadNetworkPortMirroring", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadNetworkPortMirroringUpdate" + }, + "x-ms-client-name": "workloadNetworkPortMirroring" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkPortMirroring" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_UpdatePortMirroring": { + "$ref": "./examples/WorkloadNetworks_UpdatePortMirroring.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "WorkloadNetworks_DeletePortMirroring", + "description": "Delete a WorkloadNetworkPortMirroring", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PortMirroringProfileParameter" + }, + { + "$ref": "#/parameters/PrivateCloudNameParameter" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_DeletePortMirroring": { + "$ref": "./examples/WorkloadNetworks_DeletePortMirroring.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs": { + "get": { + "operationId": "WorkloadNetworks_ListPublicIPs", + "description": "List WorkloadNetworkPublicIP resources by WorkloadNetwork", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkPublicIPListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_ListPublicIPs": { + "$ref": "./examples/WorkloadNetworks_ListPublicIPs.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}": { + "get": { + "operationId": "WorkloadNetworks_GetPublicIP", + "description": "Get a WorkloadNetworkPublicIP", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "publicIPId", + "in": "path", + "description": "ID of the DNS zone.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkPublicIP" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_GetPublicIP": { + "$ref": "./examples/WorkloadNetworks_GetPublicIP.json" + } + } + }, + "put": { + "operationId": "WorkloadNetworks_CreatePublicIP", + "description": "Create a WorkloadNetworkPublicIP", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "publicIPId", + "in": "path", + "description": "ID of the DNS zone.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "workloadNetworkPublicIP", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadNetworkPublicIP" + }, + "x-ms-client-name": "workloadNetworkPublicIP" + } + ], + "responses": { + "200": { + "description": "Resource 'WorkloadNetworkPublicIP' update operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkPublicIP" + } + }, + "201": { + "description": "Resource 'WorkloadNetworkPublicIP' create operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkPublicIP" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_CreatePublicIP": { + "$ref": "./examples/WorkloadNetworks_CreatePublicIP.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "WorkloadNetworks_DeletePublicIP", + "description": "Delete a WorkloadNetworkPublicIP", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PublicIPIdParameter" + }, + { + "$ref": "#/parameters/PrivateCloudNameParameter" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_DeletePublicIP": { + "$ref": "./examples/WorkloadNetworks_DeletePublicIP.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments": { + "get": { + "operationId": "WorkloadNetworks_ListSegments", + "tags": [ + "WorkloadNetworkSegments" + ], + "description": "List WorkloadNetworkSegment resources by WorkloadNetwork", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkSegmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_ListSegments": { + "$ref": "./examples/WorkloadNetworks_ListSegments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}": { + "get": { + "operationId": "WorkloadNetworks_GetSegment", + "tags": [ + "WorkloadNetworkSegments" + ], + "description": "Get a WorkloadNetworkSegment", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "segmentId", + "in": "path", + "description": "The ID of the NSX Segment", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkSegment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_GetSegment": { + "$ref": "./examples/WorkloadNetworks_GetSegment.json" + } + } + }, + "put": { + "operationId": "WorkloadNetworks_CreateSegments", + "tags": [ + "WorkloadNetworkSegments" + ], + "description": "Create a WorkloadNetworkSegment", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "segmentId", + "in": "path", + "description": "The ID of the NSX Segment", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "workloadNetworkSegment", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadNetworkSegment" + }, + "x-ms-client-name": "workloadNetworkSegment" + } + ], + "responses": { + "200": { + "description": "Resource 'WorkloadNetworkSegment' update operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkSegment" + } + }, + "201": { + "description": "Resource 'WorkloadNetworkSegment' create operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkSegment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_CreateSegments": { + "$ref": "./examples/WorkloadNetworks_CreateSegments.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "WorkloadNetworks_UpdateSegments", + "tags": [ + "WorkloadNetworkSegments" + ], + "description": "Update a WorkloadNetworkSegment", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "segmentId", + "in": "path", + "description": "The ID of the NSX Segment", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "workloadNetworkSegment", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadNetworkSegmentUpdate" + }, + "x-ms-client-name": "workloadNetworkSegment" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkSegment" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_UpdateSegments": { + "$ref": "./examples/WorkloadNetworks_UpdateSegments.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "WorkloadNetworks_DeleteSegment", + "tags": [ + "WorkloadNetworkSegments" + ], + "description": "Delete a WorkloadNetworkSegment", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "segmentId", + "in": "path", + "description": "The ID of the NSX Segment", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_DeleteSegment": { + "$ref": "./examples/WorkloadNetworks_DeleteSegment.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines": { + "get": { + "operationId": "WorkloadNetworks_ListVirtualMachines", + "tags": [ + "WorkloadNetworkVirtualMachines" + ], + "description": "List WorkloadNetworkVirtualMachine resources by WorkloadNetwork", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkVirtualMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_ListVirtualMachines": { + "$ref": "./examples/WorkloadNetworks_ListVirtualMachines.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines/{virtualMachineId}": { + "get": { + "operationId": "WorkloadNetworks_GetVirtualMachine", + "tags": [ + "WorkloadNetworkVirtualMachines" + ], + "description": "Get a WorkloadNetworkVirtualMachine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "virtualMachineId", + "in": "path", + "description": "ID of the virtual machine.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkVirtualMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_GetVirtualMachine": { + "$ref": "./examples/WorkloadNetworks_GetVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups": { + "get": { + "operationId": "WorkloadNetworks_ListVMGroups", + "description": "List WorkloadNetworkVMGroup resources by WorkloadNetwork", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkVMGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_ListVMGroups": { + "$ref": "./examples/WorkloadNetworks_ListVMGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}": { + "get": { + "operationId": "WorkloadNetworks_GetVMGroup", + "description": "Get a WorkloadNetworkVMGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "vmGroupId", + "in": "path", + "description": "ID of the VM group.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkVMGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_GetVMGroup": { + "$ref": "./examples/WorkloadNetworks_GetVMGroup.json" + } + } + }, + "put": { + "operationId": "WorkloadNetworks_CreateVMGroup", + "description": "Create a WorkloadNetworkVMGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "vmGroupId", + "in": "path", + "description": "ID of the VM group.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "workloadNetworkVMGroup", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadNetworkVMGroup" + }, + "x-ms-client-name": "workloadNetworkVMGroup" + } + ], + "responses": { + "200": { + "description": "Resource 'WorkloadNetworkVMGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkVMGroup" + } + }, + "201": { + "description": "Resource 'WorkloadNetworkVMGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/WorkloadNetworkVMGroup" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_CreateVMGroup": { + "$ref": "./examples/WorkloadNetworks_CreateVMGroup.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "WorkloadNetworks_UpdateVMGroup", + "description": "Update a WorkloadNetworkVMGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "vmGroupId", + "in": "path", + "description": "ID of the VM group.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "workloadNetworkVMGroup", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadNetworkVMGroupUpdate" + }, + "x-ms-client-name": "workloadNetworkVMGroup" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkloadNetworkVMGroup" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_UpdateVMGroup": { + "$ref": "./examples/WorkloadNetworks_UpdateVMGroup.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "WorkloadNetworks_DeleteVMGroup", + "description": "Delete a WorkloadNetworkVMGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VmGroupIdParameter" + }, + { + "$ref": "#/parameters/PrivateCloudNameParameter" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkloadNetworks_DeleteVMGroup": { + "$ref": "./examples/WorkloadNetworks_DeleteVMGroup.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Addon": { + "type": "object", + "description": "An addon resource", + "properties": { + "properties": { + "$ref": "#/definitions/AddonProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AddonArcProperties": { + "type": "object", + "description": "The properties of an Arc addon", + "properties": { + "vCenter": { + "type": "string", + "description": "The VMware vCenter resource ID" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AddonProperties" + } + ], + "x-ms-discriminator-value": "Arc" + }, + "AddonHcxProperties": { + "type": "object", + "description": "The properties of an HCX addon", + "properties": { + "offer": { + "type": "string", + "description": "The HCX offer, example VMware MaaS Cloud Provider (Enterprise)" + } + }, + "required": [ + "offer" + ], + "allOf": [ + { + "$ref": "#/definitions/AddonProperties" + } + ], + "x-ms-discriminator-value": "HCX" + }, + "AddonListResult": { + "type": "object", + "description": "The response of a Addon list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Addon items on this page", + "items": { + "$ref": "#/definitions/Addon" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AddonProperties": { + "type": "object", + "description": "The properties of an addon", + "properties": { + "addonType": { + "$ref": "#/definitions/AddonType", + "description": "Addon type" + }, + "provisioningState": { + "$ref": "#/definitions/AddonProvisioningState", + "description": "The state of the addon provisioning", + "readOnly": true + } + }, + "discriminator": "addonType", + "required": [ + "addonType" + ] + }, + "AddonProvisioningState": { + "type": "string", + "description": "Addon provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Cancelled", + "Building", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "AddonProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "is cancelled" + }, + { + "name": "Building", + "value": "Building", + "description": "is building" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "AddonSrmProperties": { + "type": "object", + "description": "The properties of a Site Recovery Manager (SRM) addon", + "properties": { + "licenseKey": { + "type": "string", + "description": "The Site Recovery Manager (SRM) license" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AddonProperties" + } + ], + "x-ms-discriminator-value": "SRM" + }, + "AddonType": { + "type": "string", + "description": "Addon type", + "enum": [ + "SRM", + "VR", + "HCX", + "Arc" + ], + "x-ms-enum": { + "name": "AddonType", + "modelAsString": true, + "values": [ + { + "name": "SRM", + "value": "SRM" + }, + { + "name": "VR", + "value": "VR" + }, + { + "name": "HCX", + "value": "HCX" + }, + { + "name": "Arc", + "value": "Arc" + } + ] + } + }, + "AddonVrProperties": { + "type": "object", + "description": "The properties of a vSphere Replication (VR) addon", + "properties": { + "vrsCount": { + "type": "integer", + "format": "int32", + "description": "The vSphere Replication Server (VRS) count" + } + }, + "required": [ + "vrsCount" + ], + "allOf": [ + { + "$ref": "#/definitions/AddonProperties" + } + ], + "x-ms-discriminator-value": "VR" + }, + "AdminCredentials": { + "type": "object", + "description": "Administrative credentials for accessing vCenter and NSX-T", + "properties": { + "nsxtUsername": { + "type": "string", + "description": "NSX-T Manager username", + "readOnly": true + }, + "nsxtPassword": { + "type": "string", + "format": "password", + "description": "NSX-T Manager password", + "readOnly": true, + "x-ms-secret": true + }, + "vcenterUsername": { + "type": "string", + "description": "vCenter admin username", + "readOnly": true + }, + "vcenterPassword": { + "type": "string", + "format": "password", + "description": "vCenter admin password", + "readOnly": true, + "x-ms-secret": true + } + } + }, + "AffinityStrength": { + "type": "string", + "description": "Affinity Strength", + "enum": [ + "Should", + "Must" + ], + "x-ms-enum": { + "name": "AffinityStrength", + "modelAsString": true, + "values": [ + { + "name": "Should", + "value": "Should", + "description": "is should" + }, + { + "name": "Must", + "value": "Must", + "description": "is must" + } + ] + } + }, + "AffinityType": { + "type": "string", + "description": "Affinity type", + "enum": [ + "Affinity", + "AntiAffinity" + ], + "x-ms-enum": { + "name": "AffinityType", + "modelAsString": true, + "values": [ + { + "name": "Affinity", + "value": "Affinity", + "description": "is affinity" + }, + { + "name": "AntiAffinity", + "value": "AntiAffinity", + "description": "is anti-affinity" + } + ] + } + }, + "AvailabilityProperties": { + "type": "object", + "description": "The properties describing private cloud availability zone distribution", + "properties": { + "strategy": { + "$ref": "#/definitions/AvailabilityStrategy", + "description": "The availability strategy for the private cloud" + }, + "zone": { + "type": "integer", + "format": "int32", + "description": "The primary availability zone for the private cloud" + }, + "secondaryZone": { + "type": "integer", + "format": "int32", + "description": "The secondary availability zone for the private cloud" + } + } + }, + "AvailabilityStrategy": { + "type": "string", + "description": "Whether the private clouds is available in a single zone or two zones", + "enum": [ + "SingleZone", + "DualZone" + ], + "x-ms-enum": { + "name": "AvailabilityStrategy", + "modelAsString": true, + "values": [ + { + "name": "SingleZone", + "value": "SingleZone", + "description": "in single zone" + }, + { + "name": "DualZone", + "value": "DualZone", + "description": "in two zones" + } + ] + } + }, + "AzureHybridBenefitType": { + "type": "string", + "description": "Azure Hybrid Benefit type", + "enum": [ + "SqlHost", + "None" + ], + "x-ms-enum": { + "name": "AzureHybridBenefitType", + "modelAsString": true, + "values": [ + { + "name": "SqlHost", + "value": "SqlHost", + "description": "is SqlHost" + }, + { + "name": "None", + "value": "None", + "description": "is None" + } + ] + } + }, + "Circuit": { + "type": "object", + "description": "An ExpressRoute Circuit", + "properties": { + "primarySubnet": { + "type": "string", + "description": "CIDR of primary subnet", + "readOnly": true + }, + "secondarySubnet": { + "type": "string", + "description": "CIDR of secondary subnet", + "readOnly": true + }, + "expressRouteID": { + "type": "string", + "description": "Identifier of the ExpressRoute Circuit (Microsoft Colo only)", + "readOnly": true + }, + "expressRoutePrivatePeeringID": { + "type": "string", + "description": "ExpressRoute Circuit private peering identifier", + "readOnly": true + } + } + }, + "CloudLink": { + "type": "object", + "description": "A cloud link resource", + "properties": { + "properties": { + "$ref": "#/definitions/CloudLinkProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "CloudLinkListResult": { + "type": "object", + "description": "The response of a CloudLink list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudLink items on this page", + "items": { + "$ref": "#/definitions/CloudLink" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudLinkProperties": { + "type": "object", + "description": "The properties of a cloud link.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/CloudLinkProvisioningState", + "description": "The provisioning state of the resource.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/CloudLinkStatus", + "description": "The state of the cloud link.", + "readOnly": true + }, + "linkedCloud": { + "type": "string", + "description": "Identifier of the other private cloud participating in the link." + } + } + }, + "CloudLinkProvisioningState": { + "type": "string", + "description": "cloud link provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "CloudLinkProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] + }, + "readOnly": true + }, + "CloudLinkStatus": { + "type": "string", + "description": "Cloud Link status", + "enum": [ + "Active", + "Building", + "Deleting", + "Failed", + "Disconnected" + ], + "x-ms-enum": { + "name": "CloudLinkStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "is active" + }, + { + "name": "Building", + "value": "Building", + "description": "is building" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Failed", + "value": "Failed", + "description": "is failed" + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "is disconnected" + } + ] + } + }, + "Cluster": { + "type": "object", + "description": "A cluster resource", + "properties": { + "properties": { + "$ref": "#/definitions/ClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ClusterListResult": { + "type": "object", + "description": "The response of a Cluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Cluster items on this page", + "items": { + "$ref": "#/definitions/Cluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ClusterProperties": { + "type": "object", + "description": "The properties of a cluster", + "properties": { + "clusterSize": { + "type": "integer", + "format": "int32", + "description": "The cluster size" + }, + "provisioningState": { + "$ref": "#/definitions/ClusterProvisioningState", + "description": "The state of the cluster provisioning", + "readOnly": true + }, + "clusterId": { + "type": "integer", + "format": "int32", + "description": "The identity", + "readOnly": true + }, + "hosts": { + "type": "array", + "description": "The hosts", + "items": { + "type": "string" + } + }, + "vsanDatastoreName": { + "type": "string", + "description": "Name of the vsan datastore associated with the cluster" + } + } + }, + "ClusterProvisioningState": { + "type": "string", + "description": "Cluster provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Cancelled", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "ClusterProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "is cancelled" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "ClusterUpdate": { + "type": "object", + "description": "An update of a cluster resource", + "properties": { + "sku": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + }, + "properties": { + "$ref": "#/definitions/ClusterUpdateProperties", + "description": "The properties of a cluster resource that may be updated", + "x-ms-client-flatten": true + } + } + }, + "ClusterUpdateProperties": { + "type": "object", + "description": "The properties of a cluster that may be updated", + "properties": { + "clusterSize": { + "type": "integer", + "format": "int32", + "description": "The cluster size" + }, + "hosts": { + "type": "array", + "description": "The hosts", + "items": { + "type": "string" + } + } + } + }, + "ClusterZone": { + "type": "object", + "description": "Zone and associated hosts info", + "properties": { + "hosts": { + "type": "array", + "description": "List of hosts belonging to the availability zone in a cluster", + "items": { + "type": "string" + }, + "readOnly": true + }, + "zone": { + "type": "string", + "description": "Availability zone identifier", + "readOnly": true + } + } + }, + "ClusterZoneList": { + "type": "object", + "description": "List of all zones and associated hosts for a cluster", + "properties": { + "zones": { + "type": "array", + "description": "Zone and associated hosts info", + "items": { + "$ref": "#/definitions/ClusterZone" + }, + "x-ms-identifiers": [] + } + } + }, + "Datastore": { + "type": "object", + "description": "A datastore resource", + "properties": { + "properties": { + "$ref": "#/definitions/DatastoreProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DatastoreListResult": { + "type": "object", + "description": "The response of a Datastore list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Datastore items on this page", + "items": { + "$ref": "#/definitions/Datastore" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DatastoreProperties": { + "type": "object", + "description": "The properties of a datastore", + "properties": { + "provisioningState": { + "$ref": "#/definitions/DatastoreProvisioningState", + "description": "The state of the datastore provisioning", + "readOnly": true + }, + "netAppVolume": { + "$ref": "#/definitions/NetAppVolume", + "description": "An Azure NetApp Files volume" + }, + "diskPoolVolume": { + "$ref": "#/definitions/DiskPoolVolume", + "description": "An iSCSI volume" + }, + "elasticSanVolume": { + "$ref": "#/definitions/ElasticSanVolume", + "description": "An Elastic SAN volume" + }, + "status": { + "$ref": "#/definitions/DatastoreStatus", + "description": "The operational status of the datastore", + "readOnly": true + } + } + }, + "DatastoreProvisioningState": { + "type": "string", + "description": "datastore provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Cancelled", + "Pending", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "DatastoreProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "is cancelled" + }, + { + "name": "Pending", + "value": "Pending", + "description": "is pending" + }, + { + "name": "Creating", + "value": "Creating", + "description": "is creating" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + } + ] + }, + "readOnly": true + }, + "DatastoreStatus": { + "type": "string", + "description": "datastore status", + "enum": [ + "Unknown", + "Accessible", + "Inaccessible", + "Attached", + "Detached", + "LostCommunication", + "DeadOrError" + ], + "x-ms-enum": { + "name": "DatastoreStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "is unknown" + }, + { + "name": "Accessible", + "value": "Accessible", + "description": "is accessible" + }, + { + "name": "Inaccessible", + "value": "Inaccessible", + "description": "is inaccessible" + }, + { + "name": "Attached", + "value": "Attached", + "description": "is attached" + }, + { + "name": "Detached", + "value": "Detached", + "description": "is detached" + }, + { + "name": "LostCommunication", + "value": "LostCommunication", + "description": "is lost communication" + }, + { + "name": "DeadOrError", + "value": "DeadOrError", + "description": "is dead or error" + } + ] + } + }, + "DhcpTypeEnum": { + "type": "string", + "description": "Type of DHCP: SERVER or RELAY.", + "enum": [ + "SERVER", + "RELAY" + ], + "x-ms-enum": { + "name": "DhcpTypeEnum", + "modelAsString": true, + "values": [ + { + "name": "SERVER", + "value": "SERVER" + }, + { + "name": "RELAY", + "value": "RELAY" + } + ] + } + }, + "DiskPoolVolume": { + "type": "object", + "description": "An iSCSI volume from Microsoft.StoragePool provider", + "properties": { + "targetId": { + "type": "string", + "description": "Azure resource ID of the iSCSI target" + }, + "lunName": { + "type": "string", + "description": "Name of the LUN to be used for datastore" + }, + "mountOption": { + "type": "string", + "description": "Mode that describes whether the LUN has to be mounted as a datastore or\nattached as a LUN", + "default": "MOUNT", + "enum": [ + "MOUNT", + "ATTACH" + ], + "x-ms-enum": { + "name": "MountOptionEnum", + "modelAsString": true, + "values": [ + { + "name": "MOUNT", + "value": "MOUNT", + "description": "is mount" + }, + { + "name": "ATTACH", + "value": "ATTACH", + "description": "is attach" + } + ] + } + }, + "path": { + "type": "string", + "description": "Device path", + "readOnly": true + } + }, + "required": [ + "targetId", + "lunName" + ] + }, + "DnsServiceLogLevelEnum": { + "type": "string", + "description": "DNS service log level", + "enum": [ + "DEBUG", + "INFO", + "WARNING", + "ERROR", + "FATAL" + ], + "x-ms-enum": { + "name": "DnsServiceLogLevelEnum", + "modelAsString": true, + "values": [ + { + "name": "DEBUG", + "value": "DEBUG", + "description": "is debug" + }, + { + "name": "INFO", + "value": "INFO", + "description": "is info" + }, + { + "name": "WARNING", + "value": "WARNING", + "description": "is warning" + }, + { + "name": "ERROR", + "value": "ERROR", + "description": "is error" + }, + { + "name": "FATAL", + "value": "FATAL", + "description": "is fatal" + } + ] + } + }, + "DnsServiceStatusEnum": { + "type": "string", + "description": "DNS service status", + "enum": [ + "SUCCESS", + "FAILURE" + ], + "x-ms-enum": { + "name": "DnsServiceStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "SUCCESS", + "value": "SUCCESS", + "description": "is success" + }, + { + "name": "FAILURE", + "value": "FAILURE", + "description": "is failure" + } + ] + } + }, + "DnsZoneType": { + "type": "string", + "description": "The type of DNS zone.", + "enum": [ + "Public", + "Private" + ], + "x-ms-enum": { + "name": "DnsZoneType", + "modelAsString": true, + "values": [ + { + "name": "Public", + "value": "Public", + "description": "Primary DNS zone." + }, + { + "name": "Private", + "value": "Private", + "description": "Private DNS zone." + } + ] + } + }, + "ElasticSanVolume": { + "type": "object", + "description": "An Elastic SAN volume from Microsoft.ElasticSan provider", + "properties": { + "targetId": { + "type": "string", + "format": "arm-id", + "description": "Azure resource ID of the Elastic SAN Volume", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups/volumes" + } + ] + } + } + }, + "required": [ + "targetId" + ] + }, + "Encryption": { + "type": "object", + "description": "The properties of customer managed encryption key", + "properties": { + "status": { + "$ref": "#/definitions/EncryptionState", + "description": "Status of customer managed encryption key" + }, + "keyVaultProperties": { + "$ref": "#/definitions/EncryptionKeyVaultProperties", + "description": "The key vault where the encryption key is stored" + } + } + }, + "EncryptionKeyStatus": { + "type": "string", + "description": "Whether the the encryption key is connected or access denied", + "enum": [ + "Connected", + "AccessDenied" + ], + "x-ms-enum": { + "name": "EncryptionKeyStatus", + "modelAsString": true, + "values": [ + { + "name": "Connected", + "value": "Connected", + "description": "is connected" + }, + { + "name": "AccessDenied", + "value": "AccessDenied", + "description": "is access denied" + } + ] + } + }, + "EncryptionKeyVaultProperties": { + "type": "object", + "description": "An Encryption Key", + "properties": { + "keyName": { + "type": "string", + "description": "The name of the key." + }, + "keyVersion": { + "type": "string", + "description": "The version of the key." + }, + "autoDetectedKeyVersion": { + "type": "string", + "description": "The auto-detected version of the key if versionType is auto-detected.", + "readOnly": true + }, + "keyVaultUrl": { + "type": "string", + "description": "The URL of the vault." + }, + "keyState": { + "$ref": "#/definitions/EncryptionKeyStatus", + "description": "The state of key provided", + "readOnly": true + }, + "versionType": { + "$ref": "#/definitions/EncryptionVersionType", + "description": "Property of the key if user provided or auto detected", + "readOnly": true + } + } + }, + "EncryptionState": { + "type": "string", + "description": "Whether encryption is enabled or disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EncryptionState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "is disabled" + } + ] + } + }, + "EncryptionVersionType": { + "type": "string", + "description": "Whether the encryption version is fixed or auto-detected", + "enum": [ + "Fixed", + "AutoDetected" + ], + "x-ms-enum": { + "name": "EncryptionVersionType", + "modelAsString": true, + "values": [ + { + "name": "Fixed", + "value": "Fixed", + "description": "is fixed" + }, + { + "name": "AutoDetected", + "value": "AutoDetected", + "description": "is auto-detected" + } + ] + } + }, + "Endpoints": { + "type": "object", + "description": "Endpoint addresses", + "properties": { + "nsxtManager": { + "type": "string", + "description": "Endpoint FQDN for the NSX-T Data Center manager", + "readOnly": true + }, + "vcsa": { + "type": "string", + "description": "Endpoint FQDN for Virtual Center Server Appliance", + "readOnly": true + }, + "hcxCloudManager": { + "type": "string", + "description": "Endpoint FQDN for the HCX Cloud Manager", + "readOnly": true + }, + "nsxtManagerIp": { + "type": "string", + "description": "Endpoint IP for the NSX-T Data Center manager", + "readOnly": true + }, + "vcenterIp": { + "type": "string", + "description": "Endpoint IP for Virtual Center Server Appliance", + "readOnly": true + }, + "hcxCloudManagerIp": { + "type": "string", + "description": "Endpoint IP for the HCX Cloud Manager", + "readOnly": true + } + } + }, + "ExpressRouteAuthorization": { + "type": "object", + "description": "ExpressRoute Circuit Authorization", + "properties": { + "properties": { + "$ref": "#/definitions/ExpressRouteAuthorizationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ExpressRouteAuthorizationListResult": { + "type": "object", + "description": "The response of a ExpressRouteAuthorization list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ExpressRouteAuthorization items on this page", + "items": { + "$ref": "#/definitions/ExpressRouteAuthorization" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ExpressRouteAuthorizationProperties": { + "type": "object", + "description": "The properties of an ExpressRoute Circuit Authorization resource", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ExpressRouteAuthorizationProvisioningState", + "description": "The state of the ExpressRoute Circuit Authorization provisioning", + "readOnly": true + }, + "expressRouteAuthorizationId": { + "type": "string", + "description": "The ID of the ExpressRoute Circuit Authorization", + "readOnly": true + }, + "expressRouteAuthorizationKey": { + "type": "string", + "description": "The key of the ExpressRoute Circuit Authorization", + "readOnly": true + }, + "expressRouteId": { + "type": "string", + "description": "The ID of the ExpressRoute Circuit" + } + } + }, + "ExpressRouteAuthorizationProvisioningState": { + "type": "string", + "description": "Express Route Circuit Authorization provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating" + ], + "x-ms-enum": { + "name": "ExpressRouteAuthorizationProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "GlobalReachConnection": { + "type": "object", + "description": "A global reach connection resource", + "properties": { + "properties": { + "$ref": "#/definitions/GlobalReachConnectionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GlobalReachConnectionListResult": { + "type": "object", + "description": "The response of a GlobalReachConnection list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GlobalReachConnection items on this page", + "items": { + "$ref": "#/definitions/GlobalReachConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GlobalReachConnectionProperties": { + "type": "object", + "description": "The properties of a global reach connection", + "properties": { + "provisioningState": { + "$ref": "#/definitions/GlobalReachConnectionProvisioningState", + "description": "The state of the ExpressRoute Circuit Authorization provisioning", + "readOnly": true + }, + "addressPrefix": { + "type": "string", + "description": "The network used for global reach carved out from the original network block\nprovided for the private cloud", + "readOnly": true + }, + "authorizationKey": { + "type": "string", + "description": "Authorization key from the peer express route used for the global reach\nconnection" + }, + "circuitConnectionStatus": { + "$ref": "#/definitions/GlobalReachConnectionStatus", + "description": "The connection status of the global reach connection", + "readOnly": true + }, + "peerExpressRouteCircuit": { + "type": "string", + "description": "Identifier of the ExpressRoute Circuit to peer with in the global reach\nconnection" + }, + "expressRouteId": { + "type": "string", + "description": "The ID of the Private Cloud's ExpressRoute Circuit that is participating in the\nglobal reach connection" + } + } + }, + "GlobalReachConnectionProvisioningState": { + "type": "string", + "description": "Global Reach Connection provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating" + ], + "x-ms-enum": { + "name": "GlobalReachConnectionProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "GlobalReachConnectionStatus": { + "type": "string", + "description": "Global Reach Connection status", + "enum": [ + "Connected", + "Connecting", + "Disconnected" + ], + "x-ms-enum": { + "name": "GlobalReachConnectionStatus", + "modelAsString": true, + "values": [ + { + "name": "Connected", + "value": "Connected", + "description": "is connected" + }, + { + "name": "Connecting", + "value": "Connecting", + "description": "is connecting" + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "is disconnected" + } + ] + } + }, + "HcxEnterpriseSite": { + "type": "object", + "description": "An HCX Enterprise Site resource", + "properties": { + "properties": { + "$ref": "#/definitions/HcxEnterpriseSiteProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "HcxEnterpriseSiteListResult": { + "type": "object", + "description": "The response of a HcxEnterpriseSite list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HcxEnterpriseSite items on this page", + "items": { + "$ref": "#/definitions/HcxEnterpriseSite" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HcxEnterpriseSiteProperties": { + "type": "object", + "description": "The properties of an HCX Enterprise Site", + "properties": { + "provisioningState": { + "$ref": "#/definitions/HcxEnterpriseSiteProvisioningState", + "description": "The provisioning state of the resource.", + "readOnly": true + }, + "activationKey": { + "type": "string", + "description": "The activation key", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/HcxEnterpriseSiteStatus", + "description": "The status of the HCX Enterprise Site", + "readOnly": true + } + } + }, + "HcxEnterpriseSiteProvisioningState": { + "type": "string", + "description": "HCX Enterprise Site provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "HcxEnterpriseSiteProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] + }, + "readOnly": true + }, + "HcxEnterpriseSiteStatus": { + "type": "string", + "description": "HCX Enterprise Site status", + "enum": [ + "Available", + "Consumed", + "Deactivated", + "Deleted" + ], + "x-ms-enum": { + "name": "HcxEnterpriseSiteStatus", + "modelAsString": true, + "values": [ + { + "name": "Available", + "value": "Available", + "description": "is available" + }, + { + "name": "Consumed", + "value": "Consumed", + "description": "is consumed" + }, + { + "name": "Deactivated", + "value": "Deactivated", + "description": "is deactivated" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "is deleted" + } + ] + } + }, + "IdentitySource": { + "type": "object", + "description": "vCenter Single Sign On Identity Source", + "properties": { + "name": { + "type": "string", + "description": "The name of the identity source" + }, + "alias": { + "type": "string", + "description": "The domain's NetBIOS name" + }, + "domain": { + "type": "string", + "description": "The domain's dns name" + }, + "baseUserDN": { + "type": "string", + "description": "The base distinguished name for users" + }, + "baseGroupDN": { + "type": "string", + "description": "The base distinguished name for groups" + }, + "primaryServer": { + "type": "string", + "description": "Primary server URL" + }, + "secondaryServer": { + "type": "string", + "description": "Secondary server URL" + }, + "ssl": { + "$ref": "#/definitions/SslEnum", + "description": "Protect LDAP communication using SSL certificate (LDAPS)" + }, + "username": { + "type": "string", + "description": "The ID of an Active Directory user with a minimum of read-only access to Base\nDN for users and group" + }, + "password": { + "type": "string", + "format": "password", + "description": "The password of the Active Directory user with a minimum of read-only access to\nBase DN for users and groups.", + "x-ms-secret": true + } + } + }, + "InternetEnum": { + "type": "string", + "description": "Whether internet is enabled or disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "InternetEnum", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "is disabled" + } + ] + } + }, + "IscsiPath": { + "type": "object", + "description": "An iSCSI path resource", + "properties": { + "properties": { + "$ref": "#/definitions/IscsiPathProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "IscsiPathListResult": { + "type": "object", + "description": "The response of a IscsiPath list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IscsiPath items on this page", + "items": { + "$ref": "#/definitions/IscsiPath" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IscsiPathProperties": { + "type": "object", + "description": "The properties of an iSCSI path resource", + "properties": { + "provisioningState": { + "$ref": "#/definitions/IscsiPathProvisioningState", + "description": "The state of the iSCSI path provisioning", + "readOnly": true + }, + "networkBlock": { + "type": "string", + "description": "CIDR Block for iSCSI path.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "networkBlock" + ] + }, + "IscsiPathProvisioningState": { + "type": "string", + "description": "private cloud provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Pending", + "Building", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "IscsiPathProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Pending", + "value": "Pending", + "description": "is pending" + }, + { + "name": "Building", + "value": "Building", + "description": "is building" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "ManagementCluster": { + "type": "object", + "description": "The properties of a management cluster", + "properties": { + "clusterSize": { + "type": "integer", + "format": "int32", + "description": "The cluster size" + }, + "provisioningState": { + "$ref": "#/definitions/ClusterProvisioningState", + "description": "The state of the cluster provisioning", + "readOnly": true + }, + "clusterId": { + "type": "integer", + "format": "int32", + "description": "The identity", + "readOnly": true + }, + "hosts": { + "type": "array", + "description": "The hosts", + "items": { + "type": "string" + } + }, + "vsanDatastoreName": { + "type": "string", + "description": "Name of the vsan datastore associated with the cluster" + } + } + }, + "NetAppVolume": { + "type": "object", + "description": "An Azure NetApp Files volume from Microsoft.NetApp provider", + "properties": { + "id": { + "type": "string", + "description": "Azure resource ID of the NetApp volume" + } + }, + "required": [ + "id" + ] + }, + "NsxPublicIpQuotaRaisedEnum": { + "type": "string", + "description": "NSX public IP quota raised", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "NsxPublicIpQuotaRaisedEnum", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "is disabled" + } + ] + } + }, + "OptionalParamEnum": { + "type": "string", + "description": "Optional Param", + "enum": [ + "Optional", + "Required" + ], + "x-ms-enum": { + "name": "OptionalParamEnum", + "modelAsString": true, + "values": [ + { + "name": "Optional", + "value": "Optional", + "description": "is optional" + }, + { + "name": "Required", + "value": "Required", + "description": "is required" + } + ] + } + }, + "PSCredentialExecutionParameter": { + "type": "object", + "description": "a powershell credential object", + "properties": { + "username": { + "type": "string", + "description": "username for login" + }, + "password": { + "type": "string", + "format": "password", + "description": "password for login", + "x-ms-secret": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ScriptExecutionParameter" + } + ], + "x-ms-discriminator-value": "Credential" + }, + "PlacementPolicy": { + "type": "object", + "description": "A vSphere Distributed Resource Scheduler (DRS) placement policy", + "properties": { + "properties": { + "$ref": "#/definitions/PlacementPolicyProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PlacementPolicyListResult": { + "type": "object", + "description": "The response of a PlacementPolicy list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PlacementPolicy items on this page", + "items": { + "$ref": "#/definitions/PlacementPolicy" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PlacementPolicyProperties": { + "type": "object", + "description": "Abstract placement policy properties", + "properties": { + "type": { + "$ref": "#/definitions/PlacementPolicyType", + "description": "Placement Policy type" + }, + "state": { + "$ref": "#/definitions/PlacementPolicyState", + "description": "Whether the placement policy is enabled or disabled" + }, + "displayName": { + "type": "string", + "description": "Display name of the placement policy" + }, + "provisioningState": { + "$ref": "#/definitions/PlacementPolicyProvisioningState", + "description": "The provisioning state", + "readOnly": true + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "PlacementPolicyProvisioningState": { + "type": "string", + "description": "Placement Policy provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Building", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "PlacementPolicyProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Building", + "value": "Building", + "description": "is building" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "PlacementPolicyState": { + "type": "string", + "description": "Placement Policy state", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PlacementPolicyState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "is disabled" + } + ] + } + }, + "PlacementPolicyType": { + "type": "string", + "description": "Placement Policy type", + "enum": [ + "VmVm", + "VmHost" + ], + "x-ms-enum": { + "name": "PlacementPolicyType", + "modelAsString": true, + "values": [ + { + "name": "VmVm", + "value": "VmVm" + }, + { + "name": "VmHost", + "value": "VmHost" + } + ] + } + }, + "PlacementPolicyUpdate": { + "type": "object", + "description": "An update of a DRS placement policy resource", + "properties": { + "properties": { + "$ref": "#/definitions/PlacementPolicyUpdateProperties", + "description": "The properties of a placement policy resource that may be updated", + "x-ms-client-flatten": true + } + } + }, + "PlacementPolicyUpdateProperties": { + "type": "object", + "description": "The properties of a placement policy resource that may be updated", + "properties": { + "state": { + "$ref": "#/definitions/PlacementPolicyState", + "description": "Whether the placement policy is enabled or disabled" + }, + "vmMembers": { + "type": "array", + "description": "Virtual machine members list", + "items": { + "type": "string" + } + }, + "hostMembers": { + "type": "array", + "description": "Host members list", + "items": { + "type": "string" + } + }, + "affinityStrength": { + "$ref": "#/definitions/AffinityStrength", + "description": "vm-host placement policy affinity strength (should/must)" + }, + "azureHybridBenefitType": { + "$ref": "#/definitions/AzureHybridBenefitType", + "description": "placement policy azure hybrid benefit opt-in type" + } + } + }, + "PortMirroringDirectionEnum": { + "type": "string", + "description": "Port Mirroring Direction", + "enum": [ + "INGRESS", + "EGRESS", + "BIDIRECTIONAL" + ], + "x-ms-enum": { + "name": "PortMirroringDirectionEnum", + "modelAsString": true, + "values": [ + { + "name": "INGRESS", + "value": "INGRESS", + "description": "is ingress" + }, + { + "name": "EGRESS", + "value": "EGRESS", + "description": "is egress" + }, + { + "name": "BIDIRECTIONAL", + "value": "BIDIRECTIONAL", + "description": "is bidirectional" + } + ] + } + }, + "PortMirroringStatusEnum": { + "type": "string", + "description": "Port Mirroring status", + "enum": [ + "SUCCESS", + "FAILURE" + ], + "x-ms-enum": { + "name": "PortMirroringStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "SUCCESS", + "value": "SUCCESS", + "description": "is success" + }, + { + "name": "FAILURE", + "value": "FAILURE", + "description": "is failure" + } + ] + } + }, + "PrivateCloud": { + "type": "object", + "description": "A private cloud resource", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateCloudProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/SystemAssignedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "PrivateCloudListResult": { + "type": "object", + "description": "The response of a PrivateCloud list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateCloud items on this page", + "items": { + "$ref": "#/definitions/PrivateCloud" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateCloudProperties": { + "type": "object", + "description": "The properties of a private cloud resource", + "properties": { + "managementCluster": { + "$ref": "#/definitions/ManagementCluster", + "description": "The default cluster used for management" + }, + "internet": { + "type": "string", + "description": "Connectivity to internet is enabled or disabled", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "InternetEnum", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "is disabled" + } + ] + } + }, + "identitySources": { + "type": "array", + "description": "vCenter Single Sign On Identity Sources", + "items": { + "$ref": "#/definitions/IdentitySource" + }, + "x-ms-identifiers": [] + }, + "availability": { + "$ref": "#/definitions/AvailabilityProperties", + "description": "Properties describing how the cloud is distributed across availability zones", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Customer managed key encryption, can be enabled or disabled" + }, + "extendedNetworkBlocks": { + "type": "array", + "description": "Array of additional networks noncontiguous with networkBlock. Networks must be\nunique and non-overlapping across VNet in your subscription, on-premise, and\nthis privateCloud networkBlock attribute. Make sure the CIDR format conforms to\n(A.B.C.D/X).", + "items": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/PrivateCloudProvisioningState", + "description": "The provisioning state", + "readOnly": true + }, + "circuit": { + "$ref": "#/definitions/Circuit", + "description": "An ExpressRoute Circuit" + }, + "endpoints": { + "$ref": "#/definitions/Endpoints", + "description": "The endpoints", + "readOnly": true + }, + "networkBlock": { + "type": "string", + "description": "The block of addresses should be unique across VNet in your subscription as\nwell as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where\nA,B,C,D are between 0 and 255, and X is between 0 and 22" + }, + "managementNetwork": { + "type": "string", + "description": "Network used to access vCenter Server and NSX-T Manager", + "readOnly": true + }, + "provisioningNetwork": { + "type": "string", + "description": "Used for virtual machine cold migration, cloning, and snapshot migration", + "readOnly": true + }, + "vmotionNetwork": { + "type": "string", + "description": "Used for live migration of virtual machines", + "readOnly": true + }, + "vcenterPassword": { + "type": "string", + "format": "password", + "description": "Optionally, set the vCenter admin password when the private cloud is created", + "x-ms-secret": true + }, + "nsxtPassword": { + "type": "string", + "format": "password", + "description": "Optionally, set the NSX-T Manager password when the private cloud is created", + "x-ms-secret": true + }, + "vcenterCertificateThumbprint": { + "type": "string", + "description": "Thumbprint of the vCenter Server SSL certificate", + "readOnly": true + }, + "nsxtCertificateThumbprint": { + "type": "string", + "description": "Thumbprint of the NSX-T Manager SSL certificate", + "readOnly": true + }, + "externalCloudLinks": { + "type": "array", + "description": "Array of cloud link IDs from other clouds that connect to this one", + "items": { + "type": "string" + }, + "readOnly": true + }, + "secondaryCircuit": { + "$ref": "#/definitions/Circuit", + "description": "A secondary expressRoute circuit from a separate AZ. Only present in a\nstretched private cloud" + }, + "nsxPublicIpQuotaRaised": { + "$ref": "#/definitions/NsxPublicIpQuotaRaisedEnum", + "description": "Flag to indicate whether the private cloud has the quota for provisioned NSX\nPublic IP count raised from 64 to 1024", + "readOnly": true + }, + "virtualNetworkId": { + "type": "string", + "format": "arm-id", + "description": "Azure resource ID of the virtual network", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "\\Microsoft.Network\\vnet" + } + ] + } + }, + "dnsZoneType": { + "$ref": "#/definitions/DnsZoneType", + "description": "The type of DNS zone to use." + } + }, + "required": [ + "managementCluster", + "networkBlock" + ] + }, + "PrivateCloudProvisioningState": { + "type": "string", + "description": "private cloud provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Cancelled", + "Pending", + "Building", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "PrivateCloudProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "is cancelled" + }, + { + "name": "Pending", + "value": "Pending", + "description": "is pending" + }, + { + "name": "Building", + "value": "Building", + "description": "is building" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "PrivateCloudUpdate": { + "type": "object", + "description": "An update to a private cloud resource", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/SystemAssignedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "properties": { + "$ref": "#/definitions/PrivateCloudUpdateProperties", + "description": "The updatable properties of a private cloud resource", + "x-ms-client-flatten": true + } + } + }, + "PrivateCloudUpdateProperties": { + "type": "object", + "description": "The properties of a private cloud resource that may be updated", + "properties": { + "managementCluster": { + "$ref": "#/definitions/ManagementCluster", + "description": "The default cluster used for management" + }, + "internet": { + "$ref": "#/definitions/InternetEnum", + "description": "Connectivity to internet is enabled or disabled" + }, + "identitySources": { + "type": "array", + "description": "vCenter Single Sign On Identity Sources", + "items": { + "$ref": "#/definitions/IdentitySource" + }, + "x-ms-identifiers": [] + }, + "availability": { + "$ref": "#/definitions/AvailabilityProperties", + "description": "Properties describing how the cloud is distributed across availability zones", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Customer managed key encryption, can be enabled or disabled" + }, + "extendedNetworkBlocks": { + "type": "array", + "description": "Array of additional networks noncontiguous with networkBlock. Networks must be\nunique and non-overlapping across VNet in your subscription, on-premise, and\nthis privateCloud networkBlock attribute. Make sure the CIDR format conforms to\n(A.B.C.D/X).", + "items": { + "type": "string" + } + }, + "dnsZoneType": { + "$ref": "#/definitions/DnsZoneType", + "description": "The type of DNS zone to use." + } + } + }, + "Quota": { + "type": "object", + "description": "Subscription quotas", + "properties": { + "hostsRemaining": { + "type": "object", + "description": "Remaining hosts quota by sku type", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "quotaEnabled": { + "$ref": "#/definitions/QuotaEnabled", + "description": "Host quota is active for current subscription", + "readOnly": true + } + } + }, + "QuotaEnabled": { + "type": "string", + "description": "quota enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "QuotaEnabled", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "is disabled" + } + ] + } + }, + "ScriptCmdlet": { + "type": "object", + "description": "A cmdlet available for script execution", + "properties": { + "properties": { + "$ref": "#/definitions/ScriptCmdletProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ScriptCmdletAudience": { + "type": "string", + "description": "Specifies whether a script cmdlet is intended to be invoked only through automation or visible to customers", + "enum": [ + "Automation", + "Any" + ], + "x-ms-enum": { + "name": "ScriptCmdletAudience", + "modelAsString": true, + "values": [ + { + "name": "Automation", + "value": "Automation", + "description": "is automation" + }, + { + "name": "Any", + "value": "Any", + "description": "is any" + } + ] + } + }, + "ScriptCmdletListResult": { + "type": "object", + "description": "The response of a ScriptCmdlet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ScriptCmdlet items on this page", + "items": { + "$ref": "#/definitions/ScriptCmdlet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ScriptCmdletProperties": { + "type": "object", + "description": "Properties of a pre-canned script", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ScriptCmdletProvisioningState", + "description": "The provisioning state of the resource.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the scripts functionality", + "readOnly": true + }, + "timeout": { + "type": "string", + "description": "Recommended time limit for execution", + "readOnly": true + }, + "audience": { + "$ref": "#/definitions/ScriptCmdletAudience", + "description": "Specifies whether a script cmdlet is intended to be invoked only through automation or visible to customers", + "readOnly": true + }, + "parameters": { + "type": "array", + "description": "Parameters the script will accept", + "items": { + "$ref": "#/definitions/ScriptParameter" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ScriptCmdletProvisioningState": { + "type": "string", + "description": "A script cmdlet provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ScriptCmdletProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] + }, + "readOnly": true + }, + "ScriptExecution": { + "type": "object", + "description": "An instance of a script executed by a user - custom or AVS", + "properties": { + "properties": { + "$ref": "#/definitions/ScriptExecutionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ScriptExecutionListResult": { + "type": "object", + "description": "The response of a ScriptExecution list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ScriptExecution items on this page", + "items": { + "$ref": "#/definitions/ScriptExecution" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ScriptExecutionParameter": { + "type": "object", + "description": "The arguments passed in to the execution", + "properties": { + "type": { + "$ref": "#/definitions/ScriptExecutionParameterType", + "description": "script execution parameter type" + }, + "name": { + "type": "string", + "description": "The parameter name" + } + }, + "discriminator": "type", + "required": [ + "type", + "name" + ] + }, + "ScriptExecutionParameterType": { + "type": "string", + "description": "script execution parameter type", + "enum": [ + "Value", + "SecureValue", + "Credential" + ], + "x-ms-enum": { + "name": "ScriptExecutionParameterType", + "modelAsString": true, + "values": [ + { + "name": "Value", + "value": "Value" + }, + { + "name": "SecureValue", + "value": "SecureValue" + }, + { + "name": "Credential", + "value": "Credential" + } + ] + } + }, + "ScriptExecutionProperties": { + "type": "object", + "description": "Properties of a user-invoked script", + "properties": { + "scriptCmdletId": { + "type": "string", + "description": "A reference to the script cmdlet resource if user is running a AVS script" + }, + "parameters": { + "type": "array", + "description": "Parameters the script will accept", + "items": { + "$ref": "#/definitions/ScriptExecutionParameter" + }, + "x-ms-identifiers": [] + }, + "hiddenParameters": { + "type": "array", + "description": "Parameters that will be hidden/not visible to ARM, such as passwords and\ncredentials", + "items": { + "$ref": "#/definitions/ScriptExecutionParameter" + }, + "x-ms-identifiers": [] + }, + "failureReason": { + "type": "string", + "description": "Error message if the script was able to run, but if the script itself had\nerrors or powershell threw an exception" + }, + "timeout": { + "type": "string", + "description": "Time limit for execution" + }, + "retention": { + "type": "string", + "description": "Time to live for the resource. If not provided, will be available for 60 days" + }, + "submittedAt": { + "type": "string", + "format": "date-time", + "description": "Time the script execution was submitted", + "readOnly": true + }, + "startedAt": { + "type": "string", + "format": "date-time", + "description": "Time the script execution was started", + "readOnly": true + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "description": "Time the script execution was finished", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ScriptExecutionProvisioningState", + "description": "The state of the script execution resource", + "readOnly": true + }, + "output": { + "type": "array", + "description": "Standard output stream from the powershell execution", + "items": { + "type": "string" + } + }, + "namedOutputs": { + "type": "object", + "description": "User-defined dictionary.", + "additionalProperties": { + "type": "object" + } + }, + "information": { + "type": "array", + "description": "Standard information out stream from the powershell execution", + "items": { + "type": "string" + }, + "readOnly": true + }, + "warnings": { + "type": "array", + "description": "Standard warning out stream from the powershell execution", + "items": { + "type": "string" + }, + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Standard error output stream from the powershell execution", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "timeout" + ] + }, + "ScriptExecutionProvisioningState": { + "type": "string", + "description": "Script Execution provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Pending", + "Running", + "Cancelling", + "Cancelled", + "Deleting" + ], + "x-ms-enum": { + "name": "ScriptExecutionProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Pending", + "value": "Pending", + "description": "is pending" + }, + { + "name": "Running", + "value": "Running", + "description": "is running" + }, + { + "name": "Cancelling", + "value": "Cancelling", + "description": "is cancelling" + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "is cancelled" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + } + ] + }, + "readOnly": true + }, + "ScriptOutputStreamType": { + "type": "string", + "description": "Script Output Stream type", + "enum": [ + "Information", + "Warning", + "Output", + "Error" + ], + "x-ms-enum": { + "name": "ScriptOutputStreamType", + "modelAsString": true, + "values": [ + { + "name": "Information", + "value": "Information", + "description": "is information" + }, + { + "name": "Warning", + "value": "Warning", + "description": "is warning" + }, + { + "name": "Output", + "value": "Output", + "description": "is output" + }, + { + "name": "Error", + "value": "Error", + "description": "is error" + } + ] + } + }, + "ScriptPackage": { + "type": "object", + "description": "Script Package resources available for execution", + "properties": { + "properties": { + "$ref": "#/definitions/ScriptPackageProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ScriptPackageListResult": { + "type": "object", + "description": "The response of a ScriptPackage list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ScriptPackage items on this page", + "items": { + "$ref": "#/definitions/ScriptPackage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ScriptPackageProperties": { + "type": "object", + "description": "Properties of a Script Package subresource", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ScriptPackageProvisioningState", + "description": "The provisioning state of the resource.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "User friendly description of the package", + "readOnly": true + }, + "version": { + "type": "string", + "description": "Module version", + "readOnly": true + }, + "company": { + "type": "string", + "description": "Company that created and supports the package", + "readOnly": true + }, + "uri": { + "type": "string", + "description": "Link to support by the package vendor", + "readOnly": true + } + } + }, + "ScriptPackageProvisioningState": { + "type": "string", + "description": "Script Package provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ScriptPackageProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] + }, + "readOnly": true + }, + "ScriptParameter": { + "type": "object", + "description": "An parameter that the script will accept", + "properties": { + "type": { + "$ref": "#/definitions/ScriptParameterTypes", + "description": "The type of parameter the script is expecting. psCredential is a\nPSCredentialObject", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The parameter name that the script will expect a parameter value for" + }, + "description": { + "type": "string", + "description": "User friendly description of the parameter", + "readOnly": true + }, + "visibility": { + "$ref": "#/definitions/VisibilityParameterEnum", + "description": "Should this parameter be visible to arm and passed in the parameters argument\nwhen executing", + "readOnly": true + }, + "optional": { + "$ref": "#/definitions/OptionalParamEnum", + "description": "Is this parameter required or optional", + "readOnly": true + } + } + }, + "ScriptParameterTypes": { + "type": "string", + "description": "Script Parameter types", + "enum": [ + "String", + "SecureString", + "Credential", + "Int", + "Bool", + "Float" + ], + "x-ms-enum": { + "name": "ScriptParameterTypes", + "modelAsString": true, + "values": [ + { + "name": "String", + "value": "String", + "description": "is string" + }, + { + "name": "SecureString", + "value": "SecureString", + "description": "is secure string" + }, + { + "name": "Credential", + "value": "Credential", + "description": "is credential" + }, + { + "name": "Int", + "value": "Int", + "description": "is int" + }, + { + "name": "Bool", + "value": "Bool", + "description": "is bool" + }, + { + "name": "Float", + "value": "Float", + "description": "is float" + } + ] + } + }, + "ScriptSecureStringExecutionParameter": { + "type": "object", + "description": "a plain text value execution parameter", + "properties": { + "secureValue": { + "type": "string", + "format": "password", + "description": "A secure value for the passed parameter, not to be stored in logs", + "x-ms-secret": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ScriptExecutionParameter" + } + ], + "x-ms-discriminator-value": "SecureValue" + }, + "ScriptStringExecutionParameter": { + "type": "object", + "description": "a plain text value execution parameter", + "properties": { + "value": { + "type": "string", + "description": "The value for the passed parameter" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ScriptExecutionParameter" + } + ], + "x-ms-discriminator-value": "Value" + }, + "SegmentStatusEnum": { + "type": "string", + "description": "Segment status", + "enum": [ + "SUCCESS", + "FAILURE" + ], + "x-ms-enum": { + "name": "SegmentStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "SUCCESS", + "value": "SUCCESS", + "description": "is success" + }, + { + "name": "FAILURE", + "value": "FAILURE", + "description": "is failure" + } + ] + } + }, + "SslEnum": { + "type": "string", + "description": "Whether SSL is enabled or disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SslEnum", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "is disabled" + } + ] + } + }, + "Trial": { + "type": "object", + "description": "Subscription trial availability", + "properties": { + "status": { + "$ref": "#/definitions/TrialStatus", + "description": "Trial status", + "readOnly": true + }, + "availableHosts": { + "type": "integer", + "format": "int32", + "description": "Number of trial hosts available", + "readOnly": true + } + } + }, + "TrialStatus": { + "type": "string", + "description": "trial status", + "enum": [ + "TrialAvailable", + "TrialUsed", + "TrialDisabled" + ], + "x-ms-enum": { + "name": "TrialStatus", + "modelAsString": true, + "values": [ + { + "name": "TrialAvailable", + "value": "TrialAvailable", + "description": "is available" + }, + { + "name": "TrialUsed", + "value": "TrialUsed", + "description": "is used" + }, + { + "name": "TrialDisabled", + "value": "TrialDisabled", + "description": "is disabled" + } + ] + } + }, + "VMGroupStatusEnum": { + "type": "string", + "description": "VM group status", + "enum": [ + "SUCCESS", + "FAILURE" + ], + "x-ms-enum": { + "name": "VMGroupStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "SUCCESS", + "value": "SUCCESS", + "description": "is success" + }, + { + "name": "FAILURE", + "value": "FAILURE", + "description": "is failure" + } + ] + } + }, + "VMTypeEnum": { + "type": "string", + "description": "VM type", + "enum": [ + "REGULAR", + "EDGE", + "SERVICE" + ], + "x-ms-enum": { + "name": "VMTypeEnum", + "modelAsString": true, + "values": [ + { + "name": "REGULAR", + "value": "REGULAR", + "description": "is regular" + }, + { + "name": "EDGE", + "value": "EDGE", + "description": "is edge" + }, + { + "name": "SERVICE", + "value": "SERVICE", + "description": "is service" + } + ] + } + }, + "VirtualMachine": { + "type": "object", + "description": "Virtual Machine", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VirtualMachineListResult": { + "type": "object", + "description": "The response of a VirtualMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualMachine items on this page", + "items": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualMachineProperties": { + "type": "object", + "description": "Virtual Machine Properties", + "properties": { + "provisioningState": { + "$ref": "#/definitions/VirtualMachineProvisioningState", + "description": "The provisioning state of the resource.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display name of the VM.", + "readOnly": true + }, + "moRefId": { + "type": "string", + "description": "Virtual machine managed object reference id", + "readOnly": true + }, + "folderPath": { + "type": "string", + "description": "Path to virtual machine's folder starting from datacenter virtual machine folder", + "readOnly": true + }, + "restrictMovement": { + "$ref": "#/definitions/VirtualMachineRestrictMovementState", + "description": "Whether VM DRS-driven movement is restricted (enabled) or not (disabled)", + "readOnly": true + } + } + }, + "VirtualMachineProvisioningState": { + "type": "string", + "description": "Virtual Machine provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "VirtualMachineProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + } + ] + }, + "readOnly": true + }, + "VirtualMachineRestrictMovement": { + "type": "object", + "description": "Set VM DRS-driven movement to restricted (enabled) or not (disabled)", + "properties": { + "restrictMovement": { + "$ref": "#/definitions/VirtualMachineRestrictMovementState", + "description": "Whether VM DRS-driven movement is restricted (enabled) or not (disabled)" + } + } + }, + "VirtualMachineRestrictMovementState": { + "type": "string", + "description": "Virtual Machine Restrict Movement state", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "VirtualMachineRestrictMovementState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "is disabled" + } + ] + } + }, + "VisibilityParameterEnum": { + "type": "string", + "description": "Visibility Parameter", + "enum": [ + "Visible", + "Hidden" + ], + "x-ms-enum": { + "name": "VisibilityParameterEnum", + "modelAsString": true, + "values": [ + { + "name": "Visible", + "value": "Visible", + "description": "is visible" + }, + { + "name": "Hidden", + "value": "Hidden", + "description": "is hidden" + } + ] + } + }, + "VmHostPlacementPolicyProperties": { + "type": "object", + "description": "VM-Host placement policy properties", + "properties": { + "vmMembers": { + "type": "array", + "description": "Virtual machine members list", + "items": { + "type": "string" + } + }, + "hostMembers": { + "type": "array", + "description": "Host members list", + "items": { + "type": "string" + } + }, + "affinityType": { + "$ref": "#/definitions/AffinityType", + "description": "placement policy affinity type" + }, + "affinityStrength": { + "$ref": "#/definitions/AffinityStrength", + "description": "vm-host placement policy affinity strength (should/must)" + }, + "azureHybridBenefitType": { + "$ref": "#/definitions/AzureHybridBenefitType", + "description": "placement policy azure hybrid benefit opt-in type" + } + }, + "required": [ + "vmMembers", + "hostMembers", + "affinityType" + ], + "allOf": [ + { + "$ref": "#/definitions/PlacementPolicyProperties" + } + ], + "x-ms-discriminator-value": "VmHost" + }, + "VmVmPlacementPolicyProperties": { + "type": "object", + "description": "VM-VM placement policy properties", + "properties": { + "vmMembers": { + "type": "array", + "description": "Virtual machine members list", + "items": { + "type": "string" + } + }, + "affinityType": { + "$ref": "#/definitions/AffinityType", + "description": "placement policy affinity type" + } + }, + "required": [ + "vmMembers", + "affinityType" + ], + "allOf": [ + { + "$ref": "#/definitions/PlacementPolicyProperties" + } + ], + "x-ms-discriminator-value": "VmVm" + }, + "WorkloadNetwork": { + "type": "object", + "description": "Workload Network", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WorkloadNetworkDhcp": { + "type": "object", + "description": "NSX DHCP", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkDhcpEntity", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WorkloadNetworkDhcpEntity": { + "type": "object", + "description": "Base class for WorkloadNetworkDhcpServer and WorkloadNetworkDhcpRelay to\ninherit from", + "properties": { + "dhcpType": { + "$ref": "#/definitions/DhcpTypeEnum", + "description": "Type of DHCP: SERVER or RELAY." + }, + "displayName": { + "type": "string", + "description": "Display name of the DHCP entity." + }, + "segments": { + "type": "array", + "description": "NSX Segments consuming DHCP.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/WorkloadNetworkDhcpProvisioningState", + "description": "The provisioning state", + "readOnly": true + }, + "revision": { + "type": "integer", + "format": "int64", + "description": "NSX revision number." + } + }, + "discriminator": "dhcpType", + "required": [ + "dhcpType" + ] + }, + "WorkloadNetworkDhcpEntityUpdate": { + "type": "object", + "description": "Base class for WorkloadNetworkDhcpServer and WorkloadNetworkDhcpRelay to\ninherit from", + "properties": { + "dhcpType": { + "$ref": "#/definitions/DhcpTypeEnum", + "description": "Type of DHCP: SERVER or RELAY." + }, + "displayName": { + "type": "string", + "description": "Display name of the DHCP entity." + }, + "revision": { + "type": "integer", + "format": "int64", + "description": "NSX revision number." + } + }, + "discriminator": "dhcpType", + "required": [ + "dhcpType" + ] + }, + "WorkloadNetworkDhcpListResult": { + "type": "object", + "description": "The response of a WorkloadNetworkDhcp list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkDhcp items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkDhcp" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WorkloadNetworkDhcpProvisioningState": { + "type": "string", + "description": "Workload Network DHCP provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Building", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "WorkloadNetworkDhcpProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Building", + "value": "Building", + "description": "is building" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "WorkloadNetworkDhcpRelay": { + "type": "object", + "description": "NSX DHCP Relay", + "properties": { + "serverAddresses": { + "type": "array", + "description": "DHCP Relay Addresses. Max 3.", + "minItems": 1, + "maxItems": 3, + "items": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/WorkloadNetworkDhcpEntity" + } + ], + "x-ms-discriminator-value": "RELAY" + }, + "WorkloadNetworkDhcpRelayUpdate": { + "type": "object", + "description": "NSX DHCP Relay", + "properties": { + "serverAddresses": { + "type": "array", + "description": "DHCP Relay Addresses. Max 3.", + "minItems": 1, + "maxItems": 3, + "items": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/WorkloadNetworkDhcpEntityUpdate" + } + ], + "x-ms-discriminator-value": "RELAY" + }, + "WorkloadNetworkDhcpServer": { + "type": "object", + "description": "NSX DHCP Server", + "properties": { + "serverAddress": { + "type": "string", + "description": "DHCP Server Address." + }, + "leaseTime": { + "type": "integer", + "format": "int64", + "description": "DHCP Server Lease Time." + } + }, + "allOf": [ + { + "$ref": "#/definitions/WorkloadNetworkDhcpEntity" + } + ], + "x-ms-discriminator-value": "SERVER" + }, + "WorkloadNetworkDhcpServerUpdate": { + "type": "object", + "description": "NSX DHCP Server", + "properties": { + "serverAddress": { + "type": "string", + "description": "DHCP Server Address." + }, + "leaseTime": { + "type": "integer", + "format": "int64", + "description": "DHCP Server Lease Time." + } + }, + "allOf": [ + { + "$ref": "#/definitions/WorkloadNetworkDhcpEntityUpdate" + } + ], + "x-ms-discriminator-value": "SERVER" + }, + "WorkloadNetworkDhcpUpdate": { + "type": "object", + "description": "NSX DHCP update", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkDhcpEntityUpdate", + "description": "The updatable properties of a DHCP update", + "x-ms-client-flatten": false + } + } + }, + "WorkloadNetworkDnsService": { + "type": "object", + "description": "NSX DNS Service", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkDnsServiceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WorkloadNetworkDnsServiceListResult": { + "type": "object", + "description": "The response of a WorkloadNetworkDnsService list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkDnsService items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkDnsService" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WorkloadNetworkDnsServiceProperties": { + "type": "object", + "description": "NSX DNS Service Properties", + "properties": { + "displayName": { + "type": "string", + "description": "Display name of the DNS Service." + }, + "dnsServiceIp": { + "type": "string", + "description": "DNS service IP of the DNS Service." + }, + "defaultDnsZone": { + "type": "string", + "description": "Default DNS zone of the DNS Service." + }, + "fqdnZones": { + "type": "array", + "description": "FQDN zones of the DNS Service.", + "items": { + "type": "string" + } + }, + "logLevel": { + "$ref": "#/definitions/DnsServiceLogLevelEnum", + "description": "DNS Service log level." + }, + "status": { + "$ref": "#/definitions/DnsServiceStatusEnum", + "description": "DNS Service status.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/WorkloadNetworkDnsServiceProvisioningState", + "description": "The provisioning state", + "readOnly": true + }, + "revision": { + "type": "integer", + "format": "int64", + "description": "NSX revision number." + } + } + }, + "WorkloadNetworkDnsServiceProvisioningState": { + "type": "string", + "description": "Workload Network DNS Service provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Building", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "WorkloadNetworkDnsServiceProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Building", + "value": "Building", + "description": "is building" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "WorkloadNetworkDnsServiceUpdate": { + "type": "object", + "description": "NSX DNS Service update", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkDnsServiceProperties", + "description": "The updatable properties of a DNS Service update", + "x-ms-client-flatten": true + } + } + }, + "WorkloadNetworkDnsZone": { + "type": "object", + "description": "NSX DNS Zone", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkDnsZoneProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WorkloadNetworkDnsZoneListResult": { + "type": "object", + "description": "The response of a WorkloadNetworkDnsZone list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkDnsZone items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkDnsZone" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WorkloadNetworkDnsZoneProperties": { + "type": "object", + "description": "NSX DNS Zone Properties", + "properties": { + "displayName": { + "type": "string", + "description": "Display name of the DNS Zone." + }, + "domain": { + "type": "array", + "description": "Domain names of the DNS Zone.", + "items": { + "type": "string" + } + }, + "dnsServerIps": { + "type": "array", + "description": "DNS Server IP array of the DNS Zone.", + "items": { + "type": "string" + } + }, + "sourceIp": { + "type": "string", + "description": "Source IP of the DNS Zone." + }, + "dnsServices": { + "type": "integer", + "format": "int32", + "description": "Number of DNS Services using the DNS zone." + }, + "provisioningState": { + "$ref": "#/definitions/WorkloadNetworkDnsZoneProvisioningState", + "description": "The provisioning state", + "readOnly": true + }, + "revision": { + "type": "integer", + "format": "int64", + "description": "NSX revision number." + } + } + }, + "WorkloadNetworkDnsZoneProvisioningState": { + "type": "string", + "description": "Workload Network DNS Zone provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Building", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "WorkloadNetworkDnsZoneProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Building", + "value": "Building", + "description": "is building" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "WorkloadNetworkDnsZoneUpdate": { + "type": "object", + "description": "NSX DNS Zone update", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkDnsZoneProperties", + "description": "The updatable properties of a DNS Zone update", + "x-ms-client-flatten": true + } + } + }, + "WorkloadNetworkGateway": { + "type": "object", + "description": "NSX Gateway.", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkGatewayProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WorkloadNetworkGatewayListResult": { + "type": "object", + "description": "The response of a WorkloadNetworkGateway list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkGateway items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkGateway" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WorkloadNetworkGatewayProperties": { + "type": "object", + "description": "Properties of a NSX Gateway.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/WorkloadNetworkProvisioningState", + "description": "The provisioning state of the resource.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display name of the DHCP entity." + }, + "path": { + "type": "string", + "description": "NSX Gateway Path.", + "readOnly": true + } + } + }, + "WorkloadNetworkListResult": { + "type": "object", + "description": "The response of a WorkloadNetwork list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetwork items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetwork" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WorkloadNetworkPortMirroring": { + "type": "object", + "description": "NSX Port Mirroring", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkPortMirroringProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WorkloadNetworkPortMirroringListResult": { + "type": "object", + "description": "The response of a WorkloadNetworkPortMirroring list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkPortMirroring items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkPortMirroring" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WorkloadNetworkPortMirroringProperties": { + "type": "object", + "description": "NSX Port Mirroring Properties", + "properties": { + "displayName": { + "type": "string", + "description": "Display name of the port mirroring profile." + }, + "direction": { + "$ref": "#/definitions/PortMirroringDirectionEnum", + "description": "Direction of port mirroring profile." + }, + "source": { + "type": "string", + "description": "Source VM Group." + }, + "destination": { + "type": "string", + "description": "Destination VM Group." + }, + "status": { + "$ref": "#/definitions/PortMirroringStatusEnum", + "description": "Port Mirroring Status.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/WorkloadNetworkPortMirroringProvisioningState", + "description": "The provisioning state", + "readOnly": true + }, + "revision": { + "type": "integer", + "format": "int64", + "description": "NSX revision number." + } + } + }, + "WorkloadNetworkPortMirroringProvisioningState": { + "type": "string", + "description": "Workload Network Port Mirroring provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Building", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "WorkloadNetworkPortMirroringProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Building", + "value": "Building", + "description": "is building" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "WorkloadNetworkPortMirroringUpdate": { + "type": "object", + "description": "NSX Port Mirroring update", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkPortMirroringProperties", + "description": "The updatable properties of a Port Mirroring update", + "x-ms-client-flatten": true + } + } + }, + "WorkloadNetworkProperties": { + "type": "object", + "description": "The properties of a workload network", + "properties": { + "provisioningState": { + "$ref": "#/definitions/WorkloadNetworkProvisioningState", + "description": "The provisioning state of the resource.", + "readOnly": true + } + } + }, + "WorkloadNetworkProvisioningState": { + "type": "string", + "description": "base Workload Network provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Building", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "WorkloadNetworkProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Building", + "value": "Building", + "description": "is building" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "WorkloadNetworkPublicIP": { + "type": "object", + "description": "NSX Public IP Block", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkPublicIPProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WorkloadNetworkPublicIPListResult": { + "type": "object", + "description": "The response of a WorkloadNetworkPublicIP list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkPublicIP items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkPublicIP" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WorkloadNetworkPublicIPProperties": { + "type": "object", + "description": "NSX Public IP Block Properties", + "properties": { + "displayName": { + "type": "string", + "description": "Display name of the Public IP Block." + }, + "numberOfPublicIPs": { + "type": "integer", + "format": "int64", + "description": "Number of Public IPs requested." + }, + "publicIPBlock": { + "type": "string", + "description": "CIDR Block of the Public IP Block.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/WorkloadNetworkPublicIPProvisioningState", + "description": "The provisioning state", + "readOnly": true + } + } + }, + "WorkloadNetworkPublicIPProvisioningState": { + "type": "string", + "description": "Workload Network Public IP provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Building", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "WorkloadNetworkPublicIPProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Building", + "value": "Building", + "description": "is building" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "WorkloadNetworkSegment": { + "type": "object", + "description": "NSX Segment", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkSegmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WorkloadNetworkSegmentListResult": { + "type": "object", + "description": "The response of a WorkloadNetworkSegment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkSegment items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkSegment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WorkloadNetworkSegmentPortVif": { + "type": "object", + "description": "Ports and any VIF attached to segment.", + "properties": { + "portName": { + "type": "string", + "description": "Name of port or VIF attached to segment." + } + } + }, + "WorkloadNetworkSegmentProperties": { + "type": "object", + "description": "NSX Segment Properties", + "properties": { + "displayName": { + "type": "string", + "description": "Display name of the segment." + }, + "connectedGateway": { + "type": "string", + "description": "Gateway which to connect segment to." + }, + "subnet": { + "$ref": "#/definitions/WorkloadNetworkSegmentSubnet", + "description": "Subnet which to connect segment to." + }, + "portVif": { + "type": "array", + "description": "Port Vif which segment is associated with.", + "items": { + "$ref": "#/definitions/WorkloadNetworkSegmentPortVif" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/SegmentStatusEnum", + "description": "Segment status.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/WorkloadNetworkSegmentProvisioningState", + "description": "The provisioning state", + "readOnly": true + }, + "revision": { + "type": "integer", + "format": "int64", + "description": "NSX revision number." + } + } + }, + "WorkloadNetworkSegmentProvisioningState": { + "type": "string", + "description": "Workload Network Segment provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Building", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "WorkloadNetworkSegmentProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Building", + "value": "Building", + "description": "is building" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "WorkloadNetworkSegmentSubnet": { + "type": "object", + "description": "Subnet configuration for segment", + "properties": { + "dhcpRanges": { + "type": "array", + "description": "DHCP Range assigned for subnet.", + "items": { + "type": "string" + } + }, + "gatewayAddress": { + "type": "string", + "description": "Gateway address." + } + } + }, + "WorkloadNetworkSegmentUpdate": { + "type": "object", + "description": "NSX Segment update", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkSegmentProperties", + "description": "The updatable properties of a Segment update", + "x-ms-client-flatten": true + } + } + }, + "WorkloadNetworkVMGroup": { + "type": "object", + "description": "NSX VM Group", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkVMGroupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WorkloadNetworkVMGroupListResult": { + "type": "object", + "description": "The response of a WorkloadNetworkVMGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkVMGroup items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkVMGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WorkloadNetworkVMGroupProperties": { + "type": "object", + "description": "NSX VM Group Properties", + "properties": { + "displayName": { + "type": "string", + "description": "Display name of the VM group." + }, + "members": { + "type": "array", + "description": "Virtual machine members of this group.", + "items": { + "type": "string" + } + }, + "status": { + "$ref": "#/definitions/VMGroupStatusEnum", + "description": "VM Group status.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/WorkloadNetworkVMGroupProvisioningState", + "description": "The provisioning state", + "readOnly": true + }, + "revision": { + "type": "integer", + "format": "int64", + "description": "NSX revision number." + } + } + }, + "WorkloadNetworkVMGroupProvisioningState": { + "type": "string", + "description": "Workload Network VM Group provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Building", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "WorkloadNetworkVMGroupProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Building", + "value": "Building", + "description": "is building" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "is deleting" + }, + { + "name": "Updating", + "value": "Updating", + "description": "is updating" + } + ] + }, + "readOnly": true + }, + "WorkloadNetworkVMGroupUpdate": { + "type": "object", + "description": "NSX VM Group update", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkVMGroupProperties", + "description": "The updatable properties of a VM Group update", + "x-ms-client-flatten": true + } + } + }, + "WorkloadNetworkVirtualMachine": { + "type": "object", + "description": "NSX Virtual Machine", + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadNetworkVirtualMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WorkloadNetworkVirtualMachineListResult": { + "type": "object", + "description": "The response of a WorkloadNetworkVirtualMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WorkloadNetworkVirtualMachine items on this page", + "items": { + "$ref": "#/definitions/WorkloadNetworkVirtualMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WorkloadNetworkVirtualMachineProperties": { + "type": "object", + "description": "NSX Virtual Machine Properties", + "properties": { + "provisioningState": { + "$ref": "#/definitions/WorkloadNetworkProvisioningState", + "description": "The provisioning state of the resource.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display name of the VM." + }, + "vmType": { + "$ref": "#/definitions/VMTypeEnum", + "description": "Virtual machine type.", + "readOnly": true + } + } + } + }, + "parameters": { + "DhcpIdParameter": { + "name": "dhcpId", + "in": "path", + "description": "The ID of the DHCP configuration", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + }, + "DnsServiceIdParameter": { + "name": "dnsServiceId", + "in": "path", + "description": "ID of the DNS service.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + }, + "DnsZoneIdParameter": { + "name": "dnsZoneId", + "in": "path", + "description": "ID of the DNS zone.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + }, + "PortMirroringProfileParameter": { + "name": "portMirroringId", + "in": "path", + "description": "ID of the NSX port mirroring profile.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + }, + "PrivateCloudNameParameter": { + "name": "privateCloudName", + "in": "path", + "description": "Name of the private cloud", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + }, + "PublicIPIdParameter": { + "name": "publicIPId", + "in": "path", + "description": "ID of the DNS zone.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + }, + "VmGroupIdParameter": { + "name": "vmGroupId", + "in": "path", + "description": "ID of the VM group.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/vmware/resource-manager/api-set.json b/swagger-specs/vmware/resource-manager/api-set.json index 277281c8a..9e0c8ec70 100644 --- a/swagger-specs/vmware/resource-manager/api-set.json +++ b/swagger-specs/vmware/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.AVS/stable/2023-03-01/vmware.json"], "name": "package-2023-03-01"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.AVS/stable/2023-09-01/vmware.json"], "name": "package-2023-09-01"} \ No newline at end of file diff --git a/swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-01-01/AppServiceCertificateOrders.json b/swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-12-01/AppServiceCertificateOrders.json similarity index 97% rename from swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-01-01/AppServiceCertificateOrders.json rename to swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-12-01/AppServiceCertificateOrders.json index 4a579769c..5b509c970 100644 --- a/swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-01-01/AppServiceCertificateOrders.json +++ b/swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-12-01/AppServiceCertificateOrders.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "AppServiceCertificateOrders API Client" }, "host": "management.azure.com", @@ -41,7 +41,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -87,7 +87,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -127,7 +127,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -177,7 +177,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -237,7 +237,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -283,7 +283,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -337,7 +337,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -384,7 +384,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -441,7 +441,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -508,7 +508,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -561,7 +561,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -622,7 +622,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -675,7 +675,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -728,7 +728,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -772,7 +772,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -808,7 +808,7 @@ "description": "Email address", "required": true, "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/NameIdentifier" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/NameIdentifier" } }, { @@ -825,7 +825,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -881,7 +881,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -925,7 +925,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -975,7 +975,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -1025,7 +1025,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -1100,7 +1100,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/Resource" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/Resource" } ], "properties": { @@ -1313,7 +1313,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { @@ -1505,7 +1505,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { @@ -1522,7 +1522,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/Resource" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/Resource" } ], "properties": { @@ -1662,7 +1662,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { @@ -1698,7 +1698,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { diff --git a/swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-01-01/CertificateOrdersDiagnostics.json b/swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-12-01/CertificateOrdersDiagnostics.json similarity index 95% rename from swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-01-01/CertificateOrdersDiagnostics.json rename to swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-12-01/CertificateOrdersDiagnostics.json index 596ed9887..451c648d8 100644 --- a/swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-01-01/CertificateOrdersDiagnostics.json +++ b/swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-12-01/CertificateOrdersDiagnostics.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "CertificateOrdersDiagnostics API Client" }, "host": "management.azure.com", @@ -45,13 +45,13 @@ "200": { "description": "OK", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DetectorResponseCollection" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DetectorResponseCollection" } }, "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -123,13 +123,13 @@ "200": { "description": "OK", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DetectorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DetectorResponse" } }, "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, diff --git a/swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-01-01/CertificateRegistrationProvider.json b/swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-12-01/CertificateRegistrationProvider.json similarity index 93% rename from swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-01-01/CertificateRegistrationProvider.json rename to swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-12-01/CertificateRegistrationProvider.json index 30c6dce54..da1db47b2 100644 --- a/swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-01-01/CertificateRegistrationProvider.json +++ b/swagger-specs/web/resource-manager/Microsoft.CertificateRegistration/stable/2023-12-01/CertificateRegistrationProvider.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "CertificateRegistrationProvider API Client" }, "host": "management.azure.com", @@ -32,13 +32,13 @@ "200": { "description": "OK", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/CsmOperationCollection" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/CsmOperationCollection" } }, "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, diff --git a/swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/DomainRegistrationProvider.json b/swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-12-01/DomainRegistrationProvider.json similarity index 93% rename from swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/DomainRegistrationProvider.json rename to swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-12-01/DomainRegistrationProvider.json index 025ab1a78..681cd0a5e 100644 --- a/swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/DomainRegistrationProvider.json +++ b/swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-12-01/DomainRegistrationProvider.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "DomainRegistrationProvider API Client" }, "host": "management.azure.com", @@ -32,13 +32,13 @@ "200": { "description": "OK", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/CsmOperationCollection" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/CsmOperationCollection" } }, "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, diff --git a/swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/Domains.json b/swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-12-01/Domains.json similarity index 97% rename from swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/Domains.json rename to swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-12-01/Domains.json index 4eb32881b..fabb6bbcf 100644 --- a/swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/Domains.json +++ b/swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-12-01/Domains.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "Domains API Client" }, "host": "management.azure.com", @@ -30,7 +30,7 @@ "description": "Name of the domain.", "required": true, "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/NameIdentifier" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/NameIdentifier" } }, { @@ -50,7 +50,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -87,7 +87,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -127,7 +127,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -173,7 +173,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -216,7 +216,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -266,7 +266,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -327,7 +327,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -379,7 +379,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -440,7 +440,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -487,7 +487,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -544,7 +544,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -605,7 +605,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -657,7 +657,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -718,7 +718,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -768,7 +768,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -818,7 +818,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -921,7 +921,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/Resource" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/Resource" } ], "properties": { @@ -1200,7 +1200,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { @@ -1243,7 +1243,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { @@ -1554,7 +1554,7 @@ "description": "Collection of resources.", "type": "array", "items": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/NameIdentifier" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/NameIdentifier" }, "x-ms-identifiers": [ "name" diff --git a/swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/TopLevelDomains.json b/swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-12-01/TopLevelDomains.json similarity index 96% rename from swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/TopLevelDomains.json rename to swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-12-01/TopLevelDomains.json index ab00bd9a6..7dce7e95e 100644 --- a/swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/TopLevelDomains.json +++ b/swagger-specs/web/resource-manager/Microsoft.DomainRegistration/stable/2023-12-01/TopLevelDomains.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "TopLevelDomains API Client" }, "host": "management.azure.com", @@ -41,7 +41,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -88,7 +88,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -141,7 +141,7 @@ "default": { "description": "App Service error response.", "schema": { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, @@ -213,7 +213,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../Microsoft.Web/stable/2023-01-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + "$ref": "../../../Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/AppServiceEnvironments.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/AppServiceEnvironments.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/AppServiceEnvironments.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/AppServiceEnvironments.json index 2de1f2436..7bdf1768e 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/AppServiceEnvironments.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/AppServiceEnvironments.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "AppServiceEnvironments API Client" }, "host": "management.azure.com", @@ -1646,7 +1646,7 @@ "in": "body", "required": true, "schema": { - "$ref": "./CommonDefinitions.json#/definitions/PrivateLinkConnectionApprovalRequestResource" + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" } }, { diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/AppServicePlans.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/AppServicePlans.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/AppServicePlans.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/AppServicePlans.json index af851cc9d..9e8a891ab 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/AppServicePlans.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/AppServicePlans.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "AppServicePlans API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Certificates.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Certificates.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Certificates.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Certificates.json index 6d2ae7355..fde180ff1 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Certificates.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Certificates.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "Certificates API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/CommonDefinitions.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json similarity index 94% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/CommonDefinitions.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json index 26945c2b1..b5b40169d 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/CommonDefinitions.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "Common Definitions" }, "host": "management.azure.com", @@ -639,6 +639,19 @@ "name": "AzureStorageState", "modelAsString": false } + }, + "protocol": { + "description": "Mounting protocol to use for the storage account.", + "enum": [ + "Smb", + "Http", + "Nfs" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureStorageProtocol", + "modelAsString": true + } } } }, @@ -2903,6 +2916,10 @@ "type": "string", "readOnly": true }, + "dnsConfiguration": { + "$ref": "#/definitions/SiteDnsConfig", + "description": "Property to configure various DNS related settings for a site." + }, "vnetRouteAllEnabled": { "description": "Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.", "type": "boolean" @@ -2915,10 +2932,18 @@ "description": "To enable accessing content over virtual network", "type": "boolean" }, + "vnetBackupRestoreEnabled": { + "description": "To enable Backup and Restore operations over virtual network", + "type": "boolean" + }, "siteConfig": { "$ref": "#/definitions/SiteConfig", "description": "Configuration of the app." }, + "functionAppConfig": { + "$ref": "#/definitions/FunctionAppConfig", + "description": "Configuration specific of the Azure Function app." + }, "daprConfig": { "$ref": "#/definitions/DaprConfig", "description": "Dapr configuration of the app." @@ -3470,7 +3495,8 @@ "enum": [ "1.0", "1.1", - "1.2" + "1.2", + "1.3" ], "type": "string", "x-ms-enum": { @@ -3510,7 +3536,8 @@ "enum": [ "1.0", "1.1", - "1.2" + "1.2", + "1.3" ], "type": "string", "x-ms-enum": { @@ -3582,6 +3609,157 @@ } } }, + "FunctionsDeployment": { + "description": "Configuration section for the function app deployment.", + "type": "object", + "properties": { + "storage": { + "description": "Storage for deployed package used by the function app.", + "type": "object", + "properties": { + "type": { + "description": "Property to select Azure Storage type. Available options: blobContainer.", + "type": "string", + "enum": [ + "blobContainer" + ], + "x-ms-enum": { + "name": "FunctionsDeploymentStorageType", + "modelAsString": true + } + }, + "value": { + "description": "Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/.", + "type": "string", + "format": "uri" + }, + "authentication": { + "description": "Authentication method to access the storage account for deployment.", + "type": "object", + "properties": { + "type": { + "description": "Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString.", + "type": "string", + "enum": [ + "SystemAssignedIdentity", + "UserAssignedIdentity", + "StorageAccountConnectionString" + ], + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "userAssignedIdentityResourceId": { + "description": "Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type.", + "type": "string" + }, + "storageAccountConnectionStringName": { + "description": "Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type.", + "type": "string" + } + } + } + } + } + } + }, + "FunctionsAlwaysReadyConfig": { + "description": "Sets the number of 'Always Ready' instances for a function group or a specific function.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready." + }, + "instanceCount": { + "type": "number", + "description": "Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready." + } + } + }, + "FunctionsScaleAndConcurrency": { + "description": "Scale and concurrency settings for the function app.", + "type": "object", + "properties": { + "alwaysReady": { + "description": "'Always Ready' configuration for the function app.", + "type": "array", + "items": { + "$ref": "#/definitions/FunctionsAlwaysReadyConfig" + } + }, + "maximumInstanceCount": { + "description": "The maximum number of instances for the function app.", + "type": "number" + }, + "instanceMemoryMB": { + "description": "Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally.", + "type": "number" + }, + "triggers": { + "type": "object", + "description": "Scale and concurrency settings for the function app triggers.", + "properties": { + "http": { + "type": "object", + "description": "Scale and concurrency settings for the HTTP trigger.", + "properties": { + "perInstanceConcurrency": { + "type": "number", + "description": "The maximum number of concurrent HTTP trigger invocations per instance." + } + } + } + } + } + } + }, + "FunctionsRuntime": { + "description": "Function app runtime name and version.", + "type": "object", + "properties": { + "name": { + "description": "Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom", + "type": "string", + "enum": [ + "dotnet-isolated", + "node", + "java", + "powershell", + "python", + "custom" + ], + "x-ms-enum": { + "name": "RuntimeName", + "modelAsString": true + } + }, + "version": { + "description": "Function app runtime version. Example: 8 (for dotnet-isolated)", + "type": "string", + "x-nullable": true + } + } + }, + "FunctionAppConfig": { + "description": "Function app configuration.", + "type": "object", + "properties": { + "deployment": { + "$ref": "#/definitions/FunctionsDeployment", + "description": "Function app deployment configuration." + }, + "runtime": { + "$ref": "#/definitions/FunctionsRuntime", + "description": "Function app runtime settings." + }, + "scaleAndConcurrency": { + "$ref": "#/definitions/FunctionsScaleAndConcurrency", + "description": "Function app scale and concurrency settings." + } + } + }, "DaprConfig": { "description": "App Dapr configuration.", "type": "object", @@ -3645,6 +3823,42 @@ } } }, + "SiteDnsConfig": { + "type": "object", + "properties": { + "dnsServers": { + "description": "List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set.", + "type": "array", + "items": { + "type": "string" + } + }, + "dnsAltServer": { + "description": "Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting.", + "type": "string" + }, + "dnsRetryAttemptTimeout": { + "format": "int32", + "description": "Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3.", + "type": "integer" + }, + "dnsRetryAttemptCount": { + "format": "int32", + "description": "Total number of retries for dns lookup. Allowed range: 1-5. Default is 3.", + "type": "integer" + }, + "dnsMaxCacheTimeout": { + "format": "int32", + "description": "Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled.", + "type": "integer" + }, + "dnsLegacySortOrder": { + "description": "Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only.", + "type": "boolean", + "readOnly": true + } + } + }, "SiteLimits": { "description": "Metric limits set on an app.", "type": "object", diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/ContainerApps.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/ContainerApps.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/ContainerApps.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/ContainerApps.json index 045d03144..39d8c8479 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/ContainerApps.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/ContainerApps.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/ContainerAppsRevisions.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/ContainerAppsRevisions.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/ContainerAppsRevisions.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/ContainerAppsRevisions.json index 5a5c9a8eb..611d39c60 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/ContainerAppsRevisions.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/ContainerAppsRevisions.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "ContainerAppsRevisions API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/DeletedWebApps.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/DeletedWebApps.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/DeletedWebApps.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/DeletedWebApps.json index 00284cdf0..03701e4a3 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/DeletedWebApps.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/DeletedWebApps.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "DeletedWebApps API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Diagnostics.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Diagnostics.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Diagnostics.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Diagnostics.json index 15fbd78b0..4769c37ac 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Diagnostics.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Diagnostics.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "Diagnostics API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Global.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Global.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Global.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Global.json index 52adee8d0..c7aa16b8c 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Global.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Global.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "Global API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/KubeEnvironments.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/KubeEnvironments.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/KubeEnvironments.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/KubeEnvironments.json index c908c38f8..cc67e128e 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/KubeEnvironments.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/KubeEnvironments.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "KubeEnvironments API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Provider.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Provider.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Provider.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Provider.json index c1c741721..120022291 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Provider.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Provider.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "Provider API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Recommendations.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Recommendations.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Recommendations.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Recommendations.json index bd9ee71a0..23fafb9e4 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/Recommendations.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/Recommendations.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "Recommendations API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/ResourceHealthMetadata.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/ResourceHealthMetadata.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/ResourceHealthMetadata.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/ResourceHealthMetadata.json index e72d630fd..2cc6b777e 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/ResourceHealthMetadata.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/ResourceHealthMetadata.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "ResourceHealthMetadata API Client" }, "host": "management.azure.com", diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/ResourceProvider.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/ResourceProvider.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/ResourceProvider.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/ResourceProvider.json index fa5d6f8f2..7f7daf569 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/ResourceProvider.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/ResourceProvider.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": " API Client" }, "host": "management.azure.com", @@ -391,7 +391,8 @@ "PremiumV3", "PremiumContainer", "ElasticPremium", - "ElasticIsolated" + "ElasticIsolated", + "FlexConsumption" ], "x-ms-enum": { "name": "SkuName", diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/StaticSites.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/StaticSites.json similarity index 99% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/StaticSites.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/StaticSites.json index 85301baff..530f8c625 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/StaticSites.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/StaticSites.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "StaticSites API Client" }, "host": "management.azure.com", @@ -3064,7 +3064,7 @@ "description": "Request body.", "required": true, "schema": { - "$ref": "./CommonDefinitions.json#/definitions/PrivateLinkConnectionApprovalRequestResource" + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" } }, { diff --git a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/WebApps.json b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/WebApps.json similarity index 98% rename from swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/WebApps.json rename to swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/WebApps.json index 5bb245e1f..0e0367bc0 100644 --- a/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-01-01/WebApps.json +++ b/swagger-specs/web/resource-manager/Microsoft.Web/stable/2023-12-01/WebApps.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-01-01", + "version": "2023-12-01", "title": "WebApps API Client" }, "host": "management.azure.com", @@ -212,6 +212,12 @@ "Create or Update web app": { "$ref": "./examples/CreateOrUpdateWebApp.json" }, + "Create or Update Flex Consumption function app": { + "$ref": "./examples/CreateOrUpdateFunctionAppFlexConsumption.json" + }, + "Create or Update Flex Consumption function app with details": { + "$ref": "./examples/CreateOrUpdateFunctionAppFlexConsumptionWithDetails.json" + }, "Clone web app": { "$ref": "./examples/CloneWebApp.json" } @@ -7571,7 +7577,7 @@ "in": "body", "required": true, "schema": { - "$ref": "./CommonDefinitions.json#/definitions/PrivateLinkConnectionApprovalRequestResource" + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" } }, { @@ -8592,6 +8598,208 @@ "x-ms-long-running-operation": true } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Lists all the site containers of a site, or a deployment slot.", + "operationId": "WebApps_ListSiteContainers", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteContainerCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers/{containerName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a site container of a site, or a deployment slot.", + "operationId": "WebApps_GetSiteContainer", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Site Container Name", + "required": true, + "type": "string", + "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates or Updates a site container for a site, or a deployment slot.", + "operationId": "WebApps_CreateOrUpdateSiteContainer", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Site Container Name", + "required": true, + "type": "string", + "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)" + }, + { + "name": "request", + "in": "body", + "description": "Container Entity", + "required": true, + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Site container was created.", + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + "200": { + "description": "Site container was updated.", + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a site container for a site, or a deployment slot.", + "operationId": "WebApps_DeleteSiteContainer", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Site Container Name", + "required": true, + "type": "string", + "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted site container." + }, + "204": { + "description": "Site container does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions": { "get": { "tags": [ @@ -16853,7 +17061,7 @@ "in": "body", "required": true, "schema": { - "$ref": "./CommonDefinitions.json#/definitions/PrivateLinkConnectionApprovalRequestResource" + "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource" } }, { @@ -18011,6 +18219,236 @@ "x-ms-long-running-operation": true } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Lists all the site containers of a site, or a deployment slot.", + "operationId": "WebApps_ListSiteContainersSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get a list of site containers for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteContainerCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers/{containerName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a site container of a site, or a deployment slot.", + "operationId": "WebApps_GetSiteContainerSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the Site Container for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Site Container Name", + "required": true, + "type": "string", + "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates or Updates a site container for a site, or a deployment slot.", + "operationId": "WebApps_CreateOrUpdateSiteContainerSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will create the container for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Site Container Name", + "required": true, + "type": "string", + "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)" + }, + { + "name": "request", + "in": "body", + "description": "Container Entity", + "required": true, + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Site container was created.", + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + "200": { + "description": "Site container was updated.", + "schema": { + "$ref": "#/definitions/SiteContainer" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a site container for a site, or a deployment slot.", + "operationId": "WebApps_DeleteSiteContainerSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the container for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Site Container Name", + "required": true, + "type": "string", + "pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted site container." + }, + "204": { + "description": "Site container does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions": { "get": { "tags": [ @@ -25213,6 +25651,23 @@ } } }, + "EnvironmentVariable": { + "required": [ + "name", + "value" + ], + "type": "object", + "properties": { + "name": { + "description": "Environment variable name", + "type": "string" + }, + "value": { + "description": "Environment variable value", + "type": "string" + } + } + }, "ErrorInfo": { "type": "object", "description": "The error info.", @@ -28278,6 +28733,118 @@ } } }, + "SiteContainer": { + "description": "Container of a site", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SiteContainer resource specific properties", + "required": [ + "image", + "isMain" + ], + "type": "object", + "properties": { + "image": { + "description": "Image Name", + "type": "string" + }, + "targetPort": { + "description": "Target Port", + "type": "string" + }, + "isMain": { + "description": "true if the container is the main site container; false otherwise.", + "type": "boolean" + }, + "startUpCommand": { + "description": "StartUp Command", + "type": "string" + }, + "authType": { + "description": "Auth Type", + "enum": [ + "Anonymous", + "UserCredentials", + "SystemIdentity", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthType", + "modelAsString": false + } + }, + "userName": { + "description": "User Name", + "type": "string" + }, + "passwordSecret": { + "description": "Password Secret", + "type": "string", + "x-ms-secret": true + }, + "userManagedIdentityClientId": { + "description": "UserManagedIdentity ClientId", + "type": "string" + }, + "createdTime": { + "format": "date-time", + "description": "Created Time", + "type": "string", + "readOnly": true + }, + "lastModifiedTime": { + "format": "date-time", + "description": "Last Modified Time", + "type": "string", + "readOnly": true + }, + "volumeMounts": { + "description": "List of volume mounts", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + } + }, + "environmentVariables": { + "description": "List of environment variables", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "SiteContainerCollection": { + "description": "Collection of site containers", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SiteContainer" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, "SiteExtensionInfo": { "description": "Site Extension Information.", "type": "object", @@ -28561,6 +29128,10 @@ "type": "string", "readOnly": true }, + "dnsConfiguration": { + "$ref": "./CommonDefinitions.json#/definitions/SiteDnsConfig", + "description": "Property to configure various DNS related settings for a site." + }, "siteConfig": { "$ref": "./CommonDefinitions.json#/definitions/SiteConfig", "description": "Configuration of the app." @@ -29403,6 +29974,31 @@ } } }, + "VolumeMount": { + "required": [ + "volumeSubPath", + "containerMountPath" + ], + "type": "object", + "properties": { + "volumeSubPath": { + "description": "Sub path in the volume where volume is mounted from.", + "type": "string" + }, + "containerMountPath": { + "description": "Target path on the container where volume is mounted on", + "type": "string" + }, + "data": { + "description": "Config Data to be mounted on the volume", + "type": "string" + }, + "readOnly": { + "description": "Boolean to specify if the mount is read only on the container", + "type": "boolean" + } + } + }, "WebAppInstanceStatusCollection": { "description": "Collection of app instances.", "required": [ diff --git a/swagger-specs/web/resource-manager/api-set.json b/swagger-specs/web/resource-manager/api-set.json index e75022893..b7e6f96a2 100644 --- a/swagger-specs/web/resource-manager/api-set.json +++ b/swagger-specs/web/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.CertificateRegistration/stable/2023-01-01/AppServiceCertificateOrders.json", "Microsoft.CertificateRegistration/stable/2023-01-01/CertificateOrdersDiagnostics.json", "Microsoft.CertificateRegistration/stable/2023-01-01/CertificateRegistrationProvider.json", "Microsoft.DomainRegistration/stable/2023-01-01/Domains.json", "Microsoft.DomainRegistration/stable/2023-01-01/TopLevelDomains.json", "Microsoft.DomainRegistration/stable/2023-01-01/DomainRegistrationProvider.json", "Microsoft.Web/stable/2023-01-01/AppServiceEnvironments.json", "Microsoft.Web/stable/2023-01-01/AppServicePlans.json", "Microsoft.Web/stable/2023-01-01/Certificates.json", "Microsoft.Web/stable/2023-01-01/CommonDefinitions.json", "Microsoft.Web/stable/2023-01-01/ContainerApps.json", "Microsoft.Web/stable/2023-01-01/ContainerAppsRevisions.json", "Microsoft.Web/stable/2023-01-01/DeletedWebApps.json", "Microsoft.Web/stable/2023-01-01/Diagnostics.json", "Microsoft.Web/stable/2023-01-01/Global.json", "Microsoft.Web/stable/2023-01-01/KubeEnvironments.json", "Microsoft.Web/stable/2023-01-01/Provider.json", "Microsoft.Web/stable/2023-01-01/Recommendations.json", "Microsoft.Web/stable/2023-01-01/ResourceHealthMetadata.json", "Microsoft.Web/stable/2023-01-01/ResourceProvider.json", "Microsoft.Web/stable/2023-01-01/StaticSites.json", "Microsoft.Web/stable/2023-01-01/WebApps.json"], "name": "package-2023-01"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.CertificateRegistration/stable/2023-12-01/AppServiceCertificateOrders.json", "Microsoft.CertificateRegistration/stable/2023-12-01/CertificateOrdersDiagnostics.json", "Microsoft.CertificateRegistration/stable/2023-12-01/CertificateRegistrationProvider.json", "Microsoft.DomainRegistration/stable/2023-12-01/Domains.json", "Microsoft.DomainRegistration/stable/2023-12-01/TopLevelDomains.json", "Microsoft.DomainRegistration/stable/2023-12-01/DomainRegistrationProvider.json", "Microsoft.Web/stable/2023-12-01/AppServiceEnvironments.json", "Microsoft.Web/stable/2023-12-01/AppServicePlans.json", "Microsoft.Web/stable/2023-12-01/Certificates.json", "Microsoft.Web/stable/2023-12-01/CommonDefinitions.json", "Microsoft.Web/stable/2023-12-01/ContainerApps.json", "Microsoft.Web/stable/2023-12-01/ContainerAppsRevisions.json", "Microsoft.Web/stable/2023-12-01/DeletedWebApps.json", "Microsoft.Web/stable/2023-12-01/Diagnostics.json", "Microsoft.Web/stable/2023-12-01/Global.json", "Microsoft.Web/stable/2023-12-01/KubeEnvironments.json", "Microsoft.Web/stable/2023-12-01/Provider.json", "Microsoft.Web/stable/2023-12-01/Recommendations.json", "Microsoft.Web/stable/2023-12-01/ResourceHealthMetadata.json", "Microsoft.Web/stable/2023-12-01/ResourceProvider.json", "Microsoft.Web/stable/2023-12-01/StaticSites.json", "Microsoft.Web/stable/2023-12-01/WebApps.json"], "name": "package-2023-12"} \ No newline at end of file diff --git a/swagger-specs/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json b/swagger-specs/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/webpubsub.json similarity index 55% rename from swagger-specs/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json rename to swagger-specs/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/webpubsub.json index b04270021..b310f9972 100644 --- a/swagger-specs/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json +++ b/swagger-specs/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/webpubsub.json @@ -3,7 +3,7 @@ "info": { "title": "WebPubSubManagementClient", "description": "REST API for Azure WebPubSub Service", - "version": "2021-10-01" + "version": "2024-03-01" }, "paths": { "/providers/Microsoft.SignalRService/operations": { @@ -18,7 +18,7 @@ ], "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -31,7 +31,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -73,10 +73,10 @@ } }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -89,7 +89,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -119,10 +119,10 @@ "type": "string" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -135,7 +135,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -161,10 +161,10 @@ ], "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -177,7 +177,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -203,13 +203,13 @@ ], "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -222,7 +222,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -248,13 +248,13 @@ ], "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceName" @@ -270,7 +270,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -300,13 +300,13 @@ } }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceName" @@ -331,11 +331,14 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, "x-ms-examples": { "WebPubSub_CreateOrUpdate": { "$ref": "./examples/WebPubSub_CreateOrUpdate.json" @@ -350,13 +353,13 @@ "operationId": "WebPubSub_Delete", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceName" @@ -375,11 +378,14 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "WebPubSub_Delete": { "$ref": "./examples/WebPubSub_Delete.json" @@ -406,13 +412,13 @@ } }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceName" @@ -426,16 +432,24 @@ } }, "202": { - "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result.." + "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result..", + "headers": { + "Location": { + "type": "string" + } + } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "WebPubSub_Update": { "$ref": "./examples/WebPubSub_Update.json" @@ -443,41 +457,41 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates": { "get": { "tags": [ "WebPubSub" ], - "description": "List hub settings.", - "operationId": "WebPubSubHubs_List", + "description": "List all custom certificates.", + "operationId": "WebPubSubCustomCertificates_List", "produces": [ "application/json" ], "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "Success. The response describes hub settings of the resource.", + "description": "Success. The response describes custom certificates of the resource.", "schema": { - "$ref": "#/definitions/WebPubSubHubList" + "$ref": "#/definitions/CustomCertificateList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -485,60 +499,60 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "WebPubSubHubs_List": { - "$ref": "./examples/WebPubSubHubs_List.json" + "WebPubSubCustomCertificates_List": { + "$ref": "./examples/WebPubSubCustomCertificates_List.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}": { "get": { "tags": [ "WebPubSub" ], - "description": "Get a hub setting.", - "operationId": "WebPubSubHubs_Get", + "description": "Get a custom certificate.", + "operationId": "WebPubSubCustomCertificates_Get", "produces": [ "application/json" ], "parameters": [ { - "in": "path", - "name": "hubName", - "description": "The hub name.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "Success. The response describe the corresponding hub setting.", + "description": "Success. The response describe the corresponding custom certificate.", "schema": { - "$ref": "#/definitions/WebPubSubHub" + "$ref": "#/definitions/CustomCertificate" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "WebPubSubHubs_Get": { - "$ref": "./examples/WebPubSubHubs_Get.json" + "WebPubSubCustomCertificates_Get": { + "$ref": "./examples/WebPubSubCustomCertificates_Get.json" } } }, @@ -546,65 +560,72 @@ "tags": [ "WebPubSub" ], - "description": "Create or update a hub setting.", - "operationId": "WebPubSubHubs_CreateOrUpdate", + "description": "Create or update a custom certificate.", + "operationId": "WebPubSubCustomCertificates_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], "produces": [ "application/json" ], "parameters": [ { - "in": "path", - "name": "hubName", - "description": "The hub name.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "body", - "name": "parameters", - "description": "The resource of WebPubSubHub and its properties", - "required": true, - "schema": { - "$ref": "#/definitions/WebPubSubHub" - } + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "in": "body", + "name": "parameters", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/CustomCertificate" + } } ], "responses": { "200": { - "description": "OK.The request makes no change. The response describes the existing hub setting.", + "description": "Success. The response describes the certificate.", "schema": { - "$ref": "#/definitions/WebPubSubHub" + "$ref": "#/definitions/CustomCertificate" } }, "201": { - "description": "Created. The response describes the hub setting and contains a Location header to query the operation result.", + "description": "Created. The response describes the certificate.", "schema": { - "$ref": "#/definitions/WebPubSubHub" + "$ref": "#/definitions/CustomCertificate" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, "x-ms-examples": { - "WebPubSubHubs_CreateOrUpdate": { - "$ref": "./examples/WebPubSubHubs_CreateOrUpdate.json" + "WebPubSubCustomCertificates_CreateOrUpdate": { + "$ref": "./examples/WebPubSubCustomCertificates_CreateOrUpdate.json" } } }, @@ -612,134 +633,85 @@ "tags": [ "WebPubSub" ], - "description": "Delete a hub setting.", - "operationId": "WebPubSubHubs_Delete", + "description": "Delete a custom certificate.", + "operationId": "WebPubSubCustomCertificates_Delete", "parameters": [ { - "in": "path", - "name": "hubName", - "description": "The hub name.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "certificateName", + "description": "Custom certificate name", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "OK." - }, - "202": { - "description": "Accepted. The response indicates the delete operation is performed in the background." + "description": "Success." }, "204": { - "description": "Success. The response indicates the hub setting is already deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "WebPubSubHubs_Delete": { - "$ref": "./examples/WebPubSubHubs_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/listKeys": { - "post": { - "tags": [ - "WebPubSub" - ], - "description": "Get the access keys of the resource.", - "operationId": "WebPubSub_ListKeys", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - } - ], - "responses": { - "200": { - "description": "Success. The response describes access keys of the resource.", - "schema": { - "$ref": "#/definitions/WebPubSubKeys" - } + "description": "No Content." }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "WebPubSub_ListKeys": { - "$ref": "./examples/WebPubSub_ListKeys.json" + "WebPubSubCustomCertificates_Delete": { + "$ref": "./examples/WebPubSubCustomCertificates_Delete.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains": { "get": { "tags": [ "WebPubSub" ], - "description": "List private endpoint connections", - "operationId": "WebPubSubPrivateEndpointConnections_List", + "description": "List all custom domains.", + "operationId": "WebPubSubCustomDomains_List", "produces": [ "application/json" ], "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "Success. The response describes a list of private endpoint connections.", + "description": "Success. The response describes custom domains of the resource.", "schema": { - "$ref": "#/definitions/PrivateEndpointConnectionList" + "$ref": "#/definitions/CustomDomainList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -747,60 +719,60 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "WebPubSubPrivateEndpointConnections_List": { - "$ref": "./examples/WebPubSubPrivateEndpointConnections_List.json" + "WebPubSubCustomDomains_List": { + "$ref": "./examples/WebPubSubCustomDomains_List.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}": { "get": { "tags": [ "WebPubSub" ], - "description": "Get the specified private endpoint connection", - "operationId": "WebPubSubPrivateEndpointConnections_Get", + "description": "Get a custom domain.", + "operationId": "WebPubSubCustomDomains_Get", "produces": [ "application/json" ], "parameters": [ { - "in": "path", - "name": "privateEndpointConnectionName", - "description": "The name of the private endpoint connection", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "Success. The response describes a private endpoint connection.", + "description": "Success. The response describe the corresponding custom domain.", "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" + "$ref": "#/definitions/CustomDomain" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "WebPubSubPrivateEndpointConnections_Get": { - "$ref": "./examples/WebPubSubPrivateEndpointConnections_Get.json" + "WebPubSubCustomDomains_Get": { + "$ref": "./examples/WebPubSubCustomDomains_Get.json" } } }, @@ -808,58 +780,66 @@ "tags": [ "WebPubSub" ], - "description": "Update the state of specified private endpoint connection", - "operationId": "WebPubSubPrivateEndpointConnections_Update", + "description": "Create or update a custom domain.", + "operationId": "WebPubSubCustomDomains_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], "produces": [ "application/json" ], "parameters": [ { - "in": "path", - "name": "privateEndpointConnectionName", - "description": "The name of the private endpoint connection", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "in": "body", - "name": "parameters", - "description": "The resource of private endpoint and its properties", - "required": true, - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "in": "body", + "name": "parameters", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomain" + } } ], "responses": { - "200": { - "description": "OK. The response indicates the private endpoint connection is updated successfully.", + "201": { + "description": "Created. The response describes the custom domain and contains a Location header to query the operation result.", "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" + "$ref": "#/definitions/CustomDomain" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, "x-ms-examples": { - "WebPubSubPrivateEndpointConnections_Update": { - "$ref": "./examples/WebPubSubPrivateEndpointConnections_Update.json" + "WebPubSubCustomDomains_CreateOrUpdate": { + "$ref": "./examples/WebPubSubCustomDomains_CreateOrUpdate.json" } } }, @@ -867,73 +847,76 @@ "tags": [ "WebPubSub" ], - "description": "Delete the specified private endpoint connection", - "operationId": "WebPubSubPrivateEndpointConnections_Delete", + "description": "Delete a custom domain.", + "operationId": "WebPubSubCustomDomains_Delete", "parameters": [ { - "in": "path", - "name": "privateEndpointConnectionName", - "description": "The name of the private endpoint connection", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "name", + "description": "Custom domain name.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "Success. The response indicates the resource is already deleted." + "description": "Success. The response indicates the custom domain is deleted." }, "202": { - "description": "Accepted. The response indicates the delete operation is performed in the background." + "description": "Accepted. The response indicates the operation is performed in the background." }, "204": { - "description": "Success. The response indicates the private endpoint connection is already deleted." + "description": "Success. The response indicates the custom domain is deleted." }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { - "WebPubSubPrivateEndpointConnections_Delete": { - "$ref": "./examples/WebPubSubPrivateEndpointConnections_Delete.json" + "WebPubSubCustomDomains_Delete": { + "$ref": "./examples/WebPubSubCustomDomains_Delete.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateLinkResources": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs": { "get": { "tags": [ "WebPubSub" ], - "description": "Get the private link resources that need to be created for a resource.", - "operationId": "WebPubSubPrivateLinkResources_List", + "description": "List hub settings.", + "operationId": "WebPubSubHubs_List", "produces": [ "application/json" ], "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceName" @@ -941,15 +924,15 @@ ], "responses": { "200": { - "description": "Success. The response describes a list of private link resources.", + "description": "Success. The response describes hub settings of the resource.", "schema": { - "$ref": "#/definitions/PrivateLinkResourceList" + "$ref": "#/definitions/WebPubSubHubList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -957,72 +940,1110 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "WebPubSubPrivateLinkResources_List": { - "$ref": "./examples/WebPubSubPrivateLinkResources_List.json" + "WebPubSubHubs_List": { + "$ref": "./examples/WebPubSubHubs_List.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/regenerateKey": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}": { + "get": { "tags": [ "WebPubSub" ], - "description": "Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", - "operationId": "WebPubSub_RegenerateKey", + "description": "Get a hub setting.", + "operationId": "WebPubSubHubs_Get", "produces": [ "application/json" ], "parameters": [ { - "in": "body", - "name": "parameters", - "description": "Parameter that describes the Regenerate Key Operation.", + "in": "path", + "name": "hubName", + "description": "The hub name.", "required": true, - "schema": { - "$ref": "#/definitions/RegenerateKeyParameters" - } + "type": "string" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceName" } ], "responses": { - "202": { - "description": "Accepted and an async operation is executing in background to make the new key to take effect. The response contains new access keys and a Location header to query the async operation result.", + "200": { + "description": "Success. The response describe the corresponding hub setting.", "schema": { - "$ref": "#/definitions/WebPubSubKeys" + "$ref": "#/definitions/WebPubSubHub" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, "x-ms-examples": { - "WebPubSub_RegenerateKey": { - "$ref": "./examples/WebPubSub_RegenerateKey.json" + "WebPubSubHubs_Get": { + "$ref": "./examples/WebPubSubHubs_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/restart": { - "post": { + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a hub setting.", + "operationId": "WebPubSubHubs_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "hubName", + "description": "The hub name.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "parameters", + "description": "The resource of WebPubSubHub and its properties", + "required": true, + "schema": { + "$ref": "#/definitions/WebPubSubHub" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK.The request makes no change. The response describes the existing hub setting.", + "schema": { + "$ref": "#/definitions/WebPubSubHub" + } + }, + "201": { + "description": "Created. The response describes the hub setting and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/WebPubSubHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubHubs_CreateOrUpdate": { + "$ref": "./examples/WebPubSubHubs_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete a hub setting.", + "operationId": "WebPubSubHubs_Delete", + "parameters": [ + { + "in": "path", + "name": "hubName", + "description": "The hub name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the hub setting is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubHubs_Delete": { + "$ref": "./examples/WebPubSubHubs_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/listKeys": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Get the access keys of the resource.", + "operationId": "WebPubSub_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes access keys of the resource.", + "schema": { + "$ref": "#/definitions/WebPubSubKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_ListKeys": { + "$ref": "./examples/WebPubSub_ListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List private endpoint connections", + "operationId": "WebPubSubPrivateEndpointConnections_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_List": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the specified private endpoint connection", + "operationId": "WebPubSubPrivateEndpointConnections_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_Get": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Update the state of specified private endpoint connection", + "operationId": "WebPubSubPrivateEndpointConnections_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "in": "body", + "name": "parameters", + "description": "The resource of private endpoint and its properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the private endpoint connection is updated successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_Update": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_Update.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete the specified private endpoint connection", + "operationId": "WebPubSubPrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_Delete": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the private link resources that need to be created for a resource.", + "operationId": "WebPubSubPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubPrivateLinkResources_List": { + "$ref": "./examples/WebPubSubPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/regenerateKey": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", + "operationId": "WebPubSub_RegenerateKey", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "parameters", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/WebPubSubKeys" + } + }, + "202": { + "description": "Accepted and an async operation is executing in background to make the new key to take effect. The response contains new access keys and a Location header to query the async operation result.", + "schema": { + "$ref": "#/definitions/WebPubSubKeys" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSub_RegenerateKey": { + "$ref": "./examples/WebPubSub_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List all replicas belong to this resource", + "operationId": "WebPubSubReplicas_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes replicas of the resource.", + "schema": { + "$ref": "#/definitions/ReplicaList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubReplicas_List": { + "$ref": "./examples/WebPubSubReplicas_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the replica and its properties.", + "operationId": "WebPubSubReplicas_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubReplicas_Get": { + "$ref": "./examples/WebPubSubReplicas_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a replica.", + "operationId": "WebPubSubReplicas_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/Replica" + } + } + ], + "responses": { + "200": { + "description": "Updated. The response describes a replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "201": { + "description": "Created. The response describes the new replica and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubReplicas_CreateOrUpdate": { + "$ref": "./examples/WebPubSubReplicas_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to delete a replica.", + "operationId": "WebPubSubReplicas_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the replica is deleted." + }, + "204": { + "description": "Success. The response indicates the replica is deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubReplicas_Delete": { + "$ref": "./examples/WebPubSubReplicas_Delete.json" + } + } + }, + "patch": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to update an exiting replica.", + "operationId": "WebPubSubReplicas_Update", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/Replica" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes a replica.", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "202": { + "description": "Updated. The response describes the new replica and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/Replica" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubReplicas_Update": { + "$ref": "./examples/WebPubSubReplicas_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/restart": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to restart a replica.", + "operationId": "WebPubSubReplicas_Restart", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the restart operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Success. The response indicates the operation is successful and no content will be returned." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "WebPubSubReplicas_Restart": { + "$ref": "./examples/WebPubSubReplicas_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List shared private link resources", + "operationId": "WebPubSubReplicaSharedPrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of shared private link resources.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubReplicaSharedPrivateLinkResources_List": { + "$ref": "./examples/WebPubSubReplicaSharedPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the specified shared private link resource", + "operationId": "WebPubSubReplicaSharedPrivateLinkResources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a shared private link resource.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubReplicaSharedPrivateLinkResources_Get": { + "$ref": "./examples/WebPubSubReplicaSharedPrivateLinkResources_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a shared private link resource", + "operationId": "WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The shared private link resource", + "required": true, + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the shared private link resource is updated.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "201": { + "description": "Created. The response indicates the shared private link resource is created.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate": { + "$ref": "./examples/WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/skus": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List all available skus of the replica resource.", + "operationId": "WebPubSub_ListReplicaSkus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ReplicaName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes all available skus of the replica resource.", + "schema": { + "$ref": "#/definitions/SkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_ListReplicaSkus": { + "$ref": "./examples/WebPubSub_ListReplicaSkus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/restart": { + "post": { "tags": [ "WebPubSub" ], @@ -1030,13 +2051,13 @@ "operationId": "WebPubSub_Restart", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceName" @@ -1044,7 +2065,12 @@ ], "responses": { "202": { - "description": "Accepted. The response indicates the restart operation is performed in the background." + "description": "Accepted. The response indicates the restart operation is performed in the background.", + "headers": { + "Location": { + "type": "string" + } + } }, "204": { "description": "Success. The response indicates the operation is successful and no content will be returned." @@ -1052,13 +2078,13 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" + "final-state-via": "location" }, "x-ms-examples": { "WebPubSub_Restart": { @@ -1079,13 +2105,13 @@ ], "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceName" @@ -1101,7 +2127,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1127,20 +2153,16 @@ ], "parameters": [ { - "in": "path", - "name": "sharedPrivateLinkResourceName", - "description": "The name of the shared private link resource", - "required": true, - "type": "string" + "$ref": "#/parameters/SharedPrivateLinkResourceName" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceName" @@ -1156,7 +2178,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1177,11 +2199,7 @@ ], "parameters": [ { - "in": "path", - "name": "sharedPrivateLinkResourceName", - "description": "The name of the shared private link resource", - "required": true, - "type": "string" + "$ref": "#/parameters/SharedPrivateLinkResourceName" }, { "in": "body", @@ -1193,13 +2211,13 @@ } }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceName" @@ -1221,11 +2239,14 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, "x-ms-examples": { "WebPubSubSharedPrivateLinkResources_CreateOrUpdate": { "$ref": "./examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json" @@ -1240,20 +2261,16 @@ "operationId": "WebPubSubSharedPrivateLinkResources_Delete", "parameters": [ { - "in": "path", - "name": "sharedPrivateLinkResourceName", - "description": "The name of the shared private link resource", - "required": true, - "type": "string" + "$ref": "#/parameters/SharedPrivateLinkResourceName" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceName" @@ -1272,11 +2289,14 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "WebPubSubSharedPrivateLinkResources_Delete": { "$ref": "./examples/WebPubSubSharedPrivateLinkResources_Delete.json" @@ -1296,13 +2316,13 @@ ], "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceName" @@ -1318,7 +2338,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1343,52 +2363,301 @@ "modelAsString": true } }, + "CustomCertificate": { + "description": "A custom certificate.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomCertificateProperties" + } + } + }, + "CustomCertificateList": { + "description": "Custom certificates list.", + "type": "object", + "properties": { + "value": { + "description": "List of custom certificates of this resource.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomCertificate" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "CustomCertificateProperties": { + "description": "Custom certificate properties.", + "required": [ + "keyVaultBaseUri", + "keyVaultSecretName" + ], + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "keyVaultBaseUri": { + "description": "Base uri of the KeyVault that stores certificate.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "keyVaultSecretName": { + "description": "Certificate secret name.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "keyVaultSecretVersion": { + "description": "Certificate secret version.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "CustomDomain": { + "description": "A custom domain", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainProperties" + } + } + }, + "CustomDomainList": { + "description": "Custom domains list", + "type": "object", + "properties": { + "value": { + "description": "List of custom domains that bind to this resource.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomain" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "CustomDomainProperties": { + "description": "Properties of a custom domain.", + "required": [ + "customCertificate", + "domainName" + ], + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "domainName": { + "description": "The custom domain name.", + "type": "string" + }, + "customCertificate": { + "$ref": "#/definitions/ResourceReference" + } + } + }, "Dimension": { "description": "Specifications of the Dimension of metrics.", "type": "object", "properties": { - "name": { - "description": "The public facing name of the dimension.", - "type": "string" - }, - "displayName": { - "description": "Localized friendly display name of the dimension.", + "name": { + "description": "The public facing name of the dimension.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension.", + "type": "string" + }, + "internalName": { + "description": "Name of the dimension as it appears in MDM.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", + "type": "boolean" + } + } + }, + "EventHandler": { + "description": "Properties of event handler.", + "required": [ + "urlTemplate" + ], + "type": "object", + "properties": { + "urlTemplate": { + "description": "Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in.\r\nFor example, UrlTemplate can be `http://example.com/api/{hub}/{event}`. The host part can't contains parameters.", + "type": "string" + }, + "userEventPattern": { + "description": "Gets or sets the matching pattern for event names.\r\nThere are 3 kinds of patterns supported:\r\n 1. \"*\", it matches any event name\r\n 2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\r\n 3. A single event name, for example, \"event1\", it matches \"event1\"", + "type": "string" + }, + "systemEvents": { + "description": "Gets or sets the list of system events.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "auth": { + "$ref": "#/definitions/UpstreamAuthSettings" + } + } + }, + "EventHubEndpoint": { + "description": "An Event Hub endpoint. \r\nThe managed identity of Web PubSub service must be enabled, and the identity should have the \"Azure Event Hubs Data sender\" role to access Event Hub.", + "required": [ + "eventHubName", + "fullyQualifiedNamespace" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventListenerEndpoint" + } + ], + "properties": { + "fullyQualifiedNamespace": { + "description": "The fully qualified namespace name of the Event Hub resource. For example, \"example.servicebus.windows.net\".", "type": "string" }, - "internalName": { - "description": "Name of the dimension as it appears in MDM.", + "eventHubName": { + "description": "The name of the Event Hub.", "type": "string" + } + }, + "x-ms-discriminator-value": "EventHub" + }, + "EventListener": { + "description": "A setting defines which kinds of events should be sent to which endpoint.", + "required": [ + "endpoint", + "filter" + ], + "type": "object", + "properties": { + "filter": { + "$ref": "#/definitions/EventListenerFilter" }, - "toBeExportedForShoebox": { - "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", - "type": "boolean" + "endpoint": { + "$ref": "#/definitions/EventListenerEndpoint" } } }, - "EventHandler": { - "description": "Properties of event handler.", + "EventListenerEndpoint": { + "description": "An endpoint specifying where Web PubSub should send events to.", "required": [ - "urlTemplate" + "type" ], "type": "object", "properties": { - "urlTemplate": { - "description": "Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in.\r\nFor example, UrlTemplate can be `http://example.com/api/{hub}/{event}`. The host part can't contains parameters.", - "type": "string" - }, - "userEventPattern": { - "description": "Gets or sets the matching pattern for event names.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any event name\r\n 2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\r\n 3. The single event name, for example, \"event1\", it matches \"event1\"", - "type": "string" - }, + "type": { + "enum": [ + "EventHub" + ], + "type": "string", + "x-ms-enum": { + "name": "EventListenerEndpointDiscriminator", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "EventListenerFilter": { + "description": "A base class for event filter which determines whether an event should be sent to an event listener.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "enum": [ + "EventName" + ], + "type": "string", + "x-ms-enum": { + "name": "EventListenerFilterDiscriminator", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "EventNameFilter": { + "description": "Filter events by their name.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventListenerFilter" + } + ], + "properties": { "systemEvents": { - "description": "Gets ot sets the list of system events.", + "description": "Gets or sets a list of system events. Supported events: \"connected\" and \"disconnected\". Blocking event \"connect\" is not supported because it requires a response.", "type": "array", "items": { "type": "string" - } + }, + "x-ms-identifiers": [] }, - "auth": { - "$ref": "#/definitions/UpstreamAuthSettings" + "userEventPattern": { + "description": "Gets or sets a matching pattern for event names.\r\nThere are 3 kinds of patterns supported:\r\n 1. \"*\", it matches any event name\r\n 2. Combine multiple events with \",\", for example \"event1,event2\", it matches events \"event1\" and \"event2\"\r\n 3. A single event name, for example, \"event1\", it matches \"event1\"", + "type": "string" + } + }, + "x-ms-discriminator-value": "EventName" + }, + "IPRule": { + "description": "An IP rule", + "type": "object", + "properties": { + "value": { + "description": "An IP or CIDR or ServiceTag", + "type": "string" + }, + "action": { + "$ref": "#/definitions/ACLAction" } } }, @@ -1574,7 +2843,7 @@ "type": "object", "properties": { "type": { - "description": "The resource type. Can be \"Microsoft.SignalRService/SignalR\" or \"Microsoft.SignalRService/webPubSub\"", + "description": "The resource type. Can be \"Microsoft.SignalRService/SignalR\", \"Microsoft.SignalRService/WebPubSub\", \"Microsoft.SignalRService/SignalR/replicas\" or \"Microsoft.SignalRService/WebPubSub/replicas\"", "type": "string" }, "name": { @@ -1592,14 +2861,16 @@ "type": "array", "items": { "$ref": "#/definitions/WebPubSubRequestType" - } + }, + "x-ms-identifiers": [] }, "deny": { "description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", "type": "array", "items": { "$ref": "#/definitions/WebPubSubRequestType" - } + }, + "x-ms-identifiers": [] } } }, @@ -1712,14 +2983,10 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ], "properties": { - "systemData": { - "readOnly": true, - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PrivateEndpointConnectionProperties" @@ -1735,7 +3002,8 @@ "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" - } + }, + "x-ms-identifiers": [] }, "nextLink": { "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", @@ -1760,7 +3028,8 @@ "items": { "type": "string" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/PrivateLinkServiceConnectionState" @@ -1772,7 +3041,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ], "properties": { @@ -1791,7 +3060,8 @@ "type": "array", "items": { "$ref": "#/definitions/PrivateLinkResource" - } + }, + "x-ms-identifiers": [] }, "nextLink": { "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", @@ -1812,14 +3082,16 @@ "type": "array", "items": { "type": "string" - } + }, + "x-ms-identifiers": [] }, "requiredZoneNames": { "description": "Required private DNS zone names", "type": "array", "items": { "type": "string" - } + }, + "x-ms-identifiers": [] }, "shareablePrivateLinkResourceTypes": { "description": "The list of resources that are onboarded to private link service", @@ -1876,50 +3148,73 @@ "Moving" ], "type": "string", + "readOnly": true, "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true } }, - "ProxyResource": { - "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "keyType": { + "$ref": "#/definitions/KeyType" + } + } + }, + "Replica": { + "description": "A class represent a replica resource.", "type": "object", "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } - ] + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReplicaProperties" + } + } }, - "RegenerateKeyParameters": { - "description": "Parameters describes the request to regenerate access keys", + "ReplicaList": { "type": "object", "properties": { - "keyType": { - "$ref": "#/definitions/KeyType" + "value": { + "description": "List of the replica", + "type": "array", + "items": { + "$ref": "#/definitions/Replica" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" } } }, - "Resource": { - "description": "The core properties of ARM resources.", + "ReplicaProperties": { "type": "object", "properties": { - "id": { - "description": "Fully qualified resource Id for the resource.", - "type": "string", - "readOnly": true + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" }, - "name": { - "description": "The name of the resource.", - "type": "string", - "readOnly": true + "regionEndpointEnabled": { + "description": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.", + "default": "Enabled", + "type": "string" }, - "type": { - "description": "The type of the resource - e.g. \"Microsoft.SignalRService/SignalR\"", - "type": "string", - "readOnly": true + "resourceStopped": { + "description": "Stop or start the resource. Default to \"false\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started.", + "default": "false", + "type": "string" } - }, - "x-ms-azure-resource": true + } }, "ResourceLogCategory": { "description": "Resource log category configuration of a Microsoft.SignalRService resource.", @@ -1951,6 +3246,16 @@ } } }, + "ResourceReference": { + "description": "Reference to a resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string" + } + } + }, "ResourceSku": { "description": "The billing information of the resource.", "required": [ @@ -1959,7 +3264,7 @@ "type": "object", "properties": { "name": { - "description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1", + "description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2", "type": "string" }, "tier": { @@ -1977,7 +3282,7 @@ }, "capacity": { "format": "int32", - "description": "Optional, integer. The unit count of the resource. 1 by default.\r\n\r\nIf present, following values are allowed:\r\n Free: 1\r\n Standard: 1,2,5,10,20,50,100", + "description": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n Free_F1: 1;\r\n Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium_P2: 100,200,300,400,500,600,700,800,900,1000;", "type": "integer" } } @@ -1995,6 +3300,18 @@ "modelAsString": true } }, + "ServiceKind": { + "description": "The kind of the service", + "enum": [ + "WebPubSub", + "SocketIO" + ], + "type": "string", + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true + } + }, "ServiceSpecification": { "description": "An object that describes a specification.", "type": "object", @@ -2058,14 +3375,10 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ], "properties": { - "systemData": { - "readOnly": true, - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SharedPrivateLinkResourceProperties" @@ -2081,7 +3394,8 @@ "type": "array", "items": { "$ref": "#/definitions/SharedPrivateLinkResource" - } + }, + "x-ms-identifiers": [] }, "nextLink": { "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", @@ -2170,7 +3484,8 @@ "type": "array", "items": { "$ref": "#/definitions/SignalRServiceUsage" - } + }, + "x-ms-identifiers": [] }, "nextLink": { "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", @@ -2240,7 +3555,8 @@ "format": "int32", "type": "integer" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "scaleType": { "readOnly": true, @@ -2258,12 +3574,12 @@ "items": { "$ref": "#/definitions/Sku" }, + "readOnly": true, "x-ms-identifiers": [ "resourceType", "/sku/name", "/sku/tier" - ], - "readOnly": true + ] }, "nextLink": { "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", @@ -2272,32 +3588,6 @@ } } }, - "TrackedResource": { - "description": "The resource model definition for a ARM tracked top level resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "description": "Tags of the service which is a list of key value pairs that describe the resource.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, "UpstreamAuthSettings": { "description": "Upstream auth settings. If not set, no auth is used for upstream messages.", "type": "object", @@ -2346,14 +3636,10 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ], "properties": { - "systemData": { - "readOnly": true, - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - }, "properties": { "$ref": "#/definitions/WebPubSubHubProperties" } @@ -2368,7 +3654,8 @@ "type": "array", "items": { "$ref": "#/definitions/WebPubSubHub" - } + }, + "x-ms-identifiers": [] }, "nextLink": { "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", @@ -2387,14 +3674,28 @@ "items": { "$ref": "#/definitions/EventHandler" }, - "x-ms-identifiers": [ - "urlTemplate" - ] + "x-ms-identifiers": [] + }, + "eventListeners": { + "description": "Event listener settings for forwarding your client events to listeners.\r\nEvent listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.\r\nOne event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter.\r\nMaximum count of event listeners among all hubs is 10.", + "type": "array", + "items": { + "$ref": "#/definitions/EventListener" + }, + "x-ms-identifiers": [] }, "anonymousConnectPolicy": { "description": "The settings for configuring if anonymous connections are allowed for this hub: \"allow\" or \"deny\". Default to \"deny\".", "default": "deny", "type": "string" + }, + "webSocketKeepAliveIntervalInSeconds": { + "format": "int32", + "description": "The settings for configuring the WebSocket ping-pong interval in seconds for all clients in the hub. Valid range: 1 to 120. Default to 20 seconds.", + "default": 20, + "maximum": 120, + "minimum": 1, + "type": "integer" } } }, @@ -2443,6 +3744,15 @@ "x-ms-identifiers": [ "name" ] + }, + "ipRules": { + "description": "IP rules for filtering public traffic", + "maxItems": 30, + "type": "array", + "items": { + "$ref": "#/definitions/IPRule" + }, + "x-ms-identifiers": [] } } }, @@ -2487,7 +3797,8 @@ "items": { "$ref": "#/definitions/PrivateEndpointConnection" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "sharedPrivateLinkResources": { "description": "The list of shared private link resources.", @@ -2495,7 +3806,8 @@ "items": { "$ref": "#/definitions/SharedPrivateLinkResource" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "tls": { "$ref": "#/definitions/WebPubSubTlsSettings" @@ -2528,6 +3840,19 @@ "description": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work.", "default": false, "type": "boolean" + }, + "regionEndpointEnabled": { + "description": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\r\nThis property is replica specific. Disable the regional endpoint without replica is not allowed.", + "default": "Enabled", + "type": "string" + }, + "resourceStopped": { + "description": "Stop or start the resource. Default to \"False\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started.", + "default": "false", + "type": "string" + }, + "socketIO": { + "$ref": "#/definitions/WebPubSubSocketIOSettings" } } }, @@ -2550,7 +3875,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "properties": { @@ -2561,12 +3886,15 @@ "x-ms-client-flatten": true, "$ref": "#/definitions/WebPubSubProperties" }, + "kind": { + "x-ms-mutability": [ + "read", + "create" + ], + "$ref": "#/definitions/ServiceKind" + }, "identity": { "$ref": "#/definitions/ManagedIdentity" - }, - "systemData": { - "readOnly": true, - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" } } }, @@ -2579,7 +3907,8 @@ "type": "array", "items": { "$ref": "#/definitions/WebPubSubResource" - } + }, + "x-ms-identifiers": [] }, "nextLink": { "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", @@ -2601,46 +3930,59 @@ "modelAsString": true } }, + "WebPubSubSocketIOSettings": { + "description": "SocketIO settings for the resource", + "type": "object", + "properties": { + "serviceMode": { + "description": "The service mode of Web PubSub for Socket.IO. Values allowed: \r\n\"Default\": have your own backend Socket.IO server\r\n\"Serverless\": your application doesn't have a backend server", + "type": "string" + } + } + }, "WebPubSubTlsSettings": { "description": "TLS settings for the resource", "type": "object", "properties": { "clientCertEnabled": { - "description": "Request client certificate during TLS handshake if enabled", - "default": true, + "description": "Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier.", + "default": false, "type": "boolean" } } } }, "parameters": { - "ApiVersionParameter": { - "in": "query", - "name": "api-version", - "description": "Client Api Version.", - "required": true, - "type": "string" - }, - "SubscriptionIdParameter": { + "ResourceName": { "in": "path", - "name": "subscriptionId", - "description": "Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "name": "resourceName", + "description": "The name of the resource.", "required": true, - "type": "string" + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", + "type": "string", + "x-ms-parameter-location": "method" }, - "ResourceGroupParameter": { + "ReplicaName": { "in": "path", - "name": "resourceGroupName", - "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.", + "name": "replicaName", + "description": "The name of the replica.", "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", "type": "string", "x-ms-parameter-location": "method" }, - "ResourceName": { + "SharedPrivateLinkResourceName": { "in": "path", - "name": "resourceName", - "description": "The name of the resource.", + "name": "sharedPrivateLinkResourceName", + "description": "The name of the shared private link resource.", "required": true, + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$", "type": "string", "x-ms-parameter-location": "method" } diff --git a/swagger-specs/webpubsub/resource-manager/api-set.json b/swagger-specs/webpubsub/resource-manager/api-set.json index aa79839e7..f9018e3f0 100644 --- a/swagger-specs/webpubsub/resource-manager/api-set.json +++ b/swagger-specs/webpubsub/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.SignalRService/stable/2021-10-01/webpubsub.json"], "name": "package-2021-10-01"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.SignalRService/stable/2024-03-01/webpubsub.json"], "name": "package-2024-03-01"} \ No newline at end of file